time-to-botec/js/node_modules/@stdlib/stats/base/dists/gumbel/entropy

Entropy

Gumbel distribution differential entropy.

The differential entropy for a gumbel random variable with location μ and scale β is

where γ is the Euler–Mascheroni constant.

Usage

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

entropy( mu, beta )

Returns the differential entropy for a Gumbel distribution with location parameter mu and scale parameter beta (in nats).

var y = entropy( 2.0, 1.0 );
// returns ~1.577

y = entropy( 0.0, 1.0 );
// returns ~1.577

y = entropy( -1.0, 4.0 );
// returns ~2.964

If provided NaN as any argument, the function returns NaN.

var y = entropy( NaN, 1.0 );
// returns NaN

y = entropy( 0.0, NaN );
// returns NaN

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

var y = entropy( 0.0, 0.0 );
// returns NaN

y = entropy( 0.0, -1.0 );
// returns NaN

Examples

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

var beta;
var mu;
var y;
var i;

for ( i = 0; i < 10; i++ ) {
    mu = ( randu()*10.0 ) - 5.0;
    beta = randu() * 20.0;
    y = entropy( mu, beta );
    console.log( 'µ: %d, β: %d, h(X;µ,β): %d', mu.toFixed( 4 ), beta.toFixed( 4 ), y.toFixed( 4 ) );
}