Skip to content

Latest commit

 

History

History
360 lines (231 loc) · 19.5 KB

README.md

File metadata and controls

360 lines (231 loc) · 19.5 KB
Raw
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 Build Status Coverage Status

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

Usage

import random from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-base@deno/mod.js';

You can also import the following named exports from the package:

import { arcsine, bernoulli, beta, betaprime, binomial, boxMuller, cauchy, chi, chisquare, cosine, discreteUniform, erlang, exponential, f, frechet, gamma, geometric, gumbel, hypergeometric, improvedZiggurat, invgamma, kumaraswamy, laplace, levy, logistic, lognormal, minstd, minstdShuffle, mt19937, negativeBinomial, normal, pareto1, poisson, randi, randn, randu, rayleigh, reviveBasePRNG, t, triangular, uniform, weibull } from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-base@deno/mod.js';

random

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

var ns = random;
// returns {...}

The namespace contains the following PRNGs:

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.

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,

// 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 <number>

// Create a PRNG with fixed parameters:
rand = random.normal.factory( 1.0, 2.0, {
    'seed': 12345
});

r = rand();
// returns <number>

Examples

import objectKeys from 'https://cdn.jsdelivr.net/gh/stdlib-js/utils-keys@deno/mod.js';
import random from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-base@deno/mod.js';

console.log( objectKeys( random ) );

Notice

This package is part of stdlib, a standard library 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

Chat

License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.