Data

Tools

Indexes

Applications

Experiments

Open Source Science

random-streams-mt19937

Create a readable stream for a 32-bit Mersenne Twister pseudorandom number generator.

https://github.com/stdlib-js/random-streams-mt19937

Science Score: 67.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ✓
    DOI references
    Found 3 DOI reference(s) in README
  • ✓
    Academic publication links
    Links to: arxiv.org
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (15.1%) to scientific vocabulary

Keywords

discrete generator integer javascript math mathematics node node-js nodejs prng pseudorandom rand randint random randu rng statistics stats stdlib uniform
Last synced: 4 months ago · JSON representation ·

Repository

Create a readable stream for a 32-bit Mersenne Twister pseudorandom number generator.

Basic Info
Statistics
  • Stars: 2
  • Watchers: 3
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Topics
discrete generator integer javascript math mathematics node node-js nodejs prng pseudorandom rand randint random randu rng statistics stats stdlib uniform
Created over 4 years ago · Last pushed 4 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation Security Notice

README.md

About stdlib...

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.

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.

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.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

MT19937

NPM version Build Status Coverage Status <!-- dependencies -->

Create a readable stream for a 32-bit Mersenne Twister pseudorandom number generator.

## Installation ```bash npm install @stdlib/random-streams-mt19937 ``` Alternatively, - To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]). - If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions). - For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]). - To use as a general utility for the command line, install the corresponding [CLI package][cli-section] globally. The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships. To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.
## Usage ```javascript var randomStream = require( '@stdlib/random-streams-mt19937' ); ``` #### randomStream( \[options] ) Returns a [readable stream][readable-stream] for a 32-bit [Mersenne Twister][@stdlib/random/base/mt19937] pseudorandom number generator. ```javascript var inspectStream = require( '@stdlib/streams-node-inspect-sink' ); var iStream; var stream; function log( chunk, idx ) { console.log( chunk.toString() ); if ( idx === 10 ) { stream.destroy(); } } stream = randomStream(); iStream = inspectStream( log ); stream.pipe( iStream ); ``` The function accepts the following `options`: - **objectMode**: specifies whether a [stream][stream] should operate in [objectMode][object-mode]. Default: `false`. - **encoding**: specifies how `Buffer` objects should be decoded to `strings`. Default: `null`. - **highWaterMark**: specifies the maximum number of bytes to store in an internal buffer before ceasing to generate additional pseudorandom numbers. - **sep**: separator used to join streamed data. This option is only applicable when a stream is **not** in [objectMode][object-mode]. Default: `'\n'`. - **iter**: number of iterations. - **normalized**: `boolean` indicating whether to return pseudorandom numbers on the interval `[0,1)`. - **seed**: pseudorandom number generator seed. - **state**: a [`Uint32Array`][@stdlib/array/uint32] containing pseudorandom number generator state. If provided, the function ignores the `seed` option. - **copy**: `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 and/or streams. Setting this option to `true` ensures that a stream generator has exclusive control over its internal state. Default: `true`. - **siter**: number of iterations after which to emit the pseudorandom number generator state. This option is useful when wanting to deterministically capture a stream's underlying PRNG state. Default: `1e308`. To set [stream][stream] `options`, ```javascript var opts = { 'objectMode': true, 'encoding': 'utf8', 'highWaterMark': 64 }; var stream = randomStream( opts ); ``` By default, the function returns a [stream][stream] which can generate an infinite number of values (i.e., the [stream][stream] will **never** end). To limit the number of generated pseudorandom numbers, set the `iter` option. ```javascript var inspectStream = require( '@stdlib/streams-node-inspect-sink' ); function log( chunk ) { console.log( chunk.toString() ); } var opts = { 'iter': 10 }; var stream = randomStream( opts ); var iStream = inspectStream( log ); stream.pipe( iStream ); ``` To return pseudorandom numbers on the interval `[0,1)`, set the `normalized` option. ```javascript var inspectStream = require( '@stdlib/streams-node-inspect-sink' ); function log( chunk ) { console.log( chunk.toString() ); } var opts = { 'iter': 10, 'normalized': true }; var stream = randomStream( opts ); var iStream = inspectStream( log ); stream.pipe( iStream ); ``` By default, when not operating in [objectMode][object-mode], a returned [stream][stream] delineates generated pseudorandom numbers using a newline character. To specify an alternative separator, set the `sep` option. ```javascript var inspectStream = require( '@stdlib/streams-node-inspect-sink' ); function log( chunk ) { console.log( chunk.toString() ); } var opts = { 'iter': 10, 'sep': ',' }; var stream = randomStream( opts ); var iStream = inspectStream( log ); stream.pipe( iStream ); ``` To seed the underlying pseudorandom number generator, set the `seed` option. ```javascript var inspectStream = require( '@stdlib/streams-node-inspect-sink' ); function log( v ) { console.log( v ); } var opts = { 'objectMode': true, 'iter': 10, 'seed': 1234 }; var stream = randomStream( opts ); opts = { 'objectMode': true }; var iStream = inspectStream( opts, log ); stream.pipe( iStream ); ``` To return a [readable stream][readable-stream] with an underlying pseudorandom number generator having a specific initial state, set the `state` option. ```javascript var inspectStream = require( '@stdlib/streams-node-inspect-sink' ); function log( v ) { console.log( v ); } var opts1 = { 'objectMode': true, 'iter': 10 }; var stream = randomStream( opts1 ); var opts2 = { 'objectMode': true }; var iStream = inspectStream( opts2, log ); // Stream pseudorandom numbers, thus progressing the underlying generator state: stream.pipe( iStream ); // Create a new PRNG stream initialized to the last state of the previous stream: var opts3 = { 'objectMode': true, 'iter': 10, 'state': stream.state }; stream = randomStream( opts3 ); iStream = inspectStream( opts2, log ); // Stream pseudorandom numbers starting from the last state of the previous stream: stream.pipe( iStream ); ``` ##### stream.seed The value used to seed the underlying pseudorandom number generator. ```javascript var stream = randomStream(); var seed = stream.seed; // returns ``` ##### stream.seedLength Length of underlying pseudorandom number generator seed. ```javascript var stream = randomStream(); var len = stream.seedLength; // returns ``` ##### stream.state Writable property for getting and setting the underlying pseudorandom number generator state. ```javascript var stream = randomStream(); var state = stream.state; // returns ``` ##### stream.stateLength Length of underlying pseudorandom number generator state. ```javascript var stream = randomStream(); var len = stream.stateLength; // returns ``` ##### stream.byteLength Size (in bytes) of underlying pseudorandom number generator state. ```javascript var stream = randomStream(); var sz = stream.byteLength; // returns ``` * * * #### randomStream.factory( \[options] ) Returns a `function` for creating [readable streams][readable-stream] which generate pseudorandom numbers via a 32-bit [Mersenne Twister][@stdlib/random/base/mt19937] pseudorandom number generator. ```javascript var opts = { 'objectMode': true, 'encoding': 'utf8', 'highWaterMark': 64 }; var createStream = randomStream.factory( opts ); ``` The method accepts the same `options` as [`randomStream()`](#random-stream). * * * #### randomStream.objectMode( \[options] ) This method is a convenience function to create [streams][stream] which **always** operate in [objectMode][object-mode]. ```javascript var inspectStream = require( '@stdlib/streams-node-inspect-sink' ); function log( v ) { console.log( v ); } var opts = { 'iter': 10 }; var stream = randomStream.objectMode( opts ); opts = { 'objectMode': true }; var iStream = inspectStream( opts, log ); stream.pipe( iStream ); ``` This method accepts the same `options` as [`randomStream()`](#random-stream); however, the method will **always** override the [`objectMode`][object-mode] option in `options`. * * * ### Events In addition to the standard [readable stream][readable-stream] events, the following events are supported... #### 'state' Emitted after internally generating `siter` pseudorandom numbers. ```javascript var opts = { 'siter': 10 // emit the PRNG state every 10 pseudorandom numbers }; var stream = randomStream( opts ); stream.on( 'state', onState ); function onState( state ) { // Do something with the emitted state, such as save to file... } ```
## Notes - [Mersenne Twister][@stdlib/random/base/mt19937] is **not** a cryptographically secure PRNG, as the PRNG is based on a linear recursion. Any pseudorandom number sequence generated by a linear recursion is **insecure**, due to the fact that one can predict future generated outputs by observing a sufficiently long subsequence of generated values. - The underlying PRNG has a period of `2^19937 - 1`. - If PRNG state is "shared" (meaning a state array was provided during stream creation and **not** copied) and one sets the generator state to a state array having a different length, the underlying PRNG does **not** update the existing shared state and, instead, points to the newly provided state array. In order to synchronize PRNG output according to the new shared state array, the state array for **each** relevant PRNG must be **explicitly** set. - If PRNG state is "shared" and one sets the generator state to a state array of the same length, the PRNG state is updated (along with the state of all other PRNGs sharing the PRNG's state array). - In order to capture the PRNG state after a specific number of generated pseudorandom numbers, regardless of internal stream buffering, use the `siter` option in conjunction with a `state` event listener. Attempting to capture the underlying PRNG state after **reading** generated numbers is **not** likely to give expected results, as internal stream buffering will mean more values have been generated than have been read. Thus, the state returned by the `state` property will likely reflect a future PRNG state from the perspective of downstream consumers.
## Examples ```javascript var inspectStream = require( '@stdlib/streams-node-inspect-sink' ); var randomStream = require( '@stdlib/random-streams-mt19937' ); function log( v ) { console.log( v.toString() ); } var opts = { 'objectMode': true, 'iter': 10 }; var stream = randomStream( opts ); opts = { 'objectMode': true }; var iStream = inspectStream( opts, log ); stream.pipe( iStream ); ```
## CLI
## Installation To use as a general utility, install the CLI package globally ```bash npm install -g @stdlib/random-streams-mt19937-cli ```
### Usage ```text Usage: random-mt19937 [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. ```
### 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 ```bash $ random-mt19937 -n 10 --seed 1234 ```

## References - Matsumoto, Makoto, and Takuji Nishimura. 1998. "Mersenne Twister: A 623-dimensionally Equidistributed Uniform Pseudo-random Number Generator." _ACM Transactions on Modeling and Computer Simulation_ 8 (1). New York, NY, USA: ACM: 3–30. doi:[10.1145/272991.272995][@matsumoto:1998a]. - Harase, Shin. 2017. "Conversion of Mersenne Twister to double-precision floating-point numbers." _ArXiv_ abs/1708.06018 (September). .
* * * ## See Also - [`@stdlib/random-base/mt19937`][@stdlib/random/base/mt19937]: A 32-bit Mersenne Twister pseudorandom number generator. - [`@stdlib/random-iter/mt19937`][@stdlib/random/iter/mt19937]: create an iterator for a 32-bit Mersenne Twister pseudorandom number generator. - [`@stdlib/random-streams/minstd`][@stdlib/random/streams/minstd]: create a readable stream for a linear congruential pseudorandom number generator (LCG) based on Park and Miller. - [`@stdlib/random-streams/minstd-shuffle`][@stdlib/random/streams/minstd-shuffle]: create a readable stream for a linear congruential pseudorandom number generator (LCG) whose output is shuffled. - [`@stdlib/random-streams/randi`][@stdlib/random/streams/randi]: create a readable stream for generating pseudorandom numbers having integer values. - [`@stdlib/random-streams/randu`][@stdlib/random/streams/randu]: create a readable stream for generating uniformly distributed pseudorandom numbers between 0 and 1.
* * * ## 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-2025. The Stdlib [Authors][stdlib-authors].

Owner

  • Name: stdlib
  • Login: stdlib-js
  • Kind: organization

Standard library for JavaScript.

Citation (CITATION.cff) 

cff-version: 1.2.0
title: stdlib
message: >-
  If you use this software, please cite it using the
  metadata from this file.

type: software

authors:
  - name: The Stdlib Authors
    url: https://github.com/stdlib-js/stdlib/graphs/contributors

repository-code: https://github.com/stdlib-js/stdlib
url: https://stdlib.io

abstract: |
  Standard library for JavaScript and Node.js.

keywords:
  - JavaScript
  - Node.js
  - TypeScript
  - standard library
  - scientific computing
  - numerical computing
  - statistical computing

license: Apache-2.0 AND BSL-1.0

date-released: 2016

GitHub Events

Total
  • Push event: 7
Last Year
  • Push event: 7

Committers

Last synced: 6 months ago

All Time
  • Total Commits: 48
  • Total Committers: 1
  • Avg Commits per committer: 48.0
  • Development Distribution Score (DDS): 0.0
Past Year
  • Commits: 5
  • Committers: 1
  • Avg Commits per committer: 5.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
stdlib-bot n****y@s****o 48
Committer Domains (Top 20 + Academic)
stdlib.io: 1

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 0
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Dependencies

package.json npm
  • @stdlib/assert-is-browser ^0.0.x development
  • @stdlib/assert-is-buffer ^0.0.x development
  • @stdlib/assert-is-uint32array ^0.0.x development
  • @stdlib/assert-is-windows ^0.0.x development
  • @stdlib/bench ^0.0.x development
  • @stdlib/constants-uint32-max ^0.0.x development
  • @stdlib/fs-exists ^0.0.x development
  • @stdlib/fs-unlink ^0.0.x development
  • @stdlib/math-base-assert-is-integer ^0.0.x development
  • @stdlib/math-base-assert-is-nan ^0.0.x development
  • @stdlib/process-exec-path ^0.0.x development
  • @stdlib/streams-node-inspect-sink ^0.0.x development
  • @stdlib/string-replace ^0.0.x development
  • @stdlib/time-now ^0.0.x development
  • istanbul ^0.4.1 development
  • proxyquire ^2.0.0 development
  • tap-spec 5.x.x development
  • tape git+https://github.com/kgryte/tape.git#fix/globby development
  • @stdlib/array-uint32 ^0.0.x
  • @stdlib/array-uint8 ^0.0.x
  • @stdlib/assert-has-own-property ^0.0.x
  • @stdlib/assert-is-boolean ^0.0.x
  • @stdlib/assert-is-error ^0.0.x
  • @stdlib/assert-is-integer ^0.0.x
  • @stdlib/assert-is-nonnegative-integer ^0.0.x
  • @stdlib/assert-is-nonnegative-number ^0.0.x
  • @stdlib/assert-is-plain-object ^0.0.x
  • @stdlib/assert-is-positive-integer ^0.0.x
  • @stdlib/assert-is-string ^0.0.x
  • @stdlib/assert-is-uint8array ^0.0.x
  • @stdlib/blas-base-gcopy ^0.0.x
  • @stdlib/buffer-from-array ^0.0.x
  • @stdlib/buffer-from-string ^0.0.x
  • @stdlib/cli-ctor ^0.0.x
  • @stdlib/fs-read-file ^0.0.x
  • @stdlib/fs-write-file ^0.0.x
  • @stdlib/process-cwd ^0.0.x
  • @stdlib/random-base-mt19937 ^0.0.x
  • @stdlib/streams-node-stdout ^0.0.x
  • @stdlib/string-format ^0.0.x
  • @stdlib/types ^0.0.x
  • @stdlib/utils-copy ^0.0.x
  • @stdlib/utils-define-nonenumerable-property ^0.0.x
  • @stdlib/utils-define-nonenumerable-read-only-property ^0.0.x
  • @stdlib/utils-define-read-only-accessor ^0.0.x
  • @stdlib/utils-define-read-write-accessor ^0.0.x
  • @stdlib/utils-inherit ^0.0.x
  • @stdlib/utils-next-tick ^0.0.x
  • debug ^2.6.9
  • readable-stream ^2.1.4
.github/workflows/benchmark.yml actions
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
.github/workflows/cancel.yml actions
  • styfle/cancel-workflow-action 0.11.0 composite
.github/workflows/close_pull_requests.yml actions
  • superbrothers/close-pull-request v3 composite
.github/workflows/examples.yml actions
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
.github/workflows/npm_downloads.yml actions
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
  • actions/upload-artifact v3 composite
  • distributhor/workflow-webhook v3 composite
.github/workflows/productionize.yml actions
  • act10ns/slack v1 composite
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
  • stdlib-js/bundle-action main composite
  • stdlib-js/transform-errors-action main composite
.github/workflows/publish.yml actions
  • JS-DevTools/npm-publish v1 composite
  • act10ns/slack v1 composite
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
  • styfle/cancel-workflow-action 0.11.0 composite
.github/workflows/test.yml actions
  • act10ns/slack v1 composite
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
.github/workflows/test_bundles.yml actions
  • act10ns/slack v1 composite
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
  • denoland/setup-deno v1 composite
.github/workflows/test_coverage.yml actions
  • act10ns/slack v1 composite
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
  • codecov/codecov-action v3 composite
  • distributhor/workflow-webhook v3 composite
.github/workflows/test_install.yml actions
  • act10ns/slack v1 composite
  • actions/checkout v3 composite
  • actions/setup-node v3 composite