Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Random

Interface for generating pseudorandom numbers drawn from an Erlang distribution.

Hierarchy

Callable

  • __call(k: number, lambda: number): number

  • Returns an Erlang distributed pseudorandom number.

    Notes
    • If k is not a positive integer or lambda <= 0, the function returns NaN.
    • If k or lambda is NaN, the function returns NaN.

    Parameters

    • k: number

      shape parameter

    • lambda: number

      rate parameter

    Returns number

    pseudorandom number

    Example

    var v = erlang( 3, 1.5 );
// returns <number>

Index

Properties

Methods

Properties

NAME

NAME: string

Generator name.

PRNG

PRNG: random.PRNG

Underlying pseudorandom number generator.

byteLength

byteLength: number

PRNG state size (in bytes).

seed

seed: random.PRNGSeedMT19937

PRNG seed.

seedLength

seedLength: number

PRNG seed length.

state

state: random.PRNGStateMT19937

PRNG state.

stateLength

stateLength: number

PRNG state length.

Methods

factory

  • Returns a pseudorandom number generator for generating Erlang distributed random numbers.

    Notes
    • When provided k and lambda, the returned PRNG returns random variates drawn from the specified distribution.
    throws

    must provide a valid state

    Parameters

    • k: number

      shape parameter

    • lambda: number

      rate parameter

    • Optional options: Options

      function options

    Returns NullaryFunction

    pseudorandom number generator

    Example

    var myerlang = erlang.factory( 3, 1.5 );

var v = myerlang();
// returns <number>

    Example

    var myerlang = erlang.factory( 2, 1.5, {
    'seed': 297
});
var v = myerlang();
// returns <number>

  • Returns a pseudorandom number generator for generating Erlang distributed random numbers.

    Notes
    • When not provided k and lambda, the returned PRNG requires that both k and lambda be provided at each invocation.
    throws

    must provide a valid state

    Parameters

    • Optional options: Options

      function options

    Returns BinaryFunction

    pseudorandom number generator

    Example

    var myerlang = erlang.factory();

var v = myerlang( 1, 1.5 );
// returns <number>

    Example

    var myerlang = erlang.factory({
    'seed': 297
});
var v = myerlang( 2, 2.3 );
// returns <number>

toJSON

  • toJSON(): string