Degenerate distribution entropy.
APACHE-2.0 License
Degenerate distribution entropy.
The entropy (in nats) for a degenerate random variable is
H\left( X \right) = 0
where μ
is the constant value of the distribution.
npm install @stdlib/stats-base-dists-degenerate-entropy
Alternatively,
script
tag without installation and bundlers, use the ES Module available on the esm
branch (see README).deno
branch (see README for usage intructions).umd
branch (see README).The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.
To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.
var entropy = require( '@stdlib/stats-base-dists-degenerate-entropy' );
Returns the entropy of a degenerate distribution with constant value mu
.
var v = entropy( 10.0 );
// returns 0.0
v = entropy( -0.5 );
// returns 0.0
v = entropy( NaN );
// returns NaN
var randu = require( '@stdlib/random-base-randu' );
var entropy = require( '@stdlib/stats-base-dists-degenerate-entropy' );
var mu;
var v;
var i;
for ( i = 0; i < 10; i++ ) {
mu = randu();
v = entropy( mu );
console.log( 'µ: %d, H(X;µ): %d', mu.toFixed( 4 ), v.toFixed( 4 ) );
}
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.
See LICENSE.
Copyright © 2016-2024. The Stdlib Authors.