Class XorShiftRng

Hierarchy

Rng
- XorShiftRng

Index

Constructors

Methods

[iterator] fillBytes float fromArray iter keyFromObject next nextFloat nextFloatInRange nextInt nextIntInRange set setSeed shuffle uniformFloat uniformInt valueFromObject fromSeed

Constructors

constructor

new XorShiftRng(x?: number, y?: number, z?: number, w?: number): XorShiftRng
Parameters
- Optional x: number
- Optional y: number
- Optional z: number
- Optional w: number
Returns XorShiftRng
Overrides Rng.constructor
- Defined in XorShiftRng.ts:12

Methods

[iterator]

[iterator](): XorShiftRng
Returns XorShiftRng
Inherited from Rng.[iterator]
- Defined in Rng.ts:79

fillBytes

fillBytes<B>(bytes: B): B
Type Parameters
- B extends number[] | Uint8Array = number[] | Uint8Array
Parameters
- bytes: B
Returns B
Inherited from Rng.fillBytes
- Defined in Rng.ts:61

float

float(): FloatIter<XorShiftRng>
Returns FloatIter<XorShiftRng>
Inherited from Rng.float
- Defined in Rng.ts:91

fromArray

fromArray<T>(array: ArrayLike<T>): Option<T>
Type Parameters
- T
Parameters
- array: ArrayLike<T>
Returns Option<T>
Inherited from Rng.fromArray
- Defined in Rng.ts:45

iter

iter(): Iter<number>
Returns Iter<number>
Inherited from Rng.iter
- Defined in Rng.ts:83

keyFromObject

keyFromObject<T>(object: T): Option<keyof T>
Type Parameters
- T extends object
Parameters
- object: T
Returns Option<keyof T>
Inherited from Rng.keyFromObject
- Defined in Rng.ts:53

next

next(): IteratorResult<number, any>
Returns IteratorResult<number, any>
Inherited from Rng.next
- Defined in Rng.ts:87

nextFloat

nextFloat(): number
Returns number
Inherited from Rng.nextFloat
- Defined in Rng.ts:15

nextFloatInRange

nextFloatInRange(min?: number, max?: number): number
returns inclusive float between min and max
Parameters
- min: number = 0.0
- max: number = 1.0
Returns number
Inherited from Rng.nextFloatInRange
- Defined in Rng.ts:22

nextInt

nextInt(): number
Returns number
Overrides Rng.nextInt
- Defined in XorShiftRng.ts:34

nextIntInRange

nextIntInRange(min?: number, max?: number): number
returns inclusive integer between min and max
Parameters
- min: number = 0
- max: number = MAX_INT
Returns number
Inherited from Rng.nextIntInRange
- Defined in Rng.ts:29

set

set(x?: number, y?: number, z?: number, w?: number): XorShiftRng
Parameters
- x: number = 0x193a6754
- y: number = 0xa8a7d469
- z: number = 0x97830e05
- w: number = 0x113ba7bb
Returns XorShiftRng
- Defined in XorShiftRng.ts:26

setSeed

setSeed(seed?: number): XorShiftRng
Parameters
- Optional seed: number
Returns XorShiftRng
- Defined in XorShiftRng.ts:21

shuffle

shuffle<T>(array: T[]): T[]
Type Parameters
- T
Parameters
- array: T[]
Returns T[]
Inherited from Rng.shuffle
- Defined in Rng.ts:33

uniformFloat

uniformFloat(min?: number, max?: number): UniformFloatIter<XorShiftRng>
Parameters
- min: number = 0.0
- max: number = 1.0
Returns UniformFloatIter<XorShiftRng>
Inherited from Rng.uniformFloat
- Defined in Rng.ts:95

uniformInt

uniformInt(min?: number, max?: number): UniformIntIter<XorShiftRng>
Parameters
- min: number = 0
- max: number = MAX_INT
Returns UniformIntIter<XorShiftRng>
Inherited from Rng.uniformInt
- Defined in Rng.ts:99

valueFromObject

valueFromObject<T>(object: T): Option<T[keyof T]>
Type Parameters
- T extends object
Parameters
- object: T
Returns Option<T[keyof T]>
Inherited from Rng.valueFromObject
- Defined in Rng.ts:57

`Static` fromSeed

fromSeed(seed?: number): XorShiftRng
Parameters
- Optional seed: number
Returns XorShiftRng
- Defined in XorShiftRng.ts:17

Generated using TypeDoc