# Beta Prime Random Numbers

Beta prime distributed pseudorandom numbers.

## Usage

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

#### betaprime( alpha, beta )

Returns a pseudorandom number drawn from a beta prime distribution with parameters `alpha` (first shape parameter) and `beta` (second shape parameter).

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

If `alpha <= 0` or `beta <= 0`, the function returns `NaN`.

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

r = betaprime( -2.0, 2.0 );
// returns NaN
``````

If `alpha` or `beta` is `NaN`, the function returns `NaN`.

``````var r = betaprime( NaN, 5.0 );
// returns NaN

r = betaprime( 2.0, NaN );
// returns NaN
``````

#### betaprime.factory( [alpha, beta, ][options] )

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

``````var rand = betaprime.factory();

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

If provided `alpha` and `beta`, the returned generator returns random variates from the specified distribution.

``````// Draw from BetaPrime( 1.5, 1.5 ) distribution:
var rand = betaprime.factory( 1.5, 1.5 );

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

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

If not provided `alpha` and `beta`, the returned generator requires that both parameters be provided at each invocation.

``````var rand = betaprime.factory();

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

r = rand( 3.14, 2.25 );
// 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 = betaprime.factory({
'seed': 12345
});

var r = rand( 2.0, 3.0 );
// returns ~2.433

rand = betaprime.factory( 2.0, 3.0, {
'seed': 12345
});

r = rand();
// returns ~2.433
``````

#### betaprime.NAME

The generator name.

``````var str = betaprime.NAME;
// returns 'betaprime'
``````

#### betaprime.PRNG

The underlying pseudorandom number generator.

``````var prng = betaprime.PRNG;
// returns <Function>
``````

#### betaprime.SEED

The value used to seed `betaprime()`.

``````var rand;
var r;
var i;

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

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

## Examples

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

var seed;
var rand;
var i;

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

// Create a new pseudorandom number generator...
seed = 1234;
rand = betaprime.factory( 6.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 = betaprime.factory( 2.0, 2.0, {
'seed': betaprime.SEED
});
console.log( '\nseed: %d', betaprime.SEED );
for ( i = 0; i < 100; i++ ) {
console.log( rand() );
}
``````