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!

Rayleigh Random Numbers

Create an array containing pseudorandom numbers drawn from a Rayleigh distribution.

Installation

npm install @stdlib/random-array-rayleigh

Usage

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

rayleigh( len, sigma[, options] )

Returns an array containing pseudorandom numbers drawn from a Rayleigh distribution.

var out = rayleigh( 10, 2.0 );
// returns <Float64Array>

The function has the following parameters:

len: output array length.
sigma: scale parameter.
options: function options.

The function accepts the following options:

dtype: output array data type. Must be a real-valued floating-point data type or "generic". Default: 'float64'.

By default, the function returns a Float64Array. To return an array having a different data type, set the dtype option.

var opts = {
    'dtype': 'generic'
};

var out = rayleigh( 10, 2.0, opts );
// returns [...]

rayleigh.assign( sigma, out )

Fills an array with pseudorandom numbers drawn from a Rayleigh distribution.

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

var x = zeros( 10, 'float64' );
// returns <Float64Array>

var out = rayleigh.assign( 2.0, x );
// returns <Float64Array>

var bool = ( out === x );
// returns true

The function has the following parameters:

sigma: scale parameter.
out: output array.

rayleigh.factory( [sigma, ][options] )

Returns a function for creating arrays containing pseudorandom numbers drawn from a Rayleigh distribution.

var random = rayleigh.factory();

var out = random( 10, 2.0 );
// returns <Float64Array>

var len = out.length;
// returns 10

If provided sigma, the returned generator returns random variates from the specified distribution.

var random = rayleigh.factory( 2.0 );

var out = random( 10 );
// returns <Float64Array>

out = random( 10 );
// returns <Float64Array>

If not provided sigma, the returned generator requires that sigma be provided at each invocation.

var random = rayleigh.factory();

var out = random( 10, 2.0 );
// returns <Float64Array>

out = random( 10, 2.0 );
// returns <Float64Array>

The function accepts the following options:

prng: pseudorandom number generator for generating uniformly distributed pseudorandom numbers on the interval [0,1). If provided, the function ignores both the state and seed options. In order to seed the underlying pseudorandom number generator, one must seed the provided prng (assuming the provided prng is seedable).
seed: pseudorandom number generator seed.
state: a Uint32Array 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 an underlying generator has exclusive control over its internal state. Default: true.
dtype: default output array data type. Must be a real-valued floating-point data type or "generic". Default: 'float64'.

To use a custom PRNG as the underlying source of uniformly distributed pseudorandom numbers, set the prng option.

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

var opts = {
    'prng': minstd.normalized
};
var random = rayleigh.factory( 2.0, opts );

var out = random( 10 );
// returns <Float64Array>

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

var opts = {
    'seed': 12345
};
var random = rayleigh.factory( 2.0, opts );

var out = random( 10, opts );
// returns <Float64Array>

The returned function accepts the following options:

dtype: output array data type. Must be a real-valued floating-point data type or "generic". This overrides the default output array data type.

To override the default output array data type, set the dtype option.

var random = rayleigh.factory( 2.0 );

var out = random( 10 );
// returns <Float64Array>

var opts = {
    'dtype': 'generic'
};
out = random( 10, opts );
// returns [...]

rayleigh.PRNG

The underlying pseudorandom number generator.

var prng = rayleigh.PRNG;
// returns <Function>