Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/stdlib-js/random-streams-negative-binomial

Create a readable stream for generating pseudorandom numbers drawn from a negative binomial distribution.
https://github.com/stdlib-js/random-streams-negative-binomial

binomial discrete javascript math mathematics negative node node-js nodejs prng pseudorandom rand random readable rng seed statistics stats stdlib stream

Last synced: about 1 month ago
JSON representation

Create a readable stream for generating pseudorandom numbers drawn from a negative binomial distribution.

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!



# Negative Binomial Random Numbers



[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] 



> Create a [readable stream][readable-stream] for generating pseudorandom numbers drawn from a [negative binomial][negative-binomial] distribution.



## Installation



```bash

npm install @stdlib/random-streams-negative-binomial

```



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]).

-   To use as a general utility for the command line, install the corresponding [CLI package][cli-section] globally.



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 randomStream = require( '@stdlib/random-streams-negative-binomial' );

```






#### randomStream( r, p\[, options] )



Returns a [readable stream][readable-stream] for generating pseudorandom numbers drawn from a [negative binomial][negative-binomial] distribution with number of successes until experiment is stopped `r` and success probability `p`.



```javascript

var inspectStream = require( '@stdlib/streams-node-inspect-sink' );



var iStream;

var stream;



function log( chunk, idx ) {

    console.log( chunk.toString() );

    if ( idx === 10 ) {

        stream.destroy();

    }

}



stream = randomStream( 20.0, 0.3 );

iStream = inspectStream( log );



stream.pipe( iStream );

```



The function accepts the following `options`:



-   **objectMode**: specifies whether a [stream][stream] should operate in [objectMode][object-mode]. Default: `false`.

-   **encoding**: specifies how `Buffer` objects should be decoded to `strings`. Default: `null`.

-   **highWaterMark**: specifies the maximum number of bytes to store in an internal buffer before ceasing to generate additional pseudorandom numbers.

-   **sep**: separator used to join streamed data. This option is only applicable when a stream is **not** in [objectMode][object-mode]. Default: `'\n'`.

-   **iter**: number of iterations.

-   **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 pseudorandom number generator stream, 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 and/or streams. Setting this option to `true` ensures that a stream generator has exclusive control over its internal state. Default: `true`.

-   **siter**: number of iterations after which to emit the pseudorandom number generator state. This option is useful when wanting to deterministically capture a stream's underlying PRNG state. Default: `1e308`.



To set [stream][stream] `options`,



```javascript

var opts = {

    'objectMode': true,

    'encoding': 'utf8',

    'highWaterMark': 64

};



var stream = randomStream( 20.0, 0.3, opts );

```



By default, the function returns a [stream][stream] which can generate an infinite number of values (i.e., the [stream][stream] will **never** end). To limit the number of generated pseudorandom numbers, set the `iter` option.



```javascript

var inspectStream = require( '@stdlib/streams-node-inspect-sink' );



function log( chunk ) {

    console.log( chunk.toString() );

}



var opts = {

    'iter': 10

};



var stream = randomStream( 5, 0.7, opts );

var iStream = inspectStream( log );



stream.pipe( iStream );

```



By default, when not operating in [objectMode][object-mode], a returned [stream][stream] delineates generated pseudorandom numbers using a newline character. To specify an alternative separator, set the `sep` option.



```javascript

var inspectStream = require( '@stdlib/streams-node-inspect-sink' );



function log( chunk ) {

    console.log( chunk.toString() );

}



var opts = {

    'iter': 10,

    'sep': ','

};



var stream = randomStream( 5, 0.7, opts );

var iStream = inspectStream( log );



stream.pipe( iStream );

```



To seed the underlying pseudorandom number generator, set the `seed` option.



```javascript

var inspectStream = require( '@stdlib/streams-node-inspect-sink' );



function log( v ) {

    console.log( v );

}



var opts = {

    'objectMode': true,

    'iter': 10,

    'seed': 1234

};



var stream = randomStream( 5, 0.7, opts );



opts = {

    'objectMode': true

};

var iStream = inspectStream( opts, log );



stream.pipe( iStream );

```



To return a [readable stream][readable-stream] with an underlying pseudorandom number generator having a specific initial state, set the `state` option.



```javascript

var inspectStream = require( '@stdlib/streams-node-inspect-sink' );



function log( v ) {

    console.log( v );

}



var opts1 = {

    'objectMode': true,

    'iter': 10

};



var stream = randomStream( 20.0, 0.3, opts1 );



var opts2 = {

    'objectMode': true

};

var iStream = inspectStream( opts2, log );



// Stream pseudorandom numbers, thus progressing the underlying generator state:

stream.pipe( iStream );



// Create a new PRNG stream initialized to the last state of the previous stream:

var opts3 = {

    'objectMode': true,

    'iter': 10,

    'state': stream.state

};



stream = randomStream( 20.0, 0.3, opts3 );

iStream = inspectStream( opts2, log );



// Stream pseudorandom numbers starting from the last state of the previous stream:

stream.pipe( iStream );

```



##### stream.PRNG



The underlying pseudorandom number generator.



```javascript

var stream = randomStream( 20.0, 0.3 );



var prng = stream.PRNG;

// returns 

```



##### stream.seed



The value used to seed the underlying pseudorandom number generator.



```javascript

var stream = randomStream( 20.0, 0.3 );



var seed = stream.seed;

// returns 

```



If provided a PRNG for uniformly distributed numbers, this value is `null`.



```javascript

var minstd = require( '@stdlib/random-base-minstd-shuffle' ).normalized;



var stream = randomStream( 20.0, 0.3, {

    'prng': minstd

});



var seed = stream.seed;

// returns null

```



##### stream.seedLength



Length of underlying pseudorandom number generator seed.



```javascript

var stream = randomStream( 20.0, 0.3 );



var len = stream.seedLength;

// returns 

```



If provided a PRNG for uniformly distributed numbers, this value is `null`.



```javascript

var minstd = require( '@stdlib/random-base-minstd-shuffle' ).normalized;



var stream = randomStream( 20.0, 0.3, {

    'prng': minstd

});



var len = stream.seedLength;

// returns null

```



##### stream.state



Writable property for getting and setting the underlying pseudorandom number generator state.



```javascript

var stream = randomStream( 20.0, 0.3 );



var state = stream.state;

// returns 

```



If provided a PRNG for uniformly distributed numbers, this value is `null`.



```javascript

var minstd = require( '@stdlib/random-base-minstd-shuffle' ).normalized;



var stream = randomStream( 20.0, 0.3, {

    'prng': minstd

});



var state = stream.state;

// returns null

```



##### stream.stateLength



Length of underlying pseudorandom number generator state.



```javascript

var stream = randomStream( 20.0, 0.3 );



var len = stream.stateLength;

// returns 

```



If provided a PRNG for uniformly distributed numbers, this value is `null`.



```javascript

var minstd = require( '@stdlib/random-base-minstd-shuffle' ).normalized;



var stream = randomStream( 20.0, 0.3, {

    'prng': minstd

});



var len = stream.stateLength;

// returns null

```



##### stream.byteLength



Size (in bytes) of underlying pseudorandom number generator state.



```javascript

var stream = randomStream( 20.0, 0.3 );



var sz = stream.byteLength;

// returns 

```



If provided a PRNG for uniformly distributed numbers, this value is `null`.



```javascript

var minstd = require( '@stdlib/random-base-minstd-shuffle' ).normalized;



var stream = randomStream( 20.0, 0.3, {

    'prng': minstd

});



var sz = stream.byteLength;

// returns null

```



* * *



#### randomStream.factory( \[r, p, ]\[options] )



Returns a `function` for creating [readable streams][readable-stream] which generate pseudorandom numbers drawn from a [negative binomial][negative-binomial] distribution.



```javascript

var opts = {

    'objectMode': true,

    'encoding': 'utf8',

    'highWaterMark': 64

};



var createStream = randomStream.factory( opts );

```



If provided distribution parameters, the returned function returns [readable streams][readable-stream] which generate pseudorandom numbers drawn from the specified distribution.



```javascript

var createStream = randomStream.factory( 20.0, 0.5 );



var stream1 = createStream();

var stream2 = createStream();

// ...

```



If not provided distribution parameters, the returned function requires that distribution parameters be provided at each invocation.



```javascript

var createStream = randomStream.factory();



var stream1 = createStream( 20.0, 0.5 );

var stream2 = createStream( 20.0, 0.5 );

// ...

```



The method accepts the same `options` as [`randomStream()`](#random-stream).



* * *



#### randomStream.objectMode( r, p\[, options] )



This method is a convenience function to create [streams][stream] which **always** operate in [objectMode][object-mode].



```javascript

var inspectStream = require( '@stdlib/streams-node-inspect-sink' );



function log( v ) {

    console.log( v );

}



var opts = {

    'iter': 10

};

var stream = randomStream.objectMode( 20.0, 0.5, opts );



opts = {

    'objectMode': true

};

var iStream = inspectStream( opts, log );



stream.pipe( iStream );

```



This method accepts the same `options` as [`randomStream()`](#random-stream); however, the method will **always** override the [`objectMode`][object-mode] option in `options`.



* * *



### Events



In addition to the standard [readable stream][readable-stream] events, the following events are supported...



#### 'state'



Emitted after internally generating `siter` pseudorandom numbers.



```javascript

var opts = {

    'siter': 10 // emit the PRNG state every 10 pseudorandom numbers

};



var stream = randomStream( 20.0, 0.3, opts );



stream.on( 'state', onState );



function onState( state ) {

    // Do something with the emitted state, such as save to file...

}

```



* * *



## Notes



-   If PRNG state is "shared" (meaning a state array was provided during stream creation and **not** copied) and one sets the generator state to a state array having a different length, the underlying PRNG does **not** update the existing shared state and, instead, points to the newly provided state array. In order to synchronize PRNG output according to the new shared state array, the state array for **each** relevant PRNG must be **explicitly** set.

-   If PRNG state is "shared" and one sets the generator state to a state array of the same length, the PRNG state is updated (along with the state of all other PRNGs sharing the PRNG's state array).

-   In order to capture the PRNG state after a specific number of generated pseudorandom numbers, regardless of internal stream buffering, use the `siter` option in conjunction with a `state` event listener. Attempting to capture the underlying PRNG state after **reading** generated numbers is **not** likely to give expected results, as internal stream buffering will mean more values have been generated than have been read. Thus, the state returned by the `state` property will likely reflect a future PRNG state from the perspective of downstream consumers.



* * *



## Examples



```javascript

var inspectStream = require( '@stdlib/streams-node-inspect-sink' );

var randomStream = require( '@stdlib/random-streams-negative-binomial' );



function log( v ) {

    console.log( v.toString() );

}



var opts = {

    'objectMode': true,

    'iter': 10

};



var stream = randomStream( 20.0, 0.3, opts );



opts = {

    'objectMode': true

};

var iStream = inspectStream( opts, log );



stream.pipe( iStream );

```



* * *



## CLI



## Installation



To use as a general utility, install the CLI package globally



```bash

npm install -g @stdlib/random-streams-negative-binomial-cli

```



### Usage



```text

Usage: random-negative-binomial [options]  



Options:



  -h,  --help               Print this message.

  -V,  --version            Print the package version.

       --sep sep            Separator used to join streamed data. Default: '\n'.

  -n,  --iter iterations    Number of pseudorandom numbers.

       --seed seed          Pseudorandom number generator seed.

       --state filepath     Path to a file containing the pseudorandom number

                            generator state.

       --snapshot filepath  Output file path for saving the pseudorandom number

                            generator state upon exit.

```






### Notes



-   In accordance with POSIX convention, a trailing newline is **always** appended to generated output prior to exit.

-   Specifying a "snapshot" file path is useful when wanting to resume pseudorandom number generation due to, e.g., a downstream failure in an analysis pipeline. Before exiting, the process will store the pseudorandom number generator state in a file specified according to a provided file path. Upon loading a snapshot (state), the process will generate pseudorandom numbers starting from the loaded state, thus avoiding having to seed and replay an entire analysis.



### Examples



```bash

$ random-negative-binomial 20 0.1 -n 10 --seed 1234

```



* * *



## See Also



-   [`@stdlib/random-base/negative-binomial`][@stdlib/random/base/negative-binomial]: negative binomial distributed pseudorandom numbers.

-   [`@stdlib/random-iter/negative-binomial`][@stdlib/random/iter/negative-binomial]: create an iterator for generating pseudorandom numbers drawn from a negative binomial 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-streams-negative-binomial.svg

[npm-url]: https://npmjs.org/package/@stdlib/random-streams-negative-binomial



[test-image]: https://github.com/stdlib-js/random-streams-negative-binomial/actions/workflows/test.yml/badge.svg?branch=main

[test-url]: https://github.com/stdlib-js/random-streams-negative-binomial/actions/workflows/test.yml?query=branch:main



[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/random-streams-negative-binomial/main.svg

[coverage-url]: https://codecov.io/github/stdlib-js/random-streams-negative-binomial?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



[cli-section]: https://github.com/stdlib-js/random-streams-negative-binomial#cli

[cli-url]: https://github.com/stdlib-js/random-streams-negative-binomial/tree/cli

[@stdlib/random-streams-negative-binomial]: https://github.com/stdlib-js/random-streams-negative-binomial/tree/main



[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-streams-negative-binomial/tree/deno

[deno-readme]: https://github.com/stdlib-js/random-streams-negative-binomial/blob/deno/README.md

[umd-url]: https://github.com/stdlib-js/random-streams-negative-binomial/tree/umd

[umd-readme]: https://github.com/stdlib-js/random-streams-negative-binomial/blob/umd/README.md

[esm-url]: https://github.com/stdlib-js/random-streams-negative-binomial/tree/esm

[esm-readme]: https://github.com/stdlib-js/random-streams-negative-binomial/blob/esm/README.md

[branches-url]: https://github.com/stdlib-js/random-streams-negative-binomial/blob/main/branches.md



[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/random-streams-negative-binomial/main/LICENSE



[stream]: https://nodejs.org/api/stream.html



[object-mode]: https://nodejs.org/api/stream.html#stream_object_mode



[readable-stream]: https://nodejs.org/api/stream.html



[negative-binomial]: https://en.wikipedia.org/wiki/Negative_binomial_distribution



[@stdlib/array/uint32]: https://github.com/stdlib-js/array-uint32



[@stdlib/random/base/negative-binomial]: https://github.com/stdlib-js/random-base-negative-binomial



[@stdlib/random/iter/negative-binomial]: https://github.com/stdlib-js/random-iter-negative-binomial