Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stdlib-js/random-array-invgamma
Create an array containing pseudorandom numbers drawn from an inverse gamma distribution.
https://github.com/stdlib-js/random-array-invgamma
continuous gamma generator inverse inverse-gamma javascript math mathematics node node-js nodejs prng pseudorandom rand random rng seed statistics stats stdlib
Last synced: 4 days ago
JSON representation
Create an array containing pseudorandom numbers drawn from an inverse gamma distribution.
- Host: GitHub
- URL: https://github.com/stdlib-js/random-array-invgamma
- Owner: stdlib-js
- License: apache-2.0
- Created: 2023-02-23T21:48:47.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-12T10:07:20.000Z (6 months ago)
- Last Synced: 2024-09-06T08:19:14.992Z (22 days ago)
- Topics: continuous, gamma, generator, inverse, inverse-gamma, javascript, math, mathematics, node, node-js, nodejs, prng, pseudorandom, rand, random, rng, seed, statistics, stats, stdlib
- Language: JavaScript
- Homepage: https://github.com/stdlib-js/stdlib
- Size: 3.77 MB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Security: SECURITY.md
Awesome Lists containing this project
README
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!
# Inverse Gamma Random Numbers
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Create an array containing pseudorandom numbers drawn from a [inverse gamma][@stdlib/random/base/invgamma] distribution.
## Installation
```bash
npm install @stdlib/random-array-invgamma
```
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 invgamma = require( '@stdlib/random-array-invgamma' );
```
#### invgamma( len, alpha, beta\[, options] )
Returns an array containing pseudorandom numbers drawn from a [inverse gamma][@stdlib/random/base/invgamma] distribution.
```javascript
var out = invgamma( 10, 2.0, 5.0 );
// returns
```
The function has the following parameters:
- **len**: output array length.
- **alpha**: shape parameter.
- **beta**: scale 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 = invgamma( 10, 2.0, 5.0, opts );
// returns [...]
```
#### invgamma.assign( alpha, beta, out )
Fills an array with pseudorandom numbers drawn from a [inverse gamma][@stdlib/random/base/invgamma] distribution.
```javascript
var zeros = require( '@stdlib/array-zeros' );
var x = zeros( 10, 'float64' );
// returns
var out = invgamma.assign( 2.0, 5.0, x );
// returns
var bool = ( out === x );
// returns true
```
The function has the following parameters:
- **alpha**: shape parameter.
- **beta**: scale parameter.
- **out**: output array.
#### invgamma.factory( \[alpha, beta, ]\[options] )
Returns a function for creating arrays containing pseudorandom numbers drawn from a [inverse gamma][@stdlib/random/base/invgamma] distribution.
```javascript
var random = invgamma.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 = invgamma.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 = invgamma.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 = invgamma.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 = invgamma.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 = invgamma.factory( 2.0, 5.0 );
var out = random( 10 );
// returns
var opts = {
'dtype': 'generic'
};
out = random( 10, opts );
// returns [...]
```
#### invgamma.PRNG
The underlying pseudorandom number generator.
```javascript
var prng = invgamma.PRNG;
// returns
```
#### invgamma.seed
The value used to seed the underlying pseudorandom number generator.
```javascript
var seed = invgamma.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 = invgamma.factory( 2.0, 5.0, {
'prng': minstd
});
var seed = random.seed;
// returns null
```
#### invgamma.seedLength
Length of underlying pseudorandom number generator seed.
```javascript
var len = invgamma.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 = invgamma.factory( 2.0, 5.0, {
'prng': minstd
});
var len = random.seedLength;
// returns null
```
#### invgamma.state
Writable property for getting and setting the underlying pseudorandom number generator state.
```javascript
var state = invgamma.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 = invgamma.factory( 2.0, 5.0, {
'prng': minstd
});
var state = random.state;
// returns null
```
#### invgamma.stateLength
Length of underlying pseudorandom number generator state.
```javascript
var len = invgamma.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 = invgamma.factory( 2.0, 5.0, {
'prng': minstd
});
var len = random.stateLength;
// returns null
```
#### invgamma.byteLength
Size (in bytes) of underlying pseudorandom number generator state.
```javascript
var sz = invgamma.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 = invgamma.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 invgamma = require( '@stdlib/random-array-invgamma' );
// Create a function for generating random arrays originating from the same state:
var random = invgamma.factory( 2.0, 5.0, {
'state': invgamma.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 = invgamma.factory( 2.0, 5.0, {
'state': invgamma.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 );
```
* * *
## See Also
- [`@stdlib/random-base/invgamma`][@stdlib/random/base/invgamma]: inverse gamma distributed pseudorandom numbers.
- [`@stdlib/random-strided/invgamma`][@stdlib/random/strided/invgamma]: fill a strided array with pseudorandom numbers drawn from an inverse gamma distribution.
* * *
## 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].
[npm-image]: http://img.shields.io/npm/v/@stdlib/random-array-invgamma.svg
[npm-url]: https://npmjs.org/package/@stdlib/random-array-invgamma
[test-image]: https://github.com/stdlib-js/random-array-invgamma/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/random-array-invgamma/actions/workflows/test.yml?query=branch:main
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/random-array-invgamma/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/random-array-invgamma?branch=main
[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
[deno-url]: https://github.com/stdlib-js/random-array-invgamma/tree/deno
[deno-readme]: https://github.com/stdlib-js/random-array-invgamma/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/random-array-invgamma/tree/umd
[umd-readme]: https://github.com/stdlib-js/random-array-invgamma/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/random-array-invgamma/tree/esm
[esm-readme]: https://github.com/stdlib-js/random-array-invgamma/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/random-array-invgamma/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/random-array-invgamma/main/LICENSE
[@stdlib/random/base/invgamma]: https://github.com/stdlib-js/random-base-invgamma
[@stdlib/array/typed-real-float-dtypes]: https://github.com/stdlib-js/array-typed-real-float-dtypes
[@stdlib/array/uint32]: https://github.com/stdlib-js/array-uint32
[@stdlib/array/float64]: https://github.com/stdlib-js/array-float64
[@stdlib/random/strided/invgamma]: https://github.com/stdlib-js/random-strided-invgamma