time-to-botec/squiggle/node_modules/@stdlib/stats/base/dists/hypergeometric/README.md

Hypergeometric

Hypergeometric distribution.

Usage

var hypergeometric = require( '@stdlib/stats/base/dists/hypergeometric' );

hypergeometric

Hypergeometric distribution.

var dist = hypergeometric;
// returns {...}

The namespace contains the following distribution functions:

• cdf( x, N, K, n ): hypergeometric distribution cumulative distribution function.
• logpmf( x, N, K, n ): evaluate the natural logarithm of the probability mass function (PMF) for a hypergeometric distribution.
• pmf( x, N, K, n ): hypergeometric distribution probability mass function (PMF).
• quantile( p, N, K, n ): hypergeometric distribution quantile function.

The namespace contains the following functions for calculating distribution properties:

• kurtosis( N, K, n ): hypergeometric distribution excess kurtosis.
• mean( N, K, n ): hypergeometric distribution expected value.
• mode( N, K, n ): hypergeometric distribution mode.
• skewness( N, K, n ): hypergeometric distribution skewness.
• stdev( N, K, n ): hypergeometric distribution standard deviation.
• variance( N, K, n ): hypergeometric distribution variance.

The namespace contains a constructor function for creating a hypergeometric distribution object.

• Hypergeometric( N, K, n ): hypergeometric distribution constructor.

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

var objectKeys = require( '@stdlib/utils/keys' );
var hypergeometric = require( '@stdlib/stats/base/dists/hypergeometric' );

console.log( objectKeys( hypergeometric ) );