@stdlib/random-array-tools-binary

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!

Binary

Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.

Installation

npm install @stdlib/random-array-tools-binary

Usage

var Random = require( '@stdlib/random-array-tools-binary' );

Random( prng, dtypes, dtype )

Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.

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

var dtypes = [ 'float64', 'float32', 'generic' ];
var defaultDType = 'float64';

var random = new Random( arcsine, dtypes, defaultDType );

The constructor has the following parameters:

• prng: binary pseudorandom value generator.
• dtypes: list of supported output data types.
• dtype: default output data type.

Random.prototype.generate( len, param1, param2[, options] )

Returns an array filled with pseudorandom values drawn from a binary PRNG.

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

var dtypes = [ 'float64', 'float32', 'generic' ];
var defaultDType = 'float64';

var random = new Random( arcsine, dtypes, defaultDType );

var v = random.generate( 10, 2.0, 5.0 );
// returns <Float64Array>

The method has the following parameters:

• len: output array length.
• param1: first PRNG parameter.
• param2: second PRNG parameter.
• options: function options.

The method accepts the following options:

• dtype: output array data type. Setting this option, overrides the default output array data type.

By default, the method returns an array having the default output array data type. To override the default, set the dtype option.

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

var dtypes = [ 'float64', 'float32', 'generic' ];
var defaultDType = 'float64';

var random = new Random( arcsine, dtypes, defaultDType );

var v = random.generate( 10, 2.0, 5.0, {
    'dtype': 'float32'
});
// returns <Float32Array>

Random.prototype.assign( param1, param2, out )

Fills an array with pseudorandom values drawn from a binary PRNG.

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

var dtypes = [ 'float64', 'float32', 'generic' ];
var defaultDType = 'float64';

var random = new Random( arcsine, dtypes, defaultDType );

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

var v = random.assign( 2.0, 5.0, out );
// returns <Float64Array>

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

The method has the following parameters:

• param1: first PRNG parameter.
• param2: second PRNG parameter.
• out: output array.

Examples

var arcsine = require( '@stdlib/random-base-arcsine' );
var dtypes = require( '@stdlib/array-dtypes' );
var Random = require( '@stdlib/random-array-tools-binary' );

var dt = dtypes( 'real_floating_point_and_generic' );
var random = new Random( arcsine, dt, 'float64' );

var x = random.generate( 10, 2.0, 5.0 );
// returns <Float64Array>

x = random.generate( 10, 2.0, 5.0, {
    'dtype': 'float32'
});
// returns <Float32Array>

x = random.generate( 10, 2.0, 5.0, {
    'dtype': 'generic'
});
// returns [...]

Notice

This package is part of 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, see the main project repository.

Community

License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.

Changelog

0.2.2 (2024-07-29)

No changes reported for this release.

</section> <!-- /.release --> <section class="release" id="v0.2.1">