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

Entropy

Logistic distribution differential entropy.

The differential entropy (in nats) for a logistic random variable with location μ and scale s > 0 is

Usage

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

entropy( mu, s )

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

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

y = entropy( 0.0, 1.0 );
// returns 2.0

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

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 s <= 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/logistic/entropy' );

var mu;
var s;
var y;
var i;

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