{"id":18341269,"url":"https://github.com/ricardomatias/roll","last_synced_at":"2025-04-09T20:47:56.371Z","repository":{"id":35079608,"uuid":"204467143","full_name":"ricardomatias/roll","owner":"ricardomatias","description":"Let's you pick an element randomly based on a chosen probability distribution","archived":false,"fork":false,"pushed_at":"2023-01-06T02:06:29.000Z","size":1062,"stargazers_count":1,"open_issues_count":16,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-26T09:17:15.834Z","etag":null,"topics":["javascript","probability","probability-distribution","random"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ricardomatias.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-08-26T12:06:42.000Z","updated_at":"2023-03-08T03:25:33.000Z","dependencies_parsed_at":"2023-01-15T13:24:33.181Z","dependency_job_id":null,"html_url":"https://github.com/ricardomatias/roll","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ricardomatias%2Froll","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ricardomatias%2Froll/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ricardomatias%2Froll/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ricardomatias%2Froll/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ricardomatias","download_url":"https://codeload.github.com/ricardomatias/roll/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248111643,"owners_count":21049570,"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":["javascript","probability","probability-distribution","random"],"created_at":"2024-11-05T20:26:03.776Z","updated_at":"2025-04-09T20:47:56.347Z","avatar_url":"https://github.com/ricardomatias.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# roll [![Build Status](https://travis-ci.com/ricardomatias/roll.svg?branch=master)](https://travis-ci.com/ricardomatias/roll)\n\nLet's you pick an element randomly based on a chosen probability distribution\n\n```js\nimport { roll, distribute } from '@ricardomatias/roll';\nimport seedRandom from 'seed-random'; // works nicely together\n\nconst rng = seedRandom('roll');\nconst AM7 = [ 'A', 'C', 'E', 'G' ];\n\nconst equalOdds = distribute.equal(AM7.length);\nconst decreasingOdds = distribute.decreasing(AM7.length);\nconst increasingOdds = distribute.increasing(AM7);\n\nroll(AM7, equalOdds, rng); // =\u003e G\nroll(AM7, equalOdds, rng); // =\u003e C\nroll(AM7, decreasingOdds, rng); // =\u003e A\nroll(AM7, increasingOdds, rng); // =\u003e E\n```\n\n## Install\n\nUse [npm](https://npmjs.com/) to install.\n\n```sh\nnpm install @ricardomatias/roll --save\n```\n\n## Usage\n\n### roll\n\n#### roll(elements, probabilities, rng) ⇒ \u003ccode\u003eObject\u003c/code\u003e \\| \u003ccode\u003eNull\u003c/code\u003e\nPick an element randomly based on a chosen probability distribution\n\n| Param | Type | Description |\n| --- | --- | --- |\n| elements | \u003ccode\u003eArray\u003c/code\u003e |  |\n| probabilities | \u003ccode\u003eArray.\u0026lt;String\u0026gt;\u003c/code\u003e |  |\n| rng | \u003ccode\u003efunction\u003c/code\u003e | Random Number Generator |\n\n### distribute\n\n\u003cdl\u003e\n\u003cdt\u003e\u003ca href=\"#decreasing\"\u003edecreasing(k, precision)\u003c/a\u003e ⇒ \u003ccode\u003eArray.\u0026lt;String\u0026gt;\u003c/code\u003e\u003c/dt\u003e\n\u003cdd\u003e\u003cp\u003eCreates a decreasing probability distribution\u003c/p\u003e\n\u003c/dd\u003e\n\u003cdt\u003e\u003ca href=\"#increasing\"\u003eincreasing(k, precision)\u003c/a\u003e ⇒ \u003ccode\u003eArray.\u0026lt;String\u0026gt;\u003c/code\u003e\u003c/dt\u003e\n\u003cdd\u003e\u003cp\u003eCreates an increasing probability distribution\u003c/p\u003e\n\u003c/dd\u003e\n\u003cdt\u003e\u003ca href=\"#equal\"\u003eequal(k, precision)\u003c/a\u003e ⇒ \u003ccode\u003eArray.\u0026lt;String\u0026gt;\u003c/code\u003e\u003c/dt\u003e\n\u003cdd\u003e\u003cp\u003eCreates an equal probability distribution\u003c/p\u003e\n\u003c/dd\u003e\n\u003c/dl\u003e\n\n\u003ca name=\"decreasing\"\u003e\u003c/a\u003e\n\n### decreasing(k, precision) ⇒ \u003ccode\u003eArray.\u0026lt;String\u0026gt;\u003c/code\u003e\nCreates a decreasing probability distribution\n\n| Param | Type |\n| --- | --- |\n| k | \u003ccode\u003eNumber\u003c/code\u003e \\| \u003ccode\u003eArray.\u0026lt;Number\u0026gt;\u003c/code\u003e |\n| [precision] | \u003ccode\u003eNumber\u003c/code\u003e | \u003ccode\u003e3\u003c/code\u003e |\n\n\u003ca name=\"increasing\"\u003e\u003c/a\u003e\n\n### increasing(k, precision) ⇒ \u003ccode\u003eArray.\u0026lt;String\u0026gt;\u003c/code\u003e\nCreates an increasing probability distribution\n\n| Param | Type |\n| --- | --- |\n| k | \u003ccode\u003eNumber\u003c/code\u003e \\| \u003ccode\u003eArray.\u0026lt;Number\u0026gt;\u003c/code\u003e |\n| [precision] | \u003ccode\u003eNumber\u003c/code\u003e | \u003ccode\u003e3\u003c/code\u003e |\n\n\u003ca name=\"equal\"\u003e\u003c/a\u003e\n\n### equal(k, precision) ⇒ \u003ccode\u003eArray.\u0026lt;String\u0026gt;\u003c/code\u003e\nCreates an equal probability distribution\n\n| Param | Type |\n| --- | --- |\n| k | \u003ccode\u003eNumber\u003c/code\u003e \\| \u003ccode\u003eArray.\u0026lt;Number\u0026gt;\u003c/code\u003e |\n| [precision] | \u003ccode\u003eNumber\u003c/code\u003e | \u003ccode\u003e3\u003c/code\u003e |\n\n\n## License\n\nMIT, see [LICENSE.md](http://github.com/ricardomatias/ring/blob/master/LICENSE.md) for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fricardomatias%2Froll","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fricardomatias%2Froll","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fricardomatias%2Froll/lists"}