time-to-botec/squiggle/node_modules/@stdlib/stats/base/dists/degenerate/entropy

Entropy

Degenerate distribution entropy.

The entropy (in nats) for a degenerate random variable is

where μ is the constant value of the distribution.

Usage

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

entropy( mu )

Returns the entropy of a degenerate distribution with constant value mu.

var v = entropy( 10.0 );
// returns 0.0

v = entropy( -0.5 );
// returns 0.0

v = entropy( NaN );
// returns NaN

Examples

var randu = require( '@stdlib/random/base/randu' );
var entropy = require( '@stdlib/stats/base/dists/degenerate/entropy' );

var mu;
var v;
var i;

for ( i = 0; i < 10; i++ ) {
    mu = randu();
    v = entropy( mu );
    console.log( 'µ: %d, H(X;µ): %d', mu.toFixed( 4 ), v.toFixed( 4 ) );
}