time-to-botec/squiggle/node_modules/@stdlib/random/iter/mt19937/docs/repl.txt
NunoSempere b6addc7f05 feat: add the node modules
Necessary in order to clearly see the squiggle hotwiring.
2022-12-03 12:44:49 +00:00

83 lines
2.4 KiB
Plaintext

{{alias}}( [options] )
Returns an iterator for generating pseudorandom integers on the interval
`[1, 4294967295]`.
If an environment supports Symbol.iterator, the returned iterator is
iterable.
This pseudorandom number generator (PRNG) is a 32-bit Mersenne Twister
pseudorandom number generator.
The PRNG is *not* a cryptographically secure PRNG.
The PRNG has a period of 2^19937 - 1.
Parameters
----------
options: Object (optional)
Options.
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
unsigned 32-bit integer or, for arbitrary length seeds, an array-like
object containing unsigned 32-bit integers.
options.state: Uint32Array (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.iter: integer (optional)
Number of iterations.
Returns
-------
iterator: Object
Iterator.
iterator.next(): Function
Returns an iterator protocol-compliant object containing the next
iterated value (if one exists) and a boolean flag indicating whether the
iterator is finished.
iterator.return( [value] ): Function
Finishes an iterator and returns a provided value.
iterator.seed: Uint32Array
Pseudorandom number generator seed.
iterator.seedLength: integer
Length of generator seed.
iterator.state: Uint32Array
Generator state.
iterator.stateLength: integer
Length of generator state.
iterator.byteLength: integer
Size (in bytes) of generator state.
Examples
--------
> var it = {{alias}}();
> var r = it.next().value
<number>
> r = it.next().value
<number>
See Also
--------