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

Erlang

Erlang distribution.

Usage

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

erlang

Erlang distribution.

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

The namespace contains the following distribution functions:

• cdf( x, k, lambda ): Erlang distribution cumulative distribution function.
• logpdf( x, k, lambda ): evaluate the natural logarithm of the probability density function (PDF) for an Erlang distribution.
• mgf( t, k, lambda ): Erlang distribution moment-generating function (MGF).
• pdf( x, k, lambda ): Erlang distribution probability density function (PDF).
• quantile( p, k, lambda ): Erlang distribution quantile function.

The namespace contains the following functions for calculating distribution properties:

• entropy( k, lambda ): Erlang distribution differential entropy.
• kurtosis( k, lambda ): Erlang distribution excess kurtosis.
• mean( k, lambda ): Erlang distribution expected value.
• mode( k, lambda ): Erlang distribution mode.
• skewness( k, lambda ): Erlang distribution skewness.
• stdev( k, lambda ): Erlang distribution standard deviation.
• variance( k, lambda ): Erlang distribution variance.

The namespace contains a constructor function for creating an Erlang distribution object.

• Erlang( [k, lambda] ): Erlang distribution constructor.

var Erlang = require( '@stdlib/stats/base/dists/erlang' ).Erlang;

var dist = new Erlang( 2, 4.0 );

var y = dist.logpdf( 0.8 );
// returns ~-0.65

Examples

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

console.log( objectKeys( erlang ) );