@stdlib/random-base-mt19937
Advanced tools
A 32-bit Mersenne Twister pseudorandom number generator.
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!
A 32-bit Mersenne Twister pseudorandom number generator.
npm install @stdlib/random-base-mt19937
var mt19937 = require( '@stdlib/random-base-mt19937' );
Returns a pseudorandom integer on the interval [0, 4294967295].
var r = mt19937();
// returns <number>
Returns a pseudorandom number on the interval [0, 1) with 53-bit precision.
var r = mt19937.normalized();
// returns <number>
Returns a 32-bit Mersenne Twister pseudorandom number generator.
var rand = mt19937.factory();
The function accepts the following options:
Uint32Array containing pseudorandom number generator state. If provided, the function ignores the seed option.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 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]
var rand = mt19937.factory({
'seed': 1234
});
var r = rand();
// returns 822569775
or, for arbitrary length seeds, an array-like object containing unsigned 32-bit integers
var Uint32Array = require( '@stdlib/array-uint32' );
var rand = mt19937.factory({
'seed': new Uint32Array( [ 291, 564, 837, 1110 ] )
});
var r = rand();
// returns 1067595299
To return a generator having a specific initial state, set the generator state option.
var rand;
var bool;
var r;
var i;
// Generate pseudorandom numbers, thus progressing the generator state:
for ( i = 0; i < 1000; i++ ) {
r = mt19937();
}
// Create a new MT19937 PRNG initialized to the current state of `mt19937`:
rand = mt19937.factory({
'state': mt19937.state
});
// Test that the generated pseudorandom numbers are the same:
bool = ( rand() === mt19937() );
// returns true
The generator name.
var str = mt19937.NAME;
// returns 'mt19937'
Minimum possible value.
var min = mt19937.MIN;
// returns 0
Maximum possible value.
var max = mt19937.MAX;
// returns 4294967295
The value used to seed mt19937().
var rand;
var r;
var i;
// Generate pseudorandom values...
for ( i = 0; i < 100; i++ ) {
r = mt19937();
}
// Generate the same pseudorandom values...
rand = mt19937.factory({
'seed': mt19937.seed
});
for ( i = 0; i < 100; i++ ) {
r = rand();
}
Length of generator seed.
var len = mt19937.seedLength;
// returns <number>
Writable property for getting and setting the generator state.
var r = mt19937();
// returns <number>
r = mt19937();
// returns <number>
// ...
// Get a copy of the current state:
var state = mt19937.state;
// returns <Uint32Array>
r = mt19937();
// returns <number>
r = mt19937();
// returns <number>
// Reset the state:
mt19937.state = state;
// Replay the last two pseudorandom numbers:
r = mt19937();
// returns <number>
r = mt19937();
// returns <number>
// ...
Length of generator state.
var len = mt19937.stateLength;
// returns <number>
Size (in bytes) of generator state.
var sz = mt19937.byteLength;
// returns <number>
Serializes the pseudorandom number generator as a JSON object.
var o = mt19937.toJSON();
// returns { 'type': 'PRNG', 'name': '...', 'state': {...}, 'params': [] }
~2.5kB). Because of the large state size, beware of increased memory consumption when using the factory() method to create many Mersenne Twister PRNGs. When appropriate (e.g., when external state mutation is not a concern), consider sharing PRNG state.1 is considered equivalent to an integer seed equal to the lone seed array element and vice versa.2^19937 - 1.var mt19937 = require( '@stdlib/random-base-mt19937' );
var seed;
var rand;
var i;
// Generate pseudorandom numbers...
for ( i = 0; i < 100; i++ ) {
console.log( mt19937() );
}
// Create a new pseudorandom number generator...
seed = 1234;
rand = mt19937.factory({
'seed': seed
});
for ( i = 0; i < 100; i++ ) {
console.log( rand() );
}
// Create another pseudorandom number generator using a previous seed...
rand = mt19937.factory({
'seed': mt19937.seed
});
for ( i = 0; i < 100; i++ ) {
console.log( rand() );
}
@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.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.
Copyright © 2016-2024. The Stdlib Authors.
0.2.1 (2024-02-25)
<section class="features">efe050d - update minimum TypeScript versionefe050d: update minimum TypeScript version
efe050d: update minimum TypeScript version to 4.1
382c8bb - refactor: use shared package (by Athan Reines)1e909db - docs: update related packages sections (#1267) (by stdlib-bot)efe050d - feat: update minimum TypeScript version (by Philipp Burckhardt)64c8e5a - build: add further backslashes and remove blank comments (by Philipp Burckhardt)10c6209 - test: use strictEqual checks (by Philipp Burckhardt)28e1c84 - docs: resolve C lint errors (by Athan Reines)A total of 2 people contributed to this release. Thank you to the following contributors:
FAQs
A 32-bit Mersenne Twister pseudorandom number generator.
The npm package @stdlib/random-base-mt19937 receives a total of 0 weekly downloads. As such, @stdlib/random-base-mt19937 popularity was classified as not popular.
We found that @stdlib/random-base-mt19937 demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 4 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket’s threat research team has detected six malicious npm packages typosquatting popular libraries to insert SSH backdoors.
Security News
MITRE's 2024 CWE Top 25 highlights critical software vulnerabilities like XSS, SQL Injection, and CSRF, reflecting shifts due to a refined ranking methodology.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.