Class: LCG

Constructor

new LCG(seed)

Implements the LCG algorithm to generate pseudorandom numbers.

This class provides the LCG method of generating psuedorandom numbers to the PRNG class.

Parameters:

Name	Type	Description
`seed`	number	The seed value for the LCG PRNG.

Source: Random.js, line 126
See: https://en.wikipedia.org/wiki/Linear_congruential_generator

Example

const rng = new LCG(123456789);
console.log(rng.next()); // Generates a pseudorandom number

Extends

PRNG

Classes

LCG: Implements the LCG algorithm to generate pseudorandom numbers.

Methods

maxValue() → {number}

Returns the maximum possible value of the LCG.

Overrides: PRNG#maxValue
Source: Random.js, line 152

Returns:

The maximum value (2^32).

Type:: number

next() → {number}

Generates the next pseudorandom number.

Overrides: PRNG#next
Source: Random.js, line 143

Returns:

A pseudorandom number in the range [0-1).

Type:: number

randomBipolarFloat() → {number}

Generate a random float in the range [-1, 1).

Overrides: PRNG#randomBipolarFloat
Source: Random.js, line 47

Returns:

A number between -1 (inclusive) and 1 (exclusive).

Type:: number

randomChance(chanceopt) → {boolean}

Returns a boolean based on a specified probability.

Parameters:

Name	Type	Attributes	Default	Description
`chance`	number	<optional>	0.5	The probability of returning true (between 0 and 1).

Overrides: PRNG#randomChance
Source: Random.js, line 77

Returns:

True if the random float is less than the chance, otherwise false.

Type:: boolean

randomElement(array) → {*}

Select a random element from an array.

Parameters:

Name	Type	Description
`array`	array	The array from which to select an element.

Overrides: PRNG#randomElement
Source: Random.js, line 67

Returns:

A randomly selected element from the array.

Type:: *

randomFloat() → {number}

Generate a random float in the range [0, 1).

Overrides: PRNG#randomFloat
Source: Random.js, line 39

Returns:

A number between 0 (inclusive) and 1 (exclusive).

Type:: number

randomInteger(min, max) → {number}

Generate a random integer from a specified range of values.

Parameters:

Name	Type	Description
`min`	number	The minimum integer value (inclusive).
`max`	number	The maximum integer value (exclusive).

Overrides: PRNG#randomInteger
Source: Random.js, line 57

Returns:

A random integer between min (inclusive) and max (exclusive).

Type:: number

randomWeighted(choices) → {function|number|string}

Selects an option probabalistically from a set of weighted choices.

Parameters:

Name Type Description

choices

Array.<Object>

An array of objects with option and weight properties.

Properties

Name	Type	Description
`option`	function \| number \| string	The outcome of the choice.
`weight`	number	The weight of the choice. Higher weights (relative to the other choices) increase the likelihood of selection.

Overrides: PRNG#randomWeighted
Source: Random.js, line 88

Returns:

The selected option.

Type:: function | number | string