{"id":26558097,"url":"https://github.com/stdlib-js/random-base-mt19937","last_synced_at":"2025-03-22T12:22:28.153Z","repository":{"id":41407422,"uuid":"377255244","full_name":"stdlib-js/random-base-mt19937","owner":"stdlib-js","description":"A 32-bit Mersenne Twister pseudorandom number generator.","archived":false,"fork":false,"pushed_at":"2025-03-10T02:10:31.000Z","size":2031,"stargazers_count":7,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-10T02:46:11.158Z","etag":null,"topics":["generator","javascript","math","mathematics","mersenne","mt19937","node","node-js","nodejs","prng","pseudorandom","rand","randint","random","randu","statistics","stats","stdlib","twister","uniform"],"latest_commit_sha":null,"homepage":"https://github.com/stdlib-js/stdlib","language":"JavaScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/stdlib-js.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["stdlib-js"],"open_collective":"stdlib","tidelift":"npm/@stdlib/stdlib"}},"created_at":"2021-06-15T18:12:26.000Z","updated_at":"2025-03-10T01:28:46.000Z","dependencies_parsed_at":"2024-01-23T21:38:07.179Z","dependency_job_id":"9729e283-ecc9-4bf8-88a4-6ba4bb539aa5","html_url":"https://github.com/stdlib-js/random-base-mt19937","commit_stats":{"total_commits":43,"total_committers":1,"mean_commits":43.0,"dds":0.0,"last_synced_commit":"921363a3957940e5bce76453f9f33b412db58e13"},"previous_names":[],"tags_count":18,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Frandom-base-mt19937","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Frandom-base-mt19937/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Frandom-base-mt19937/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Frandom-base-mt19937/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stdlib-js","download_url":"https://codeload.github.com/stdlib-js/random-base-mt19937/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244954229,"owners_count":20537736,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["generator","javascript","math","mathematics","mersenne","mt19937","node","node-js","nodejs","prng","pseudorandom","rand","randint","random","randu","statistics","stats","stdlib","twister","uniform"],"created_at":"2025-03-22T12:22:27.624Z","updated_at":"2025-03-22T12:22:28.142Z","avatar_url":"https://github.com/stdlib-js.png","language":"JavaScript","readme":"\u003c!--\n\n@license Apache-2.0\n\nCopyright (c) 2018 The Stdlib Authors.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n   http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n\n--\u003e\n\n\n\u003cdetails\u003e\n  \u003csummary\u003e\n    About stdlib...\n  \u003c/summary\u003e\n  \u003cp\u003eWe 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.\u003c/p\u003e\n  \u003cp\u003eThe 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.\u003c/p\u003e\n  \u003cp\u003eWhen 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.\u003c/p\u003e\n  \u003cp\u003eTo join us in bringing numerical computing to the web, get started by checking us out on \u003ca href=\"https://github.com/stdlib-js/stdlib\"\u003eGitHub\u003c/a\u003e, and please consider \u003ca href=\"https://opencollective.com/stdlib\"\u003efinancially supporting stdlib\u003c/a\u003e. We greatly appreciate your continued support!\u003c/p\u003e\n\u003c/details\u003e\n\n# Mersenne Twister\n\n[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] \u003c!-- [![dependencies][dependencies-image]][dependencies-url] --\u003e\n\n\u003e A 32-bit [Mersenne Twister][mersenne-twister] pseudorandom number generator.\n\n\u003csection class=\"installation\"\u003e\n\n## Installation\n\n```bash\nnpm install @stdlib/random-base-mt19937\n```\n\nAlternatively,\n\n-   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]).\n-   If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).\n-   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]).\n\nThe [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.\n\nTo 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.\n\n\u003c/section\u003e\n\n\u003csection class=\"usage\"\u003e\n\n## Usage\n\n```javascript\nvar mt19937 = require( '@stdlib/random-base-mt19937' );\n```\n\n#### mt19937()\n\nReturns a pseudorandom integer on the interval `[0, 4294967295]`.\n\n```javascript\nvar r = mt19937();\n// returns \u003cnumber\u003e\n```\n\n#### mt19937.normalized()\n\nReturns a pseudorandom number on the interval `[0, 1)` with 53-bit precision.\n\n```javascript\nvar r = mt19937.normalized();\n// returns \u003cnumber\u003e\n```\n\n#### mt19937.factory( \\[options] )\n\nReturns a 32-bit [Mersenne Twister][mersenne-twister] pseudorandom number generator.\n\n```javascript\nvar rand = mt19937.factory();\n```\n\nThe function accepts the following `options`:\n\n-   **seed**: pseudorandom number generator seed.\n-   **state**: a [`Uint32Array`][@stdlib/array/uint32] containing pseudorandom number generator state. If provided, the function ignores the `seed` option.\n-   **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. Setting this option to `true` ensures that a returned generator has exclusive control over its internal state. Default: `true`.\n\nBy default, a random integer is used to seed the returned generator. To seed the generator, provide either a nonzero integer on the interval `[1, 4294967295]`\n\n```javascript\nvar rand = mt19937.factory({\n    'seed': 1234\n});\n\nvar r = rand();\n// returns 822569775\n```\n\nor, for arbitrary length seeds, an array-like object containing unsigned 32-bit integers\n\n```javascript\nvar Uint32Array = require( '@stdlib/array-uint32' );\n\nvar rand = mt19937.factory({\n    'seed': new Uint32Array( [ 291, 564, 837, 1110 ] )\n});\n\nvar r = rand();\n// returns 1067595299\n```\n\nTo return a generator having a specific initial state, set the generator `state` option.\n\n```javascript\n// Generate pseudorandom numbers, thus progressing the generator state:\nvar r;\nvar i;\nfor ( i = 0; i \u003c 1000; i++ ) {\n    r = mt19937();\n}\n\n// Create a new MT19937 PRNG initialized to the current state of `mt19937`:\nvar rand = mt19937.factory({\n    'state': mt19937.state\n});\n\n// Test that the generated pseudorandom numbers are the same:\nvar bool = ( rand() === mt19937() );\n// returns true\n```\n\n#### mt19937.NAME\n\nThe generator name.\n\n```javascript\nvar str = mt19937.NAME;\n// returns 'mt19937'\n```\n\n#### mt19937.MIN\n\nMinimum possible value.\n\n```javascript\nvar min = mt19937.MIN;\n// returns 0\n```\n\n#### mt19937.MAX\n\nMaximum possible value.\n\n```javascript\nvar max = mt19937.MAX;\n// returns 4294967295\n```\n\n#### mt19937.seed\n\nThe value used to seed `mt19937()`.\n\n```javascript\n// Generate pseudorandom values...\nvar r;\nvar i;\nfor ( i = 0; i \u003c 100; i++ ) {\n    r = mt19937();\n}\n\n// Generate the same pseudorandom values...\nvar rand = mt19937.factory({\n    'seed': mt19937.seed\n});\nfor ( i = 0; i \u003c 100; i++ ) {\n    r = rand();\n}\n```\n\n#### mt19937.seedLength\n\nLength of generator seed.\n\n```javascript\nvar len = mt19937.seedLength;\n// returns \u003cnumber\u003e\n```\n\n#### mt19937.state\n\nWritable property for getting and setting the generator state.\n\n```javascript\nvar r = mt19937();\n// returns \u003cnumber\u003e\n\nr = mt19937();\n// returns \u003cnumber\u003e\n\n// ...\n\n// Get a copy of the current state:\nvar state = mt19937.state;\n// returns \u003cUint32Array\u003e\n\nr = mt19937();\n// returns \u003cnumber\u003e\n\nr = mt19937();\n// returns \u003cnumber\u003e\n\n// Reset the state:\nmt19937.state = state;\n\n// Replay the last two pseudorandom numbers:\nr = mt19937();\n// returns \u003cnumber\u003e\n\nr = mt19937();\n// returns \u003cnumber\u003e\n\n// ...\n```\n\n#### mt19937.stateLength\n\nLength of generator state.\n\n```javascript\nvar len = mt19937.stateLength;\n// returns \u003cnumber\u003e\n```\n\n#### mt19937.byteLength\n\nSize (in bytes) of generator state.\n\n```javascript\nvar sz = mt19937.byteLength;\n// returns \u003cnumber\u003e\n```\n\n#### mt19937.toJSON()\n\nSerializes the pseudorandom number generator as a JSON object.\n\n```javascript\nvar o = mt19937.toJSON();\n// returns { 'type': 'PRNG', 'name': '...', 'state': {...}, 'params': [] }\n```\n\n\u003c/section\u003e\n\n\u003c!-- /.usage --\u003e\n\n\u003csection class=\"notes\"\u003e\n\n## Notes\n\n-   [Mersenne Twister][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.\n-   Compared to other PRNGs, [Mersenne Twister][mersenne-twister] has a large state size (`~2.5kB`). Because of the large state size, beware of increased memory consumption when using the `factory()` method to create many [Mersenne Twister][mersenne-twister] PRNGs. When appropriate (e.g., when external state mutation is not a concern), consider sharing PRNG state.\n-   A seed array of length `1` is considered **equivalent** to an integer seed equal to the lone seed array element and vice versa.\n-   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.\n-   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).\n-   The PRNG has a period of `2^19937 - 1`.\n\n\u003c/section\u003e\n\n\u003c!-- /.notes --\u003e\n\n\u003csection class=\"examples\"\u003e\n\n## Examples\n\n\u003c!-- eslint no-undef: \"error\" --\u003e\n\n```javascript\nvar mt19937 = require( '@stdlib/random-base-mt19937' );\n\n// Generate pseudorandom numbers...\nvar i;\nfor ( i = 0; i \u003c 100; i++ ) {\n    console.log( mt19937() );\n}\n\n// Create a new pseudorandom number generator...\nvar seed = 1234;\nvar rand = mt19937.factory({\n    'seed': seed\n});\nfor ( i = 0; i \u003c 100; i++ ) {\n    console.log( rand() );\n}\n\n// Create another pseudorandom number generator using a previous seed...\nrand = mt19937.factory({\n    'seed': mt19937.seed\n});\nfor ( i = 0; i \u003c 100; i++ ) {\n    console.log( rand() );\n}\n```\n\n\u003c/section\u003e\n\n\u003c!-- /.examples --\u003e\n\n* * *\n\n\u003csection class=\"references\"\u003e\n\n## References\n\n-   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].\n-   Harase, Shin. 2017. \"Conversion of Mersenne Twister to double-precision floating-point numbers.\" _ArXiv_ abs/1708.06018 (September). \u003chttps://arxiv.org/abs/1708.06018\u003e.\n\n\u003c/section\u003e\n\n\u003c!-- /.references --\u003e\n\n\u003c!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. --\u003e\n\n\u003csection class=\"related\"\u003e\n\n* * *\n\n## See Also\n\n-   \u003cspan class=\"package-name\"\u003e[`@stdlib/random-array/mt19937`][@stdlib/random/array/mt19937]\u003c/span\u003e\u003cspan class=\"delimiter\"\u003e: \u003c/span\u003e\u003cspan class=\"description\"\u003ecreate an array containing pseudorandom numbers generated using a 32-bit Mersenne Twister pseudorandom number generator.\u003c/span\u003e\n-   \u003cspan class=\"package-name\"\u003e[`@stdlib/random-iter/mt19937`][@stdlib/random/iter/mt19937]\u003c/span\u003e\u003cspan class=\"delimiter\"\u003e: \u003c/span\u003e\u003cspan class=\"description\"\u003ecreate an iterator for a 32-bit Mersenne Twister pseudorandom number generator.\u003c/span\u003e\n-   \u003cspan class=\"package-name\"\u003e[`@stdlib/random-streams/mt19937`][@stdlib/random/streams/mt19937]\u003c/span\u003e\u003cspan class=\"delimiter\"\u003e: \u003c/span\u003e\u003cspan class=\"description\"\u003ecreate a readable stream for a 32-bit Mersenne Twister pseudorandom number generator.\u003c/span\u003e\n-   \u003cspan class=\"package-name\"\u003e[`@stdlib/random-base/minstd`][@stdlib/random/base/minstd]\u003c/span\u003e\u003cspan class=\"delimiter\"\u003e: \u003c/span\u003e\u003cspan class=\"description\"\u003eA linear congruential pseudorandom number generator (LCG) based on Park and Miller.\u003c/span\u003e\n-   \u003cspan class=\"package-name\"\u003e[`@stdlib/random-base/randi`][@stdlib/random/base/randi]\u003c/span\u003e\u003cspan class=\"delimiter\"\u003e: \u003c/span\u003e\u003cspan class=\"description\"\u003epseudorandom numbers having integer values.\u003c/span\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.related --\u003e\n\n\u003c!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. --\u003e\n\n\n\u003csection class=\"main-repo\" \u003e\n\n* * *\n\n## Notice\n\nThis 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.\n\nFor 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].\n\n#### Community\n\n[![Chat][chat-image]][chat-url]\n\n---\n\n## Copyright\n\nCopyright \u0026copy; 2016-2025. The Stdlib [Authors][stdlib-authors].\n\n\u003c/section\u003e\n\n\u003c!-- /.stdlib --\u003e\n\n\u003c!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. --\u003e\n\n\u003csection class=\"links\"\u003e\n\n[npm-image]: http://img.shields.io/npm/v/@stdlib/random-base-mt19937.svg\n[npm-url]: https://npmjs.org/package/@stdlib/random-base-mt19937\n\n[test-image]: https://github.com/stdlib-js/random-base-mt19937/actions/workflows/test.yml/badge.svg?branch=main\n[test-url]: https://github.com/stdlib-js/random-base-mt19937/actions/workflows/test.yml?query=branch:main\n\n[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/random-base-mt19937/main.svg\n[coverage-url]: https://codecov.io/github/stdlib-js/random-base-mt19937?branch=main\n\n\u003c!--\n\n[dependencies-image]: https://img.shields.io/david/stdlib-js/random-base-mt19937.svg\n[dependencies-url]: https://david-dm.org/stdlib-js/random-base-mt19937/main\n\n--\u003e\n\n[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg\n[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im\n\n[stdlib]: https://github.com/stdlib-js/stdlib\n\n[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors\n\n[umd]: https://github.com/umdjs/umd\n[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules\n\n[deno-url]: https://github.com/stdlib-js/random-base-mt19937/tree/deno\n[deno-readme]: https://github.com/stdlib-js/random-base-mt19937/blob/deno/README.md\n[umd-url]: https://github.com/stdlib-js/random-base-mt19937/tree/umd\n[umd-readme]: https://github.com/stdlib-js/random-base-mt19937/blob/umd/README.md\n[esm-url]: https://github.com/stdlib-js/random-base-mt19937/tree/esm\n[esm-readme]: https://github.com/stdlib-js/random-base-mt19937/blob/esm/README.md\n[branches-url]: https://github.com/stdlib-js/random-base-mt19937/blob/main/branches.md\n\n[mersenne-twister]: https://en.wikipedia.org/wiki/Mersenne_Twister\n\n[@matsumoto:1998a]: https://doi.org/10.1145/272991.272995\n\n[@stdlib/array/uint32]: https://github.com/stdlib-js/array-uint32\n\n\u003c!-- \u003crelated-links\u003e --\u003e\n\n[@stdlib/random/array/mt19937]: https://github.com/stdlib-js/random-array-mt19937\n\n[@stdlib/random/iter/mt19937]: https://github.com/stdlib-js/random-iter-mt19937\n\n[@stdlib/random/streams/mt19937]: https://github.com/stdlib-js/random-streams-mt19937\n\n[@stdlib/random/base/minstd]: https://github.com/stdlib-js/random-base-minstd\n\n[@stdlib/random/base/randi]: https://github.com/stdlib-js/random-base-randi\n\n\u003c!-- \u003c/related-links\u003e --\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.links --\u003e\n","funding_links":["https://github.com/sponsors/stdlib-js","https://opencollective.com/stdlib","https://tidelift.com/funding/github/npm/@stdlib/stdlib"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstdlib-js%2Frandom-base-mt19937","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstdlib-js%2Frandom-base-mt19937","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstdlib-js%2Frandom-base-mt19937/lists"}