Entropy
The entropy (in nats) for a binomial random variable is
where n is the number of trials and p is the success probability.
Usage
var entropy = require( '@stdlib/stats/base/dists/binomial/entropy' );
entropy( n, p )
Returns the entropy of a binomial distribution with number of trials n and success probability p (in nats).
var v = entropy( 20, 0.1 );
// returns ~1.667
v = entropy( 50, 0.5 );
// returns ~2.682
If provided NaN as any argument, the function returns NaN.
var v = entropy( NaN, 0.5 );
// returns NaN
v = entropy( 20, NaN );
// returns NaN
If provided a number of trials n which is not a nonnegative integer, the function returns NaN.
var v = entropy( 1.5, 0.5 );
// returns NaN
v = entropy( -2.0, 0.5 );
// returns NaN
If provided a success probability p outside of [0,1], the function returns NaN.
var v = entropy( 20, -1.0 );
// returns NaN
v = entropy( 20, 1.5 );
// 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/binomial/entropy' );
var v;
var i;
var n;
var p;
for ( i = 0; i < 10; i++ ) {
n = round( randu() * 100.0 );
p = randu();
v = entropy( n, p );
console.log( 'n: %d, p: %d, H(X;n,p): %d', n, p.toFixed( 4 ), v.toFixed( 4 ) );
}