https://github.com/stdlib-js/stats-base-dists-hypergeometric-quantile
Hypergeometric distribution quantile function.
https://github.com/stdlib-js/stats-base-dists-hypergeometric-quantile
cdf combinatorics discrete dist distribution hypergeometric inverse javascript node node-js nodejs probability statistics stats stdlib univariate
Last synced: 8 months ago
JSON representation
Hypergeometric distribution quantile function.
- Host: GitHub
- URL: https://github.com/stdlib-js/stats-base-dists-hypergeometric-quantile
- Owner: stdlib-js
- License: apache-2.0
- Created: 2021-06-15T17:24:48.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2025-06-30T01:00:54.000Z (11 months ago)
- Last Synced: 2025-07-31T06:25:58.986Z (10 months ago)
- Topics: cdf, combinatorics, discrete, dist, distribution, hypergeometric, inverse, javascript, node, node-js, nodejs, probability, statistics, stats, stdlib, univariate
- Language: JavaScript
- Homepage: https://github.com/stdlib-js/stdlib
- Size: 1.1 MB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Security: SECURITY.md
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!
# Quantile Function
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> [Hypergeometric][hypergeometric-distribution] distribution [quantile function][quantile-function].
Imagine a scenario with a population of size `N`, of which a subpopulation of size `K` can be considered successes. We draw `n` observations from the total population. Defining the random variable `X` as the number of successes in the `n` draws, `X` is said to follow a [hypergeometric distribution][hypergeometric-distribution].
The [quantile function][quantile-function] for a [hypergeometric][hypergeometric-distribution] random variable returns for any `0 <= p <= 1` the value `x` for which
```math
F(x-1;N,K,n) < p \le F(x;N,K,n)
```
where `F` is the cumulative distribution function (CDF) of a hypergeometric random variable with parameters `N`, `K` and `n`, where `N` is the population size, `K` is the subpopulation size, and `n` is the number of draws.
## Installation
```bash
npm install @stdlib/stats-base-dists-hypergeometric-quantile
```
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]).
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 quantile = require( '@stdlib/stats-base-dists-hypergeometric-quantile' );
```
#### quantile( p, N, K, n )
Evaluates the [quantile function][quantile-function] for a [hypergeometric][hypergeometric-distribution] distribution with parameters `N` (population size), `K` (subpopulation size), and `n` (number of draws).
```javascript
var y = quantile( 0.5, 8, 4, 2 );
// returns 1
y = quantile( 0.9, 120, 80, 20 );
// returns 16
y = quantile( 0.0, 120, 80, 50 );
// returns 10
y = quantile( 0.0, 8, 4, 2 );
// returns 0
```
If provided `NaN` as any argument, the function returns `NaN`.
```javascript
var y = quantile( NaN, 10, 5, 2 );
// returns NaN
y = quantile( 0.4, NaN, 5, 2 );
// returns NaN
y = quantile( 0.4, 10, NaN, 2 );
// returns NaN
y = quantile( 0.4, 10, 5, NaN );
// returns NaN
```
If provided a population size `N`, subpopulation size `K` or draws `n` which is not a nonnegative integer, the function returns `NaN`.
```javascript
var y = quantile( 0.2, 6.5, 5, 2 );
// returns NaN
y = quantile( 0.2, 5, 1.5, 2 );
// returns NaN
y = quantile( 0.2, 10, 5, -2.0 );
// returns NaN
```
If the number of draws `n` or the subpopulation size `K` exceed population size `N`, the function returns `NaN`.
```javascript
var y = quantile( 0.2, 10, 5, 12 );
// returns NaN
y = quantile( 0.2, 8, 3, 9 );
// returns NaN
```
#### quantile.factory( N, K, n )
Returns a function for evaluating the [quantile function][quantile-function] for a [hypergeometric ][hypergeometric-distribution] distribution with parameters `N` (population size), `K` (subpopulation size), and `n` (number of draws).
```javascript
var myquantile = quantile.factory( 100, 20, 10 );
var y = myquantile( 0.2 );
// returns 1
y = myquantile( 0.9 );
// returns 4
```
## Examples
```javascript
var randu = require( '@stdlib/random-base-randu' );
var round = require( '@stdlib/math-base-special-round' );
var quantile = require( '@stdlib/stats-base-dists-hypergeometric-quantile' );
var i;
var N;
var K;
var n;
var p;
var y;
for ( i = 0; i < 10; i++ ) {
p = randu();
N = round( randu() * 20 );
K = round( randu() * N );
n = round( randu() * K );
y = quantile( p, N, K, n );
console.log( 'p: %d, N: %d, K: %d, n: %d, Q(p;N,K,n): %d', p.toFixed( 4 ), N, K, n, y.toFixed( 4 ) );
}
```
* * *
## 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-2025. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/stats-base-dists-hypergeometric-quantile.svg
[npm-url]: https://npmjs.org/package/@stdlib/stats-base-dists-hypergeometric-quantile
[test-image]: https://github.com/stdlib-js/stats-base-dists-hypergeometric-quantile/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/stats-base-dists-hypergeometric-quantile/actions/workflows/test.yml?query=branch:main
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-base-dists-hypergeometric-quantile/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/stats-base-dists-hypergeometric-quantile?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/stats-base-dists-hypergeometric-quantile/tree/deno
[deno-readme]: https://github.com/stdlib-js/stats-base-dists-hypergeometric-quantile/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/stats-base-dists-hypergeometric-quantile/tree/umd
[umd-readme]: https://github.com/stdlib-js/stats-base-dists-hypergeometric-quantile/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/stats-base-dists-hypergeometric-quantile/tree/esm
[esm-readme]: https://github.com/stdlib-js/stats-base-dists-hypergeometric-quantile/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/stats-base-dists-hypergeometric-quantile/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/stats-base-dists-hypergeometric-quantile/main/LICENSE
[hypergeometric-distribution]: https://en.wikipedia.org/wiki/hypergeometric_distribution
[quantile-function]: https://en.wikipedia.org/wiki/Quantile_function