random

constructor

constructor(seed?: Seed);

property i

i: number;

property j

j: number;

property name

readonly name: string;

property S

S: number[];

method clone

clone: () => ARC4RNG;

method g

g: (count: number) => number;

method next

next: () => number;

constructor

constructor(rngFn: RNGFn);

property name

readonly name: string;

method clone

clone: () => FunctionRNG;

method next

next: () => number;

property name

readonly name: string;

method clone

clone: () => MathRandomRNG;

method next

next: () => number;

constructor

constructor(seedOrRNG?: SeedOrRNG);

property rng

readonly rng: RNG;

• {RNG} rng - Underlying pseudo-random number generator.

method bates

bates: (n?: number) => IDist<number>;

• Generates a [Bates distribution](https://en.wikipedia.org/wiki/Bates_distribution).

  Parameter n

  Number of uniform samples to average (n >= 1)

method bernoulli

bernoulli: (p?: number) => IDist<number>;

• Generates a [Bernoulli distribution](https://en.wikipedia.org/wiki/Bernoulli_distribution).

  Parameter p

  Success probability of each trial.

method binomial

binomial: (n?: number, p?: number) => IDist<number>;

• Generates a [Binomial distribution](https://en.wikipedia.org/wiki/Binomial_distribution).

  Parameter n

  Number of trials.

  Parameter p

  Success probability of each trial.

method bool

bool: () => boolean;

• Samples a uniform random boolean value.

  Convenience wrapper around random.uniformBoolean()

  random.boolean

method boolean

boolean: () => boolean;

• Samples a uniform random boolean value.

  Convenience wrapper around random.uniformBoolean()

method choice

choice: <T>(array: Array<T>) => T | undefined;

• Returns an item chosen uniformly at random from the given array.

  Convenience wrapper around random.uniformInt()

  Parameter array

  Input array

method clone

clone: (seedOrRNG?: SeedOrRNG) => Random;

• Creates a new Random instance, optionally specifying parameters to set a new seed.

method exponential

exponential: (lambda?: number) => IDist<number>;

• Generates an [Exponential distribution](https://en.wikipedia.org/wiki/Exponential_distribution).

  Parameter lambda

  Inverse mean (lambda > 0)

method float

float: (min?: number, max?: number) => number;

• Samples a uniform random floating point number, optionally specifying lower and upper bounds.

  Convenience wrapper around random.uniform()

  Parameter min

  Lower bound (float, inclusive)

  Parameter max

  Upper bound (float, exclusive)

method geometric

geometric: (p?: number) => IDist<number>;

• Generates a [Geometric distribution](https://en.wikipedia.org/wiki/Geometric_distribution).

  Parameter p

  Success probability of each trial.

method int

int: (min?: number, max?: number) => number;

• Samples a uniform random integer, optionally specifying lower and upper bounds.

  Convenience wrapper around random.uniformInt()

  Parameter min

  Lower bound (integer, inclusive)

  Parameter max

  Upper bound (integer, inclusive)

method integer

integer: (min?: number, max?: number) => number;

• Samples a uniform random integer, optionally specifying lower and upper bounds.

  Convenience wrapper around random.uniformInt()

  random.int

  Parameter min

  Lower bound (integer, inclusive)

  Parameter max

  Upper bound (integer, inclusive)

method irwinHall

irwinHall: (n?: number) => IDist<number>;

• Generates an [Irwin Hall distribution](https://en.wikipedia.org/wiki/Irwin%E2%80%93Hall_distribution).

  Parameter n

  Number of uniform samples to sum (n >= 0)

method logNormal

logNormal: (mu?: number, sigma?: number) => IDist<number>;

• Generates a [Log-normal distribution](https://en.wikipedia.org/wiki/Log-normal_distribution).

  Parameter mu

  Mean of underlying normal distribution

  Parameter sigma

  Standard deviation of underlying normal distribution

method next

next: () => number;

• Convenience wrapper around this.rng.next()

  Returns a floating point number in [0, 1).

  {number}

method normal

normal: (mu?: number, sigma?: number) => IDist<number>;

• Generates a [Normal distribution](https://en.wikipedia.org/wiki/Normal_distribution).

  Parameter mu

  Mean

  Parameter sigma

  Standard deviation

method pareto

pareto: (alpha?: number) => IDist<number>;

• Generates a [Pareto distribution](https://en.wikipedia.org/wiki/Pareto_distribution).

  Parameter alpha

  Alpha

method poisson

poisson: (lambda?: number) => IDist<number>;

• Generates a [Poisson distribution](https://en.wikipedia.org/wiki/Poisson_distribution).

  Parameter lambda

  Mean (lambda > 0)

method sample

sample: <T>(array: Array<T>, k: number) => Array<T>;

• Returns a random subset of k items from the given array (without replacement).

  Parameter array

  Input array

method sampler

sampler: <T>(array: Array<T>, k: number) => () => Array<T>;

• Generates a thunk which returns samples of size k from the given array.

  This is for convenience only; there is no gain in efficiency.

  Parameter array

  Input array

method shuffle

shuffle: <T>(array: Array<T>) => Array<T>;

• Returns a shuffled copy of the given array.

  Parameter array

  Input array

method shuffler

shuffler: <T>(array: Array<T>) => () => Array<T>;

• Generates a thunk which returns shuffled copies of the given array.

  Parameter array

  Input array

method uniform

uniform: (min?: number, max?: number) => IDist<number>;

• Generates a [Continuous uniform distribution](https://en.wikipedia.org/wiki/Uniform_distribution_(continuous)).

  Parameter min

  Lower bound (float, inclusive)

  Parameter max

  Upper bound (float, exclusive)

method uniformBoolean

uniformBoolean: () => IDist<boolean>;

• Generates a [Discrete uniform distribution](https://en.wikipedia.org/wiki/Discrete_uniform_distribution), with two possible outcomes, true or `false.

  This method is analogous to flipping a coin.

method uniformInt

uniformInt: (min?: number, max?: number) => IDist<number>;

• Generates a [Discrete uniform distribution](https://en.wikipedia.org/wiki/Discrete_uniform_distribution).

  Parameter min

  Lower bound (integer, inclusive)

  Parameter max

  Upper bound (integer, inclusive)

method use

use: (seedOrRNG: SeedOrRNG) => void;

• Sets the underlying pseudorandom number generator.

  Example 1

  import random from 'random'
  
  random.use('example-seed')
  // or
  random.use(Math.random)

method weibull

weibull: (lambda: number, k: number) => () => number;

• Generates a [Weibull distribution](https://en.wikipedia.org/wiki/Weibull_distribution).

  Parameter lambda

  Lambda, the scale parameter

  Parameter k

  k, the shape parameter

property name

readonly name: string;

method clone

abstract clone: () => RNG;

method next

abstract next: () => number;

constructor

constructor(seed?: Seed);

property name

readonly name: string;

property w

w: number;

property x

x: number;

property y

y: number;

property z

z: number;

method clone

clone: () => XOR128RNG;

method next

next: () => number;