Usage

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

#### f( len, d1, d2\[, options] )

Returns an array containing pseudorandom numbers drawn from an [F][@stdlib/random/base/f] distribution.

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

The function has the following parameters:

- len: output array length.
- d1: degrees of freedom.
- d2: degrees of freedom.
- options: function options.

The function accepts the following options:

- dtype: output array data type. Must be a [real-valued floating-point data type][@stdlib/array/typed-real-float-dtypes] or "generic". Default: 'float64'.

By default, the function returns a [Float64Array][@stdlib/array/float64]. To return an array having a different data type, set the dtype option.

`javascript
var opts = {
'dtype': 'generic'
};

var out = f( 10, 2.0, 5.0, opts );
// returns [...]
`

#### f.assign( d1, d2, out )

Fills an array with pseudorandom numbers drawn from an [F][@stdlib/random/base/f] distribution.

`javascript
var zeros = require( '@stdlib/array-zeros' );

var x = zeros( 10, 'float64' );
// returns

var out = f.assign( 2.0, 5.0, x );
// returns

var bool = ( out === x );
// returns true
`

The function has the following parameters:

- d1: degrees of freedom.
- d2: degrees of freedom.
- out: output array.

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

Returns a function for creating arrays containing pseudorandom numbers drawn from an [F][@stdlib/random/base/f] distribution.

`javascript
var random = f.factory();

var out = random( 10, 2.0, 5.0 );
// returns

var len = out.length;
// returns 10
`

If provided distribution parameters, the returned generator returns random variates from the specified distribution.

`javascript
var random = f.factory( 2.0, 5.0 );

var out = random( 10 );
// returns

out = random( 10 );
// returns
`

If not provided distribution parameters, the returned generator requires that distribution parameters be provided at each invocation.

`javascript
var random = f.factory();

var out = random( 10, 2.0, 5.0 );
// returns

out = random( 10, 2.0, 5.0 );
// 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 underlying 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 an underlying generator has exclusive control over its internal state. Default: true.
- dtype: default output array data type. Must be a [real-valued floating-point data type][@stdlib/array/typed-real-float-dtypes] or "generic". Default: 'float64'.

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 opts = {
'prng': minstd.normalized
};
var random = f.factory( 2.0, 5.0, opts );

var out = random( 10 );
// returns
`

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

`javascript
var opts = {
'seed': 12345
};
var random = f.factory( 2.0, 5.0, opts );

var out = random( 10, opts );
// returns
`

The returned function accepts the following options:

- dtype: output array data type. Must be a [real-valued floating-point data type][@stdlib/array/typed-real-float-dtypes] or "generic". This overrides the default output array data type.

To override the default output array data type, set the dtype option.

`javascript
var random = f.factory( 2.0, 5.0 );

var out = random( 10 );
// returns

var opts = {
'dtype': 'generic'
};
out = random( 10, opts );
// returns [...]
`

#### f.PRNG

The underlying pseudorandom number generator.

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

#### f.seed

The value used to seed the underlying pseudorandom number generator.

`javascript
var seed = f.seed;
// returns
`

If the factory method is provided a PRNG for uniformly distributed numbers, the associated property value on the returned function is null.

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

var random = f.factory( 2.0, 5.0, {
'prng': minstd
});

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

#### f.seedLength

Length of underlying pseudorandom number generator seed.

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

If the factory method is provided a PRNG for uniformly distributed numbers, the associated property value on the returned function is null.

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

var random = f.factory( 2.0, 5.0, {
'prng': minstd
});

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

#### f.state

Writable property for getting and setting the underlying pseudorandom number generator state.

`javascript
var state = f.state;
// returns
`

If the factory method is provided a PRNG for uniformly distributed numbers, the associated property value on the returned function is null.

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

var random = f.factory( 2.0, 5.0, {
'prng': minstd
});

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

#### f.stateLength

Length of underlying pseudorandom number generator state.

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

If the factory method is provided a PRNG for uniformly distributed numbers, the associated property value on the returned function is null.

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

var random = f.factory( 2.0, 5.0, {
'prng': minstd
});

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

#### f.byteLength

Size (in bytes) of underlying pseudorandom number generator state.

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

If the factory method is provided a PRNG for uniformly distributed numbers, the associated property value on the returned function is null.

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

var random = f.factory( 2.0, 5.0, {
'prng': minstd
});

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