Generator ¶

properties¶

BitGenerator : () -> number

The bit generator thats used to generate random numbers.

type : "Generator"

The type of the object, this being "Generator"

methods¶

random -> () ¶

Generator:random(

): Generator

Generates a ndArray of random values between 0 - 1.

integers -> () ¶

Generator:integers(
    min : number,
    max : number,
    shape : {number}
): ndArray

Generates a ndArray of random integers between min - max.

choice -> () ¶

Generator:choice(
    shape : {number},
    target : ndArray
): ndArray

Generates a ndArray of random values from a target array.

normal -> () ¶

Generator:normal(
    mean : number,
    std_dev : number,
    shape : {number}
): ndArray

Generates a ndArray of random values sampled from a normal distribution, defined by a mean and standard deviation.

lognormal -> () ¶

Generator:lognormal(
    mean : number,
    std_dev : number,
    shape : {number}
): ndArray

Generates a ndArray of random values sampled from a lognormal distribution, defined by a mean and standard deviation.

exponential -> () ¶

Generator:exponential(
    scale : number,
    shape : {number}
): ndArray

Generates a ndArray of random values sampled from a exponential distribution thats scaled.

gamma -> () ¶

Generator:gamma(
    alpha : number,
    scale : number,
    shape : {number}
): ndArray

Generates a ndArray of random values sampled from a gamma distribution, defined by ɑ and scale.

beta -> () ¶

Generator:beta(
    alpha : number,
    beta : number,
    shape : {number}
): ndArray

Generates a ndArray of random values sampled from a gamma distribution, defined by ɑ and β.

uniform -> () ¶

Generator:uniform(
    min : number,
    max : number,
    shape : {number}
): ndArray

Generates a ndArray of random values sampled from a uniform distribution between min - max.

poisson -> () ¶

Generator:poisson(
    lambda : number,
    shape : {number}
): ndArray

Generates a ndArray of random values sampled from a poisson distribution defined by λ. with λ representing rate

binomial -> () ¶

Generator:binomial(
    trial_num : number,
    probability : number,
    shape : {number}
): ndArray

Generates a ndArray of random values sampled from a binomial distribution defined by a trial number and probability.

shuffle -> () ¶

Generator:shuffle(
    target : ndArray,
    axis : number
): ndArray

Performs a inplace shuffle on a target ndArray across an axis.

permutation -> () ¶

Generator:permutation(
    target : ndArray | number,
    axis : number
): ndArray

returns a result of shuffle on a clone of the target ndArray across an axis.