{"id":26119177,"url":"https://github.com/stdlib-js/random-array-minstd","last_synced_at":"2025-04-13T10:21:33.775Z","repository":{"id":66335044,"uuid":"602947806","full_name":"stdlib-js/random-array-minstd","owner":"stdlib-js","description":"Create an array containing pseudorandom numbers generated using a linear congruential pseudorandom number generator (LCG).","archived":false,"fork":false,"pushed_at":"2025-04-07T02:16:56.000Z","size":1380,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-12T17:54:00.456Z","etag":null,"topics":["javascript","lcg","lehmer","math","mathematics","minstd","node","node-js","nodejs","prng","pseudorandom","rand","randi","randint","random","randu","rng","statistics","stats","stdlib"],"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,"zenodo":null},"funding":{"github":["stdlib-js"],"open_collective":"stdlib","tidelift":"npm/@stdlib/stdlib"}},"created_at":"2023-02-17T09:38:32.000Z","updated_at":"2025-04-07T01:42:52.000Z","dependencies_parsed_at":"2023-10-03T10:14:52.485Z","dependency_job_id":"0f41081e-1c0e-48c3-a5a9-1ab340743249","html_url":"https://github.com/stdlib-js/random-array-minstd","commit_stats":null,"previous_names":[],"tags_count":16,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Frandom-array-minstd","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Frandom-array-minstd/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Frandom-array-minstd/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Frandom-array-minstd/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stdlib-js","download_url":"https://codeload.github.com/stdlib-js/random-array-minstd/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248610408,"owners_count":21132920,"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":["javascript","lcg","lehmer","math","mathematics","minstd","node","node-js","nodejs","prng","pseudorandom","rand","randi","randint","random","randu","rng","statistics","stats","stdlib"],"created_at":"2025-03-10T12:16:33.094Z","updated_at":"2025-04-13T10:21:33.733Z","avatar_url":"https://github.com/stdlib-js.png","language":"JavaScript","funding_links":["https://github.com/sponsors/stdlib-js","https://opencollective.com/stdlib","https://tidelift.com/funding/github/npm/@stdlib/stdlib"],"categories":[],"sub_categories":[],"readme":"\u003c!--\n\n@license Apache-2.0\n\nCopyright (c) 2023 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# minstd\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 Create an array containing pseudorandom numbers generated using a [linear congruential pseudorandom number generator][@stdlib/random/base/minstd] (LCG).\n\n\u003csection class=\"installation\"\u003e\n\n## Installation\n\n```bash\nnpm install @stdlib/random-array-minstd\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 minstd = require( '@stdlib/random-array-minstd' );\n```\n\n#### minstd( len\\[, options] )\n\nReturns an array containing pseudorandom integers on the interval `[1, 2147483646]`.\n\n```javascript\nvar out = minstd( 10 );\n// returns \u003cFloat64Array\u003e\n```\n\nThe function has the following parameters:\n\n-   **len**: output array length.\n-   **options**: function options.\n\nThe function accepts the following `options`:\n\n-   **dtype**: output array data type. Must be a [real-valued data type][@stdlib/array/typed-real-dtypes] or \"generic\". Default: `'float64'`.\n\nBy default, the function returns a [`Float64Array`][@stdlib/array/float64]. To return an array having a different data type, set the `dtype` option.\n\n```javascript\nvar opts = {\n    'dtype': 'generic'\n};\n\nvar out = minstd( 10, opts );\n// returns [...]\n```\n\n#### minstd.normalized( len\\[, options] )\n\nReturns an array containing pseudorandom numbers on the interval `[0, 1)`.\n\n```javascript\nvar out = minstd.normalized( 10 );\n// returns \u003cFloat64Array\u003e\n```\n\nThe function has the following parameters:\n\n-   **len**: output array length.\n-   **options**: function options.\n\nThe function accepts the following `options`:\n\n-   **dtype**: output array data type. Must be a [real-valued floating-point data type][@stdlib/array/typed-real-float-dtypes] or \"generic\". Default: `'float64'`.\n\nBy default, the function returns a [`Float64Array`][@stdlib/array/float64]. To return an array having a different data type, set the `dtype` option.\n\n```javascript\nvar opts = {\n    'dtype': 'generic'\n};\n\nvar out = minstd.normalized( 10, opts );\n// returns [...]\n```\n\n#### minstd.factory( \\[options] )\n\nReturns a function for creating arrays containing pseudorandom numbers generated using a [linear congruential pseudorandom number generator][@stdlib/random/base/minstd] (LCG).\n\n```javascript\nvar random = minstd.factory();\n\nvar out = random( 10 );\n// returns \u003cFloat64Array\u003e\n\nvar len = out.length;\n// returns 10\n\nout = random.normalized( 10 );\n// returns \u003cFloat64Array\u003e\n\nlen = out.length;\n// returns 10\n```\n\nThe function accepts the following `options`:\n\n-   **seed**: pseudorandom number generator seed.\n-   **state**: an [`Int32Array`][@stdlib/array/int32] 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-   **idtype**: default output array data type when generating integers. Must be a [real-valued data type][@stdlib/array/typed-real-dtypes] or \"generic\". Default: `'float64'`.\n-   **ndtype**: default output array data type when generating normalized numbers. Must be a [real-valued floating-point data type][@stdlib/array/typed-real-float-dtypes] or \"generic\". Default: `'float64'`.\n\nTo seed the underlying pseudorandom number generator, set the `seed` option.\n\n```javascript\nvar opts = {\n    'seed': 12345\n};\nvar random = minstd.factory( opts );\n\nvar out = random( 10, opts );\n// returns \u003cFloat64Array\u003e\n```\n\nThe returned function accepts the following `options`:\n\n-   **dtype**: output array data type. Must be a [real-valued data type][@stdlib/array/typed-real-dtypes] or \"generic\". This overrides the default output array data type.\n\nThe returned function has a `normalized` method which accepts the following `options`:\n\n-   **dtype**: output array data type. Must be a [real-valued floating-point data type][@stdlib/array/typed-real-float-dtypes] or \"generic\". This overrides the default output array data type.\n\nTo override the default output array data type, set the `dtype` option.\n\n```javascript\nvar random = minstd.factory();\n\nvar out = random( 10 );\n// returns \u003cFloat64Array\u003e\n\nvar opts = {\n    'dtype': 'generic'\n};\nout = random( 10, opts );\n// returns [...]\n```\n\n#### minstd.PRNG\n\nThe underlying pseudorandom number generator.\n\n```javascript\nvar prng = minstd.PRNG;\n// returns \u003cFunction\u003e\n```\n\n#### minstd.seed\n\nThe value used to seed the underlying pseudorandom number generator.\n\n```javascript\nvar seed = minstd.seed;\n// returns \u003cInt32Array\u003e\n```\n\n#### minstd.seedLength\n\nLength of underlying pseudorandom number generator seed.\n\n```javascript\nvar len = minstd.seedLength;\n// returns \u003cnumber\u003e\n```\n\n#### minstd.state\n\nWritable property for getting and setting the underlying pseudorandom number generator state.\n\n```javascript\nvar state = minstd.state;\n// returns \u003cInt32Array\u003e\n```\n\n#### minstd.stateLength\n\nLength of underlying pseudorandom number generator state.\n\n```javascript\nvar len = minstd.stateLength;\n// returns \u003cnumber\u003e\n```\n\n#### minstd.byteLength\n\nSize (in bytes) of underlying pseudorandom number generator state.\n\n```javascript\nvar sz = minstd.byteLength;\n// returns \u003cnumber\u003e\n```\n\n\u003c/section\u003e\n\n\u003c!-- /.usage --\u003e\n\n\u003csection class=\"notes\"\u003e\n\n## Notes\n\n-   An [LCG][@stdlib/random/base/minstd] is fast and uses little memory. On the other hand, because the generator is a simple [linear congruential generator][@stdlib/random/base/minstd], the generator has recognized shortcomings. By today's PRNG standards, the generator's period is relatively short. More importantly, the \"randomness quality\" of the generator's output is lacking. These defects make the generator unsuitable, for example, in Monte Carlo simulations and in cryptographic applications.\n-   If PRNG state is \"shared\" (meaning a state array was provided during function creation and **not** copied) and one sets the underlying generator state to a state array having a different length, the function returned by the `factory` method does **not** update the existing shared state and, instead, points to the newly provided state array. In order to synchronize the output of the underlying generator according to the new shared state array, the state array for **each** relevant creation function and/or PRNG must be **explicitly** set.\n-   If PRNG state is \"shared\" and one sets the underlying generator state to a state array of the same length, the PRNG state is updated (along with the state of all other creation functions and/or PRNGs sharing the PRNG's state array).\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 logEach = require( '@stdlib/console-log-each' );\nvar minstd = require( '@stdlib/random-array-minstd' );\n\n// Create a function for generating random arrays originating from the same state:\nvar random = minstd.factory({\n    'state': minstd.state,\n    'copy': true\n});\n\n// Generate 3 arrays:\nvar x1 = random.normalized( 5 );\nvar x2 = random.normalized( 5 );\nvar x3 = random.normalized( 5 );\n\n// Print the contents:\nlogEach( '%f, %f, %f', x1, x2, x3 );\n\n// Create another function for generating random arrays with the original state:\nrandom = minstd.factory({\n    'state': minstd.state,\n    'copy': true\n});\n\n// Generate a single array which replicates the above pseudorandom number generation sequence:\nvar x4 = random.normalized( 15 );\n\n// Print the contents:\nlogEach( '%f', x4 );\n```\n\n\u003c/section\u003e\n\n\u003c!-- /.examples --\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/minstd-shuffle`][@stdlib/random/array/minstd-shuffle]\u003c/span\u003e\u003cspan class=\"delimiter\"\u003e: \u003c/span\u003e\u003cspan class=\"description\"\u003ecreate an array containing pseudorandom numbers generated using a linear congruential pseudorandom number generator (LCG) whose output is shuffled.\u003c/span\u003e\n-   \u003cspan class=\"package-name\"\u003e[`@stdlib/random-array/randu`][@stdlib/random/array/randu]\u003c/span\u003e\u003cspan class=\"delimiter\"\u003e: \u003c/span\u003e\u003cspan class=\"description\"\u003ecreate an array containing uniformly distributed pseudorandom numbers between 0 and 1.\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-strided/minstd`][@stdlib/random/strided/minstd]\u003c/span\u003e\u003cspan class=\"delimiter\"\u003e: \u003c/span\u003e\u003cspan class=\"description\"\u003efill a strided array with pseudorandom numbers generated using a linear congruential pseudorandom number generator (LCG).\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## License\n\nSee [LICENSE][stdlib-license].\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-array-minstd.svg\n[npm-url]: https://npmjs.org/package/@stdlib/random-array-minstd\n\n[test-image]: https://github.com/stdlib-js/random-array-minstd/actions/workflows/test.yml/badge.svg?branch=main\n[test-url]: https://github.com/stdlib-js/random-array-minstd/actions/workflows/test.yml?query=branch:main\n\n[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/random-array-minstd/main.svg\n[coverage-url]: https://codecov.io/github/stdlib-js/random-array-minstd?branch=main\n\n\u003c!--\n\n[dependencies-image]: https://img.shields.io/david/stdlib-js/random-array-minstd.svg\n[dependencies-url]: https://david-dm.org/stdlib-js/random-array-minstd/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-array-minstd/tree/deno\n[deno-readme]: https://github.com/stdlib-js/random-array-minstd/blob/deno/README.md\n[umd-url]: https://github.com/stdlib-js/random-array-minstd/tree/umd\n[umd-readme]: https://github.com/stdlib-js/random-array-minstd/blob/umd/README.md\n[esm-url]: https://github.com/stdlib-js/random-array-minstd/tree/esm\n[esm-readme]: https://github.com/stdlib-js/random-array-minstd/blob/esm/README.md\n[branches-url]: https://github.com/stdlib-js/random-array-minstd/blob/main/branches.md\n\n[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/random-array-minstd/main/LICENSE\n\n[@stdlib/random/base/minstd]: https://github.com/stdlib-js/random-base-minstd\n\n[@stdlib/array/typed-real-float-dtypes]: https://github.com/stdlib-js/array-typed-real-float-dtypes\n\n[@stdlib/array/typed-real-dtypes]: https://github.com/stdlib-js/array-typed-real-dtypes\n\n[@stdlib/array/float64]: https://github.com/stdlib-js/array-float64\n\n[@stdlib/array/int32]: https://github.com/stdlib-js/array-int32\n\n\u003c!-- \u003crelated-links\u003e --\u003e\n\n[@stdlib/random/array/minstd-shuffle]: https://github.com/stdlib-js/random-array-minstd-shuffle\n\n[@stdlib/random/array/randu]: https://github.com/stdlib-js/random-array-randu\n\n[@stdlib/random/strided/minstd]: https://github.com/stdlib-js/random-strided-minstd\n\n\u003c!-- \u003c/related-links\u003e --\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.links --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstdlib-js%2Frandom-array-minstd","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstdlib-js%2Frandom-array-minstd","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstdlib-js%2Frandom-array-minstd/lists"}