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

Entropy

Chi distribution differential entropy.

The differential entropy (in nats) for a chi random variable is

where k > 0 is the degrees of freedom and Γ and Ψ denote the gamma and digamma functions, respectively.

Usage

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

entropy( k )

Returns the differential entropy of a chi distribution with degrees of freedom k (in nats).

var v = entropy( 9.0 );
// returns ~1.052

v = entropy( 0.5 );
// returns ~0.135

If provided k <= 0, the function returns NaN.

var v = entropy( -1.0 );
// returns NaN

Examples

var randu = require( '@stdlib/random/base/randu' );
var round = require( '@stdlib/math/base/special/round' );
var entropy = require( '@stdlib/stats/base/dists/chi/entropy' );

var k;
var v;
var i;

for ( i = 0; i < 10; i++ ) {
    k = randu() * 20.0;
    v = entropy( k );
    console.log( 'k: %d, h(X,k): %d', k.toFixed( 4 ), v.toFixed( 4 ) );
}