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!
Beta Prime Random Numbers
Fill a strided array with pseudorandom numbers drawn from a beta prime distribution.
Installation
npm install @stdlib/random-strided-betaprime
Usage
var betaprime = require( '@stdlib/random-strided-betaprime' );
betaprime( N, alpha, sa, beta, sb, out, so[, options] )
Fills a strided array with pseudorandom numbers drawn from a beta prime distribution.
var Float64Array = require( '@stdlib/array-float64' );
// Create an array:
var out = new Float64Array( 10 );
// Fill the array with pseudorandom numbers:
betaprime( out.length, [ 2.0 ], 0, [ 5.0 ], 0, out, 1 );
The function has the following parameters:
- N: number of indexed elements.
- alpha: first shape parameter.
-
sa: index increment for
alpha
. - beta: second shape parameter.
-
sb: index increment for
beta
. - 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
,
var out = [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ];
betaprime( 3, [ 2.0 ], 0, [ 5.0 ], 0, out, 2 );
Note that indexing is relative to the first index. To introduce an offset, use typed array
views.
var Float64Array = require( '@stdlib/array-float64' );
// Initial arrays...
var alpha0 = new Float64Array( [ 0.0, 0.0, 0.0, 2.0, 2.0, 2.0 ] );
var beta0 = new Float64Array( [ 5.0, 5.0, 5.0, 5.0, 5.0, 5.0 ] );
// Create offset views...
var alpha1 = new Float64Array( alpha0.buffer, alpha0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
var beta1 = new Float64Array( beta0.buffer, beta0.BYTES_PER_ELEMENT*3 ); // start at 4th element
// Create an output array:
var out = new Float64Array( 3 );
// Fill the output array:
betaprime( out.length, alpha1, -2, beta1, 1, 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 thestate
andseed
options. In order to seed the underlying pseudorandom number generator, one must seed the providedprng
(assuming the providedprng
is seedable). - seed: pseudorandom number generator seed.
-
state: a
Uint32Array
containing pseudorandom number generator state. If provided, the function ignores theseed
option. -
copy:
boolean
indicating whether to copy a provided pseudorandom number generator state. Setting this option tofalse
allows sharing state between two or more pseudorandom number generators. Setting this option totrue
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.
var Float64Array = require( '@stdlib/array-float64' );
var minstd = require( '@stdlib/random-base-minstd' );
var opts = {
'prng': minstd.normalized
};
var out = new Float64Array( 10 );
betaprime( out.length, [ 2.0 ], 0, [ 5.0 ], 0, out, 1, opts );
To seed the underlying pseudorandom number generator, set the seed
option.
var Float64Array = require( '@stdlib/array-float64' );
var opts = {
'seed': 12345
};
var out = new Float64Array( 10 );
betaprime( out.length, [ 2.0 ], 0, [ 5.0 ], 0, out, 1, opts );
betaprime.ndarray( N, alpha, sa, oa, beta, sb, ob, out, so, oo[, options] )
Fills a strided array with pseudorandom numbers drawn from a beta prime distribution using alternative indexing semantics.
var Float64Array = require( '@stdlib/array-float64' );
// Create an array:
var out = new Float64Array( 10 );
// Fill the array with pseudorandom numbers:
betaprime.ndarray( out.length, [ 2.0 ], 0, 0, [ 5.0 ], 0, 0, out, 1, 0 );
The function has the following additional parameters:
-
oa: starting index for
alpha
. -
ob: starting index for
beta
. -
oo: starting index for
out
.
While 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,
var out = [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ];
betaprime.ndarray( 3, [ 2.0 ], 0, 0, [ 5.0 ], 0, 0, out, 2, 1 );
The function accepts the same options
as documented above for betaprime()
.
Notes
- If
N <= 0
, both functions leave the output array unchanged. - Both functions support array-like objects having getter and setter accessors for array element access.
Examples
var zeros = require( '@stdlib/array-zeros' );
var zeroTo = require( '@stdlib/array-base-zero-to' );
var logEach = require( '@stdlib/console-log-each' );
var betaprime = require( '@stdlib/random-strided-betaprime' );
// Specify a PRNG seed:
var opts = {
'seed': 1234
};
// Create an array:
var x1 = zeros( 10, 'float64' );
// Create a list of indices:
var idx = zeroTo( x1.length );
// Fill the array with pseudorandom numbers:
betaprime( x1.length, [ 2.0 ], 0, [ 5.0 ], 0, x1, 1, opts );
// Create a second array:
var x2 = zeros( 10, 'generic' );
// Fill the array with the same pseudorandom numbers:
betaprime( x2.length, [ 2.0 ], 0, [ 5.0 ], 0, x2, 1, opts );
// Print the array contents:
logEach( 'x1[%d] = %.2f; x2[%d] = %.2f', idx, x1, idx, x2 );
See Also
-
@stdlib/random-base/betaprime
: beta prime distributed pseudorandom numbers. -
@stdlib/random-array/betaprime
: create an array containing pseudorandom numbers drawn from a beta prime distribution.
Notice
This package is part of 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, see the main project repository.
Community
License
See LICENSE.
Copyright
Copyright © 2016-2024. The Stdlib Authors.