Data

Tools

Indexes

Applications

Experiments

Open Source Science

@stdlib/random-array-tools-binary-factory

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

https://github.com/stdlib-js/random-array-tools-binary-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
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (15.1%) to scientific vocabulary

Keywords

factory fcn func function generator javascript math mathematics node node-js nodejs prng pseudorandom rand random rng statistics stats stdlib tools
Last synced: 4 months ago · JSON representation ·

Repository

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

Basic Info
Statistics
  • Stars: 1
  • Watchers: 3
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Topics
factory fcn func function generator javascript math mathematics node node-js nodejs prng pseudorandom rand random rng statistics stats stdlib tools
Created almost 2 years ago · Last pushed 9 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation Security

README.md

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!

binaryFactory

NPM version Build Status Coverage Status <!-- dependencies -->

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

## Installation ```bash npm install @stdlib/random-array-tools-binary-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 binaryFactory = require( '@stdlib/random-array-tools-binary-factory' ); ``` #### binaryFactory( prng, dtypes, dtype ) Returns a factory function for generating pseudorandom values drawn from a binary PRNG. ```javascript var arcsine = require( '@stdlib/random-base-arcsine' ); var dtypes = [ 'float64', 'float32', 'generic' ]; var factory = binaryFactory( arcsine, dtypes, 'float64' ); // returns ``` The function has the following parameters: - **prng**: binary pseudorandom number generator. - **dtypes**: list of supported output data types. - **dtype**: default output array data type. * * * #### factory( \[param1, param2, ]\[options] ) Returns a function for generating pseudorandom values drawn from a binary PRNG. ```javascript var arcsine = require( '@stdlib/random-base-arcsine' ); var dtypes = [ 'float64', 'float32', 'generic' ]; var factory = binaryFactory( arcsine, dtypes, dtypes[ 0 ] ); // returns var random = factory(); // returns ``` The function has the following parameters: - **param1**: first PRNG parameter. - **param2**: second PRNG parameter. - **options**: function options. The function supports the following options: - **prng**: pseudorandom number generator which generates uniformly distributed pseudorandom numbers. - **seed**: pseudorandom value generator seed. - **state**: pseudorandom value generator state. - **copy**: boolean indicating whether to copy a provided pseudorandom value generator state. - **dtype**: default output array data type. Setting this option overrides the default output array data type provided to the parent function. If provided PRNG parameters, the function returns a partially applied function for creating arrays, which can be useful when wanting to pass around a parameterized function for array creation. * * * ### Full Arity #### random( len, param1, param2\[, options] ) Returns an array of pseudorandom values drawn from a binary PRNG. ```javascript var arcsine = require( '@stdlib/random-base-arcsine' ); var dtypes = [ 'float64', 'float32', 'generic' ]; var factory = binaryFactory( arcsine, dtypes, dtypes[ 0 ] ); // returns var random = factory(); // returns var v = random( 10, 2.0, 5.0 ); // returns ``` The function has the following parameters: - **len**: output array length. - **param1**: first PRNG parameter. - **param2**: second PRNG parameter. - **options**: function options. The function accepts the following options: - **dtype**: output array data type. Setting this option overrides the default output array data type. ```javascript var arcsine = require( '@stdlib/random-base-arcsine' ); var dtypes = [ 'float64', 'float32', 'generic' ]; var factory = binaryFactory( arcsine, dtypes, dtypes[ 0 ] ); // returns var random = factory(); // returns var v = random( 10, 2.0, 5.0, { 'dtype': 'float32' }); // returns ``` #### random.assign( param1, param2, out ) Fills an array with pseudorandom values drawn from a binary PRNG. ```javascript var arcsine = require( '@stdlib/random-base-arcsine' ); var zeros = require( '@stdlib/array-zeros' ); var dtypes = [ 'float64', 'float32', 'generic' ]; var factory = binaryFactory( arcsine, dtypes, dtypes[ 0 ] ); // returns var random = factory(); // returns var out = zeros( 10, 'float64' ); // returns var v = random.assign( 2.0, 5.0, out ); // returns var bool = ( out === v ); // returns true ``` The method has the following parameters: - **param1**: first PRNG parameter. - **param2**: second PRNG parameter. - **out**: output array. ### Partial Application #### random( len\[, options] ) Returns an array of pseudorandom values drawn from a binary PRNG. ```javascript var arcsine = require( '@stdlib/random-base-arcsine' ); var dtypes = [ 'float64', 'float32', 'generic' ]; var factory = binaryFactory( arcsine, dtypes, dtypes[ 0 ] ); // returns var random = factory( 2.0, 5.0 ); // returns var v = random( 10 ); // returns v = random( 10 ); // returns ``` The function has the following parameters: - **len**: output array length. - **options**: function options. The function accepts the following options: - **dtype**: output array data type. Setting this option overrides the default output array data type. ```javascript var arcsine = require( '@stdlib/random-base-arcsine' ); var dtypes = [ 'float64', 'float32', 'generic' ]; var factory = binaryFactory( arcsine, dtypes, dtypes[ 0 ] ); // returns var random = factory( 2.0, 5.0 ); // returns var v = random( 10, { 'dtype': 'float32' }); // returns v = random( 10, { 'dtype': 'generic' }); // returns [...] ``` #### random.assign( out ) Fills an array with pseudorandom values drawn from a binary PRNG. ```javascript var arcsine = require( '@stdlib/random-base-arcsine' ); var zeros = require( '@stdlib/array-zeros' ); var dtypes = [ 'float64', 'float32', 'generic' ]; var factory = binaryFactory( arcsine, dtypes, dtypes[ 0 ] ); // returns var random = factory( 2.0, 5.0 ); // returns var out = zeros( 10, 'float64' ); // returns var v = random.assign( out ); // returns var bool = ( out === v ); // returns true ``` The method has the following parameters: - **out**: output array. * * * #### random.PRNG The underlying pseudorandom number generator. ```javascript var arcsine = require( '@stdlib/random-base-arcsine' ); var dtypes = [ 'float64', 'float32', 'generic' ]; var factory = binaryFactory( arcsine, dtypes, dtypes[ 0 ] ); // returns var random = factory(); // returns var prng = random.PRNG; // returns ``` #### random.seed The value used to seed the underlying pseudorandom number generator. ```javascript var arcsine = require( '@stdlib/random-base-arcsine' ); var dtypes = [ 'float64', 'float32', 'generic' ]; var factory = binaryFactory( arcsine, dtypes, dtypes[ 0 ] ); // returns 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 minstd = require( '@stdlib/random-base-minstd-shuffle' ).normalized; var arcsine = require( '@stdlib/random-base-arcsine' ); var dtypes = [ 'float64', 'float32', 'generic' ]; var factory = binaryFactory( arcsine, dtypes, dtypes[ 0 ] ); // returns var random = factory({ 'prng': minstd }); // returns var seed = random.seed; // returns null ``` #### random.seedLength Length of underlying pseudorandom number generator seed. ```javascript var arcsine = require( '@stdlib/random-base-arcsine' ); var dtypes = [ 'float64', 'float32', 'generic' ]; var factory = binaryFactory( arcsine, dtypes, dtypes[ 0 ] ); // returns 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 minstd = require( '@stdlib/random-base-minstd-shuffle' ).normalized; var arcsine = require( '@stdlib/random-base-arcsine' ); var dtypes = [ 'float64', 'float32', 'generic' ]; var factory = binaryFactory( arcsine, dtypes, dtypes[ 0 ] ); // returns var random = factory({ 'prng': minstd }); // returns var len = random.seedLength; // returns null ``` #### random.state Writable property for getting and setting the underlying pseudorandom number generator state. ```javascript var arcsine = require( '@stdlib/random-base-arcsine' ); var dtypes = [ 'float64', 'float32', 'generic' ]; var factory = binaryFactory( arcsine, dtypes, dtypes[ 0 ] ); // returns 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 minstd = require( '@stdlib/random-base-minstd-shuffle' ).normalized; var arcsine = require( '@stdlib/random-base-arcsine' ); var dtypes = [ 'float64', 'float32', 'generic' ]; var factory = binaryFactory( arcsine, dtypes, dtypes[ 0 ] ); // returns var random = factory({ 'prng': minstd }); // returns var state = random.state; // returns null ``` #### random.stateLength Length of underlying pseudorandom number generator state. ```javascript var arcsine = require( '@stdlib/random-base-arcsine' ); var dtypes = [ 'float64', 'float32', 'generic' ]; var factory = binaryFactory( arcsine, dtypes, dtypes[ 0 ] ); // returns 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 minstd = require( '@stdlib/random-base-minstd-shuffle' ).normalized; var arcsine = require( '@stdlib/random-base-arcsine' ); var dtypes = [ 'float64', 'float32', 'generic' ]; var factory = binaryFactory( arcsine, dtypes, dtypes[ 0 ] ); // returns var random = factory({ 'prng': minstd }); // returns var len = random.stateLength; // returns null ``` #### random.byteLength Size (in bytes) of underlying pseudorandom number generator state. ```javascript var arcsine = require( '@stdlib/random-base-arcsine' ); var dtypes = [ 'float64', 'float32', 'generic' ]; var factory = binaryFactory( arcsine, dtypes, dtypes[ 0 ] ); // returns var random = factory(); // returns var sz = 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 minstd = require( '@stdlib/random-base-minstd-shuffle' ).normalized; var arcsine = require( '@stdlib/random-base-arcsine' ); var dtypes = [ 'float64', 'float32', 'generic' ]; var factory = binaryFactory( arcsine, dtypes, dtypes[ 0 ] ); // returns var random = factory({ 'prng': minstd }); // returns var sz = random.byteLength; // returns null ```
* * * ## Examples ```javascript var arcsine = require( '@stdlib/random-base-arcsine' ); var dtypes = require( '@stdlib/array-dtypes' ); var binaryFactory = require( '@stdlib/random-array-tools-binary-factory' ); var dt = dtypes( 'real_floating_point_and_generic' ); var factory = binaryFactory( arcsine, dt, 'float64' ); // returns var random = factory(); // returns var x = random( 10, 2.0, 5.0 ); // returns x = random( 10, 2.0, 5.0, { 'dtype': 'float32' }); // returns x = random( 10, 2.0, 5.0, { 'dtype': 'generic' }); // returns [...] ```
* * * ## 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

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
  • Push event: 19
Last Year
  • Push event: 19

Committers

Last synced: 6 months ago

All Time
  • Total Commits: 15
  • Total Committers: 1
  • Avg Commits per committer: 15.0
  • Development Distribution Score (DDS): 0.0
Past Year
  • Commits: 6
  • Committers: 1
  • Avg Commits per committer: 6.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
stdlib-bot n****y@s****o 15
Committer Domains (Top 20 + Academic)
stdlib.io: 1

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 0
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • npm 6,707 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 4
  • Total maintainers: 4
npmjs.org: @stdlib/random-array-tools-binary-factory

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

  • Homepage: https://stdlib.io
  • License: Apache-2.0
  • Latest release: 0.2.2
    published over 1 year ago
  • Versions: 4
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 6,707 Last month
Rankings
Downloads: 4.8%
Forks count: 14.9%
Stargazers count: 16.1%
Average: 23.5%
Dependent repos count: 33.6%
Dependent packages count: 47.9%
Maintainers (4)
planeshifter rreusser stdlib-bot kgryte
Funding
  • type: opencollective
  • url: https://opencollective.com/stdlib
Last synced: 4 months ago

Dependencies

.github/workflows/benchmark.yml actions
  • actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
  • actions/setup-node 5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d composite
.github/workflows/cancel.yml actions
  • styfle/cancel-workflow-action b173b6ec0100793626c2d9e6b90435061f4fc3e5 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 5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d composite
.github/workflows/npm_downloads.yml actions
  • actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
  • actions/setup-node 5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d composite
  • actions/upload-artifact a8a3f3ad30e3422c9c7b888a15615d19a852ae32 composite
  • distributhor/workflow-webhook 48a40b380ce4593b6a6676528cd005986ae56629 composite
.github/workflows/productionize.yml actions
  • act10ns/slack ed1309ab9862e57e9e583e51c7889486b9a00b0f composite
  • actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
  • actions/setup-node 5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d composite
  • stdlib-js/bundle-action main composite
  • stdlib-js/transform-errors-action main composite
.github/workflows/publish.yml actions
  • JS-DevTools/npm-publish fe72237be0920f7a0cafd6a966c9b929c9466e9b composite
  • act10ns/slack ed1309ab9862e57e9e583e51c7889486b9a00b0f composite
  • actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
  • actions/setup-node 5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d composite
  • styfle/cancel-workflow-action b173b6ec0100793626c2d9e6b90435061f4fc3e5 composite
.github/workflows/test.yml actions
  • act10ns/slack ed1309ab9862e57e9e583e51c7889486b9a00b0f composite
  • actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
  • actions/setup-node 5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d composite
.github/workflows/test_bundles.yml actions
  • act10ns/slack ed1309ab9862e57e9e583e51c7889486b9a00b0f composite
  • actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
  • actions/setup-node 5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d composite
  • denoland/setup-deno 61fe2df320078202e33d7d5ad347e7dcfa0e8f31 composite
.github/workflows/test_coverage.yml actions
  • act10ns/slack ed1309ab9862e57e9e583e51c7889486b9a00b0f composite
  • actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
  • actions/setup-node 5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d composite
  • codecov/codecov-action eaaf4bedf32dbdc6b720b63067d99c4d77d6047d composite
  • distributhor/workflow-webhook 48a40b380ce4593b6a6676528cd005986ae56629 composite
.github/workflows/test_install.yml actions
  • act10ns/slack ed1309ab9862e57e9e583e51c7889486b9a00b0f composite
  • actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
  • actions/setup-node 5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d composite
package.json npm
  • @stdlib/array-dtypes ^0.1.0 development
  • @stdlib/array-zeros ^0.1.0 development
  • @stdlib/bench-harness ^0.1.2 development
  • @stdlib/math-base-assert-is-nan ^0.1.1 development
  • @stdlib/math-base-special-pow ^0.1.0 development
  • @stdlib/random-base-arcsine ^0.1.0 development
  • @stdlib/random-base-normal ^0.1.0 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-assert-contains ^0.1.0
  • @stdlib/assert-has-own-property ^0.1.1
  • @stdlib/assert-is-function ^0.1.1
  • @stdlib/assert-is-method-in ^0.1.1
  • @stdlib/assert-is-string-array ^0.1.1
  • @stdlib/random-array-tools-binary github:stdlib-js/random-array-tools-binary#main
  • @stdlib/random-array-tools-nullary github:stdlib-js/random-array-tools-nullary#main
  • @stdlib/string-format ^0.1.1
  • @stdlib/utils-constant-function ^0.1.1
  • @stdlib/utils-define-nonenumerable-read-only-accessor ^0.1.1
  • @stdlib/utils-define-nonenumerable-read-only-property ^0.1.1
  • @stdlib/utils-define-nonenumerable-read-write-accessor ^0.1.1
  • @stdlib/utils-noop ^0.1.1