Options
All
  • Public
  • Public/Protected
  • All
Menu

@thi.ng/random

@thi.ng/random

npm version npm downloads Twitter Follow

This project is part of the @thi.ng/umbrella monorepo.

About

Pseudo-random number generators w/ unified API.

This package provides the IRandom interface and various (mostly seedable) pseudo-random number generator implementations, incl. a IRandom wrapper for Math.random():

Partially ported from C implementations taken from c.thi.ng.

Status

STABLE - used in production

Installation

yarn add @thi.ng/random

Package sizes (gzipped): ESM: 1.1KB / CJS: 1.2KB / UMD: 1.2KB

Dependencies

Usage examples

Several demos in this repo's /examples directory are using this package.

A selection:

fft-synth

screenshot

Interactive inverse FFT toy synth

Live demo | Source

shader-ast-evo

screenshot

Live demo | Source

API

Generated API docs

import { Smush32 } from "@thi.ng/random";

const rnd = new Smush32(0xdecafbad);

// the following methods are available for all generators

// next uint (0 .. 2^32-1)
rnd.int()
// 4022849029

// next float [0.0 .. 1.0)
rnd.float()
// 0.2698542904737066

// next normalized float (w/ opt scale)
// [-scale .. +scale)
rnd.norm(100)
// 57.70723665079737

// next float in given interval [min .. max)
rnd.minmax(10, 20)
// 15.295951807707537

// next gaussian (using iterative CLT approach)
// optional params: num samples, offset, scale
rnd.gaussian()
// 0.10632886109089679

Other utilities

Authors

Karsten Schmidt

License

© 2016 - 2020 Karsten Schmidt // Apache Software License 2.0

Generated using TypeDoc