Skip to content
/ random-tools-binary-factory Public

Create a function for generating pseudorandom values drawn from a binary PRNG.

github.com/stdlib-js/stdlib

License

Apache-2.0 license
0 stars 0 forks Branches Tags Activity
Star
Notifications You must be signed in to change notification settings

stdlib-js/random-tools-binary-factory

BranchesTags

Repository files navigation

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!

createFactory

NPM version Build Status Coverage Status

Create a function for generating pseudorandom values drawn from a binary PRNG.

Installation

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

Alternatively,

  • To load the package in a website via a script tag without installation and bundlers, use the ES Module available on the esm branch (see README).
  • If you are using Deno, visit the deno branch (see README for usage intructions).
  • For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the umd branch (see README).

The branches.md 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

var createFactory = require( '@stdlib/random-tools-binary-factory' );

createFactory( prng, idtypes, odtypes, policies[, options] )

Returns a function for generating pseudorandom values drawn from a binary PRNG.

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

var idt = dtypes( 'real_and_generic' );
var odt = dtypes( 'real_floating_point_and_generic' );

var policies = {
    'output': 'real_floating_point_and_generic'
};
var options = {
    'order': 'row-major'
};

var factory = createFactory( uniform, [ idt, idt ], odt, policies, options );

The function has the following parameters:

  • prng: binary pseudorandom value generator. Must have the following methods:

    • factory: method which returns a new binary pseudorandom value generator.

  • idtypes: list containing a list of supported input data types for each PRNG parameter.

  • odtypes: list of supported output data types.

  • policies: interface policies. Must have the following properties:

    • output: output data type policy.

  • options: function options (optional).

The function supports the following options:

factory( [options] )

Returns a function for generating pseudorandom values drawn from a binary PRNG.

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

var idt = dtypes( 'real_and_generic' );
var odt = dtypes( 'real_floating_point_and_generic' );

var policies = {
    'output': 'real_floating_point_and_generic'
};
var options = {
    'order': 'row-major'
};

var factory = createFactory( uniform, [ idt, idt ], odt, policies, options );

var random = factory();
// returns <Function>

The function supports 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 value generator seed.
  • state: a Uint32Array containing pseudorandom value generator state. If provided, the function ignores the seed option.
  • copy: boolean indicating whether to copy a provided pseudorandom value generator state. Setting this option to false allows sharing state between two or more pseudorandom value generators. Setting this option to true ensures that an underlying generator has exclusive control over its internal state. Default: true.

random( shape, param1, param2[, options] )

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

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

var idt = dtypes( 'real_and_generic' );
var odt = dtypes( 'real_floating_point_and_generic' );

var policies = {
    'output': 'real_floating_point_and_generic'
};
var options = {
    'order': 'row-major'
};

var factory = createFactory( uniform, [ idt, idt ], odt, policies, options );

var random = factory();
// returns <Function>

var v = random( [ 2, 2 ], 0.0, 1.0 );
// returns <ndarray>

The function has the following parameters:

  • shape: output ndarray shape.
  • param1: first PRNG parameter. May be either a scalar or an ndarray. If an ndarray, must be broadcast compatible with the specified output ndarray shape.
  • param2: second PRNG parameter. May be either a scalar or an ndarray. If an ndarray, must be broadcast compatible with the specified output ndarray shape.
  • options: function options (optional).

The function accepts the following options:

  • dtype: output ndarray data type. Setting this option overrides the output data type policy.
  • order: memory layout. Setting this option overrides the default memory layout.
  • mode: specifies how to handle indices which exceed ndarray dimensions.
  • submode: specifies how to handle subscripts which exceed ndarray dimensions on a per dimension basis.
  • readonly: boolean indicating whether an ndarray should be read-only.

By default, the function returns an ndarray having a data type determined by the output data type policy. To override the default behavior, set the dtype option.

var dtypes = require( '@stdlib/ndarray-dtypes' );
var getDType = require( '@stdlib/ndarray-dtype' );
var uniform = require( '@stdlib/random-base-uniform' );

var idt = dtypes( 'real_and_generic' );
var odt = dtypes( 'real_floating_point_and_generic' );

var policies = {
    'output': 'real_floating_point_and_generic'
};
var options = {
    'order': 'row-major'
};

var factory = createFactory( uniform, [ idt, idt ], odt, policies, options );

var random = factory();
// returns <Function>

var v = random( [ 2, 2 ], 0.0, 1.0, {
    'dtype': 'generic'
});
// returns <ndarray>

var dt = getDType( v );
// returns 'generic'

random.assign( param1, param2, out )

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

var dtypes = require( '@stdlib/ndarray-dtypes' );
var ndzeros = require( '@stdlib/ndarray-zeros' );
var uniform = require( '@stdlib/random-base-uniform' );

var idt = dtypes( 'real_and_generic' );
var odt = dtypes( 'real_floating_point_and_generic' );

var policies = {
    'output': 'real_floating_point_and_generic'
};
var options = {
    'order': 'row-major'
};

var factory = createFactory( uniform, [ idt, idt ], odt, policies, options );

var random = factory();
// returns <Function>

var out = ndzeros( [ 2, 2 ] );
var v = random.assign( 0.0, 1.0, out );
// returns <ndarray>

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

The method has the following parameters:

  • param1: first PRNG parameter. May be either a scalar or an ndarray. If an ndarray, must be broadcast compatible with the output ndarray.
  • param2: second PRNG parameter. May be either a scalar or an ndarray. If an ndarray, must be broadcast compatible with the output ndarray.
  • out: output ndarray.

random.PRNG

The underlying pseudorandom number generator.

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

var idt = dtypes( 'real_and_generic' );
var odt = dtypes( 'real_floating_point_and_generic' );

var policies = {
    'output': 'real_floating_point_and_generic'
};
var options = {
    'order': 'row-major'
};

var factory = createFactory( uniform, [ idt, idt ], odt, policies, options );

var random = factory();
// returns <Function>

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

random.seed

The value used to seed the underlying pseudorandom value generator.

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

var idt = dtypes( 'real_and_generic' );
var odt = dtypes( 'real_floating_point_and_generic' );

var policies = {
    'output': 'real_floating_point_and_generic'
};
var options = {
    'order': 'row-major'
};

var factory = createFactory( uniform, [ idt, idt ], odt, policies, options );

var random = factory();
// returns <Function>

var seed = random.seed;
// returns <Uint32Array>

If the factory function is provided a PRNG for uniformly distributed numbers, the associated property value on the returned function is null.

var dtypes = require( '@stdlib/ndarray-dtypes' );
var minstd = require( '@stdlib/random-base-minstd-shuffle' ).normalized;
var uniform = require( '@stdlib/random-base-uniform' );

var idt = dtypes( 'real_and_generic' );
var odt = dtypes( 'real_floating_point_and_generic' );

var policies = {
    'output': 'real_floating_point_and_generic'
};
var options = {
    'order': 'row-major'
};

var factory = createFactory( uniform, [ idt, idt ], odt, policies, options );

var random = factory({
    'prng': minstd
});
// returns <Function>

var seed = random.seed;
// returns null

random.seedLength

Length of the underlying pseudorandom value generator seed.

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

var idt = dtypes( 'real_and_generic' );
var odt = dtypes( 'real_floating_point_and_generic' );

var policies = {
    'output': 'real_floating_point_and_generic'
};
var options = {
    'order': 'row-major'
};

var factory = createFactory( uniform, [ idt, idt ], odt, policies, options );

var random = factory();
// returns <Function>

var len = random.seedLength;
// returns <number>

If the factory function is provided a PRNG for uniformly distributed numbers, the associated property value on the returned function is null.

var dtypes = require( '@stdlib/ndarray-dtypes' );
var minstd = require( '@stdlib/random-base-minstd-shuffle' ).normalized;
var uniform = require( '@stdlib/random-base-uniform' );

var idt = dtypes( 'real_and_generic' );
var odt = dtypes( 'real_floating_point_and_generic' );

var policies = {
    'output': 'real_floating_point_and_generic'
};
var options = {
    'order': 'row-major'
};

var factory = createFactory( uniform, [ idt, idt ], odt, policies, options );

var random = factory({
    'prng': minstd
});
// returns <Function>

var len = random.seedLength;
// returns null

random.state

Writable property for getting and setting the underlying pseudorandom value generator state.

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

var idt = dtypes( 'real_and_generic' );
var odt = dtypes( 'real_floating_point_and_generic' );

var policies = {
    'output': 'real_floating_point_and_generic'
};
var options = {
    'order': 'row-major'
};

var factory = createFactory( uniform, [ idt, idt ], odt, policies, options );

var random = factory();
// returns <Function>

var state = random.state;
// returns <Uint32Array>

If the factory function is provided a PRNG for uniformly distributed numbers, the associated property value on the returned function is null.

var dtypes = require( '@stdlib/ndarray-dtypes' );
var minstd = require( '@stdlib/random-base-minstd-shuffle' ).normalized;
var uniform = require( '@stdlib/random-base-uniform' );

var idt = dtypes( 'real_and_generic' );
var odt = dtypes( 'real_floating_point_and_generic' );

var policies = {
    'output': 'real_floating_point_and_generic'
};
var options = {
    'order': 'row-major'
};

var factory = createFactory( uniform, [ idt, idt ], odt, policies, options );

var random = factory({
    'prng': minstd
});
// returns <Function>

var state = random.state;
// returns null

random.stateLength

Length of the underlying pseudorandom value generator state.

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

var idt = dtypes( 'real_and_generic' );
var odt = dtypes( 'real_floating_point_and_generic' );

var policies = {
    'output': 'real_floating_point_and_generic'
};
var options = {
    'order': 'row-major'
};

var factory = createFactory( uniform, [ idt, idt ], odt, policies, options );

var random = factory();
// returns <Function>

var len = random.stateLength;
// returns <number>

If the factory function is provided a PRNG for uniformly distributed numbers, the associated property value on the returned function is null.

var dtypes = require( '@stdlib/ndarray-dtypes' );
var minstd = require( '@stdlib/random-base-minstd-shuffle' ).normalized;
var uniform = require( '@stdlib/random-base-uniform' );

var idt = dtypes( 'real_and_generic' );
var odt = dtypes( 'real_floating_point_and_generic' );

var policies = {
    'output': 'real_floating_point_and_generic'
};
var options = {
    'order': 'row-major'
};

var factory = createFactory( uniform, [ idt, idt ], odt, policies, options );

var random = factory({
    'prng': minstd
});
// returns <Function>

var len = random.stateLength;
// returns null

random.byteLength

Size (in bytes) of underlying pseudorandom value generator state.

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

var idt = dtypes( 'real_and_generic' );
var odt = dtypes( 'real_floating_point_and_generic' );

var policies = {
    'output': 'real_floating_point_and_generic'
};
var options = {
    'order': 'row-major'
};

var factory = createFactory( uniform, [ idt, idt ], odt, policies, options );

var random = factory();
// returns <Function>

var len = random.byteLength;
// returns <number>

If the factory function is provided a PRNG for uniformly distributed numbers, the associated property value on the returned function is null.

var dtypes = require( '@stdlib/ndarray-dtypes' );
var minstd = require( '@stdlib/random-base-minstd-shuffle' ).normalized;
var uniform = require( '@stdlib/random-base-uniform' );

var idt = dtypes( 'real_and_generic' );
var odt = dtypes( 'real_floating_point_and_generic' );

var policies = {
    'output': 'real_floating_point_and_generic'
};
var options = {
    'order': 'row-major'
};

var factory = createFactory( uniform, [ idt, idt ], odt, policies, options );

var random = factory({
    'prng': minstd
});
// returns <Function>

var len = random.byteLength;
// returns null

Notes

  • The output data type policy only applies to the function which returns a new ndarray. For the assign method, the output ndarray is allowed to have any supported output data type.
  • If PRNG state is "shared" (meaning a state array was provided during function creation and not copied) and one sets the underlying generator state to a state array having a different length, the function returned by the factory function 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 creation function 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 creation functions and/or PRNGs sharing the PRNG's state array).

Examples

var uniform = require( '@stdlib/random-base-uniform' );
var dtypes = require( '@stdlib/ndarray-dtypes' );
var ndarray = require( '@stdlib/ndarray-ctor' );
var ndarray2array = require( '@stdlib/ndarray-to-array' );
var createFactory = require( '@stdlib/random-tools-binary-factory' );

// Create a new PRNG factory...
var idt = dtypes( 'real_and_generic' );
var odt = dtypes( 'real_floating_point_and_generic' );
var policies = {
    'output': 'real_floating_point_and_generic'
};
var factory = createFactory( uniform, [ idt, idt ], odt, policies );

// Create a function for generating pseudorandom numbers:
var random = factory();

// Generate a 3x3 matrix of pseudorandom numbers:
var x = random( [ 3, 3 ], 0.0, 1.0 );
console.log( ndarray2array( x ) );

// Generate another matrix with a specified data type:
x = random( [ 3, 3 ], 0.0, 1.0, {
    'dtype': 'float32'
});
console.log( ndarray2array( x ) );

// Define arrays of distribution parameters:
var param1 = new ndarray( 'generic', [ 1.0, 10.0, 100.0 ], [ 3, 1 ], [ 1, 1 ], 0, 'row-major' );
var param2 = new ndarray( 'generic', [ 2.0, 20.0, 200.0 ], [ 3, 1 ], [ 1, 1 ], 0, 'row-major' );

// Broadcast the parameters to generate another 3x3 matrix of pseudorandom numbers:
x = random( [ 3, 3 ], param1, param2 );
console.log( ndarray2array( x ) );

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

Chat

License

See LICENSE.

Copyright

Copyright © 2016-2025. The Stdlib Authors.

About

Create a function for generating pseudorandom values drawn from a binary PRNG.

github.com/stdlib-js/stdlib

Topics

nodejs javascript factory node statistics tools math random stdlib function mathematics prng stats rng ndarray fcn node-js rand pseudorandom func

Resources

Readme

License

Apache-2.0 license

Code of conduct

Code of conduct

Security policy

Security policy
Activity
Custom properties

Stars

0 stars

Watchers

2 watching

Forks

0 forks
Report repository

Releases

No releases published

Sponsor this project

  •  
Learn more about GitHub Sponsors

Packages

No packages published

Languages