Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/stdlib-js/random-strided-minstd

Fill a strided array with pseudorandom numbers generated using a linear congruential pseudorandom number generator (LCG).
https://github.com/stdlib-js/random-strided-minstd

javascript lcg lehmer math mathematics minstd node node-js nodejs prng pseudorandom rand randi randint random randu rng statistics stats stdlib

Last synced: 11 days ago
JSON representation

Fill a strided array with pseudorandom numbers generated using a linear congruential pseudorandom number generator (LCG).

Awesome Lists containing this project

README 

        



  

    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



[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] 



> Fill a strided array with pseudorandom numbers generated using a [linear congruential pseudorandom number generator][@stdlib/random/base/minstd] (LCG).



## Installation



```bash

npm install @stdlib/random-strided-minstd

```



Alternatively,



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

-   If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).

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



The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.



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



## Usage



```javascript

var minstd = require( '@stdlib/random-strided-minstd' );

```



#### minstd( N, out, so\[, options] )



Fills a strided array with pseudorandom integers between `1` and `2147483646`.



```javascript

var Float64Array = require( '@stdlib/array-float64' );



// Create an array:

var out = new Float64Array( 10 );



// Fill the array with pseudorandom numbers:

minstd( out.length, out, 1 );

```



The function has the following parameters:



-   **N**: number of indexed elements.

-   **out**: output array.

-   **so**: index increment for `out`.



The `N` and stride parameters determine which strided array elements are accessed at runtime. For example, to access every other value in `out`,



```javascript

var out = [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ];



minstd( 3, out, 2 );

```



Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views.



```javascript

var Float64Array = require( '@stdlib/array-float64' );



// Initial array:

var out0 = new Float64Array( 6 );



// Create offset views:

var out1 = new Float64Array( out0.buffer, out0.BYTES_PER_ELEMENT*1 ); // start at 2nd element



// Fill the output array:

minstd( out1.length, out1, 1 );

```



The function accepts the following `options`:



-   **seed**: pseudorandom number generator seed.

-   **state**: an [`Int32Array`][@stdlib/array/int32] 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`.



To seed the underlying pseudorandom number generator, set the `seed` option.



```javascript

var Float64Array = require( '@stdlib/array-float64' );



var opts = {

    'seed': 12345

};



var out = new Float64Array( 10 );

minstd( out.length, out, 1, opts );

```



#### minstd.ndarray( N, out, so, oo\[, options] )



Fills a strided array with pseudorandom integers between `1` and `2147483646` using alternative indexing semantics.



```javascript

var Float64Array = require( '@stdlib/array-float64' );



// Create an array:

var out = new Float64Array( 10 );



// Fill the array with pseudorandom numbers:

minstd.ndarray( out.length, out, 1, 0 );

```



The function has the following additional parameters:



-   **oo**: starting index for `out`.



While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying `buffer`, the offset parameters support indexing semantics based on starting indices. For example, to access every other value in `out` starting from the second value,



```javascript

var out = [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ];



minstd.ndarray( 3, out, 2, 1 );

```



The function accepts the same `options` as documented above for `minstd()`.



#### minstd.normalized( N, out, so\[, options] )



Fills a strided array with pseudorandom numbers between `0` and `1`.



```javascript

var Float64Array = require( '@stdlib/array-float64' );



// Create an array:

var out = new Float64Array( 10 );



// Fill the array with pseudorandom numbers:

minstd.normalized( out.length, out, 1 );

```



The function has the following parameters:



-   **N**: number of indexed elements.

-   **out**: output array.

-   **so**: index increment for `out`.



The function accepts the same `options` as documented above for `minstd()`.



#### minstd.normalized.ndarray( N, out, so, oo\[, options] )



Fills a strided array with pseudorandom numbers between `0` and `1` using alternative indexing semantics.



```javascript

var Float64Array = require( '@stdlib/array-float64' );



// Create an array:

var out = new Float64Array( 10 );



// Fill the array with pseudorandom numbers:

minstd.normalized.ndarray( out.length, out, 1, 0 );

```



The function has the following additional parameters:



-   **oo**: starting index for `out`.



The function accepts the same `options` as documented above for `minstd()`.



## Notes



-   If `N <= 0`, all functions leave the output array unchanged.

-   All functions support array-like objects having getter and setter accessors for array element access.



## Examples



```javascript

var zeros = require( '@stdlib/array-zeros' );

var zeroTo = require( '@stdlib/array-base-zero-to' );

var logEach = require( '@stdlib/console-log-each' );

var minstd = require( '@stdlib/random-strided-minstd' );



// Specify a PRNG seed:

var opts = {

    'seed': 1234

};



// Create an array:

var x1 = zeros( 10, 'float64' );



// Create a list of indices:

var idx = zeroTo( x1.length );



// Fill the array with pseudorandom numbers:

minstd.normalized( x1.length, x1, 1, opts );



// Create a second array:

var x2 = zeros( 10, 'generic' );



// Fill the array with the same pseudorandom numbers:

minstd.normalized( x2.length, x2, 1, opts );



// Print the array contents:

logEach( 'x1[%d] = %.2f; x2[%d] = %.2f', idx, x1, idx, x2 );

```



* * *



## See Also



-   [`@stdlib/random-base/minstd`][@stdlib/random/base/minstd]: A linear congruential pseudorandom number generator (LCG) based on Park and Miller.

-   [`@stdlib/random-array/minstd`][@stdlib/random/array/minstd]: create an array containing pseudorandom numbers generated using a linear congruential pseudorandom number generator (LCG).

-   [`@stdlib/random-strided/minstd-shuffle`][@stdlib/random/strided/minstd-shuffle]: fill a strided array with pseudorandom numbers generated using a linear congruential pseudorandom number generator (LCG) whose output is shuffled.

-   [`@stdlib/random-strided/randu`][@stdlib/random/strided/randu]: fill a strided array with uniformly distributed pseudorandom numbers between 0 and 1.



* * *



## Notice



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]



---



## License



See [LICENSE][stdlib-license].



## Copyright



Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors].



[npm-image]: http://img.shields.io/npm/v/@stdlib/random-strided-minstd.svg

[npm-url]: https://npmjs.org/package/@stdlib/random-strided-minstd



[test-image]: https://github.com/stdlib-js/random-strided-minstd/actions/workflows/test.yml/badge.svg?branch=main

[test-url]: https://github.com/stdlib-js/random-strided-minstd/actions/workflows/test.yml?query=branch:main



[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/random-strided-minstd/main.svg

[coverage-url]: https://codecov.io/github/stdlib-js/random-strided-minstd?branch=main



[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg

[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im



[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-strided-minstd/tree/deno

[deno-readme]: https://github.com/stdlib-js/random-strided-minstd/blob/deno/README.md

[umd-url]: https://github.com/stdlib-js/random-strided-minstd/tree/umd

[umd-readme]: https://github.com/stdlib-js/random-strided-minstd/blob/umd/README.md

[esm-url]: https://github.com/stdlib-js/random-strided-minstd/tree/esm

[esm-readme]: https://github.com/stdlib-js/random-strided-minstd/blob/esm/README.md

[branches-url]: https://github.com/stdlib-js/random-strided-minstd/blob/main/branches.md



[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/random-strided-minstd/main/LICENSE



[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray



[@stdlib/random/base/minstd]: https://github.com/stdlib-js/random-base-minstd



[@stdlib/array/int32]: https://github.com/stdlib-js/array-int32



[@stdlib/random/array/minstd]: https://github.com/stdlib-js/random-array-minstd



[@stdlib/random/strided/minstd-shuffle]: https://github.com/stdlib-js/random-strided-minstd-shuffle



[@stdlib/random/strided/randu]: https://github.com/stdlib-js/random-strided-randu