randi

Usage

var randomStream = require( '@stdlib/random/streams/randi' );

randomStream( [options] )

Returns a readable stream for generating pseudorandom numbers having integer values.

var inspectStream = require( '@stdlib/streams/node/inspect-sink' );

var iStream;
var stream;

function log( chunk, idx ) {
    console.log( chunk.toString() );
    if ( idx === 10 ) {
        stream.destroy();
    }
}

stream = randomStream();
iStream = inspectStream( log );

stream.pipe( iStream );

The function accepts the following options:

• objectMode: specifies whether a stream should operate in objectMode. Default: false.

• encoding: specifies how Buffer objects should be decoded to strings. Default: null.

• highWaterMark: specifies the maximum number of bytes to store in an internal buffer before ceasing to generate additional pseudorandom numbers.

• sep: separator used to join streamed data. This option is only applicable when a stream is not in objectMode. Default: '\n'.

• iter: number of iterations.

• 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: 32-bit Mersenne Twister.
  • minstd: linear congruential pseudorandom number generator (LCG) based on Park and Miller.
  • minstd-shuffle: linear congruential pseudorandom number generator (LCG) whose output is shuffled.

  Default: '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 and/or streams. Setting this option to true ensures that a stream generator has exclusive control over its internal state. Default: true.

• siter: number of iterations after which to emit the pseudorandom number generator state. This option is useful when wanting to deterministically capture a stream's underlying PRNG state. Default: 1e308.

To set stream options,

var opts = {
    'objectMode': true,
    'encoding': 'utf8',
    'highWaterMark': 64
};

var stream = randomStream( opts );

By default, the function returns a stream which can generate an infinite number of values (i.e., the stream will never end). To limit the number of generated pseudorandom numbers, set the iter option.

var inspectStream = require( '@stdlib/streams/node/inspect-sink' );

function log( chunk ) {
    console.log( chunk.toString() );
}

var opts = {
    'iter': 10
};

var stream = randomStream( opts );
var iStream = inspectStream( log );

stream.pipe( iStream );

By default, when not operating in objectMode, a returned stream delineates generated pseudorandom numbers using a newline character. To specify an alternative separator, set the sep option.

var inspectStream = require( '@stdlib/streams/node/inspect-sink' );

function log( chunk ) {
    console.log( chunk.toString() );
}

var opts = {
    'iter': 10,
    'sep': ','
};

var stream = randomStream( opts );
var iStream = inspectStream( log );

stream.pipe( iStream );

By default, the underlying pseudorandom number generator is mt19937. To use a different PRNG, set the name option.

var opts = {
    'name': 'minstd-shuffle'
};

var stream = randomStream( opts );

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

var inspectStream = require( '@stdlib/streams/node/inspect-sink' );

function log( v ) {
    console.log( v );
}

var opts = {
    'name': 'mt19937',
    'objectMode': true,
    'iter': 10,
    'seed': 1234
};

var stream = randomStream( opts );

opts = {
    'objectMode': true
};
var iStream = inspectStream( opts, log );

stream.pipe( iStream );

To return a readable stream with an underlying pseudorandom number generator having a specific initial state, set the state option.

var inspectStream = require( '@stdlib/streams/node/inspect-sink' );

function log( v ) {
    console.log( v );
}

var opts1 = {
    'name': 'mt19937',
    'objectMode': true,
    'iter': 10
};

var stream = randomStream( opts1 );

var opts2 = {
    'objectMode': true
};
var iStream = inspectStream( opts2, log );

// Stream pseudorandom numbers, thus progressing the underlying generator state:
stream.pipe( iStream );

// Create a new PRNG stream initialized to the last state of the previous stream:
var opts3 = {
    'name': 'mt19937',
    'objectMode': true,
    'iter': 10,
    'state': stream.state
};

stream = randomStream( opts3 );
iStream = inspectStream( opts2, log );

// Stream pseudorandom numbers starting from the last state of the previous stream:
stream.pipe( iStream );

stream.seed

The value used to seed the underlying pseudorandom number generator.

var stream = randomStream();

var seed = stream.seed;

stream.seedLength

Length of underlying pseudorandom number generator seed.

var stream = randomStream();

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

stream.state

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

var stream = randomStream();

var state = stream.state;

stream.stateLength

Length of underlying pseudorandom number generator state.

var stream = randomStream();

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

stream.byteLength

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

var stream = randomStream();

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

randomStream.factory( [options] )

Returns a function for creating readable streams which generate pseudorandom numbers having integer values.

var opts = {
    'objectMode': true,
    'encoding': 'utf8',
    'highWaterMark': 64
};

var createStream = randomStream.factory( opts );

The method accepts the same options as randomStream().

randomStream.objectMode( [options] )

This method is a convenience function to create streams which always operate in objectMode.

var inspectStream = require( '@stdlib/streams/node/inspect-sink' );

function log( v ) {
    console.log( v );
}

var opts = {
    'iter': 10
};
var stream = randomStream.objectMode( opts );

opts = {
    'objectMode': true
};
var iStream = inspectStream( opts, log );

stream.pipe( iStream );

This method accepts the same options as randomStream(); however, the method will always override the objectMode option in options.

Events

In addition to the standard readable stream events, the following events are supported...

'state'

Emitted after internally generating siter pseudorandom numbers.

var opts = {
    'siter': 10 // emit the PRNG state every 10 pseudorandom numbers
};

var stream = randomStream( opts );

stream.on( 'state', onState );

function onState( state ) {
    // Do something with the emitted state, such as save to file...
}