Class Xoshiro128

Remarks

References:

Hierarchy (view full)

ARandom
- Xoshiro128

Implements

IBuffered<Uint32Array>
ICopy<Xoshiro128>
ISeedable<ArrayLike<number>>

Index

Constructors

Properties

Methods

bytes copy float int minmax minmaxInt minmaxUint norm normMinMax probability seed

Constructors

constructor

new Xoshiro128(seed?): Xoshiro128
Parameters
- seed: ArrayLike<number> = DEFAULT_SEED_128
Returns Xoshiro128
Overrides ARandom.constructor
- Defined in xoshiro128.ts:21

Properties

buffer

buffer: Uint32Array

Methods

bytes

bytes(): Uint8Array
Returns Uint8Array
Implementation of IBuffered.bytes
- Defined in xoshiro128.ts:31

copy

copy(): Xoshiro128
Returns Xoshiro128
Implementation of ICopy.copy
- Defined in xoshiro128.ts:27

float

float(norm?): number
Returns float in [0..max) interval.
Parameters
- norm: number = 1
  default 1
Returns number
Remarks
See: https://github.com/thi-ng/umbrella/wiki/Glossary#interval
Inherited from ARandom.float
- Defined in arandom.ts:8

int

int(): number
Returns unsigned 32bit int in [0..0xffffffff] interval.
Returns number
Remarks
See: https://github.com/thi-ng/umbrella/wiki/Glossary#interval
Overrides ARandom.int
- Defined in xoshiro128.ts:40

minmax

minmax(min, max): number
Returns float in [min..max) interval.
Parameters
- min: number
- max: number
Returns number
Remarks
See: https://github.com/thi-ng/umbrella/wiki/Glossary#interval
Inherited from ARandom.minmax
- Defined in arandom.ts:25

minmaxInt

minmaxInt(min, max): number
Returns int in signed integer [min..max) interval.
Parameters
- min: number
- max: number
Returns number
Remarks
See: https://github.com/thi-ng/umbrella/wiki/Glossary#interval
Inherited from ARandom.minmaxInt
- Defined in arandom.ts:29

minmaxUint

minmaxUint(min, max): number
Returns int in unsigned integer [min..max) interval.
Parameters
- min: number
- max: number
Returns number
Remarks
See: https://github.com/thi-ng/umbrella/wiki/Glossary#interval
Inherited from ARandom.minmaxUint
- Defined in arandom.ts:35

norm

norm(norm?): number
Returns float in [-scale..scale) interval.
Parameters
- norm: number = 1
  default 1
Returns number
Remarks
Not to be confused with the normal distribution function. The name here refers to "normalized".
Also see: https://github.com/thi-ng/umbrella/wiki/Glossary#interval
Inherited from ARandom.norm
- Defined in arandom.ts:16

normMinMax

normMinMax(min, max): number
Similar to INorm.norm, but returns values in either the [min..max) or in the (-max...-min] interval (i.e. excluding values in the (-min..min) range). Both min and max MUST be >= 0.
Parameters
- min: number
- max: number
Returns number
Remarks
See: https://github.com/thi-ng/umbrella/wiki/Glossary#interval
Inherited from ARandom.normMinMax
- Defined in arandom.ts:20

probability

probability(p): boolean
Calls IRandom.float and returns true iff result is < p (assumed to be in [0..1] interval).
Parameters
- p: number
Returns boolean
Inherited from ARandom.probability
- Defined in arandom.ts:12

seed

seed(seed): Xoshiro128
(Re)seeds this PRNG instance with given value(s).
Parameters
- seed: ArrayLike<number>
Returns Xoshiro128
Implementation of ISeedable.seed
- Defined in xoshiro128.ts:35

Generated using TypeDoc