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-iter-randu

Create an iterator for generating uniformly distributed pseudorandom numbers between 0 and 1.
https://github.com/stdlib-js/random-iter-randu

continuous generator javascript math mathematics node node-js nodejs prng pseudorandom rand random randu rng seed seedable statistics stats stdlib uniform

Last synced: about 1 month ago
JSON representation

Create an iterator for generating uniformly distributed pseudorandom numbers between 0 and 1.

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!



# randu



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



> Create an iterator for generating uniformly distributed pseudorandom numbers between `0` and `1`.



## Installation



```bash

npm install @stdlib/random-iter-randu

```



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 iterator = require( '@stdlib/random-iter-randu' );

```



#### iterator( \[options] )



Returns an iterator for generating uniformly distributed pseudorandom numbers between `0` and `1`.



```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`:



-   **name**: name of a supported pseudorandom number generator (PRNG), which will serve as the underlying source of pseudorandom numbers. The following generators are supported:



    -   [`mt19937`][@stdlib/random/base/mt19937]: 32-bit Mersenne Twister.

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

    -   [`minstd-shuffle`][@stdlib/random/base/minstd-shuffle]: linear congruential pseudorandom number generator (LCG) whose output is shuffled.



    Default: [`'mt19937'`][@stdlib/random/base/mt19937].



-   **seed**: pseudorandom number generator seed. Valid seed values vary according to the underlying PRNG.



-   **state**: pseudorandom number generator state. Valid state values vary according to the underlying PRNG. 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`.



-   **iter**: number of iterations.



By default, the underlying pseudorandom number generator is [`mt19937`][@stdlib/random/base/mt19937]. To use a different PRNG, set the `name` option.



```javascript

var it = iterator({

    'name': 'minstd-shuffle'

});



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 it1 = iterator({

    'seed': 7823

});



var r1 = it1.next().value;

// returns 



var it2 = iterator({

    'seed': 7823

});



var r2 = it2.next().value;

// returns 



var bool = ( r1 === r2 );

// returns true

```



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.

-   **PRNG**: underlying pseudorandom number generator.



## Notes



-   If an environment supports `Symbol.iterator`, the returned iterator is iterable.

-   **Warning**: the default underlying source of pseudorandom numbers may **change** in the future. If exact reproducibility is required, either explicitly specify a PRNG via the `name` option or use an underlying PRNG directly.

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



## Examples



```javascript

var iterator = require( '@stdlib/random-iter-randu' );



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 );

}

```



* * *



## See Also



-   [`@stdlib/random-base/randu`][@stdlib/random/base/randu]: uniformly distributed pseudorandom numbers between 0 and 1.

-   [`@stdlib/random-iter/randi`][@stdlib/random/iter/randi]: create an iterator for generating pseudorandom numbers having integer values.



* * *



## 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-iter-randu.svg

[npm-url]: https://npmjs.org/package/@stdlib/random-iter-randu



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

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



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

[coverage-url]: https://codecov.io/github/stdlib-js/random-iter-randu?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-iter-randu/tree/deno

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

[umd-url]: https://github.com/stdlib-js/random-iter-randu/tree/umd

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

[esm-url]: https://github.com/stdlib-js/random-iter-randu/tree/esm

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

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



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



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



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



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



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



[@stdlib/random/iter/randi]: https://github.com/stdlib-js/random-iter-randi