Usage

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

#### randi()

Returns a pseudorandom number having an integer value.

`javascript
var v = randi();
// returns
`

#### randi.factory( \[options] )

Returns a pseudorandom number generator (PRNG) for generating random numbers.

`javascript
var rand = randi.factory();
`

The function accepts the following options:

- name: name of a supported pseudorandom number generator (PRNG), which will serve as the underlying source of pseudorandom numbers. The following generators are supported:

- [mt19937][@stdlib/random/base/mt19937]: 32-bit Mersenne Twister.
- [minstd][@stdlib/random/base/minstd]: linear congruential pseudorandom number generator (LCG) based on Park and Miller.
- [minstd-shuffle][@stdlib/random/base/minstd-shuffle]: linear congruential pseudorandom number generator (LCG) whose output is shuffled.

Default: ['mt19937'][@stdlib/random/base/mt19937].

- seed: pseudorandom number generator seed. Valid seed values vary according to the underlying PRNG.

- state: pseudorandom number generator state. Valid state values vary according to the underlying PRNG. 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.

By default, the underlying pseudorandom number generator is [mt19937][@stdlib/random/base/mt19937]. To use a different PRNG, set the name option.

`javascript
var rand = randi.factory({
'name': 'minstd-shuffle'
});

var v = rand();
// returns
`

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

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

var r1 = rand1();
// returns

var rand2 = randi.factory({
'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 = randi();
}

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

// Test that the generated pseudorandom numbers are the same:
bool = ( rand() === randi() );
// returns true
`

#### randi.NAME

The generator name.

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

#### randi.PRNG

The underlying pseudorandom number generator.

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

#### randi.MIN

Minimum value lower bound (specific to underlying PRNG).

`javascript
var min = randi.MIN;
// returns
`

#### randi.MAX

Maximum value upper bound (specific to underlying PRNG).

`javascript
var max = randi.MAX;
// returns
`

#### randi.seed

The value used to seed randi().

`javascript
var rand;
var v;
var i;

// Generate pseudorandom values...
for ( i = 0; i < 100; i++ ) {
v = randi();
}

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

#### randi.seedLength

Length of generator seed.

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

#### randi.state

Writable property for getting and setting the generator state.

`javascript
var r = randi();
// returns

r = randi();
// returns

// ...

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

r = randi();
// returns

r = randi();
// returns

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

// Replay the last two pseudorandom numbers:
r = randi();
// returns

r = randi();
// returns

// ...
`

#### randi.stateLength

Length of generator state.

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

#### randi.byteLength

Size (in bytes) of generator state.

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

#### randi.toJSON()

Serializes the pseudorandom number generator as a JSON object.

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