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

Binomial

Binomial distribution.

Usage

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

binomial

Binomial distribution.

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

The namespace contains the following distribution functions:

• cdf( x, n, p ): binomial distribution cumulative distribution function.
• logpmf( x, n, p ): evaluate the natural logarithm of the probability mass function (PMF) for a binomial distribution.
• mgf( t, n, p ): binomial distribution moment-generating function (MGF).
• pmf( x, n, p ): binomial distribution probability mass function (PMF).
• quantile( r, n, p ): binomial distribution quantile function.

The namespace contains the following functions for calculating distribution properties:

• entropy( n, p ): binomial distribution entropy.
• kurtosis( n, p ): binomial distribution excess kurtosis.
• mean( n, p ): binomial distribution expected value.
• median( n, p ): binomial distribution median.
• mode( n, p ): binomial distribution mode.
• skewness( n, p ): binomial distribution skewness.
• stdev( n, p ): binomial distribution standard deviation.
• variance( n, p ): binomial distribution variance.

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

• Binomial( [n, p] ): binomial distribution constructor.

var Binomial = require( '@stdlib/stats/base/dists/binomial' ).Binomial;
var dist = new Binomial( 10, 0.4 );

var mu = dist.mean;
// returns 4

Examples

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

console.log( objectKeys( binomial ) );