time-to-botec/js/node_modules/@stdlib/random/streams/minstd/docs/repl.txt

232 lines
8.0 KiB
Plaintext
Raw Normal View History

{{alias}}( [options] )
Returns a readable stream for generating pseudorandom numbers on the
interval `[1, 2147483646]`.
In addition to standard readable stream events, the returned stream emits a
'state' event after internally generating `siter` pseudorandom numbers,
which is useful when wanting to deterministically capture a stream's
underlying PRNG state.
The underlying pseudorandom number generator (PRNG) is a linear congruential
pseudorandom number generator (LCG) based on Park and Miller.
The generator has a period of approximately `2.1e9`.
An LCG is fast and uses little memory. On the other hand, because the
generator is a simple LCG, the generator has recognized shortcomings. By
today's PRNG standards, the generator's period is relatively short. More
importantly, the "randomness quality" of the generator's output is lacking.
These defects make the generator unsuitable, for example, in Monte Carlo
simulations and in cryptographic applications.
Parameters
----------
options: Object (optional)
Options.
options.objectMode: boolean (optional)
Specifies whether a stream should operate in "objectMode". Default:
false.
options.encoding: string|null (optional)
Specifies how Buffer objects should be decoded to strings. Default:
null.
options.highWaterMark: integer (optional)
Specifies the maximum number of bytes to store in an internal buffer
before ceasing to generate additional pseudorandom numbers.
options.sep: string (optional)
Separator used to join streamed data. This option is only applicable
when a stream is not in "objectMode". Default: '\n'.
options.iter: integer (optional)
Number of iterations.
options.normalized: boolean (optional)
Boolean indicating whether to return pseudorandom numbers on the
interval `[0,1)`.
options.seed: integer|ArrayLikeObject<integer> (optional)
Pseudorandom number generator seed. The seed may be either a positive
signed 32-bit integer or, for arbitrary length seeds, an array-like
object containing signed 32-bit integers.
options.state: Int32Array (optional)
Pseudorandom number generator state. If provided, the `seed` option is
ignored.
options.copy: boolean (optional)
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 iterator has exclusive control over
its internal state. Default: true.
options.siter: integer (optional)
Number of iterations after which to emit the PRNG state. Default: 1e308.
Returns
-------
stream: ReadableStream
Readable stream.
stream.seed: Int32Array|null
Pseudorandom number generator seed.
stream.seedLength: integer|null
Length of generator seed.
stream.state: Int32Array|null
Generator state.
stream.stateLength: integer|null
Length of generator state.
stream.byteLength: integer|null
Size (in bytes) of generator state.
Examples
--------
> function fcn( chunk ) { console.log( chunk.toString() ); };
> var opts = { 'iter': 10 };
> var s = {{alias}}( opts );
> var o = {{alias:@stdlib/streams/node/inspect-sink}}( fcn );
> s.pipe( o );
{{alias}}.factory( [options] )
Returns a function for creating readable streams which generate pseudorandom
numbers on the interval `[1, 2147483646]`.
Parameters
----------
options.objectMode: boolean (optional)
Specifies whether a stream should operate in "objectMode". Default:
false.
options.encoding: string|null (optional)
Specifies how Buffer objects should be decoded to strings. Default:
null.
options.highWaterMark: integer (optional)
Specifies the maximum number of bytes to store in an internal buffer
before ceasing to generate additional pseudorandom numbers.
options.sep: string (optional)
Separator used to join streamed data. This option is only applicable
when a stream is not in "objectMode". Default: '\n'.
options.iter: integer (optional)
Number of iterations.
options.normalized: boolean (optional)
Boolean indicating whether to return pseudorandom numbers on the
interval `[0,1)`.
options.seed: integer|ArrayLikeObject<integer> (optional)
Pseudorandom number generator seed. The seed may be either a positive
signed 32-bit integer or, for arbitrary length seeds, an array-like
object containing signed 32-bit integers.
options.state: Int32Array (optional)
Pseudorandom number generator state. If provided, the `seed` option is
ignored.
options.copy: boolean (optional)
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 iterator has exclusive control over
its internal state. Default: true.
options.siter: integer (optional)
Number of iterations after which to emit the PRNG state. Default: 1e308.
Returns
-------
fcn: Function
Function for creating readable streams.
Examples
--------
> var opts = { 'objectMode': true, 'highWaterMark': 64 };
> var createStream = {{alias}}.factory( opts );
{{alias}}.objectMode( [options] )
Returns an "objectMode" readable stream for generating pseudorandom numbers
on the interval `[1, 2147483646]`.
Parameters
----------
options: Object (optional)
Options.
options.encoding: string|null (optional)
Specifies how Buffer objects should be decoded to strings. Default:
null.
options.highWaterMark: integer (optional)
Specifies the maximum number of objects to store in an internal buffer
before ceasing to generate additional pseudorandom numbers.
options.iter: integer (optional)
Number of iterations.
options.normalized: boolean (optional)
Boolean indicating whether to return pseudorandom numbers on the
interval `[0,1)`.
options.seed: integer|ArrayLikeObject<integer> (optional)
Pseudorandom number generator seed. The seed may be either a positive
signed 32-bit integer or, for arbitrary length seeds, an array-like
object containing signed 32-bit integers.
options.state: Int32Array (optional)
Pseudorandom number generator state. If provided, the `seed` option is
ignored.
options.copy: boolean (optional)
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 iterator has exclusive control over
its internal state. Default: true.
options.siter: integer (optional)
Number of iterations after which to emit the PRNG state. Default: 1e308.
Returns
-------
stream: ReadableStream
Readable stream operating in "objectMode".
stream.seed: Int32Array|null
Pseudorandom number generator seed.
stream.seedLength: integer|null
Length of generator seed.
stream.state: Int32Array|null
Generator state.
stream.stateLength: integer|null
Length of generator state.
stream.byteLength: integer|null
Size (in bytes) of generator state.
Examples
--------
> function fcn( v ) { console.log( v ); };
> var opts = { 'iter': 10 };
> var s = {{alias}}.objectMode( opts );
> var o = {{alias:@stdlib/streams/node/inspect-sink}}.objectMode( fcn );
> s.pipe( o );
See Also
--------