time-to-botec/squiggle/node_modules/@stdlib/random/iter/hypergeometric/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

96 lines
2.8 KiB
Plaintext

{{alias}}( N, K, n[, options] )
Returns an iterator for generating pseudorandom numbers drawn from a
hypergeometric distribution.
If an environment supports Symbol.iterator, the returned iterator is
iterable.
`N`, `K`, and `n` must all be nonnegative integers; otherwise, the function
throws an error.
If `n > N` or `K > N`, the function throws an error.
Parameters
----------
N: integer
Population size.
K: integer
Subpopulation size.
n: integer
Number of draws.
options: Object (optional)
Options.
options.prng: Function (optional)
Pseudorandom number generator (PRNG) for generating uniformly
distributed pseudorandom numbers on the interval `[0,1)`. If provided,
the `state` and `seed` options are ignored. In order to seed the
returned iterator, one must seed the provided `prng` (assuming the
provided `prng` is seedable).
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.PRNG: Function
Underlying pseudorandom number generator.
iterator.seed: Uint32Array|null
Pseudorandom number generator seed.
iterator.seedLength: integer|null
Length of generator seed.
iterator.state: Uint32Array|null
Generator state.
iterator.stateLength: integer|null
Length of generator state.
iterator.byteLength: integer|null
Size (in bytes) of generator state.
Examples
--------
> var it = {{alias}}( 20, 10, 7 );
> var r = it.next().value
<number>
> r = it.next().value
<number>
See Also
--------