random-tools-unary-factory

Create a function for generating pseudorandom numbers drawn from a single-parameter probability distribution.

https://github.com/stdlib-js/random-tools-unary-factory

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
○
Academic email domains
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (16.6%) to scientific vocabulary

Keywords

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

Last synced: 6 months ago · JSON representation ·

Repository

Create a function for generating pseudorandom numbers drawn from a single-parameter probability distribution.

Basic Info

Host: GitHub
Owner: stdlib-js
License: apache-2.0
Language: JavaScript
Default Branch: main
Homepage: https://github.com/stdlib-js/stdlib
Size: 966 KB

Statistics

Stars: 0
Watchers: 2
Forks: 0
Open Issues: 0
Releases: 0

Topics

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

Created 10 months ago · Last pushed 6 months ago

Metadata Files

Readme Changelog Contributing License Code of conduct Citation Security

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

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

## Installation ```bash npm install @stdlib/random-tools-unary-factory ``` 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 createFactory = require( '@stdlib/random-tools-unary-factory' ); ``` #### createFactory( prng, idtypes, odtypes, policies\[, options] ) Returns a function for generating pseudorandom values drawn from a unary PRNG. ```javascript var dtypes = require( '@stdlib/ndarray-dtypes' ); var exponential = require( '@stdlib/random-base-exponential' ); 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( exponential, idt, odt, policies, options ); ``` The function has the following parameters: - **prng**: unary pseudorandom value generator. Must have the following methods: - **factory**: method which returns a new unary pseudorandom value generator. - **idtypes**: list of supported input data types. - **odtypes**: list of supported output data types. - **policies**: interface policies. Must have the following properties: - **output**: output data type [policy][@stdlib/ndarray/policies]. - **options**: function options (_optional_). The function supports the following options: - **order**: default [memory layout][@stdlib/ndarray/orders]. #### factory( \[options] ) Returns a function for generating pseudorandom values drawn from a unary PRNG. ```javascript var dtypes = require( '@stdlib/ndarray-dtypes' ); var exponential = require( '@stdlib/random-base-exponential' ); 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( exponential, idt, odt, policies, options ); var random = factory(); // returns ``` 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`][@stdlib/array/uint32] 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\[, options] ) Returns an ndarray filled with pseudorandom values drawn from a unary PRNG. ```javascript var dtypes = require( '@stdlib/ndarray-dtypes' ); var exponential = require( '@stdlib/random-base-exponential' ); 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( exponential, idt, odt, policies, options ); var random = factory(); // returns var v = random( [ 2, 2 ], 2.0 ); // returns ``` The function has the following parameters: - **shape**: output ndarray shape. - **param1**: PRNG parameter. May be either a scalar or an ndarray. If an ndarray, must be [broadcast compatible][@stdlib/ndarray/base/broadcast-shapes] 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. ```javascript var dtypes = require( '@stdlib/ndarray-dtypes' ); var getDType = require( '@stdlib/ndarray-dtype' ); var exponential = require( '@stdlib/random-base-exponential' ); 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( exponential, idt, odt, policies, options ); var random = factory(); // returns var v = random( [ 2, 2 ], 2.0, { 'dtype': 'generic' }); // returns var dt = getDType( v ); // returns 'generic' ``` #### random.assign( param1, out ) Fills an ndarray with pseudorandom values drawn from a unary PRNG. ```javascript var dtypes = require( '@stdlib/ndarray-dtypes' ); var ndzeros = require( '@stdlib/ndarray-zeros' ); var exponential = require( '@stdlib/random-base-exponential' ); 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( exponential, idt, odt, policies, options ); var random = factory(); // returns var out = ndzeros( [ 2, 2 ] ); var v = random.assign( 2.0, out ); // returns var bool = ( v === out ); // returns true ``` The method has the following parameters: - **param1**: PRNG parameter. May be either a scalar or an ndarray. If an ndarray, must be [broadcast compatible][@stdlib/ndarray/base/broadcast-shapes] with the output ndarray. - **out**: output ndarray. #### random.PRNG The underlying pseudorandom number generator. ```javascript var dtypes = require( '@stdlib/ndarray-dtypes' ); var exponential = require( '@stdlib/random-base-exponential' ); 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( exponential, idt, odt, policies, options ); var random = factory(); // returns var prng = random.PRNG; // returns ``` #### random.seed The value used to seed the underlying pseudorandom value generator. ```javascript var dtypes = require( '@stdlib/ndarray-dtypes' ); var exponential = require( '@stdlib/random-base-exponential' ); 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( exponential, idt, odt, policies, options ); var random = factory(); // returns var seed = random.seed; // returns ``` If the factory function is provided a PRNG for uniformly distributed numbers, the associated property value on the returned function is `null`. ```javascript var dtypes = require( '@stdlib/ndarray-dtypes' ); var minstd = require( '@stdlib/random-base-minstd-shuffle' ).normalized; var exponential = require( '@stdlib/random-base-exponential' ); 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( exponential, idt, odt, policies, options ); var random = factory({ 'prng': minstd }); // returns var seed = random.seed; // returns null ``` #### random.seedLength Length of the underlying pseudorandom value generator seed. ```javascript var dtypes = require( '@stdlib/ndarray-dtypes' ); var exponential = require( '@stdlib/random-base-exponential' ); 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( exponential, idt, odt, policies, options ); var random = factory(); // returns var len = random.seedLength; // returns ``` If the factory function is provided a PRNG for uniformly distributed numbers, the associated property value on the returned function is `null`. ```javascript var dtypes = require( '@stdlib/ndarray-dtypes' ); var minstd = require( '@stdlib/random-base-minstd-shuffle' ).normalized; var exponential = require( '@stdlib/random-base-exponential' ); 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( exponential, idt, odt, policies, options ); var random = factory({ 'prng': minstd }); // returns var len = random.seedLength; // returns null ``` #### random.state Writable property for getting and setting the underlying pseudorandom value generator state. ```javascript var dtypes = require( '@stdlib/ndarray-dtypes' ); var exponential = require( '@stdlib/random-base-exponential' ); 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( exponential, idt, odt, policies, options ); var random = factory(); // returns var state = random.state; // returns ``` If the factory function is provided a PRNG for uniformly distributed numbers, the associated property value on the returned function is `null`. ```javascript var dtypes = require( '@stdlib/ndarray-dtypes' ); var minstd = require( '@stdlib/random-base-minstd-shuffle' ).normalized; var exponential = require( '@stdlib/random-base-exponential' ); 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( exponential, idt, odt, policies, options ); var random = factory({ 'prng': minstd }); // returns var state = random.state; // returns null ``` #### random.stateLength Length of the underlying pseudorandom value generator state. ```javascript var dtypes = require( '@stdlib/ndarray-dtypes' ); var exponential = require( '@stdlib/random-base-exponential' ); 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( exponential, idt, odt, policies, options ); var random = factory(); // returns var len = random.stateLength; // returns ``` If the factory function is provided a PRNG for uniformly distributed numbers, the associated property value on the returned function is `null`. ```javascript var dtypes = require( '@stdlib/ndarray-dtypes' ); var minstd = require( '@stdlib/random-base-minstd-shuffle' ).normalized; var exponential = require( '@stdlib/random-base-exponential' ); 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( exponential, idt, odt, policies, options ); var random = factory({ 'prng': minstd }); // returns var len = random.stateLength; // returns null ``` #### random.byteLength Size (in bytes) of underlying pseudorandom value generator state. ```javascript var dtypes = require( '@stdlib/ndarray-dtypes' ); var exponential = require( '@stdlib/random-base-exponential' ); 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( exponential, idt, odt, policies, options ); var random = factory(); // returns var len = random.byteLength; // returns ``` If the factory function is provided a PRNG for uniformly distributed numbers, the associated property value on the returned function is `null`. ```javascript var dtypes = require( '@stdlib/ndarray-dtypes' ); var minstd = require( '@stdlib/random-base-minstd-shuffle' ).normalized; var exponential = require( '@stdlib/random-base-exponential' ); 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( exponential, idt, odt, policies, options ); var random = factory({ 'prng': minstd }); // returns 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 ```javascript var exponential = require( '@stdlib/random-base-exponential' ); 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-unary-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( exponential, 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 ], 2.0 ); console.log( ndarray2array( x ) ); // Generate another matrix with a specified data type: x = random( [ 3, 3 ], 2.0, { 'dtype': 'float32' }); console.log( ndarray2array( x ) ); // Define an array of distribution parameters: var param = 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 ], param ); console.log( ndarray2array( x ) ); ```

* * * ## 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-2025. The Stdlib [Authors][stdlib-authors].

Owner

Name: stdlib
Login: stdlib-js
Kind: organization

Website: https://stdlib.io
Twitter: stdlibjs
Repositories: 3,692
Profile: https://github.com/stdlib-js

Standard library for JavaScript.

Citation (CITATION.cff)

cff-version: 1.2.0
title: stdlib
message: >-
  If you use this software, please cite it using the
  metadata from this file.

type: software

authors:
  - name: The Stdlib Authors
    url: https://github.com/stdlib-js/stdlib/graphs/contributors

repository-code: https://github.com/stdlib-js/stdlib
url: https://stdlib.io

abstract: |
  Standard library for JavaScript and Node.js.

keywords:
  - JavaScript
  - Node.js
  - TypeScript
  - standard library
  - scientific computing
  - numerical computing
  - statistical computing

license: Apache-2.0 AND BSL-1.0

date-released: 2016

GitHub Events

Total

Member event: 1
Push event: 51
Create event: 8

Last Year

Member event: 1
Push event: 51
Create event: 8

Dependencies

.github/workflows/benchmark.yml actions

actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite

.github/workflows/cancel.yml actions

styfle/cancel-workflow-action 85880fa0301c86cca9da44039ee3bb12d3bedbfa composite

.github/workflows/close_pull_requests.yml actions

superbrothers/close-pull-request 9c18513d320d7b2c7185fb93396d0c664d5d8448 composite

.github/workflows/examples.yml actions

actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite

.github/workflows/npm_downloads.yml actions

actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
actions/upload-artifact 5d5d22a31266ced268874388b861e4b58bb5c2f3 composite
distributhor/workflow-webhook 48a40b380ce4593b6a6676528cd005986ae56629 composite

.github/workflows/productionize.yml actions

8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
stdlib-js/bundle-action main composite
stdlib-js/transform-errors-action main composite

.github/workflows/publish.yml actions

8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
JS-DevTools/npm-publish 19c28f1ef146469e409470805ea4279d47c3d35c composite
actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
styfle/cancel-workflow-action 85880fa0301c86cca9da44039ee3bb12d3bedbfa composite

.github/workflows/test.yml actions

8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite

.github/workflows/test_bundles.yml actions

8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
denoland/setup-deno 041b854f97b325bd60e53e9dc2de9cb9f9ac0cba composite

.github/workflows/test_coverage.yml actions

8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
codecov/codecov-action 84508663e988701840491b86de86b666e8a86bed composite
distributhor/workflow-webhook 48a40b380ce4593b6a6676528cd005986ae56629 composite

.github/workflows/test_install.yml actions

8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite

.github/workflows/test_published_package.yml actions

8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite

package.json npm

@stdlib/bench-harness ^0.2.2 development
@stdlib/math-base-assert-is-nan ^0.2.2 development
@stdlib/math-base-special-pow ^0.3.0 development
@stdlib/ndarray-ctor ^0.2.2 development
@stdlib/ndarray-dtypes ^0.3.0 development
@stdlib/ndarray-to-array ^0.2.1 development
@stdlib/ndarray-zeros ^0.3.0 development
@stdlib/random-base-exponential ^0.2.1 development
istanbul ^0.4.1 development
tap-min git+https://github.com/Planeshifter/tap-min.git development
tape git+https://github.com/kgryte/tape.git#fix/globby development
@stdlib/array-base-every-by ^0.2.2
@stdlib/assert-has-own-property ^0.2.2
@stdlib/assert-is-collection ^0.2.2
@stdlib/assert-is-function ^0.2.2
@stdlib/assert-is-method-in ^0.2.2
@stdlib/assert-is-object ^0.2.2
@stdlib/assert-is-plain-object ^0.2.2
@stdlib/error-tools-fmtprodmsg ^0.2.2
@stdlib/ndarray-base-assert-is-data-type ^0.2.2
@stdlib/ndarray-base-assert-is-order ^0.2.2
@stdlib/ndarray-base-assert-is-output-data-type-policy github:stdlib-js/ndarray-base-assert-is-output-data-type-policy#main
@stdlib/random-tools-unary github:stdlib-js/random-tools-unary#main
@stdlib/string-format ^0.2.2
@stdlib/utils-constant-function ^0.2.2
@stdlib/utils-define-nonenumerable-read-only-accessor ^0.2.3
@stdlib/utils-define-nonenumerable-read-only-property ^0.2.2
@stdlib/utils-define-nonenumerable-read-write-accessor ^0.2.2
@stdlib/utils-noop ^0.2.2

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Open Source Science