{"id":17972380,"url":"https://github.com/stdlib-js/random-iter-binomial","last_synced_at":"2025-05-05T23:40:41.466Z","repository":{"id":41453969,"uuid":"377257656","full_name":"stdlib-js/random-iter-binomial","owner":"stdlib-js","description":"Create an iterator for generating pseudorandom numbers drawn from a binomial distribution.","archived":false,"fork":false,"pushed_at":"2024-12-23T02:48:02.000Z","size":2581,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-01-17T11:39:12.082Z","etag":null,"topics":["bernoulli","binomial","discrete","generator","javascript","math","mathematics","node","node-js","nodejs","prng","pseudorandom","rand","random","rng","seed","seedable","statistics","stats","stdlib"],"latest_commit_sha":null,"homepage":"https://github.com/stdlib-js/stdlib","language":"JavaScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/stdlib-js.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["stdlib-js"],"open_collective":"stdlib","tidelift":"npm/@stdlib/stdlib"}},"created_at":"2021-06-15T18:21:52.000Z","updated_at":"2024-12-23T02:10:26.000Z","dependencies_parsed_at":"2023-02-17T07:45:56.135Z","dependency_job_id":"5458b01f-afd9-402e-91d9-6da31f6fa08f","html_url":"https://github.com/stdlib-js/random-iter-binomial","commit_stats":{"total_commits":37,"total_committers":1,"mean_commits":37.0,"dds":0.0,"last_synced_commit":"97e4703d5d47d329d6c6d50a1f26b42a3bcbeb7c"},"previous_names":[],"tags_count":18,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Frandom-iter-binomial","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Frandom-iter-binomial/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Frandom-iter-binomial/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Frandom-iter-binomial/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stdlib-js","download_url":"https://codeload.github.com/stdlib-js/random-iter-binomial/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":237935897,"owners_count":19390233,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bernoulli","binomial","discrete","generator","javascript","math","mathematics","node","node-js","nodejs","prng","pseudorandom","rand","random","rng","seed","seedable","statistics","stats","stdlib"],"created_at":"2024-10-29T16:14:08.462Z","updated_at":"2025-02-09T10:28:13.500Z","avatar_url":"https://github.com/stdlib-js.png","language":"JavaScript","readme":"\u003c!--\n\n@license Apache-2.0\n\nCopyright (c) 2018 The Stdlib Authors.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n   http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n\n--\u003e\n\n\n\u003cdetails\u003e\n  \u003csummary\u003e\n    About stdlib...\n  \u003c/summary\u003e\n  \u003cp\u003eWe 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.\u003c/p\u003e\n  \u003cp\u003eThe 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.\u003c/p\u003e\n  \u003cp\u003eWhen 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.\u003c/p\u003e\n  \u003cp\u003eTo join us in bringing numerical computing to the web, get started by checking us out on \u003ca href=\"https://github.com/stdlib-js/stdlib\"\u003eGitHub\u003c/a\u003e, and please consider \u003ca href=\"https://opencollective.com/stdlib\"\u003efinancially supporting stdlib\u003c/a\u003e. We greatly appreciate your continued support!\u003c/p\u003e\n\u003c/details\u003e\n\n# Binomial Random Numbers\n\n[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] \u003c!-- [![dependencies][dependencies-image]][dependencies-url] --\u003e\n\n\u003e Create an iterator for generating pseudorandom numbers drawn from a [binomial][binomial] distribution.\n\n\u003csection class=\"installation\"\u003e\n\n## Installation\n\n```bash\nnpm install @stdlib/random-iter-binomial\n```\n\nAlternatively,\n\n-   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]).\n-   If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).\n-   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]).\n\nThe [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.\n\nTo 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.\n\n\u003c/section\u003e\n\n\u003csection class=\"usage\"\u003e\n\n## Usage\n\n```javascript\nvar iterator = require( '@stdlib/random-iter-binomial' );\n```\n\n#### iterator( n, p\\[, options] )\n\nReturns an iterator for generating pseudorandom numbers drawn from a [binomial][binomial] distribution with number of trials `n` and success probability `p`.\n\n```javascript\nvar it = iterator( 10, 0.3 );\n// returns \u003cObject\u003e\n\nvar r = it.next().value;\n// returns \u003cnumber\u003e\n\nr = it.next().value;\n// returns \u003cnumber\u003e\n\nr = it.next().value;\n// returns \u003cnumber\u003e\n\n// ...\n```\n\nIf `p \u003c 0` or `p \u003e 1`, the function throws an error.\n\n\u003c!-- run throws: true --\u003e\n\n```javascript\nvar it = iterator( 10, 1.2 );\n// throws \u003cTypeError\u003e\n```\n\nThe function accepts the following `options`:\n\n-   **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).\n-   **seed**: pseudorandom number generator seed.\n-   **state**: a [`Uint32Array`][@stdlib/array/uint32] containing pseudorandom number generator state. If provided, the function ignores the `seed` option.\n-   **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`.\n-   **iter**: number of iterations.\n\nTo use a custom PRNG as the underlying source of uniformly distributed pseudorandom numbers, set the `prng` option.\n\n```javascript\nvar minstd = require( '@stdlib/random-base-minstd' );\n\nvar it = iterator( 8, 0.5, {\n    'prng': minstd.normalized\n});\n\nvar r = it.next().value;\n// returns \u003cnumber\u003e\n```\n\nTo return an iterator having a specific initial state, set the iterator `state` option.\n\n```javascript\nvar bool;\nvar it1;\nvar it2;\nvar r;\nvar i;\n\nit1 = iterator( 8, 0.5 );\n\n// Generate pseudorandom numbers, thus progressing the generator state:\nfor ( i = 0; i \u003c 1000; i++ ) {\n    r = it1.next().value;\n}\n\n// Create a new iterator initialized to the current state of `it1`:\nit2 = iterator( 8, 0.5, {\n    'state': it1.state\n});\n\n// Test that the generated pseudorandom numbers are the same:\nbool = ( it1.next().value === it2.next().value );\n// returns true\n```\n\nTo seed the iterator, set the `seed` option.\n\n```javascript\nvar it1 = iterator( 8, 0.5, {\n    'seed': 12345\n});\n\nvar r1 = it1.next().value;\n// returns \u003cnumber\u003e\n\nvar it2 = iterator( 8, 0.5, {\n    'seed': 12345\n});\n\nvar r2 = it2.next().value;\n// returns \u003cnumber\u003e\n\nvar bool = ( r1 === r2 );\n// returns true\n```\n\nTo limit the number of iterations, set the `iter` option.\n\n```javascript\nvar it = iterator( 10, 0.5, {\n    'iter': 2\n});\n\nvar r = it.next().value;\n// returns \u003cnumber\u003e\n\nr = it.next().value;\n// returns \u003cnumber\u003e\n\nr = it.next().done;\n// returns true\n```\n\nThe returned iterator protocol-compliant object has the following properties:\n\n-   **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.\n-   **return**: function which closes an iterator and returns a single (optional) argument in an iterator protocol-compliant object.\n-   **seed**: pseudorandom number generator seed. If provided a `prng` option, the property value is `null`.\n-   **seedLength**: length of generator seed. If provided a `prng` option, the property value is `null`.\n-   **state**: writable property for getting and setting the generator state. If provided a `prng` option, the property value is `null`.\n-   **stateLength**: length of generator state. If provided a `prng` option, the property value is `null`.\n-   **byteLength**: size (in bytes) of generator state. If provided a `prng` option, the property value is `null`.\n-   **PRNG**: underlying pseudorandom number generator.\n\n\u003c/section\u003e\n\n\u003c!-- /.usage --\u003e\n\n\u003csection class=\"notes\"\u003e\n\n## Notes\n\n-   If an environment supports `Symbol.iterator`, the returned iterator is iterable.\n-   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.\n-   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).\n\n\u003c/section\u003e\n\n\u003c!-- /.notes --\u003e\n\n\u003csection class=\"examples\"\u003e\n\n## Examples\n\n\u003c!-- eslint no-undef: \"error\" --\u003e\n\n```javascript\nvar iterator = require( '@stdlib/random-iter-binomial' );\n\nvar it;\nvar r;\n\n// Create a seeded iterator for generating pseudorandom numbers:\nit = iterator( 10, 0.5, {\n    'seed': 1234,\n    'iter': 10\n});\n\n// Perform manual iteration...\nwhile ( true ) {\n    r = it.next();\n    if ( r.done ) {\n        break;\n    }\n    console.log( r.value );\n}\n```\n\n\u003c/section\u003e\n\n\u003c!-- /.examples --\u003e\n\n\u003c!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. --\u003e\n\n\u003csection class=\"related\"\u003e\n\n* * *\n\n## See Also\n\n-   \u003cspan class=\"package-name\"\u003e[`@stdlib/random-base/binomial`][@stdlib/random/base/binomial]\u003c/span\u003e\u003cspan class=\"delimiter\"\u003e: \u003c/span\u003e\u003cspan class=\"description\"\u003ebinomial distributed pseudorandom numbers.\u003c/span\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.related --\u003e\n\n\u003c!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. --\u003e\n\n\n\u003csection class=\"main-repo\" \u003e\n\n* * *\n\n## Notice\n\nThis 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.\n\nFor 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].\n\n#### Community\n\n[![Chat][chat-image]][chat-url]\n\n---\n\n## License\n\nSee [LICENSE][stdlib-license].\n\n\n## Copyright\n\nCopyright \u0026copy; 2016-2024. The Stdlib [Authors][stdlib-authors].\n\n\u003c/section\u003e\n\n\u003c!-- /.stdlib --\u003e\n\n\u003c!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. --\u003e\n\n\u003csection class=\"links\"\u003e\n\n[npm-image]: http://img.shields.io/npm/v/@stdlib/random-iter-binomial.svg\n[npm-url]: https://npmjs.org/package/@stdlib/random-iter-binomial\n\n[test-image]: https://github.com/stdlib-js/random-iter-binomial/actions/workflows/test.yml/badge.svg?branch=main\n[test-url]: https://github.com/stdlib-js/random-iter-binomial/actions/workflows/test.yml?query=branch:main\n\n[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/random-iter-binomial/main.svg\n[coverage-url]: https://codecov.io/github/stdlib-js/random-iter-binomial?branch=main\n\n\u003c!--\n\n[dependencies-image]: https://img.shields.io/david/stdlib-js/random-iter-binomial.svg\n[dependencies-url]: https://david-dm.org/stdlib-js/random-iter-binomial/main\n\n--\u003e\n\n[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg\n[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im\n\n[stdlib]: https://github.com/stdlib-js/stdlib\n\n[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors\n\n[umd]: https://github.com/umdjs/umd\n[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules\n\n[deno-url]: https://github.com/stdlib-js/random-iter-binomial/tree/deno\n[deno-readme]: https://github.com/stdlib-js/random-iter-binomial/blob/deno/README.md\n[umd-url]: https://github.com/stdlib-js/random-iter-binomial/tree/umd\n[umd-readme]: https://github.com/stdlib-js/random-iter-binomial/blob/umd/README.md\n[esm-url]: https://github.com/stdlib-js/random-iter-binomial/tree/esm\n[esm-readme]: https://github.com/stdlib-js/random-iter-binomial/blob/esm/README.md\n[branches-url]: https://github.com/stdlib-js/random-iter-binomial/blob/main/branches.md\n\n[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/random-iter-binomial/main/LICENSE\n\n[binomial]: https://en.wikipedia.org/wiki/Binomial_distribution\n\n[@stdlib/array/uint32]: https://github.com/stdlib-js/array-uint32\n\n\u003c!-- \u003crelated-links\u003e --\u003e\n\n[@stdlib/random/base/binomial]: https://github.com/stdlib-js/random-base-binomial\n\n\u003c!-- \u003c/related-links\u003e --\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.links --\u003e\n","funding_links":["https://github.com/sponsors/stdlib-js","https://opencollective.com/stdlib","https://tidelift.com/funding/github/npm/@stdlib/stdlib"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstdlib-js%2Frandom-iter-binomial","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstdlib-js%2Frandom-iter-binomial","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstdlib-js%2Frandom-iter-binomial/lists"}