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

Standard library base pseudorandom number generators.
https://github.com/stdlib-js/random-base
base generator javascript lib library math mathematics node node-js nodejs prng pseudorandom rand random rng seed standard statistics stats stdlib
Last synced: 2 months ago
JSON representation
Standard library base pseudorandom number generators.
Host: GitHub
URL: https://github.com/stdlib-js/random-base
Owner: stdlib-js
License: apache-2.0
Created: 2021-06-15T18:12:21.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2024-04-12T10:12:33.000Z (10 months ago)
Last Synced: 2024-10-31T22:47:21.066Z (3 months ago)
Topics: base, generator, javascript, lib, library, math, mathematics, node, node-js, nodejs, prng, pseudorandom, rand, random, rng, seed, standard, statistics, stats, stdlib
Language: Makefile
Homepage: https://github.com/stdlib-js/stdlib
Size: 12.2 MB
Stars: 2
Watchers: 3
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Security: SECURITY.md
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!


# Pseudorandom Number Generators

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

> Base (i.e., lower-level) pseudorandom number generators (PRNGs).

## Installation

```bash

npm install @stdlib/random-base

```

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

```

#### random

Namespace containing "base" (i.e., lower-level) pseudorandom number generators (PRNGs).

```javascript

var ns = random;

// returns {...}

```

The namespace contains the following PRNGs:



-   [`arcsine( a, b )`][@stdlib/random/base/arcsine]: arcsine distributed pseudorandom numbers.

-   [`bernoulli( p )`][@stdlib/random/base/bernoulli]: Bernoulli distributed pseudorandom numbers.

-   [`beta( alpha, beta )`][@stdlib/random/base/beta]: beta distributed pseudorandom numbers.

-   [`betaprime( alpha, beta )`][@stdlib/random/base/betaprime]: beta prime distributed pseudorandom numbers.

-   [`binomial( n, p )`][@stdlib/random/base/binomial]: binomial distributed pseudorandom numbers.

-   [`boxMuller()`][@stdlib/random/base/box-muller]: standard normally distributed pseudorandom numbers using the Box-Muller transform.

-   [`cauchy( x0, gamma )`][@stdlib/random/base/cauchy]: Cauchy distributed pseudorandom numbers.

-   [`chi( k )`][@stdlib/random/base/chi]: Chi distributed pseudorandom numbers.

-   [`chisquare( k )`][@stdlib/random/base/chisquare]: Chi-square distributed pseudorandom numbers.

-   [`cosine( mu, s )`][@stdlib/random/base/cosine]: raised cosine distributed pseudorandom numbers.

-   [`discreteUniform( a, b )`][@stdlib/random/base/discrete-uniform]: discrete uniform distributed pseudorandom numbers.

-   [`erlang( k, lambda )`][@stdlib/random/base/erlang]: Erlang distributed pseudorandom numbers.

-   [`exponential( lambda )`][@stdlib/random/base/exponential]: exponentially distributed pseudorandom numbers.

-   [`f( d1, d2 )`][@stdlib/random/base/f]: F distributed pseudorandom numbers.

-   [`frechet( alpha, s, m )`][@stdlib/random/base/frechet]: Fréchet distributed pseudorandom numbers.

-   [`gamma( alpha, beta )`][@stdlib/random/base/gamma]: gamma distributed pseudorandom numbers.

-   [`geometric( p )`][@stdlib/random/base/geometric]: geometric distributed pseudorandom numbers.

-   [`gumbel( mu, beta )`][@stdlib/random/base/gumbel]: Gumbel distributed pseudorandom numbers.

-   [`hypergeometric( N, K, n )`][@stdlib/random/base/hypergeometric]: hypergeometric distributed pseudorandom numbers.

-   [`improvedZiggurat()`][@stdlib/random/base/improved-ziggurat]: standard normally distributed pseudorandom numbers using the Improved Ziggurat method.

-   [`invgamma( alpha, beta )`][@stdlib/random/base/invgamma]: inverse gamma distributed pseudorandom numbers.

-   [`kumaraswamy( a, b )`][@stdlib/random/base/kumaraswamy]: Kumaraswamy's double bounded distributed pseudorandom numbers.

-   [`laplace( mu, b )`][@stdlib/random/base/laplace]: Laplace (double exponential) distributed pseudorandom numbers.

-   [`levy( mu, c )`][@stdlib/random/base/levy]: Lévy distributed pseudorandom numbers.

-   [`logistic( mu, s )`][@stdlib/random/base/logistic]: logistic distributed pseudorandom numbers.

-   [`lognormal( mu, sigma )`][@stdlib/random/base/lognormal]: lognormal distributed pseudorandom numbers.

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

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

-   [`mt19937()`][@stdlib/random/base/mt19937]: A 32-bit Mersenne Twister pseudorandom number generator.

-   [`negativeBinomial( r, p )`][@stdlib/random/base/negative-binomial]: negative binomially distributed pseudorandom numbers.

-   [`normal( mu, sigma )`][@stdlib/random/base/normal]: normally distributed pseudorandom numbers.

-   [`pareto1( alpha, beta )`][@stdlib/random/base/pareto-type1]: Pareto (Type I) distributed pseudorandom numbers.

-   [`poisson( lambda )`][@stdlib/random/base/poisson]: Poisson distributed pseudorandom numbers.

-   [`randi()`][@stdlib/random/base/randi]: pseudorandom numbers having integer values.

-   [`randn()`][@stdlib/random/base/randn]: standard normally distributed pseudorandom numbers.

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

-   [`rayleigh( sigma )`][@stdlib/random/base/rayleigh]: Rayleigh distributed pseudorandom numbers.

-   [`reviveBasePRNG( key, value )`][@stdlib/random/base/reviver]: revive a JSON-serialized pseudorandom number generator (PRNG).

-   [`t( v )`][@stdlib/random/base/t]: Student's t-distributed pseudorandom numbers.

-   [`triangular( a, b, c )`][@stdlib/random/base/triangular]: triangular distributed pseudorandom numbers.

-   [`uniform( a, b )`][@stdlib/random/base/uniform]: uniformly distributed pseudorandom numbers.

-   [`weibull( k, lambda )`][@stdlib/random/base/weibull]: Weibull distributed pseudorandom numbers.



Attached to each PRNG are the following properties:

-   **NAME**: the generator name.

-   **seed**: the value used to seed the PRNG.

-   **seedLength**: the length of the PRNG seed.

-   **state**: the PRNG state.

-   **stateLength**: the length  of the PRNG state.

-   **byteLength**: the size of the PRNG state.

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

Additionally, attached to each PRNG is a `.factory()` method which supports creating a seeded PRNG and thus generating a reproducible sequence of pseudorandom numbers.

```javascript

var rand;

var v;

var i;

// Generate pseudorandom values...

for ( i = 0; i < 100; i++ ) {

    v = random.randu();

}

// Generate the same pseudorandom values...

rand = random.randu.factory({

    'seed': random.randu.seed

});

for ( i = 0; i < 100; i++ ) {

    v = rand();

}

```

For parameterized PRNGs, the `.factory()` method supports specifying parameters upon either PRNG creation or invocation. For example,

```javascript

// Create a PRNG which requires providing parameters at each invocation:

var rand = random.normal.factory({

    'seed': 12345

});

var r = rand( 1.0, 2.0 );

// returns 

// Create a PRNG with fixed parameters:

rand = random.normal.factory( 1.0, 2.0, {

    'seed': 12345

});

r = rand();

// returns 

```

## Examples

```javascript

var objectKeys = require( '@stdlib/utils-keys' );

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

console.log( objectKeys( random ) );

```

* * *

## 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-base.svg

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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