Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stdlib-js/stats-base-dists-hypergeometric
Hypergeometric distribution.
https://github.com/stdlib-js/stats-base-dists-hypergeometric
discrete dist distribution hypergeometric javascript lib library node node-js nodejs probability standard statistics stats stdlib univariate
Last synced: about 1 month ago
JSON representation
Hypergeometric distribution.
- Host: GitHub
- URL: https://github.com/stdlib-js/stats-base-dists-hypergeometric
- Owner: stdlib-js
- License: apache-2.0
- Created: 2021-06-15T17:24:57.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-11-01T11:49:45.000Z (2 months ago)
- Last Synced: 2024-11-20T01:23:26.358Z (about 2 months ago)
- Topics: discrete, dist, distribution, hypergeometric, javascript, lib, library, node, node-js, nodejs, probability, standard, statistics, stats, stdlib, univariate
- Language: JavaScript
- Homepage: https://github.com/stdlib-js/stdlib
- Size: 1.47 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!
# Hypergeometric
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Hypergeometric distribution.
## Installation
```bash
npm install @stdlib/stats-base-dists-hypergeometric
```
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 hypergeometric = require( '@stdlib/stats-base-dists-hypergeometric' );
```
#### hypergeometric
Hypergeometric distribution.
```javascript
var dist = hypergeometric;
// returns {...}
```
The namespace contains the following distribution functions:
- [`cdf( x, N, K, n )`][@stdlib/stats/base/dists/hypergeometric/cdf]: hypergeometric distribution cumulative distribution function.
- [`logpmf( x, N, K, n )`][@stdlib/stats/base/dists/hypergeometric/logpmf]: evaluate the natural logarithm of the probability mass function (PMF) for a hypergeometric distribution.
- [`pmf( x, N, K, n )`][@stdlib/stats/base/dists/hypergeometric/pmf]: hypergeometric distribution probability mass function (PMF).
- [`quantile( p, N, K, n )`][@stdlib/stats/base/dists/hypergeometric/quantile]: hypergeometric distribution quantile function.
The namespace contains the following functions for calculating distribution properties:
- [`kurtosis( N, K, n )`][@stdlib/stats/base/dists/hypergeometric/kurtosis]: hypergeometric distribution excess kurtosis.
- [`mean( N, K, n )`][@stdlib/stats/base/dists/hypergeometric/mean]: hypergeometric distribution expected value.
- [`mode( N, K, n )`][@stdlib/stats/base/dists/hypergeometric/mode]: hypergeometric distribution mode.
- [`skewness( N, K, n )`][@stdlib/stats/base/dists/hypergeometric/skewness]: hypergeometric distribution skewness.
- [`stdev( N, K, n )`][@stdlib/stats/base/dists/hypergeometric/stdev]: hypergeometric distribution standard deviation.
- [`variance( N, K, n )`][@stdlib/stats/base/dists/hypergeometric/variance]: hypergeometric distribution variance.
The namespace contains a constructor function for creating a [hypergeometric][hypergeometric-distribution] distribution object.
- [`Hypergeometric( N, K, n )`][@stdlib/stats/base/dists/hypergeometric/ctor]: hypergeometric distribution constructor.
```javascript
var Hypergeometric = require( '@stdlib/stats-base-dists-hypergeometric' ).Hypergeometric;
var dist = new Hypergeometric( 8, 2, 4 );
var y = dist.cdf( 0.5 );
// returns ~0.214
```
## Examples
```javascript
var objectKeys = require( '@stdlib/utils-keys' );
var hypergeometric = require( '@stdlib/stats-base-dists-hypergeometric' );
console.log( objectKeys( hypergeometric ) );
```
* * *
## 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].
[npm-image]: http://img.shields.io/npm/v/@stdlib/stats-base-dists-hypergeometric.svg
[npm-url]: https://npmjs.org/package/@stdlib/stats-base-dists-hypergeometric
[test-image]: https://github.com/stdlib-js/stats-base-dists-hypergeometric/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/stats-base-dists-hypergeometric/actions/workflows/test.yml?query=branch:main
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-base-dists-hypergeometric/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/stats-base-dists-hypergeometric?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/tree/deno
[deno-readme]: https://github.com/stdlib-js/stats-base-dists-hypergeometric/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/stats-base-dists-hypergeometric/tree/umd
[umd-readme]: https://github.com/stdlib-js/stats-base-dists-hypergeometric/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/stats-base-dists-hypergeometric/tree/esm
[esm-readme]: https://github.com/stdlib-js/stats-base-dists-hypergeometric/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/stats-base-dists-hypergeometric/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/stats-base-dists-hypergeometric/main/LICENSE
[hypergeometric-distribution]: https://en.wikipedia.org/wiki/Hypergeometric_distribution
[@stdlib/stats/base/dists/hypergeometric/ctor]: https://github.com/stdlib-js/stats-base-dists-hypergeometric-ctor
[@stdlib/stats/base/dists/hypergeometric/kurtosis]: https://github.com/stdlib-js/stats-base-dists-hypergeometric-kurtosis
[@stdlib/stats/base/dists/hypergeometric/mean]: https://github.com/stdlib-js/stats-base-dists-hypergeometric-mean
[@stdlib/stats/base/dists/hypergeometric/mode]: https://github.com/stdlib-js/stats-base-dists-hypergeometric-mode
[@stdlib/stats/base/dists/hypergeometric/skewness]: https://github.com/stdlib-js/stats-base-dists-hypergeometric-skewness
[@stdlib/stats/base/dists/hypergeometric/stdev]: https://github.com/stdlib-js/stats-base-dists-hypergeometric-stdev
[@stdlib/stats/base/dists/hypergeometric/variance]: https://github.com/stdlib-js/stats-base-dists-hypergeometric-variance
[@stdlib/stats/base/dists/hypergeometric/cdf]: https://github.com/stdlib-js/stats-base-dists-hypergeometric-cdf
[@stdlib/stats/base/dists/hypergeometric/logpmf]: https://github.com/stdlib-js/stats-base-dists-hypergeometric-logpmf
[@stdlib/stats/base/dists/hypergeometric/pmf]: https://github.com/stdlib-js/stats-base-dists-hypergeometric-pmf
[@stdlib/stats/base/dists/hypergeometric/quantile]: https://github.com/stdlib-js/stats-base-dists-hypergeometric-quantile