Create an iterator for a linear congruential pseudorandom number generator (LCG) whose output is shuffled.
npm install @stdlib/random-iter-minstd-shuffleWe 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!
About stdlib...
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Create an iterator for a linear congruential pseudorandom number generator ([LCG][lcg]) whose output is shuffled.
``bash`
npm install @stdlib/random-iter-minstd-shuffle
`javascript`
var iterator = require( '@stdlib/random-iter-minstd-shuffle' );
#### iterator( \[options] )
Returns an iterator for generating pseudorandom numbers via a linear congruential pseudorandom number generator ([LCG][lcg]) whose output is shuffled.
`javascript
var it = iterator();
// returns
var r = it.next().value;
// returns
r = it.next().value;
// returns
r = it.next().value;
// returns
// ...
`
The function accepts the following options:
- normalized: boolean indicating whether to return pseudorandom numbers on the interval [0,1).Int32Array
- seed: pseudorandom number generator seed.
- state: an [][@stdlib/array/int32] containing pseudorandom number generator state. If provided, the function ignores the seed option.boolean
- copy: 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 iterator has exclusive control over its internal pseudorandom number generator state. Default: true.
- iter: number of iterations.
To return pseudorandom numbers on the interval 0,1), set the normalized option.
`javascript
var it = iterator({
'normalized': true
});
var r = it.next().value;
// returns
`
To return an iterator having a specific initial state, set the iterator state option.
`javascript
var bool;
var it1;
var it2;
var r;
var i;
it1 = iterator();
// Generate pseudorandom numbers, thus progressing the generator state:
for ( i = 0; i < 1000; i++ ) {
r = it1.next().value;
}
// Create a new iterator initialized to the current state of it1:
it2 = iterator({
'state': it1.state
});
// Test that the generated pseudorandom numbers are the same:
bool = ( it1.next().value === it2.next().value );
// returns true
`
To seed the iterator, set the seed option.
`javascript
var it = iterator({
'seed': 12345
});
var r = it.next().value;
// returns 1982386332
it = iterator({
'seed': 12345
});
r = it.next().value;
// returns 1982386332
`
To limit the number of iterations, set the iter option.
`javascript
var it = iterator({
'iter': 2
});
var r = it.next().value;
// returns
r = it.next().value;
// returns
r = it.next().done;
// returns true
`
The returned iterator protocol-compliant object has the following properties:
- next: function which returns an iterator protocol-compliant object containing the next iterated value (if one exists) assigned to a value property and a done property having a boolean value indicating whether the iterator is finished.
- return: function which closes an iterator and returns a single (optional) argument in an iterator protocol-compliant object.
- seed: pseudorandom number generator seed.
- seedLength: length of generator seed.
- state: writable property for getting and setting the generator state.
- stateLength: length of generator state.
- byteLength: size (in bytes) of generator state.
- If an environment supports Symbol.iterator, the returned iterator is iterable.2.1e9
- The generator has a period of approximately (see [Numerical Recipes in C, 2nd Edition, p. 279).
- An [LCG][lcg] is fast and uses little memory. On the other hand, because the generator is a simple [linear congruential generator][lcg], the generator has recognized shortcomings. By today's PRNG standards, the generator's period is relatively short. In general, this generator is unsuitable for Monte Carlo simulations and cryptographic applications.
- If PRNG state is "shared" (meaning a state array was provided during iterator creation and not copied) and one sets the underlying generator state to a state array having a different length, the iterator 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 iterator and/or PRNG must be explicitly set.
- 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 iterator and/or PRNGs sharing the PRNG's state array).
`javascript
var iterator = require( '@stdlib/random-iter-minstd-shuffle' );
var it;
var r;
// Create a seeded iterator for generating pseudorandom numbers:
it = iterator({
'seed': 1234,
'iter': 10
});
// Perform manual iteration...
while ( true ) {
r = it.next();
if ( r.done ) {
break;
}
console.log( r.value );
}
`
*
- Park, S. K., and K. W. Miller. 1988. "Random Number Generators: Good Ones Are Hard to Find." _Communications of the ACM_ 31 (10). New York, NY, USA: ACM: 1192–1201. doi:[10.1145/63039.63042][@park:1988].
- Bays, Carter, and S. D. Durham. 1976. "Improving a Poor Random Number Generator." _ACM Transactions on Mathematical Software_ 2 (1). New York, NY, USA: ACM: 59–64. doi:[10.1145/355666.355670][@bays:1976].
- Herzog, T.N., and G. Lord. 2002. _Applications of Monte Carlo Methods to Finance and Insurance_. ACTEX Publications. [https://books.google.com/books?id=vC7I\\\_gdX-A0C][@herzog:2002].
- Press, William H., Brian P. Flannery, Saul A. Teukolsky, and William T. Vetterling. 1992. _Numerical Recipes in C: The Art of Scientific Computing, Second Edition_. Cambridge University Press.
*
- [@stdlib/random-base/minstd-shuffle][@stdlib/random/base/minstd-shuffle]: A linear congruential pseudorandom number generator (LCG) whose output is shuffled.
- [@stdlib/random-iter/minstd][@stdlib/random/iter/minstd]: create an iterator for a linear congruential pseudorandom number generator (LCG) based on Park and Miller.
- [@stdlib/random-iter/mt19937][@stdlib/random/iter/mt19937]: create an iterator for a 32-bit Mersenne Twister pseudorandom number generator.
- [@stdlib/random-iter/randi][@stdlib/random/iter/randi]: create an iterator for generating pseudorandom numbers having integer values.
- [@stdlib/random-iter/randu][@stdlib/random/iter/randu]: create an iterator for generating uniformly distributed pseudorandom numbers between 0 and 1.
*
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]
---
See [LICENSE][stdlib-license].
Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/random-iter-minstd-shuffle.svg
[npm-url]: https://npmjs.org/package/@stdlib/random-iter-minstd-shuffle
[test-image]: https://github.com/stdlib-js/random-iter-minstd-shuffle/actions/workflows/test.yml/badge.svg?branch=v0.2.2
[test-url]: https://github.com/stdlib-js/random-iter-minstd-shuffle/actions/workflows/test.yml?query=branch:v0.2.2
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/random-iter-minstd-shuffle/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/random-iter-minstd-shuffle?branch=main
[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg
[chat-url]: https://stdlib.zulipchat.com
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
[deno-url]: https://github.com/stdlib-js/random-iter-minstd-shuffle/tree/deno
[deno-readme]: https://github.com/stdlib-js/random-iter-minstd-shuffle/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/random-iter-minstd-shuffle/tree/umd
[umd-readme]: https://github.com/stdlib-js/random-iter-minstd-shuffle/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/random-iter-minstd-shuffle/tree/esm
[esm-readme]: https://github.com/stdlib-js/random-iter-minstd-shuffle/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/random-iter-minstd-shuffle/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/random-iter-minstd-shuffle/main/LICENSE
[lcg]: https://en.wikipedia.org/wiki/Linear_congruential_generator
[@park:1988]: http://dx.doi.org/10.1145/63039.63042
[@bays:1976]: http://dx.doi.org/10.1145/355666.355670
[@herzog:2002]: https://books.google.com/books?id=vC7I_gdX-A0C
[@stdlib/array/int32]: https://www.npmjs.com/package/@stdlib/array-int32
[@stdlib/random/base/minstd-shuffle]: https://www.npmjs.com/package/@stdlib/random-base-minstd-shuffle
[@stdlib/random/iter/minstd]: https://www.npmjs.com/package/@stdlib/random-iter-minstd
[@stdlib/random/iter/mt19937]: https://www.npmjs.com/package/@stdlib/random-iter-mt19937
[@stdlib/random/iter/randi]: https://www.npmjs.com/package/@stdlib/random-iter-randi
[@stdlib/random/iter/randu]: https://www.npmjs.com/package/@stdlib/random-iter-randu