Class Random

Pseudo-random number generator following the Mersenne_Twister algorithm. Given a seed this generator will produce the same sequence of numbers each time it is called. See https://en.wikipedia.org/wiki/Mersenne_Twister for more details. Uses the MT19937-32 (2002) implementation documented here http://www.math.sci.hiroshima-u.ac.jp/~m-mat/MT/MT2002/emt19937ar.html

Api inspired by http://chancejs.com/# https://github.com/chancejs/chancejs

Hierarchy

Random

Index

Constructors

Properties

Methods

bool d10 d12 d20 d4 d6 d8 floating integer next nextInt pickOne pickSet range shuffle

Constructors

constructor

new Random(seed?: number): Random
If no seed is specified, the Date.now() is used
Parameters
- Optional seed: number
Returns Random
- Defined in Math/Random.ts:55

Properties

`Optional` seed

seed?: number

Methods

bool

bool(likelihood?: number): boolean
Returns true or false randomly with 50/50 odds by default. By default the likelihood of returning a true is .5 (50%).
Parameters
- likelihood: number = 0.5
  
  takes values between [0, 1]
Returns boolean
- Defined in Math/Random.ts:134

d10

d10(): number
Returns the result of a d10 dice roll

Returns number
- Defined in Math/Random.ts:257

d12

d12(): number
Returns the result of a d12 dice roll

Returns number
- Defined in Math/Random.ts:264

d20

d20(): number
Returns the result of a d20 dice roll

Returns number
- Defined in Math/Random.ts:271

d4

d4(): number
Returns the result of a d4 dice roll

Returns number
- Defined in Math/Random.ts:236

d6

d6(): number
Returns the result of a d6 dice roll

Returns number
- Defined in Math/Random.ts:243

d8

d8(): number
Returns the result of a d8 dice roll

Returns number
- Defined in Math/Random.ts:250

floating

floating(min: number, max: number): number
Return a random floating point in range [min, max) min is included, max is not included
Parameters
- min: number
- max: number
Returns number
- Defined in Math/Random.ts:117

integer

integer(min: number, max: number): number
Return a random integer in range [min, max] min is included, max is included. Implemented with rejection sampling, see https://medium.com/@betable/tifu-by-using-math-random-f1c308c4fd9d#.i13tdiu5a
Parameters
- min: number
- max: number
Returns number
- Defined in Math/Random.ts:125

next

next(): number
Return a random floating point number between [0, 1)

Returns number
- Defined in Math/Random.ts:110

nextInt

nextInt(): number
Return next 32 bit integer number in sequence

Returns number
- Defined in Math/Random.ts:92

pickOne

pickOne<T>(array: T[]): T
Returns one element from an array at random
Type Parameters
- T
Parameters
- array: T[]
Returns T
- Defined in Math/Random.ts:141

pickSet

pickSet<T>(array: T[], numPicks: number, allowDuplicates?: boolean): T[]
Returns a new array random picking elements from the original
Type Parameters
- T
Parameters
- array: T[]
  
  Original array to pick from
- numPicks: number
  
  can be any positive number
- allowDuplicates: boolean = false
  
  indicates whether the returned set is allowed duplicates (it does not mean there will always be duplicates just that it is possible)
Returns T[]
- Defined in Math/Random.ts:152

range

range(length: number, min: number, max: number): number[]
Generate a list of random integer numbers
Parameters
- length: number
  
  the length of the final array
- min: number
  
  the minimum integer number to generate inclusive
- max: number
  
  the maximum integer number to generate inclusive
Returns number[]
- Defined in Math/Random.ts:225

shuffle

shuffle<T>(array: T[]): T[]
Returns a new array that has its elements shuffled. Using the Fisher/Yates method https://en.wikipedia.org/wiki/Fisher%E2%80%93Yates_shuffle
Type Parameters
- T
Parameters
- array: T[]
Returns T[]
- Defined in Math/Random.ts:206