Normal Random Numbers

Normally distributed pseudorandom numbers.

Usage

var normal = require( '@stdlib/math/base/random/normal' );

normal( mu, sigma )

Returns a pseudorandom number drawn from a normal distribution with parameters mu (mean) and sigma (standard deviation).

var r = normal( 2.0, 5.0 );
// returns <number>

If mu or sigma is NaN or sigma <= 0, the function returns NaN.

var r = normal( 2.0, -2.0 );
// returns NaN

r = normal( NaN, 5.0 );
// returns NaN

r = normal( 2.0, NaN );
// returns NaN

normal.factory( [mu, sigma, ][options] )

Returns a pseudorandom number generator (PRNG) for generating pseudorandom numbers drawn from a normal distribution.

var rand = normal.factory();

var r = rand( 0.1, 1.5 );
// returns <number>

If provided mu and sigma, the returned generator returns random variates from the specified distribution.

// Draw from normal( 10.0, 2.0 ) distribution:
var rand = normal.factory( 10.0, 2.0 );

var r = rand();
// returns <number>

r = rand();
// returns <number>

If not provided mu and sigma, the returned generator requires that both parameters be provided at each invocation.

var rand = normal.factory();

var r = rand( 0.0, 1.0 );
// returns <number>

r = rand( -2.0, 2.0 );
// returns <number>

The function accepts the following options:

• seed: pseudorandom number generator seed.

To seed a pseudorandom number generator, set the seed option.

var rand = normal.factory({
    'seed': 12345
});

var r = rand( 1.0, 2.0 );
// returns <number>

rand = normal.factory( 1.0, 2.0, {
    'seed': 12345
});

r = rand();
// returns <number>

normal.NAME

The generator name.

var name = normal.NAME;
// returns 'normal'

normal.PRNG

The underlying pseudorandom number generator.

var prng = normal.PRNG;
// returns <Function>

normal.SEED

The value used to seed normal().

var rand;
var r;
var i;

// Generate pseudorandom values...
for ( i = 0; i < 100; i++ ) {
    r = normal( 2.0, 2.0 );
}

// Generate the same pseudorandom values...
rand = normal.factory( 2.0, 2.0, {
    'seed': normal.SEED
});
for ( i = 0; i < 100; i++ ) {
    r = rand();
}

Examples

var normal = require( '@stdlib/math/base/random/normal' );

var seed;
var rand;
var i;

// Generate pseudorandom numbers...
console.log( '\nseed: %d', normal.SEED );
for ( i = 0; i < 100; i++ ) {
    console.log( normal( 0.0, 1.0 ) );
}

// Create a new pseudorandom number generator...
seed = 1234;
rand = normal.factory( 5.0, 2.0, {
    'seed': seed
});
console.log( '\nseed: %d', seed );
for ( i = 0; i < 100; i++ ) {
    console.log( rand() );
}

// Create another pseudorandom number generator using a previous seed...
rand = normal.factory( 0.0, 1.0, {
    'seed': normal.SEED
});
console.log( '\nseed: %d', normal.SEED );
for ( i = 0; i < 100; i++ ) {
    console.log( rand() );
}