@stdlib/stats-base-dists-bernoulli-entropy

Entropy

Bernoulli distribution entropy.

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

where p is the success probability and q = 1 - p.

Installation

npm install @stdlib/stats-base-dists-bernoulli-entropy

Usage

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

entropy( p )

Returns the entropy of a Bernoulli distribution with success probability p (in nats).

var v = entropy( 0.1 );
// returns ~0.325

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

If provided a success probability p outside of [0,1], the function returns NaN.

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

v = entropy( 1.5 );
// returns NaN

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-bernoulli-entropy' );

var v;
var i;
var p;

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

---

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

---

License

See LICENSE.

Copyright

Copyright © 2016-2022. The Stdlib Authors.