@stdlib/random-iter-negative-binomial

<details> <summary> About stdlib... </summary> <p>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.</p> <p>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.</p> <p>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.</p> <p>To join us in bringing numerical computing to the web, get started by checking us out on <a href="https://github.com/stdlib-js/stdlib">GitHub</a>, and please consider <a href="https://opencollective.com/stdlib">financially supporting stdlib</a>. We greatly appreciate your continued support!</p> </details> # Negative Binomial Random Numbers [![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]  > Create an iterator for generating pseudorandom numbers drawn from a [negative binomial][negative-binomial] distribution. <section class="installation"> ## Installation ```bash npm install @stdlib/random-iter-negative-binomial ``` </section> <section class="usage"> ## Usage ```javascript var iterator = require( '@stdlib/random-iter-negative-binomial' ); ``` #### iterator( r, p\[, options] ) Returns an iterator for generating pseudorandom numbers drawn from a [negative binomial][negative-binomial] distribution with parameters `r` (number of successes until experiment is stopped) and `p` (success probability). ```javascript var it = iterator( 10, 0.3 ); // returns <Object> var r = it.next().value; // returns <number> r = it.next().value; // returns <number> r = it.next().value; // returns <number> // ... ``` If `p < 0` or `p > 1`, the function throws an error.  ```javascript var it = iterator( 10, 1.2 ); // 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`][@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 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. ```javascript var minstd = require( '@stdlib/random-base-minstd' ); var it = iterator( 8, 0.5, { 'prng': minstd.normalized }); var r = it.next().value; // returns <number> ``` To return an iterator having a specific initial state, set the iterator `state` option. ```javascript var bool; var it1; var it2; var r; var i; it1 = iterator( 8, 0.5 ); // 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( 8, 0.5, { '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. ```javascript var it1 = iterator( 8, 0.5, { 'seed': 12345 }); var r1 = it1.next().value; // returns <number> var it2 = iterator( 8, 0.5, { '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. ```javascript var it = iterator( 8, 0.5, { '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. </section>  <section class="notes"> ## 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). </section>  <section class="examples"> ## Examples  ```javascript var iterator = require( '@stdlib/random-iter-negative-binomial' ); var it; var r; // Create a seeded iterator for generating pseudorandom numbers: it = iterator( 10, 0.5, { 'seed': 1234, 'iter': 10 }); // Perform manual iteration... while ( true ) { r = it.next(); if ( r.done ) { break; } console.log( r.value ); } ``` </section>   <section class="related"> * * * ## See Also - <span class="package-name">[`@stdlib/random-base/negative-binomial`][@stdlib/random/base/negative-binomial]</span><span class="delimiter">: </span><span class="description">negative binomial distributed pseudorandom numbers.</span> </section>   <section class="main-repo" > * * * ## 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]. </section>   <section class="links"> [npm-image]: http://img.shields.io/npm/v/@stdlib/random-iter-negative-binomial.svg [npm-url]: https://npmjs.org/package/@stdlib/random-iter-negative-binomial [test-image]: https://github.com/stdlib-js/random-iter-negative-binomial/actions/workflows/test.yml/badge.svg?branch=v0.2.1 [test-url]: https://github.com/stdlib-js/random-iter-negative-binomial/actions/workflows/test.yml?query=branch:v0.2.1 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/random-iter-negative-binomial/main.svg [coverage-url]: https://codecov.io/github/stdlib-js/random-iter-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 [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-iter-negative-binomial/tree/deno [deno-readme]: https://github.com/stdlib-js/random-iter-negative-binomial/blob/deno/README.md [umd-url]: https://github.com/stdlib-js/random-iter-negative-binomial/tree/umd [umd-readme]: https://github.com/stdlib-js/random-iter-negative-binomial/blob/umd/README.md [esm-url]: https://github.com/stdlib-js/random-iter-negative-binomial/tree/esm [esm-readme]: https://github.com/stdlib-js/random-iter-negative-binomial/blob/esm/README.md [branches-url]: https://github.com/stdlib-js/random-iter-negative-binomial/blob/main/branches.md [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/random-iter-negative-binomial/main/LICENSE [negative-binomial]: https://en.wikipedia.org/wiki/Negative_binomial_distribution [@stdlib/array/uint32]: https://www.npmjs.com/package/@stdlib/array-uint32  [@stdlib/random/base/negative-binomial]: https://www.npmjs.com/package/@stdlib/random-base-negative-binomial  </section>