@stdlib/random-strided-chisquare

Fill a strided array with pseudorandom numbers drawn from a chi-square distribution.

https://github.com/stdlib-js/random-strided-chisquare

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

Keywords

chi-square chi-squared chi2 chisquare chisquared continuous javascript math mathematics node node-js nodejs prng pseudorandom rand random rng statistics stats stdlib

Last synced: 6 months ago · JSON representation ·

Repository

Fill a strided array with pseudorandom numbers drawn from a chi-square 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: 2.18 MB

Statistics

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

Topics

chi-square chi-squared chi2 chisquare chisquared continuous javascript math mathematics node node-js nodejs prng pseudorandom rand random rng statistics stats stdlib

Created about 2 years ago · Last pushed about 1 year 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!

Chi-square Random Numbers

Fill a strided array with pseudorandom numbers drawn from a chi-square distribution.

## Installation ```bash npm install @stdlib/random-strided-chisquare ``` 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 chisquare = require( '@stdlib/random-strided-chisquare' ); ``` #### chisquare( N, k, sk, out, so ) Fills a strided array with pseudorandom numbers drawn from a [chi-square][@stdlib/random/base/chisquare] distribution. ```javascript var Float64Array = require( '@stdlib/array-float64' ); // Create an array: var out = new Float64Array( 10 ); // Fill the array with pseudorandom numbers: chisquare( out.length, [ 2.0 ], 0, out, 1 ); ``` The function has the following parameters: - **N**: number of indexed elements. - **k**: rate parameter. - **sk**: index increment for `k`. - **out**: output array. - **so**: index increment for `out`. The `N` and stride parameters determine which strided array elements are accessed at runtime. For example, to access every other value in `out`, ```javascript var out = [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ]; chisquare( 3, [ 2.0 ], 0, out, 2 ); ``` Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views. ```javascript var Float64Array = require( '@stdlib/array-float64' ); // Initial array: var k0 = new Float64Array( [ 2.0, 2.0, 2.0, 2.0, 2.0, 2.0 ] ); // Create offset view: var k1 = new Float64Array( k0.buffer, k0.BYTES_PER_ELEMENT*3 ); // start at 4th element // Create an output array: var out = new Float64Array( 3 ); // Fill the output array: chisquare( out.length, k1, -1, out, 1 ); ``` #### chisquare.ndarray( N, k, sk, ok, out, so, oo ) Fills a strided array with pseudorandom numbers drawn from a [chi-square][@stdlib/random/base/chisquare] distribution using alternative indexing semantics. ```javascript var Float64Array = require( '@stdlib/array-float64' ); // Create an array: var out = new Float64Array( 10 ); // Fill the array with pseudorandom numbers: chisquare.ndarray( out.length, [ 2.0 ], 0, 0, out, 1, 0 ); ``` The function has the following additional parameters: - **ok**: starting index for `k`. - **oo**: starting index for `out`. While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying `buffer`, the offset parameters support indexing semantics based on starting indices. For example, to access every other value in `out` starting from the second value, ```javascript var out = [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ]; chisquare.ndarray( 3, [ 2.0 ], 0, 0, out, 2, 1 ); ``` #### chisquare.factory( \[options] ) Returns a function for filling strided arrays with pseudorandom numbers drawn from a [chi-square][@stdlib/random/base/chisquare] distribution. ```javascript var Float64Array = require( '@stdlib/array-float64' ); var random = chisquare.factory(); // returns // Create an array: var out = new Float64Array( 10 ); // Fill the array with pseudorandom numbers: random( out.length, [ 2.0 ], 0, out, 1 ); ``` 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`. To use a custom PRNG as the underlying source of uniformly distributed pseudorandom numbers, set the `prng` option. ```javascript var Float64Array = require( '@stdlib/array-float64' ); var minstd = require( '@stdlib/random-base-minstd' ); var opts = { 'prng': minstd.normalized }; var random = chisquare.factory( opts ); var out = new Float64Array( 10 ); random( out.length, [ 2.0 ], 0, out, 1 ); ``` To seed the underlying pseudorandom number generator, set the `seed` option. ```javascript var Float64Array = require( '@stdlib/array-float64' ); var opts = { 'seed': 12345 }; var random = chisquare.factory( opts ); var out = new Float64Array( 10 ); random( out.length, [ 2.0 ], 0, out, 1 ); ``` * * * #### random.PRNG The underlying pseudorandom number generator. ```javascript var prng = chisquare.PRNG; // returns ``` #### chisquare.seed The value used to seed the underlying pseudorandom number generator. ```javascript var seed = chisquare.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 = chisquare.factory({ 'prng': minstd }); // returns var seed = random.seed; // returns null ``` #### chisquare.seedLength Length of underlying pseudorandom number generator seed. ```javascript var len = chisquare.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 = chisquare.factory({ 'prng': minstd }); // returns var len = random.seedLength; // returns null ``` #### chisquare.state Writable property for getting and setting the underlying pseudorandom number generator state. ```javascript var state = chisquare.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 = chisquare.factory({ 'prng': minstd }); // returns var state = random.state; // returns null ``` #### chisquare.stateLength Length of underlying pseudorandom number generator state. ```javascript var len = chisquare.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 = chisquare.factory({ 'prng': minstd }); // returns var len = random.stateLength; // returns null ``` #### chisquare.byteLength Size (in bytes) of underlying pseudorandom number generator state. ```javascript var sz = chisquare.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 = chisquare.factory({ 'prng': minstd }); // returns var sz = random.byteLength; // returns null ```

* * * ## Notes - If `N <= 0`, both `chisquare` and `chisquare.ndarray` leave the output array unchanged. - Both `chisquare` and `chisquare.ndarray` support array-like objects having getter and setter accessors for array element access.

* * * ## Examples ```javascript var zeros = require( '@stdlib/array-zeros' ); var zeroTo = require( '@stdlib/array-zero-to' ); var logEach = require( '@stdlib/console-log-each' ); var chisquare = require( '@stdlib/random-strided-chisquare' ); // Specify a PRNG seed: var opts = { 'seed': 1234 }; // Create a seeded PRNG: var rand1 = chisquare.factory( opts ); // Create an array: var x1 = zeros( 10, 'float64' ); // Fill the array with pseudorandom numbers: rand1( x1.length, [ 2.0 ], 0, x1, 1 ); // Create another function for filling strided arrays: var rand2 = chisquare.factory( opts ); // returns // Create a second array: var x2 = zeros( 10, 'generic' ); // Fill the array with the same pseudorandom numbers: rand2( x2.length, [ 2.0 ], 0, x2, 1 ); // Create a list of indices: var idx = zeroTo( x1.length, 'generic' ); // Print the array contents: logEach( 'x1[%d] = %.2f; x2[%d] = %.2f', idx, x1, idx, x2 ); ```

* * * ## 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-2024. 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: 5

Last Year

Push event: 5

Issues and Pull Requests

Last synced: 6 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 8 last-month

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

npmjs.org: @stdlib/random-strided-chisquare

Fill a strided array with pseudorandom numbers drawn from a chi-square distribution.

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

Versions: 2
Dependent Packages: 0
Dependent Repositories: 0
Downloads: 8 Last month

Rankings

Dependent repos count: 33.9%

Average: 41.2%

Dependent packages count: 48.4%

Maintainers (4)

planeshifter rreusser stdlib-bot kgryte

Funding

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

Last synced: 6 months ago

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 a8a3f3ad30e3422c9c7b888a15615d19a852ae32 composite
distributhor/workflow-webhook 48a40b380ce4593b6a6676528cd005986ae56629 composite

.github/workflows/productionize.yml actions

act10ns/slack ed1309ab9862e57e9e583e51c7889486b9a00b0f 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

JS-DevTools/npm-publish 4b07b26a2f6e0a51846e1870223e545bae91c552 composite
act10ns/slack ed1309ab9862e57e9e583e51c7889486b9a00b0f composite
actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
styfle/cancel-workflow-action 85880fa0301c86cca9da44039ee3bb12d3bedbfa composite

.github/workflows/test.yml actions

act10ns/slack ed1309ab9862e57e9e583e51c7889486b9a00b0f composite
actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite

.github/workflows/test_bundles.yml actions

act10ns/slack ed1309ab9862e57e9e583e51c7889486b9a00b0f composite
actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
denoland/setup-deno 61fe2df320078202e33d7d5ad347e7dcfa0e8f31 composite

.github/workflows/test_coverage.yml actions

act10ns/slack ed1309ab9862e57e9e583e51c7889486b9a00b0f composite
actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 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 b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite

package.json npm

@stdlib/array-base-to-accessor-array ^0.1.0 development
@stdlib/array-filled ^0.1.0 development
@stdlib/array-float64 ^0.1.1 development
@stdlib/array-zero-to ^0.1.0 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/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-array-uniform ^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/random-base-chisquare ^0.1.0
@stdlib/random-strided-tools-unary-factory ^0.1.0
@stdlib/types ^0.3.1
@stdlib/utils-define-nonenumerable-read-only-property ^0.1.1

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Open Source Science

@stdlib/random-strided-chisquare

Science Score: 44.0%

Keywords

Repository

Basic Info

Statistics

Topics

Metadata Files

README.md

Chi-square Random Numbers

Owner

Citation (CITATION.cff)

GitHub Events

Total

Last Year

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-strided-chisquare

Rankings

Maintainers (4)

Funding

Dependencies