Degenerate

Usage

var Degenerate = require( '@stdlib/stats/base/dists/degenerate/ctor' );

Degenerate( [mu] )

Returns a Degenerate distribution object.

var degenerate = new Degenerate();

var mean = degenerate.mean;
// returns 0.0

By default, mu = 0.0. To create a distribution having a different mean value mu, provide a parameter value.

var degenerate = new Degenerate( 20.0 );

var mean = degenerate.mean;
// returns 20.0

degenerate

A Degenerate distribution object has the following properties and methods...

Writable Properties

degenerate.mu

Constant value of the distribution.

var degenerate = new Degenerate( 2.0 );

var mu = degenerate.mu;
// returns 2.0

degenerate.mu = -2.0;

mu = degenerate.mu;
// returns -2.0

Computed Properties

Degenerate.prototype.entropy

Returns the differential entropy.

var degenerate = new Degenerate( 4.0 );

var entropy = degenerate.entropy;
// returns 0.0

Degenerate.prototype.mean

Returns the mean.

var degenerate = new Degenerate( 10.0 );

var mu = degenerate.mean;
// returns 10.0

Degenerate.prototype.median

Returns the median.

var degenerate = new Degenerate( 10.0 );

var median = degenerate.median;
// returns 10.0

Degenerate.prototype.mode

Returns the mode.

var degenerate = new Degenerate( 10.0 );

var mode = degenerate.mode;
// returns 10.0

Degenerate.prototype.stdev

Returns the standard deviation.

var degenerate = new Degenerate( 4.0 );

var s = degenerate.stdev;
// returns 0.0

Degenerate.prototype.variance

Returns the variance.

var degenerate = new Degenerate( 4.0 );

var s2 = degenerate.variance;
// returns 0.0

Methods

Degenerate.prototype.cdf( x )

Evaluates the cumulative distribution function (CDF).

var degenerate = new Degenerate( 0.2 );

var y = degenerate.cdf( 0.5 );
// returns 1.0

Degenerate.prototype.logcdf( x )

Evaluates the natural logarithm of the cumulative distribution function (logCDF).

var degenerate = new Degenerate( 0.2 );

var y = degenerate.logcdf( 0.5 );
// returns 0.0

Degenerate.prototype.logpdf( x )

Evaluates the natural logarithm of the probability density function (logPDF).

var degenerate = new Degenerate( 10.0 );

var y = degenerate.logpdf( 9.0 );
// returns -Infinity

y = degenerate.logpdf( 10.0 );
// returns Infinity

Degenerate.prototype.logpmf( x )

Evaluates the natural logarithm of the probability mass function (logPMF).

var degenerate = new Degenerate( 10.0 );

var y = degenerate.logpmf( 9.0 );
// returns -Infinity

y = degenerate.logpmf( 10.0 );
// returns 0.0

Degenerate.prototype.mgf( t )

Evaluates the moment-generating function (MGF).

var degenerate = new Degenerate( 10.0 );

var y = degenerate.mgf( 0.1 );
// returns ~2.718

Degenerate.prototype.pdf( x )

Evaluates the probability density function (PDF).

var degenerate = new Degenerate( 10.0 );

var y = degenerate.pdf( 2.0 );
// returns 0.0

y = degenerate.pdf( 10.0 );
// returns +Infinity

Degenerate.prototype.pmf( x )

Evaluates the probability mass function (PMF).

var degenerate = new Degenerate( 10.0 );

var y = degenerate.pmf( 2.0 );
// returns 0.0

y = degenerate.pmf( 10.0 );
// returns 1.0

Degenerate.prototype.quantile( p )

Evaluates the quantile function at probability p.

var degenerate = new Degenerate( 10.0 );

var y = degenerate.quantile( 0.5 );
// returns 10.0

y = degenerate.quantile( 0.9 );
// returns 10.0