Usage

`javascript
var f = require( '@stdlib/random-base-f' );
`

#### f( d1, d2 )

Returns a pseudorandom number drawn from an [F][f] distribution with parameters d1 (degrees of freedom) and d2 (degrees of freedom).

`javascript
var r = f( 2.0, 5.0 );
// returns
`

If d1 <= 0 or d2 <= 0, the function returns NaN.

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

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

If d1 or d2 is NaN, the function returns NaN.

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

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

#### f.factory( \[d1, d2, ]\[options] )

Returns a pseudorandom number generator (PRNG) for generating pseudorandom numbers drawn from am [F][f] distribution.

`javascript
var rand = f.factory();

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

If provided d1 and d2, the returned generator returns random variates from the specified distribution.

`javascript
// Draw from F( 1.5, 1.5 ) distribution:
var rand = f.factory( 1.5, 1.5 );

var r = rand();
// returns

r = rand();
// returns
`

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

`javascript
var rand = f.factory();

var r = rand( 1.0, 1.0 );
// returns

r = rand( 3.14, 2.25 );
// returns
`

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][@stdlib/array/uint32] 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.

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

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

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

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

`javascript
var rand1 = f.factory({
'seed': 12345
});

var r1 = rand1( 2.0, 3.0 );
// returns

var rand2 = f.factory( 2.0, 3.0, {
'seed': 12345
});

var r2 = rand2();
// returns

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

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

`javascript
var rand;
var bool;
var r;
var i;

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

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

// Test that the generated pseudorandom numbers are the same:
bool = ( rand( 2.0, 3.0 ) === f( 2.0, 3.0 ) );
// returns true
`

#### f.NAME

The generator name.

`javascript
var str = f.NAME;
// returns 'f'
`

#### f.PRNG

The underlying pseudorandom number generator.

`javascript
var prng = f.PRNG;
// returns
`

#### f.seed

The value used to seed f().

`javascript
var rand;
var r;
var i;

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

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

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

`javascript
var rand = f.factory({
'prng': Math.random
});

var seed = rand.seed;
// returns null
`

#### f.seedLength

Length of generator seed.

`javascript
var len = f.seedLength;
// returns
`

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

`javascript
var rand = f.factory({
'prng': Math.random
});

var len = rand.seedLength;
// returns null
`

#### f.state

Writable property for getting and setting the generator state.

`javascript
var r = f( 2.0, 3.0 );
// returns

r = f( 2.0, 3.0 );
// returns

// ...

// Get a copy of the current state:
var state = f.state;
// returns

r = f( 2.0, 3.0 );
// returns

r = f( 2.0, 3.0 );
// returns

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

// Replay the last two pseudorandom numbers:
r = f( 2.0, 3.0 );
// returns

r = f( 2.0, 3.0 );
// returns

// ...
`

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

`javascript
var rand = f.factory({
'prng': Math.random
});

var state = rand.state;
// returns null
`

#### f.stateLength

Length of generator state.

`javascript
var len = f.stateLength;
// returns
`

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

`javascript
var rand = f.factory({
'prng': Math.random
});

var len = rand.stateLength;
// returns null
`

#### f.byteLength

Size (in bytes) of generator state.

`javascript
var sz = f.byteLength;
// returns
`

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

`javascript
var rand = f.factory({
'prng': Math.random
});

var sz = rand.byteLength;
// returns null
`

#### f.toJSON()

Serializes the pseudorandom number generator as a JSON object.

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

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

`javascript
var rand = f.factory({
'prng': Math.random
});

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