Entropy

Rayleigh distribution differential entropy.

The differential entropy (in nats) for a Rayleigh random variable is

where σ > 0 is the scale parameter.

Installation

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

Usage

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

entropy( sigma )

Returns the differential entropy of a Rayleigh distribution with scale sigma (in nats).

var y = entropy( 9.0 );
// returns ~3.139

y = entropy( 3.5 );
// returns ~2.195

If provided sigma < 0, the function returns NaN.

var y = 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-rayleigh-entropy' );

var sigma;
var y;
var i;

for ( i = 0; i < 10; i++ ) {
    sigma = randu() * 20.0;
    y = entropy( sigma );
    console.log( 'sigma: %d, h(X,v): %d', sigma.toFixed( 4 ), y.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-2024. The Stdlib Authors.