random-array-kumaraswamy

Create an array containing pseudorandom numbers drawn from Kumaraswamy's double bounded distribution.

https://github.com/stdlib-js/random-array-kumaraswamy

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 (14.7%) to scientific vocabulary

Keywords

array continuous generator javascript kumaraswamy math mathematics node node-js nodejs prng pseudorandom rand random rng seed seedable statistics stats stdlib

Scientific Fields

Biology Life Sciences - 40% confidence

Last synced: 4 months ago · JSON representation ·

Repository

Create an array containing pseudorandom numbers drawn from Kumaraswamy's double bounded 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: 1010 KB

Statistics

Stars: 1
Watchers: 3
Forks: 0
Open Issues: 0
Releases: 0

Topics

array continuous generator javascript kumaraswamy math mathematics node node-js nodejs prng pseudorandom rand random rng seed seedable statistics stats stdlib

Created almost 2 years ago · Last pushed 5 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!

Kumaraswamy's Double Bounded Random Numbers

Create an array containing pseudorandom numbers drawn from Kumaraswamy's double bounded distribution.

## Installation ```bash npm install @stdlib/random-array-kumaraswamy ``` 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 kumaraswamy = require( '@stdlib/random-array-kumaraswamy' ); ``` #### kumaraswamy( len, a, b\[, options] ) Returns an array containing pseudorandom numbers drawn from [Kumaraswamy's double bounded][@stdlib/random/base/kumaraswamy] distribution. ```javascript var out = kumaraswamy( 10, 2.0, 5.0 ); // returns ``` The function has the following parameters: - **len**: output array length. - **a**: first shape parameter. - **b**: second shape parameter. - **options**: function options. The function accepts the following `options`: - **dtype**: output array data type. Must be a [real-valued floating-point data type][@stdlib/array/typed-real-float-dtypes] or "generic". Default: `'float64'`. By default, the function returns a [`Float64Array`][@stdlib/array/float64]. To return an array having a different data type, set the `dtype` option. ```javascript var opts = { 'dtype': 'generic' }; var out = kumaraswamy( 10, 2.0, 5.0, opts ); // returns [...] ``` #### kumaraswamy.assign( a, b, out ) Fills an array with pseudorandom numbers drawn from [Kumaraswamy's double bounded][@stdlib/random/base/kumaraswamy] distribution. ```javascript var zeros = require( '@stdlib/array-zeros' ); var x = zeros( 10, 'float64' ); // returns var out = kumaraswamy.assign( 2.0, 5.0, x ); // returns var bool = ( out === x ); // returns true ``` The function has the following parameters: - **a**: first shape parameter. - **b**: second shape parameter. - **out**: output array. #### kumaraswamy.factory( \[a, b, ]\[options] ) Returns a function for creating arrays containing pseudorandom numbers drawn from [Kumaraswamy's double bounded][@stdlib/random/base/kumaraswamy] distribution. ```javascript var random = kumaraswamy.factory(); var out = random( 10, 2.0, 5.0 ); // returns var len = out.length; // returns 10 ``` If provided distribution parameters, the returned generator returns random variates from the specified distribution. ```javascript var random = kumaraswamy.factory( 2.0, 5.0 ); var out = random( 10 ); // returns out = random( 10 ); // returns ``` If not provided distribution parameters, the returned generator requires that distribution parameters be provided at each invocation. ```javascript var random = kumaraswamy.factory(); var out = random( 10, 2.0, 5.0 ); // returns out = random( 10, 2.0, 5.0 ); // returns ``` 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`][@stdlib/array/uint32] 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][@stdlib/array/typed-real-float-dtypes] or "generic". Default: `'float64'`. To use a custom PRNG as the underlying source of uniformly distributed pseudorandom numbers, set the `prng` option. ```javascript var minstd = require( '@stdlib/random-base-minstd' ); var opts = { 'prng': minstd.normalized }; var random = kumaraswamy.factory( 2.0, 5.0, opts ); var out = random( 10 ); // returns ``` To seed the underlying pseudorandom number generator, set the `seed` option. ```javascript var opts = { 'seed': 12345 }; var random = kumaraswamy.factory( 2.0, 5.0, opts ); var out = random( 10, opts ); // returns ``` The returned function accepts the following `options`: - **dtype**: output array data type. Must be a [real-valued floating-point data type][@stdlib/array/typed-real-float-dtypes] or "generic". This overrides the default output array data type. To override the default output array data type, set the `dtype` option. ```javascript var random = kumaraswamy.factory( 2.0, 5.0 ); var out = random( 10 ); // returns var opts = { 'dtype': 'generic' }; out = random( 10, opts ); // returns [...] ``` #### kumaraswamy.PRNG The underlying pseudorandom number generator. ```javascript var prng = kumaraswamy.PRNG; // returns ``` #### kumaraswamy.seed The value used to seed the underlying pseudorandom number generator. ```javascript var seed = kumaraswamy.seed; // returns ``` If the `factory` method 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 random = kumaraswamy.factory( 2.0, 5.0, { 'prng': minstd }); var seed = random.seed; // returns null ``` #### kumaraswamy.seedLength Length of underlying pseudorandom number generator seed. ```javascript var len = kumaraswamy.seedLength; // returns ``` If the `factory` method 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 random = kumaraswamy.factory( 2.0, 5.0, { 'prng': minstd }); var len = random.seedLength; // returns null ``` #### kumaraswamy.state Writable property for getting and setting the underlying pseudorandom number generator state. ```javascript var state = kumaraswamy.state; // returns ``` If the `factory` method 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 random = kumaraswamy.factory( 2.0, 5.0, { 'prng': minstd }); var state = random.state; // returns null ``` #### kumaraswamy.stateLength Length of underlying pseudorandom number generator state. ```javascript var len = kumaraswamy.stateLength; // returns ``` If the `factory` method 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 random = kumaraswamy.factory( 2.0, 5.0, { 'prng': minstd }); var len = random.stateLength; // returns null ``` #### kumaraswamy.byteLength Size (in bytes) of underlying pseudorandom number generator state. ```javascript var sz = kumaraswamy.byteLength; // returns ``` If the `factory` method 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 random = kumaraswamy.factory( 2.0, 5.0, { 'prng': minstd }); var sz = random.byteLength; // returns null ```

## Notes - 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` method 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 logEach = require( '@stdlib/console-log-each' ); var kumaraswamy = require( '@stdlib/random-array-kumaraswamy' ); // Create a function for generating random arrays originating from the same state: var random = kumaraswamy.factory( 2.0, 5.0, { 'state': kumaraswamy.state, 'copy': true }); // Generate 3 arrays: var x1 = random( 5 ); var x2 = random( 5 ); var x3 = random( 5 ); // Print the contents: logEach( '%f, %f, %f', x1, x2, x3 ); // Create another function for generating random arrays with the original state: random = kumaraswamy.factory( 2.0, 5.0, { 'state': kumaraswamy.state, 'copy': true }); // Generate a single array which replicates the above pseudorandom number generation sequence: var x4 = random( 15 ); // Print the contents: logEach( '%f', x4 ); ```

* * * ## 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

Push event: 26

Last Year

Push event: 26

Committers

Last synced: 5 months ago

All Time

Total Commits: 14
Total Committers: 1
Avg Commits per committer: 14.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	14

Committer Domains (Top 20 + Academic)

stdlib.io: 1

Issues and Pull Requests

Last synced: 5 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 1 last-month

Total dependent packages: 0
Total dependent repositories: 0
Total versions: 3
Total maintainers: 4

npmjs.org: @stdlib/random-array-kumaraswamy

Create an array containing pseudorandom numbers drawn from Kumaraswamy's double bounded distribution.

Homepage: https://stdlib.io
License: Apache-2.0
Latest release: 0.2.1
published almost 2 years ago

Versions: 3
Dependent Packages: 0
Dependent Repositories: 0
Downloads: 1 Last month

Rankings

Dependent repos count: 33.9%

Average: 41.0%

Dependent packages count: 48.2%

Maintainers (4)

planeshifter rreusser stdlib-bot kgryte

Funding

type: opencollective
url: https://opencollective.com/stdlib

Last synced: 5 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-float32 ^0.1.1 development
@stdlib/array-float64 ^0.1.1 development
@stdlib/array-nans ^0.1.0 development
@stdlib/array-uint32 ^0.1.1 development
@stdlib/array-zeros ^0.1.0 development
@stdlib/assert-is-uint32array ^0.1.1 development
@stdlib/bench-harness ^0.1.2 development
@stdlib/console-log-each ^0.1.0 development
@stdlib/constants-uint32-max ^0.1.1 development
@stdlib/math-base-assert-is-nan ^0.1.1 development
@stdlib/math-base-assert-is-nanf ^0.1.1 development
@stdlib/math-base-special-pow ^0.1.0 development
@stdlib/random-base-minstd ^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-defaults ^0.1.0
@stdlib/array-dtypes ^0.1.0
@stdlib/random-array-tools-binary-factory ^0.1.0
@stdlib/random-base-kumaraswamy ^0.1.0
@stdlib/types ^0.2.0
@stdlib/utils-define-nonenumerable-read-only-property ^0.1.1

random-array-kumaraswamy

Science Score: 44.0%

Keywords

Scientific Fields

Repository

Basic Info

Statistics

Topics

Metadata Files

README.md

Kumaraswamy's Double Bounded Random Numbers

Owner

Citation (CITATION.cff)

GitHub Events

Total

Last Year

Committers

All Time

Past Year

Top Committers

Committer Domains (Top 20 + Academic)

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

npmjs.org: @stdlib/random-array-kumaraswamy

Rankings

Maintainers (4)

Funding

Dependencies