{"id":24918008,"url":"https://github.com/stdlib-js/random-base-t","last_synced_at":"2025-04-09T16:23:28.266Z","repository":{"id":41454297,"uuid":"377257297","full_name":"stdlib-js/random-base-t","owner":"stdlib-js","description":"Student's t-distributed pseudorandom numbers.","archived":false,"fork":false,"pushed_at":"2025-03-24T01:06:55.000Z","size":3136,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-07T21:06:30.369Z","etag":null,"topics":["distribution","gaussian","javascript","math","mathematics","node","node-js","nodejs","normal","prng","pseudorandom","rand","randn","random","rng","statistics","stats","stdlib","student","t"],"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:20:17.000Z","updated_at":"2025-03-24T00:48:26.000Z","dependencies_parsed_at":"2024-01-12T07:09:45.843Z","dependency_job_id":"e442cf11-e53b-449f-bf8d-e65c1cc316d3","html_url":"https://github.com/stdlib-js/random-base-t","commit_stats":{"total_commits":34,"total_committers":1,"mean_commits":34.0,"dds":0.0,"last_synced_commit":"d564db98ebb9c4ed6ffd557b8d2ca15c9ae8be63"},"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-base-t","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Frandom-base-t/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Frandom-base-t/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Frandom-base-t/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stdlib-js","download_url":"https://codeload.github.com/stdlib-js/random-base-t/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248065852,"owners_count":21041979,"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":["distribution","gaussian","javascript","math","mathematics","node","node-js","nodejs","normal","prng","pseudorandom","rand","randn","random","rng","statistics","stats","stdlib","student","t"],"created_at":"2025-02-02T09:17:19.725Z","updated_at":"2025-04-09T16:23:28.259Z","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# Student's t 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 [Student's t][t]-distributed pseudorandom numbers.\n\n\u003csection class=\"installation\"\u003e\n\n## Installation\n\n```bash\nnpm install @stdlib/random-base-t\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 t = require( '@stdlib/random-base-t' );\n```\n\n#### t( v )\n\nReturns a pseudorandom number drawn from a [Student's t][t]-distribution with degrees of freedom `v`.\n\n```javascript\nvar r = t( 2.4 );\n// returns \u003cnumber\u003e\n```\n\nIf `v \u003c= 0` or `v` is `NaN`, the function returns `NaN`.\n\n```javascript\nvar r = t( -2.0 );\n// returns NaN\n\nr = t( NaN );\n// returns NaN\n```\n\n#### t.factory( \\[v, ]\\[options] )\n\nReturns a pseudorandom number generator (PRNG) for generating pseudorandom numbers drawn from a [Student's t][t]-distribution.\n\n```javascript\nvar rand = t.factory();\n\nvar r = rand( 5.0 );\n// returns \u003cnumber\u003e\n```\n\nIf provided `v`, the returned generator returns random variates from the specified distribution.\n\n```javascript\nvar rand = t.factory( 1.0 );\n\nvar r = rand();\n// returns \u003cnumber\u003e\n\nr = rand();\n// returns \u003cnumber\u003e\n```\n\nIf not provided `v`, the returned generator requires that `v` be provided at each invocation.\n\n```javascript\nvar rand = t.factory();\n\nvar r = rand( 4.0 );\n// returns \u003cnumber\u003e\n\nr = rand( 3.14 );\n// returns \u003cnumber\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 pseudorandom number generator, 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 generator has exclusive control over its internal state. Default: `true`.\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 rand = t.factory({\n    'prng': minstd.normalized\n});\n\nvar r = rand( 3.0 );\n// returns \u003cnumber\u003e\n```\n\nTo seed a pseudorandom number generator, set the `seed` option.\n\n```javascript\nvar rand1 = t.factory({\n    'seed': 12345\n});\n\nvar r1 = rand1( 3.0 );\n// returns \u003cnumber\u003e\n\nvar rand2 = t.factory( 3.0, {\n    'seed': 12345\n});\n\nvar r2 = rand2();\n// returns \u003cnumber\u003e\n\nvar bool = ( r1 === r2 );\n// returns true\n```\n\nTo return a generator having a specific initial state, set the generator `state` option.\n\n```javascript\nvar rand;\nvar bool;\nvar r;\nvar i;\n\n// Generate pseudorandom numbers, thus progressing the generator state:\nfor ( i = 0; i \u003c 1000; i++ ) {\n    r = t( 3.0 );\n}\n\n// Create a new PRNG initialized to the current state of `t`:\nrand = t.factory({\n    'state': t.state\n});\n\n// Test that the generated pseudorandom numbers are the same:\nbool = ( rand( 3.0 ) === t( 3.0 ) );\n// returns true\n```\n\n#### t.NAME\n\nThe generator name.\n\n```javascript\nvar str = t.NAME;\n// returns 't'\n```\n\n#### t.PRNG\n\nThe underlying pseudorandom number generator.\n\n```javascript\nvar prng = t.PRNG;\n// returns \u003cFunction\u003e\n```\n\n#### t.seed\n\nThe value used to seed `t()`.\n\n```javascript\nvar rand;\nvar r;\nvar i;\n\n// Generate pseudorandom values...\nfor ( i = 0; i \u003c 100; i++ ) {\n    r = t( 2.0 );\n}\n\n// Generate the same pseudorandom values...\nrand = t.factory( 2.0, {\n    'seed': t.seed\n});\nfor ( i = 0; i \u003c 100; i++ ) {\n    r = rand();\n}\n```\n\nIf provided a PRNG for uniformly distributed numbers, this value is `null`.\n\n\u003c!-- eslint-disable stdlib/no-builtin-math --\u003e\n\n```javascript\nvar rand = t.factory({\n    'prng': Math.random\n});\n\nvar seed = rand.seed;\n// returns null\n```\n\n#### t.seedLength\n\nLength of generator seed.\n\n```javascript\nvar len = t.seedLength;\n// returns \u003cnumber\u003e\n```\n\nIf provided a PRNG for uniformly distributed numbers, this value is `null`.\n\n\u003c!-- eslint-disable stdlib/no-builtin-math --\u003e\n\n```javascript\nvar rand = t.factory({\n    'prng': Math.random\n});\n\nvar len = rand.seedLength;\n// returns null\n```\n\n#### t.state\n\nWritable property for getting and setting the generator state.\n\n```javascript\nvar r = t( 10.0 );\n// returns \u003cnumber\u003e\n\nr = t( 10.0 );\n// returns \u003cnumber\u003e\n\n// ...\n\n// Get a copy of the current state:\nvar state = t.state;\n// returns \u003cUint32Array\u003e\n\nr = t( 10.0 );\n// returns \u003cnumber\u003e\n\nr = t( 10.0 );\n// returns \u003cnumber\u003e\n\n// Reset the state:\nt.state = state;\n\n// Replay the last two pseudorandom numbers:\nr = t( 10.0 );\n// returns \u003cnumber\u003e\n\nr = t( 10.0 );\n// returns \u003cnumber\u003e\n\n// ...\n```\n\nIf provided a PRNG for uniformly distributed numbers, this value is `null`.\n\n\u003c!-- eslint-disable stdlib/no-builtin-math --\u003e\n\n```javascript\nvar rand = t.factory({\n    'prng': Math.random\n});\n\nvar state = rand.state;\n// returns null\n```\n\n#### t.stateLength\n\nLength of generator state.\n\n```javascript\nvar len = t.stateLength;\n// returns \u003cnumber\u003e\n```\n\nIf provided a PRNG for uniformly distributed numbers, this value is `null`.\n\n\u003c!-- eslint-disable stdlib/no-builtin-math --\u003e\n\n```javascript\nvar rand = t.factory({\n    'prng': Math.random\n});\n\nvar len = rand.stateLength;\n// returns null\n```\n\n#### t.byteLength\n\nSize (in bytes) of generator state.\n\n```javascript\nvar sz = t.byteLength;\n// returns \u003cnumber\u003e\n```\n\nIf provided a PRNG for uniformly distributed numbers, this value is `null`.\n\n\u003c!-- eslint-disable stdlib/no-builtin-math --\u003e\n\n```javascript\nvar rand = t.factory({\n    'prng': Math.random\n});\n\nvar sz = rand.byteLength;\n// returns null\n```\n\n#### t.toJSON()\n\nSerializes the pseudorandom number generator as a JSON object.\n\n```javascript\nvar o = t.toJSON();\n// returns { 'type': 'PRNG', 'name': '...', 'state': {...}, 'params': [] }\n```\n\nIf provided a PRNG for uniformly distributed numbers, this method returns `null`.\n\n\u003c!-- eslint-disable stdlib/no-builtin-math --\u003e\n\n```javascript\nvar rand = t.factory({\n    'prng': Math.random\n});\n\nvar o = rand.toJSON();\n// returns null\n```\n\n\u003c/section\u003e\n\n\u003c!-- /.usage --\u003e\n\n\u003csection class=\"notes\"\u003e\n\n## Notes\n\n-   The `r` parameter is the shape parameter of the gamma mixing distribution when expressing the negative binomial distribution as a Gamma–Poisson mixture. Accordingly, `r` is **not** required to be an integer value.\n-   If PRNG state is \"shared\" (meaning a state array was provided during PRNG creation and **not** copied) and one sets the generator state to a state array having a different length, the 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.\n-   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).\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 t = require( '@stdlib/random-base-t' );\n\nvar seed;\nvar rand;\nvar i;\n\n// Generate pseudorandom numbers...\nfor ( i = 0; i \u003c 100; i++ ) {\n    console.log( t( 1.0 ) );\n}\n\n// Create a new pseudorandom number generator...\nseed = 1234;\nrand = t.factory( 5.0, {\n    'seed': seed\n});\nfor ( i = 0; i \u003c 100; i++ ) {\n    console.log( rand() );\n}\n\n// Create another pseudorandom number generator using a previous seed...\nrand = t.factory( 1.0, {\n    'seed': t.seed\n});\nfor ( i = 0; i \u003c 100; i++ ) {\n    console.log( rand() );\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-array/t`][@stdlib/random/array/t]\u003c/span\u003e\u003cspan class=\"delimiter\"\u003e: \u003c/span\u003e\u003cspan class=\"description\"\u003ecreate an array containing pseudorandom numbers drawn from a Student's t-distribution.\u003c/span\u003e\n-   \u003cspan class=\"package-name\"\u003e[`@stdlib/random-iter/t`][@stdlib/random/iter/t]\u003c/span\u003e\u003cspan class=\"delimiter\"\u003e: \u003c/span\u003e\u003cspan class=\"description\"\u003ecreate an iterator for generating pseudorandom numbers drawn from a Student's t distribution.\u003c/span\u003e\n-   \u003cspan class=\"package-name\"\u003e[`@stdlib/random-streams/t`][@stdlib/random/streams/t]\u003c/span\u003e\u003cspan class=\"delimiter\"\u003e: \u003c/span\u003e\u003cspan class=\"description\"\u003ecreate a readable stream for generating pseudorandom numbers drawn from a Student's t distribution.\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-2025. 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-base-t.svg\n[npm-url]: https://npmjs.org/package/@stdlib/random-base-t\n\n[test-image]: https://github.com/stdlib-js/random-base-t/actions/workflows/test.yml/badge.svg?branch=main\n[test-url]: https://github.com/stdlib-js/random-base-t/actions/workflows/test.yml?query=branch:main\n\n[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/random-base-t/main.svg\n[coverage-url]: https://codecov.io/github/stdlib-js/random-base-t?branch=main\n\n\u003c!--\n\n[dependencies-image]: https://img.shields.io/david/stdlib-js/random-base-t.svg\n[dependencies-url]: https://david-dm.org/stdlib-js/random-base-t/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-base-t/tree/deno\n[deno-readme]: https://github.com/stdlib-js/random-base-t/blob/deno/README.md\n[umd-url]: https://github.com/stdlib-js/random-base-t/tree/umd\n[umd-readme]: https://github.com/stdlib-js/random-base-t/blob/umd/README.md\n[esm-url]: https://github.com/stdlib-js/random-base-t/tree/esm\n[esm-readme]: https://github.com/stdlib-js/random-base-t/blob/esm/README.md\n[branches-url]: https://github.com/stdlib-js/random-base-t/blob/main/branches.md\n\n[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/random-base-t/main/LICENSE\n\n[t]: https://en.wikipedia.org/wiki/Student%27s_t-distribution\n\n[@stdlib/array/uint32]: https://github.com/stdlib-js/array-uint32\n\n\u003c!-- \u003crelated-links\u003e --\u003e\n\n[@stdlib/random/array/t]: https://github.com/stdlib-js/random-array-t\n\n[@stdlib/random/iter/t]: https://github.com/stdlib-js/random-iter-t\n\n[@stdlib/random/streams/t]: https://github.com/stdlib-js/random-streams-t\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-base-t","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstdlib-js%2Frandom-base-t","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstdlib-js%2Frandom-base-t/lists"}