Class default

Classdesc

Random class

Hierarchy

default

Index

Constructors

Methods

choice randInt random randomSample

Constructors

constructor

new default(seedOrRandom??: number | RandomNumberGenerator): default
Parameters
- Optional seedOrRandom: number | RandomNumberGenerator = Math.random
  
  Control the random number generator used by the Random class instance. Pass a random number generator function with a uniform distribution over the half-open interval [0, 1[. If seed will pass it to ml-xsadd to create a seeded random number generator. If undefined will use Math.random.
Returns default
- Defined in index.ts:15

Methods

choice

choice<T>(values: T[], options?: ChoiceOptions): T[]
Returns an array of elements choosen from a list

Returns
The choosen values
Type Parameters
- T
Parameters
- values: T[]
  
  The values to choose from. If a number, the list will be a range of integer from 0 to that number.
- Optional options: ChoiceOptions
  
  option object
Returns T[]
- Defined in index.ts:31
choice(values: number, options?: ChoiceOptions): number[]
Parameters
- values: number
- Optional options: ChoiceOptions
Returns number[]
- Defined in index.ts:32

randInt

randInt(low: number, high?: number): number
Draw a random integer from a uniform distribution on [low, high). If only low is specified, the number is drawn on [0, low)
Parameters
- low: number
  
  The lower bound of the uniform distribution interval.
- Optional high: number
  
  The higher bound of the uniform distribution interval.
Returns number
- Defined in index.ts:56

random

random(): number
Draw a random number from a uniform distribution on [0,1)

Returns
The random number

Returns number
- Defined in index.ts:47

randomSample

randomSample(size: number): number[]
Draw several random number from a uniform distribution on [0, 1)

Returns
- The list of drawn numbers.
Parameters
- size: number
  
  The number of number to draw
Returns number[]
- Defined in index.ts:69