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

Geometric

Geometric distribution.

Usage

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

geometric

Geometric distribution.

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

The namespace contains the following distribution functions:

• cdf( x, p ): geometric distribution cumulative distribution function.
• logcdf( x, p ): geometric distribution logarithm of cumulative distribution function.
• logpmf( x, p ): geometric distribution logarithm of probability mass function (PMF).
• mgf( t, p ): geometric distribution moment-generating function (MGF).
• pmf( x, p ): geometric distribution probability mass function (PMF).
• quantile( r, p ): geometric distribution quantile function.

The namespace contains the following functions for calculating distribution properties:

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

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

• Geometric( [p] ): geometric distribution constructor.

var Geometric = require( '@stdlib/stats/base/dists/geometric' ).Geometric;

var dist = new Geometric( 0.2 );

var y = dist.logpmf( 3.0 );
// returns ~-2.279

y = dist.logpmf( 2.3 );
// returns -Infinity

Examples

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

console.log( objectKeys( geometric ) );