@stdlib/random-streams-minstd-shuffle-cli

<details> <summary> About stdlib... </summary> <p>We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.</p> <p>The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.</p> <p>When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.</p> <p>To join us in bringing numerical computing to the web, get started by checking us out on <a href="https://github.com/stdlib-js/stdlib">GitHub</a>, and please consider <a href="https://opencollective.com/stdlib">financially supporting stdlib</a>. We greatly appreciate your continued support!</p> </details> # MINSTD Shuffle [![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]  > Create a [readable stream][readable-stream] for a linear congruential pseudorandom number generator ([LCG][@stdlib/random/base/minstd-shuffle]) whose output is shuffled.  <section class="cli"> <section class="installation"> ## Installation To use as a general utility, install the CLI package globally ```bash npm install -g @stdlib/random-streams-minstd-shuffle-cli ``` </section>  <section class="usage"> ## Usage ```text Usage: random-minstd-shuffle [options] 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. --normalized Generate pseudorandom numbers on the interval [0,1). --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. ``` </section>   <section class="notes"> ## 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. </section>   <section class="examples"> ## Examples ```bash $ random-minstd-shuffle -n 10 --seed 1234 ``` </section>  </section>  * * * <section class="references"> ## References - Park, S. K., and K. W. Miller. 1988. "Random Number Generators: Good Ones Are Hard to Find." _Communications of the ACM_ 31 (10). New York, NY, USA: ACM: 1192–1201. doi:[10.1145/63039.63042][@park:1988]. - Bays, Carter, and S. D. Durham. 1976. "Improving a Poor Random Number Generator." _ACM Transactions on Mathematical Software_ 2 (1). New York, NY, USA: ACM: 59–64. doi:[10.1145/355666.355670][@bays:1976]. - Herzog, T.N., and G. Lord. 2002. _Applications of Monte Carlo Methods to Finance and Insurance_. ACTEX Publications. [https://books.google.com/books?id=vC7I\\\_gdX-A0C][@herzog:2002]. - Press, William H., Brian P. Flannery, Saul A. Teukolsky, and William T. Vetterling. 1992. _Numerical Recipes in C: The Art of Scientific Computing, Second Edition_. Cambridge University Press. </section>   <section class="related"> ## See Also - <span class="package-name">[`@stdlib/random-streams-minstd-shuffle`][@stdlib/random-streams-minstd-shuffle]</span><span class="delimiter">: </span><span class="description">create a readable stream for a linear congruential pseudorandom number generator (LCG) whose output is shuffled.</span> - <span class="package-name">[`@stdlib/random-base/minstd-shuffle`][@stdlib/random/base/minstd-shuffle]</span><span class="delimiter">: </span><span class="description">A linear congruential pseudorandom number generator (LCG) whose output is shuffled.</span> - <span class="package-name">[`@stdlib/random-iter/minstd-shuffle`][@stdlib/random/iter/minstd-shuffle]</span><span class="delimiter">: </span><span class="description">create an iterator for a linear congruential pseudorandom number generator (LCG) whose output is shuffled.</span> - <span class="package-name">[`@stdlib/random-streams/minstd`][@stdlib/random/streams/minstd]</span><span class="delimiter">: </span><span class="description">create a readable stream for a linear congruential pseudorandom number generator (LCG) based on Park and Miller.</span> - <span class="package-name">[`@stdlib/random-streams/mt19937`][@stdlib/random/streams/mt19937]</span><span class="delimiter">: </span><span class="description">create a readable stream for a 32-bit Mersenne Twister pseudorandom number generator.</span> - <span class="package-name">[`@stdlib/random-streams/randi`][@stdlib/random/streams/randi]</span><span class="delimiter">: </span><span class="description">create a readable stream for generating pseudorandom numbers having integer values.</span> - <span class="package-name">[`@stdlib/random-streams/randu`][@stdlib/random/streams/randu]</span><span class="delimiter">: </span><span class="description">create a readable stream for generating uniformly distributed pseudorandom numbers between 0 and 1.</span> </section>   <section class="main-repo" > * * * ## Notice This package is part of [stdlib][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][stdlib], see the main project [repository][stdlib]. ### Community [![Chat][chat-image]][chat-url] --- ## License See [LICENSE][stdlib-license]. ## Copyright Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. </section>   <section class="links"> [npm-image]: http://img.shields.io/npm/v/@stdlib/random-streams-minstd-shuffle-cli.svg [npm-url]: https://npmjs.org/package/@stdlib/random-streams-minstd-shuffle-cli [test-image]: https://github.com/stdlib-js/random-streams-minstd-shuffle/actions/workflows/test.yml/badge.svg?branch=v0.2.1 [test-url]: https://github.com/stdlib-js/random-streams-minstd-shuffle/actions/workflows/test.yml?query=branch:v0.2.1 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/random-streams-minstd-shuffle/main.svg [coverage-url]: https://codecov.io/github/stdlib-js/random-streams-minstd-shuffle?branch=main  [chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg [chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im [stdlib]: https://github.com/stdlib-js/stdlib [stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors [cli-section]: https://github.com/stdlib-js/random-streams-minstd-shuffle#cli [cli-url]: https://github.com/stdlib-js/random-streams-minstd-shuffle/tree/cli [@stdlib/random-streams-minstd-shuffle]: https://www.npmjs.com/package/@stdlib/random-streams-minstd-shuffle [umd]: https://github.com/umdjs/umd [es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules [deno-url]: https://github.com/stdlib-js/random-streams-minstd-shuffle/tree/deno [deno-readme]: https://github.com/stdlib-js/random-streams-minstd-shuffle/blob/deno/README.md [umd-url]: https://github.com/stdlib-js/random-streams-minstd-shuffle/tree/umd [umd-readme]: https://github.com/stdlib-js/random-streams-minstd-shuffle/blob/umd/README.md [esm-url]: https://github.com/stdlib-js/random-streams-minstd-shuffle/tree/esm [esm-readme]: https://github.com/stdlib-js/random-streams-minstd-shuffle/blob/esm/README.md [branches-url]: https://github.com/stdlib-js/random-streams-minstd-shuffle/blob/main/branches.md [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/random-streams-minstd-shuffle/main/LICENSE [stream]: https://nodejs.org/api/stream.html [object-mode]: https://nodejs.org/api/stream.html#stream_object_mode [readable-stream]: https://nodejs.org/api/stream.html [@stdlib/array/int32]: https://www.npmjs.com/package/@stdlib/array-int32 [@park:1988]: http://dx.doi.org/10.1145/63039.63042 [@bays:1976]: http://dx.doi.org/10.1145/355666.355670 [@herzog:2002]: https://books.google.com/books?id=vC7I_gdX-A0C  [@stdlib/random/base/minstd-shuffle]: https://www.npmjs.com/package/@stdlib/random-base-minstd-shuffle [@stdlib/random/iter/minstd-shuffle]: https://www.npmjs.com/package/@stdlib/random-iter-minstd-shuffle [@stdlib/random/streams/minstd]: https://www.npmjs.com/package/@stdlib/random-streams-minstd [@stdlib/random/streams/mt19937]: https://www.npmjs.com/package/@stdlib/random-streams-mt19937 [@stdlib/random/streams/randi]: https://www.npmjs.com/package/@stdlib/random-streams-randi [@stdlib/random/streams/randu]: https://www.npmjs.com/package/@stdlib/random-streams-randu  </section>