api.md

esm-seedrandom API

Fast PRNG Algorithms

PRNG name	Period	Author	BigCrush test results
prng_alea	~2^116	Baagøe	pass all
prng_xor128	2^128-1	Marsaglia	fail MatrixRank and LinearComp
prng_tychei	~2^127	Neves/Araujo (ChaCha)	pass all
prng_xorwow	2^192-2^32	Marsaglia	fail CollisionOver, SimpPoker, and LinearComp
prng_xor4096	2^4096-2^32	Brent (xorgens)	pass all
prng_xorshift7	2^256-1	Panneton/L'ecuyer	pass all
prng_arc4	~2^1600	Bau (ARC4)	unknown

Common API

Construction

let prng = prng_algorithm('your own seed string')

// or to allow state capture:
let prng = prng_algorithm('your own seed string', {state: true})

// or to restore state:
let state = JSON.parse( your_load_from_storage_impl() )
let prng = prng_algorithm('your own seed string', {state: state})

Floating point numbers between 0.0 and 1.0

prng.quick() returns a pseudo random number between 0.0 and 1.0 with enough bits for a 32-bit floating point.

prng.double() returns a pseudo random number between 0.0 and 1.0 with enough bits for a 56-bit floating point.

prng() is an alias for prng.quick() for most algorithms. The ARC4 algorithm aliases prng() to prng.double().

32-bit Integers

prng.int32() returns a pseudo random number between -2147483648 and 2147483647 for a 32-bit signed integer.

State capture

prng.state() returns JSON serializable object used to reinitialize the PRNG algorithm to the same state.

Save State

let prng = prng_algorithm('your own seed string', {state: true})

let state = JSON.stringify( prng.state() )
your_save_to_storage_impl(state)

Restore State

let state = JSON.parse( your_load_from_storage_impl() )
let prng = prng_algorithm(null, {state})