FunctionEngine
Defined in: src/engine/function-engine.ts:17
Wraps a plain () => number in [0, 1) as an engine.
Anywhere an engine is accepted, a bare function is accepted too and wrapped for you; this is what does the wrapping.
Example
Section titled “Example”import { Random } from "ransu";
// The function is adopted automatically.new Random(() => Math.random()).integer(1, 6); // 4Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new FunctionEngine(
fn):FunctionEngine
Defined in: src/engine/function-engine.ts:23
Parameters
Section titled “Parameters”() => number
Returns
Section titled “Returns”FunctionEngine
Properties
Section titled “Properties”algorithm
Section titled “algorithm”
readonlyalgorithm:"function"="function"
Defined in: src/engine/function-engine.ts:18
Identifies the algorithm in EngineState.
Implementation of
Section titled “Implementation of”seedable
Section titled “seedable”
readonlyseedable:false=false
Defined in: src/engine/function-engine.ts:19
Whether the engine can be re-seeded. Math.random and the CSPRNG cannot.
Implementation of
Section titled “Implementation of”Methods
Section titled “Methods”clone()
Section titled “clone()”clone():
Engine
Defined in: src/engine/function-engine.ts:35
Returns
Section titled “Returns”Implementation of
Section titled “Implementation of”nextFloat64()
Section titled “nextFloat64()”nextFloat64():
number
Defined in: src/engine/function-engine.ts:31
A uniform double in [0, 1) with 53 bits of precision.
Returns
Section titled “Returns”number
Implementation of
Section titled “Implementation of”nextUint32()
Section titled “nextUint32()”nextUint32():
number
Defined in: src/engine/function-engine.ts:27
A uniform integer in [0, 2^32).
Returns
Section titled “Returns”number