Newman's Personal Motorcade

    @stdlib/random-iter-invgamma
    TypeScript icon, indicating that this package has built-in type declarations

    0.0.5 • Public • Published

    Inverse Gamma Random Numbers

    NPM version Build Status Coverage Status dependencies

    Create an iterator for generating pseudorandom numbers drawn from an inverse gamma distribution.

    Installation

    npm install @stdlib/random-iter-invgamma

    Usage

    var iterator = require( '@stdlib/random-iter-invgamma' );

    iterator( alpha, beta[, options] )

    Returns an iterator for generating pseudorandom numbers drawn from an inverse gamma distribution with parameters alpha (shape parameter) and beta (scale parameter).

    var it = iterator( 2.0, 2.0 );
    // returns <Object>
    
    var r = it.next().value;
    // returns <number>
    
    r = it.next().value;
    // returns <number>
    
    r = it.next().value;
    // returns <number>
    
    // ...

    If alpha <= 0 or beta <= 0, the function throws an error.

    var it = iterator( -1.0, 1.0 );
    // throws <TypeError>

    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 returned iterator, one must seed the provided prng (assuming the provided prng is seedable).
    • seed: pseudorandom number generator seed.
    • state: a Uint32Array 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 a returned iterator has exclusive control over its internal pseudorandom number generator state. Default: true.
    • iter: number of iterations.

    To use a custom PRNG as the underlying source of uniformly distributed pseudorandom numbers, set the prng option.

    var minstd = require( '@stdlib/random-base-minstd' );
    
    var it = iterator( 2.0, 4.0, {
        'prng': minstd.normalized
    });
    
    var r = it.next().value;
    // returns <number>

    To return an iterator having a specific initial state, set the iterator state option.

    var bool;
    var it1;
    var it2;
    var r;
    var i;
    
    it1 = iterator( 2.0, 4.0 );
    
    // Generate pseudorandom numbers, thus progressing the generator state:
    for ( i = 0; i < 1000; i++ ) {
        r = it1.next().value;
    }
    
    // Create a new iterator initialized to the current state of `it1`:
    it2 = iterator( 2.0, 4.0, {
        'state': it1.state
    });
    
    // Test that the generated pseudorandom numbers are the same:
    bool = ( it1.next().value === it2.next().value );
    // returns true

    To seed the iterator, set the seed option.

    var it1 = iterator( 2.0, 4.0, {
        'seed': 12345
    });
    
    var r1 = it1.next().value;
    // returns <number>
    
    var it2 = iterator( 2.0, 4.0, {
        'seed': 12345
    });
    
    var r2 = it2.next().value;
    // returns <number>
    
    var bool = ( r1 === r2 );
    // returns true

    To limit the number of iterations, set the iter option.

    var it = iterator( 2.0, 4.0, {
        'iter': 2
    });
    
    var r = it.next().value;
    // returns <number>
    
    r = it.next().value;
    // returns <number>
    
    r = it.next().done;
    // returns true

    The returned iterator protocol-compliant object has the following properties:

    • next: function which returns an iterator protocol-compliant object containing the next iterated value (if one exists) assigned to a value property and a done property having a boolean value indicating whether the iterator is finished.
    • return: function which closes an iterator and returns a single (optional) argument in an iterator protocol-compliant object.
    • seed: pseudorandom number generator seed. If provided a prng option, the property value is null.
    • seedLength: length of generator seed. If provided a prng option, the property value is null.
    • state: writable property for getting and setting the generator state. If provided a prng option, the property value is null.
    • stateLength: length of generator state. If provided a prng option, the property value is null.
    • byteLength: size (in bytes) of generator state. If provided a prng option, the property value is null.
    • PRNG: underlying pseudorandom number generator.

    Notes

    • If an environment supports Symbol.iterator, the returned iterator is iterable.
    • If PRNG state is "shared" (meaning a state array was provided during iterator creation and not copied) and one sets the underlying generator state to a state array having a different length, the iterator 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 iterator 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 iterator and/or PRNGs sharing the PRNG's state array).

    Examples

    var iterator = require( '@stdlib/random-iter-invgamma' );
    
    var it;
    var r;
    
    // Create a seeded iterator for generating pseudorandom numbers:
    it = iterator( 2.0, 5.0, {
        'seed': 1234,
        'iter': 10
    });
    
    // Perform manual iteration...
    while ( true ) {
        r = it.next();
        if ( r.done ) {
            break;
        }
        console.log( r.value );
    }

    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

    Chat


    License

    See LICENSE.

    Copyright

    Copyright © 2016-2021. The Stdlib Authors.

    Install

    npm i @stdlib/random-iter-invgamma

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    10

    Version

    0.0.5

    License

    Apache-2.0

    Unpacked Size

    50.1 kB

    Total Files

    9

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser