Hypergeometric Random Numbers

Create a readable stream for generating pseudorandom numbers drawn from a hypergeometric distribution.

Installation

To use as a general utility, install the CLI package globally

npm install -g @stdlib/random-streams-hypergeometric-cli

Usage

Usage: random-hypergeometric [options] <N> <K> <n>

Options:

  -h,  --help               Print this message.
  -V,  --version            Print the package version.
       --sep sep            Separator used to join streamed data. Default: '\n'.
  -n,  --iter iterations    Number of pseudorandom numbers.
       --seed seed          Pseudorandom number generator seed.
       --state filepath     Path to a file containing the pseudorandom number
                            generator state.
       --snapshot filepath  Output file path for saving the pseudorandom number
                            generator state upon exit.

Notes

• In accordance with POSIX convention, a trailing newline is always appended to generated output prior to exit.
• Specifying a "snapshot" file path is useful when wanting to resume pseudorandom number generation due to, e.g., a downstream failure in an analysis pipeline. Before exiting, the process will store the pseudorandom number generator state in a file specified according to a provided file path. Upon loading a snapshot (state), the process will generate pseudorandom numbers starting from the loaded state, thus avoiding having to seed and replay an entire analysis.

Examples

$ random-hypergeometric 5 3 2 -n 10 --seed 1234

See Also

• @stdlib/random-streams-hypergeometric: create a readable stream for generating pseudorandom numbers drawn from a hypergeometric distribution.
• @stdlib/random-base/hypergeometric: hypergeometric distributed pseudorandom numbers.
• @stdlib/random-iter/hypergeometric: create an iterator for generating pseudorandom numbers drawn from a hypergeometric distribution.

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.