Gathering detailed insights and metrics for @stdlib/random-base-mt19937
Gathering detailed insights and metrics for @stdlib/random-base-mt19937
A 32-bit Mersenne Twister pseudorandom number generator.
Installations
npm install @stdlib/random-base-mt19937Developer Guide
BETA
Typescript
Yes
Module System
CommonJS
Min. Node Version
>=0.10.0
Node Version
16.20.2
NPM Version
8.19.4
Score
86.9
Supply Chain
81.8
Quality
80.7
Maintenance
100
Vulnerability
87.6
License
Releases
Unable to fetch releases
Languages
2
JavaScript
C
JavaScript (54.26%)
C (45.74%)
Developer
Download Statistics
Total Downloads
6,539,825
Last Day
2,161
Last Week
12,442
Last Month
59,585
Last Year
744,801
GitHub Statistics
Apache-2.0 License
7 Stars
58 Commits
3 Watchers
5 Branches
12 Contributors
Updated on Apr 01, 2025
Bundle Size
81.85 kB
Minified
12.88 kB
Minified + Gzipped
Sponsor this package
Maintainers
4
Package Meta Information
Latest Version
0.2.1
Package Id
@stdlib/random-base-mt19937@0.2.1
Unpacked Size
143.39 kB
Size
32.89 kB
File Count
16
NPM Version
8.19.4
Node Version
16.20.2
Published on
Feb 25, 2024
Total Downloads
Cumulative downloads
Total Downloads
6,539,825
Last Day
16.7%
2,161
Compared to previous day
Last Week
-6%
12,442
Compared to previous week
Last Month
-27.1%
59,585
Compared to previous month
Last Year
-84.7%
744,801
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
20
@stdlib/array-to-json@stdlib/array-uint32@stdlib/assert-has-own-property@stdlib/assert-is-boolean@stdlib/assert-is-collection@stdlib/assert-is-plain-object@stdlib/assert-is-positive-integer@stdlib/assert-is-uint32array@stdlib/blas-base-gcopy@stdlib/constants-float64-max-safe-integer@stdlib/constants-uint32-max@stdlib/math-base-ops-umul@stdlib/math-base-special-floor@stdlib/math-base-special-max@stdlib/random-base-shared@stdlib/string-format@stdlib/utils-define-nonenumerable-read-only-accessor@stdlib/utils-define-nonenumerable-read-only-property@stdlib/utils-define-nonenumerable-read-write-accessor@stdlib/error-tools-fmtprodmsg
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!
Mersenne Twister
A 32-bit Mersenne Twister pseudorandom number generator.
Installation
1npm install @stdlib/random-base-mt19937
Usage
1var mt19937 = require( '@stdlib/random-base-mt19937' );
mt19937()
Returns a pseudorandom integer on the interval [0, 4294967295].
1var r = mt19937(); 2// returns <number>
mt19937.normalized()
Returns a pseudorandom number on the interval [0, 1) with 53-bit precision.
1var r = mt19937.normalized(); 2// returns <number>
mt19937.factory( [options] )
Returns a 32-bit Mersenne Twister pseudorandom number generator.
1var rand = mt19937.factory();
The function accepts the following options:
- seed: pseudorandom number generator seed.
- state: a
Uint32Arraycontaining pseudorandom number generator state. If provided, the function ignores theseedoption. - copy:
booleanindicating whether to copy a provided pseudorandom number generator state. Setting this option tofalseallows sharing state between two or more pseudorandom number generators. Setting this option totrueensures that a returned generator has exclusive control over its internal state. Default:true.
By default, a random integer is used to seed the returned generator. To seed the generator, provide either an integer on the interval [0, 4294967295]
1var rand = mt19937.factory({ 2 'seed': 1234 3}); 4 5var r = rand(); 6// returns 822569775
or, for arbitrary length seeds, an array-like object containing unsigned 32-bit integers
1var Uint32Array = require( '@stdlib/array-uint32' ); 2 3var rand = mt19937.factory({ 4 'seed': new Uint32Array( [ 291, 564, 837, 1110 ] ) 5}); 6 7var r = rand(); 8// returns 1067595299
To return a generator having a specific initial state, set the generator state option.
1var rand; 2var bool; 3var r; 4var i; 5 6// Generate pseudorandom numbers, thus progressing the generator state: 7for ( i = 0; i < 1000; i++ ) { 8 r = mt19937(); 9} 10 11// Create a new MT19937 PRNG initialized to the current state of `mt19937`: 12rand = mt19937.factory({ 13 'state': mt19937.state 14}); 15 16// Test that the generated pseudorandom numbers are the same: 17bool = ( rand() === mt19937() ); 18// returns true
mt19937.NAME
The generator name.
1var str = mt19937.NAME; 2// returns 'mt19937'
mt19937.MIN
Minimum possible value.
1var min = mt19937.MIN; 2// returns 0
mt19937.MAX
Maximum possible value.
1var max = mt19937.MAX; 2// returns 4294967295
mt19937.seed
The value used to seed mt19937().
1var rand; 2var r; 3var i; 4 5// Generate pseudorandom values... 6for ( i = 0; i < 100; i++ ) { 7 r = mt19937(); 8} 9 10// Generate the same pseudorandom values... 11rand = mt19937.factory({ 12 'seed': mt19937.seed 13}); 14for ( i = 0; i < 100; i++ ) { 15 r = rand(); 16}
mt19937.seedLength
Length of generator seed.
1var len = mt19937.seedLength; 2// returns <number>
mt19937.state
Writable property for getting and setting the generator state.
1var r = mt19937(); 2// returns <number> 3 4r = mt19937(); 5// returns <number> 6 7// ... 8 9// Get a copy of the current state: 10var state = mt19937.state; 11// returns <Uint32Array> 12 13r = mt19937(); 14// returns <number> 15 16r = mt19937(); 17// returns <number> 18 19// Reset the state: 20mt19937.state = state; 21 22// Replay the last two pseudorandom numbers: 23r = mt19937(); 24// returns <number> 25 26r = mt19937(); 27// returns <number> 28 29// ...
mt19937.stateLength
Length of generator state.
1var len = mt19937.stateLength; 2// returns <number>
mt19937.byteLength
Size (in bytes) of generator state.
1var sz = mt19937.byteLength; 2// returns <number>
mt19937.toJSON()
Serializes the pseudorandom number generator as a JSON object.
1var o = mt19937.toJSON(); 2// returns { 'type': 'PRNG', 'name': '...', 'state': {...}, 'params': [] }
Notes
- Mersenne Twister 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.
- Compared to other PRNGs, Mersenne Twister has a large state size (
~2.5kB). Because of the large state size, beware of increased memory consumption when using thefactory()method to create many Mersenne Twister PRNGs. When appropriate (e.g., when external state mutation is not a concern), consider sharing PRNG state. - A seed array of length
1is considered equivalent to an integer seed equal to the lone seed array element and vice versa. - If PRNG state is "shared" (meaning a state array was provided during PRNG creation and not copied) and one sets the generator state to a state array having a different length, the 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).
- The PRNG has a period of
2^19937 - 1.
Examples
1var mt19937 = require( '@stdlib/random-base-mt19937' ); 2 3var seed; 4var rand; 5var i; 6 7// Generate pseudorandom numbers... 8for ( i = 0; i < 100; i++ ) { 9 console.log( mt19937() ); 10} 11 12// Create a new pseudorandom number generator... 13seed = 1234; 14rand = mt19937.factory({ 15 'seed': seed 16}); 17for ( i = 0; i < 100; i++ ) { 18 console.log( rand() ); 19} 20 21// Create another pseudorandom number generator using a previous seed... 22rand = mt19937.factory({ 23 'seed': mt19937.seed 24}); 25for ( i = 0; i < 100; i++ ) { 26 console.log( rand() ); 27}
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.
- Harase, Shin. 2017. "Conversion of Mersenne Twister to double-precision floating-point numbers." ArXiv abs/1708.06018 (September). https://arxiv.org/abs/1708.06018.
See Also
@stdlib/random-array/mt19937: create an array containing pseudorandom numbers generated using a 32-bit Mersenne Twister pseudorandom number generator.@stdlib/random-iter/mt19937: create an iterator for a 32-bit Mersenne Twister pseudorandom number generator.@stdlib/random-streams/mt19937: create a readable stream for a 32-bit Mersenne Twister pseudorandom number generator.@stdlib/random-base/minstd: A linear congruential pseudorandom number generator (LCG) based on Park and Miller.@stdlib/random-base/randi: pseudorandom numbers having integer values.
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
Copyright
Copyright © 2016-2024. The Stdlib Authors.
No vulnerabilities found.
Reason
no binaries found in the repo
Reason
0 existing vulnerabilities detected
Reason
no dangerous workflow patterns detected
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: Apache License 2.0: LICENSE:0
Reason
security policy file detected
Details
- Info: security policy file detected: SECURITY.md:1
- Info: Found linked content: SECURITY.md:1
- Warn: One or no descriptive hints of disclosure, vulnerability, and/or timelines in security policy
- Info: Found text in security policy: SECURITY.md:1
Reason
4 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 3
Reason
dependency not pinned by hash detected -- score normalized to 3
Details
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/productionize.yml:85: update your workflow using https://app.stepsecurity.io/secureworkflow/stdlib-js/random-base-mt19937/productionize.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/productionize.yml:275: update your workflow using https://app.stepsecurity.io/secureworkflow/stdlib-js/random-base-mt19937/productionize.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/productionize.yml:449: update your workflow using https://app.stepsecurity.io/secureworkflow/stdlib-js/random-base-mt19937/productionize.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/productionize.yml:457: update your workflow using https://app.stepsecurity.io/secureworkflow/stdlib-js/random-base-mt19937/productionize.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/productionize.yml:623: update your workflow using https://app.stepsecurity.io/secureworkflow/stdlib-js/random-base-mt19937/productionize.yml/main?enable=pin
- Warn: npmCommand not pinned by hash: .github/workflows/benchmark.yml:58
- Warn: npmCommand not pinned by hash: .github/workflows/benchmark.yml:58
- Warn: npmCommand not pinned by hash: .github/workflows/benchmark.yml:58
- Warn: npmCommand not pinned by hash: .github/workflows/examples.yml:58
- Warn: npmCommand not pinned by hash: .github/workflows/examples.yml:58
- Warn: npmCommand not pinned by hash: .github/workflows/examples.yml:58
- Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:269
- Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:269
- Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:269
- Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:436
- Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:436
- Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:436
- Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:617
- Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:617
- Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:617
- Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:157
- Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:157
- Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:157
- Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:165
- Warn: npmCommand not pinned by hash: .github/workflows/test.yml:76
- Warn: npmCommand not pinned by hash: .github/workflows/test.yml:76
- Warn: npmCommand not pinned by hash: .github/workflows/test.yml:76
- Warn: npmCommand not pinned by hash: .github/workflows/test.yml:83
- Warn: npmCommand not pinned by hash: .github/workflows/test_bundles.yml:72
- Warn: npmCommand not pinned by hash: .github/workflows/test_coverage.yml:67
- Warn: npmCommand not pinned by hash: .github/workflows/test_coverage.yml:67
- Warn: npmCommand not pinned by hash: .github/workflows/test_coverage.yml:67
- Warn: npmCommand not pinned by hash: .github/workflows/test_coverage.yml:74
- Warn: npmCommand not pinned by hash: .github/workflows/test_install.yml:75
- Warn: npmCommand not pinned by hash: .github/workflows/test_install.yml:75
- Warn: npmCommand not pinned by hash: .github/workflows/test_install.yml:75
- Warn: npmCommand not pinned by hash: .github/workflows/test_published_package.yml:93
- Info: 33 out of 33 GitHub-owned GitHubAction dependencies pinned
- Info: 19 out of 24 third-party GitHubAction dependencies pinned
- Info: 0 out of 32 npmCommand dependencies pinned
Reason
Found 0/30 approved changesets -- score normalized to 0
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'main'
Reason
no SAST tool detected
Details
- Warn: no pull requests merged into dev branch
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/benchmark.yml:1
- Warn: no topLevel permission defined: .github/workflows/cancel.yml:1
- Warn: no topLevel permission defined: .github/workflows/close_pull_requests.yml:1
- Warn: no topLevel permission defined: .github/workflows/examples.yml:1
- Warn: no topLevel permission defined: .github/workflows/npm_downloads.yml:1
- Warn: no topLevel permission defined: .github/workflows/productionize.yml:1
- Warn: no topLevel permission defined: .github/workflows/publish.yml:1
- Warn: no topLevel permission defined: .github/workflows/test.yml:1
- Warn: no topLevel permission defined: .github/workflows/test_bundles.yml:1
- Warn: no topLevel permission defined: .github/workflows/test_coverage.yml:1
- Warn: no topLevel permission defined: .github/workflows/test_install.yml:1
- Warn: no topLevel permission defined: .github/workflows/test_published_package.yml:1
- Info: no jobLevel write permissions found
Score
4.5
/10
Last Scanned on 2025-04-28
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More