Negative Binomial Random Numbers

Usage

var negativeBinomial = require( '@stdlib/random/base/negative-binomial' );

negativeBinomial( r, p )

Returns a pseudorandom number drawn from a negative binomial distribution with parameters r (number of successes until experiment is stopped) and p (success probability).

var r = negativeBinomial( 20, 0.8 );
// returns <number>

If r or p is NaN, the function returns NaN.

var r = negativeBinomial( NaN, 0.4 );
// returns NaN

r = negativeBinomial( 20, NaN );
// returns NaN

If p is not in the interval (0,1) (exclusive), the function returns NaN.

var r = negativeBinomial( 10, 1.1 );
// returns NaN

r = negativeBinomial( 10, 1.0 );
// returns NaN

r = negativeBinomial( 10, 0.0 );
// returns NaN

negativeBinomial.factory( [r, p, ][options] )

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

var rand = negativeBinomial.factory();

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

If provided r and p, the returned generator returns random variates from the specified distribution.

var rand = negativeBinomial.factory( 10, 0.8 );

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

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

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

var rand = negativeBinomial.factory();

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

r = rand( 123, 0.21 );
// returns <number>

The function accepts the following options:

• prng: pseudorandom number generator for generating uniformly distributed pseudorandom numbers on the interval [0,1). If provided, the function ignores both the state and seed options. In order to seed the returned pseudorandom number generator, one must seed the provided prng (assuming the provided prng is seedable).
• seed: pseudorandom number generator seed.
• state: a Uint32Array containing pseudorandom number generator state. If provided, the function ignores the seed option.
• copy: boolean indicating whether to copy a provided pseudorandom number generator state. Setting this option to false allows sharing state between two or more pseudorandom number generators. Setting this option to true ensures that a returned generator has exclusive control over its internal state. Default: true.

To use a custom PRNG as the underlying source of uniformly distributed pseudorandom numbers, set the prng option.

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

var rand = negativeBinomial.factory({
    'prng': minstd.normalized
});

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

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

var rand1 = negativeBinomial.factory({
    'seed': 12345
});

var r1 = rand1( 8, 0.9 );
// returns <number>

var rand2 = negativeBinomial.factory( 8, 0.9, {
    'seed': 12345
});

var r2 = rand2();
// returns <number>

var bool = ( r1 === r2 );
// returns true

To return a generator having a specific initial state, set the generator state option.

var rand;
var bool;
var r;
var i;

// Generate pseudorandom numbers, thus progressing the generator state:
for ( i = 0; i < 1000; i++ ) {
    r = negativeBinomial( 8, 0.9 );
}

// Create a new PRNG initialized to the current state of `negativeBinomial`:
rand = negativeBinomial.factory({
    'state': negativeBinomial.state
});

// Test that the generated pseudorandom numbers are the same:
bool = ( rand( 8, 0.9 ) === negativeBinomial( 8, 0.9 ) );
// returns true

negativeBinomial.NAME

The generator name.

var str = negativeBinomial.NAME;
// returns 'negative-binomial'

negativeBinomial.PRNG

The underlying pseudorandom number generator.

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

negativeBinomial.seed

The value used to seed negativeBinomial().

var rand;
var r;
var i;

// Generate pseudorandom values...
for ( i = 0; i < 100; i++ ) {
    r = negativeBinomial( 20, 0.5 );
}

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

If provided a PRNG for uniformly distributed numbers, this value is null.

var rand = negativeBinomial.factory({
    'prng': Math.random
});

var seed = rand.seed;
// returns null

negativeBinomial.seedLength

Length of generator seed.

var len = negativeBinomial.seedLength;
// returns <number>

If provided a PRNG for uniformly distributed numbers, this value is null.

var rand = negativeBinomial.factory({
    'prng': Math.random
});

var len = rand.seedLength;
// returns null

negativeBinomial.state

Writable property for getting and setting the generator state.

var r = negativeBinomial( 20, 0.5 );
// returns <number>

r = negativeBinomial( 20, 0.5 );
// returns <number>

// ...

// Get a copy of the current state:
var state = negativeBinomial.state;
// returns <Uint32Array>

r = negativeBinomial( 20, 0.5 );
// returns <number>

r = negativeBinomial( 20, 0.5 );
// returns <number>

// Reset the state:
negativeBinomial.state = state;

// Replay the last two pseudorandom numbers:
r = negativeBinomial( 20, 0.5 );
// returns <number>

r = negativeBinomial( 20, 0.5 );
// returns <number>

// ...

If provided a PRNG for uniformly distributed numbers, this value is null.

var rand = negativeBinomial.factory({
    'prng': Math.random
});

var state = rand.state;
// returns null

negativeBinomial.stateLength

Length of generator state.

var len = negativeBinomial.stateLength;
// returns <number>

If provided a PRNG for uniformly distributed numbers, this value is null.

var rand = negativeBinomial.factory({
    'prng': Math.random
});

var len = rand.stateLength;
// returns null

negativeBinomial.byteLength

Size (in bytes) of generator state.

var sz = negativeBinomial.byteLength;
// returns <number>

If provided a PRNG for uniformly distributed numbers, this value is null.

var rand = negativeBinomial.factory({
    'prng': Math.random
});

var sz = rand.byteLength;
// returns null

negativeBinomial.toJSON()

Serializes the pseudorandom number generator as a JSON object.

var o = negativeBinomial.toJSON();
// returns { 'type': 'PRNG', 'name': '...', 'state': {...}, 'params': [] }

If provided a PRNG for uniformly distributed numbers, this method returns null.

var rand = negativeBinomial.factory({
    'prng': Math.random
});

var o = rand.toJSON();
// returns null