npmpackage.info

Gathering detailed insights and metrics for @stdlib/random-base-minstd-shuffle

@stdlib/random-base-minstd-shuffle - 0.2.1 | npmpackage.info

@stdlib/random-base-minstd-shuffle

A linear congruential pseudorandom number generator (LCG) whose output is shuffled.

0.2.1

Apache-2.0

JavaScript

108.86 kB

4.2

Installations

npm install @stdlib/random-base-minstd-shuffle

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Min. Node Version

>=0.10.0

Node Version

16.20.2

NPM Version

8.19.4 Pull Requests

Open

0

Total

0

Closed

0

Issues

Open

0

Total

0

Closed

0

Releases

Unable to fetch releases

Languages

JavaScript

JavaScript (61.79%)

C (38.21%)

Developer

stdlib-js

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

Apache-2.0 License

1 Stars

49 Commits

3 Watchers

5 Branches

14 Contributors

Updated on May 26, 2025

Sponsor this package

https://opencollective.com/stdlib

Maintainers

View All 14 Contributors

Package Meta Information

Latest Version

0.2.1

Package Id

@stdlib/random-base-minstd-shuffle@0.2.1

Unpacked Size

108.86 kB

Size

24.76 kB

File Count

NPM Version

8.19.4

Node Version

16.20.2

Published on

Feb 25, 2024

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

@stdlib/array-int32 @stdlib/array-to-json @stdlib/assert-has-own-property @stdlib/assert-is-boolean @stdlib/assert-is-collection @stdlib/assert-is-int32array @stdlib/assert-is-plain-object @stdlib/assert-is-positive-integer @stdlib/blas-base-gcopy @stdlib/constants-int32-max @stdlib/math-base-assert-is-nan @stdlib/math-base-special-floor @stdlib/random-base-minstd @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!

MINSTD Shuffle

A linear congruential pseudorandom number generator (LCG) whose output is shuffled.

Installation

1npm install @stdlib/random-base-minstd-shuffle

Usage

1var minstd = require( '@stdlib/random-base-minstd-shuffle' );

minstd()

Returns a pseudorandom integer on the interval [1, 2147483646].

1var v = minstd();
2// returns <number>

minstd.normalized()

Returns a pseudorandom number on the interval [0,1).

1var v = minstd.normalized();
2// returns <number>

minstd.factory( [options] )

Returns a linear congruential pseudorandom number generator (LCG) whose output is shuffled.

1var rand = minstd.factory();

The function accepts the following options:

seed: pseudorandom number generator seed.
state: an Int32Array containing pseudorandom number generator state. If provided, the function ignores the seed option.
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.

By default, a random integer is used to seed the returned generator. To seed the generator, provide either an integer on the interval [1, 2147483646]

1var rand = minstd.factory({
2    'seed': 1234
3});
4
5var v = rand();
6// returns 1421600654

or, for arbitrary length seeds, an array-like object containing signed 32-bit integers

1var Int32Array = require( '@stdlib/array-int32' );
2
3var rand = minstd.factory({
4    'seed': new Int32Array( [ 1234 ] )
5});
6
7var r = rand();
8// returns 20739838

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 = minstd();
9}
10
11// Create a new PRNG initialized to the current state of `minstd`:
12rand = minstd.factory({
13    'state': minstd.state
14});
15
16// Test that the generated pseudorandom numbers are the same:
17bool = ( rand() === minstd() );
18// returns true

minstd.NAME

The generator name.

1var str = minstd.NAME;
2// returns 'minstd-shuffle'

minstd.MIN

Minimum possible value.

1var min = minstd.MIN;
2// returns 1

minstd.MAX

Maximum possible value.

1var max = minstd.MAX;
2// returns 2147483646

minstd.seed

The value used to seed minstd().

1var rand;
2var v;
3var i;
4
5// Generate pseudorandom values...
6for ( i = 0; i < 100; i++ ) {
7    v = minstd();
8}
9
10// Generate the same pseudorandom values...
11rand = minstd.factory({
12    'seed': minstd.seed
13});
14for ( i = 0; i < 100; i++ ) {
15    v = rand();
16}

minstd.seedLength

Length of generator seed.

1var len = minstd.seedLength;
2// returns <number>

minstd.state

Writable property for getting and setting the generator state.

1var r = minstd();
2// returns <number>
3
4r = minstd();
5// returns <number>
6
7// ...
8
9// Get a copy of the current state:
10var state = minstd.state;
11// returns <Int32Array>
12
13r = minstd();
14// returns <number>
15
16r = minstd();
17// returns <number>
18
19// Reset the state:
20minstd.state = state;
21
22// Replay the last two pseudorandom numbers:
23r = minstd();
24// returns <number>
25
26r = minstd();
27// returns <number>
28
29// ...

minstd.stateLength

Length of generator state.

1var len = minstd.stateLength;
2// returns <number>

minstd.byteLength

Size (in bytes) of generator state.

1var sz = minstd.byteLength;
2// returns <number>

minstd.toJSON()

Serializes the pseudorandom number generator as a JSON object.

1var o = minstd.toJSON();
2// returns { 'type': 'PRNG', 'name': '...', 'state': {...}, 'params': [] }

Notes

Before output from a simple linear congruential generator (LCG) is returned, the output is shuffled using the Bays-Durham algorithm. This additional step considerably strengthens the "randomness quality" of a simple LCG's output.
The generator has a period of approximately 2.1e9 (see Numerical Recipes in C, 2nd Edition, p. 279).
An LCG is fast and uses little memory. On the other hand, because the generator is a simple linear congruential generator, 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 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).

Examples

1var minstd = require( '@stdlib/random-base-minstd-shuffle' );
2
3var seed;
4var rand;
5var i;
6
7// Generate pseudorandom numbers...
8for ( i = 0; i < 100; i++ ) {
9    console.log( minstd() );
10}
11
12// Create a new pseudorandom number generator...
13seed = 1234;
14rand = minstd.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 = minstd.factory({
23    'seed': minstd.seed
24});
25for ( i = 0; i < 100; i++ ) {
26    console.log( rand() );
27}

References

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.
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.
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.
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.

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

License

See LICENSE.

Copyright

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

10

License

Determines if the project has defined a license.

9

Security-Policy

Determines if the project has published a security policy.

3

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

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-minstd-shuffle/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-minstd-shuffle/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-minstd-shuffle/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-minstd-shuffle/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-minstd-shuffle/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: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/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/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

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

SAST

Determines if the project uses static code analysis.

0

Fuzzing

Determines if the project uses fuzzing.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

Score

4.2

/10

Last Scanned on 2025-07-07

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

@stdlib/random-base-minstd-shuffle

Installations

Developer Guide

Yes

CommonJS

>=0.10.0

16.20.2

8.19.4

Pull Requests

0

0

0

Issues

0

0

0

Releases

Unable to fetch releases

Languages

Developer

Download Statistics

GitHub Statistics

Sponsor this package

Maintainers

Package Meta Information

Total Downloads

NaN

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

MINSTD Shuffle

Installation

Usage

minstd()

minstd.normalized()

minstd.factory( [options] )

minstd.NAME

minstd.MIN

minstd.MAX

minstd.seed

minstd.seedLength

minstd.state

minstd.stateLength

minstd.byteLength

minstd.toJSON()

Notes

Examples

References

See Also

Notice

Community

License

Copyright

10

10

10

10

9

3

0

0

0

0

0

0

0

4.2

/10