@stdlib/stats-base-dists-gamma-entropy
TypeScript icon, indicating that this package has built-in type declarations

0.1.0 • Public • Published
About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

Entropy

NPM version Build Status Coverage Status

Gamma distribution differential entropy.

The differential entropy (in nats) for a gamma random variable with shape parameter α > 0 and rate parameter β > 0 is

Differential entropy for a gamma distribution.

where Γ and Ψ denote the gamma and digamma function, respectively.

Installation

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

Usage

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

entropy( alpha, beta )

Returns the differential entropy of a gamma distribution with shape parameter alpha and rate parameter beta (in nats).

var v = entropy( 1.0, 1.0 );
// returns 1.0

v = entropy( 4.0, 12.0 );
// returns ~-0.462

v = entropy( 8.0, 2.0 );
// returns ~1.723

If provided NaN as any argument, the function returns NaN.

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

v = entropy( 2.0, NaN );
// returns NaN

If provided alpha <= 0, the function returns NaN.

var v = entropy( 0.0, 1.0 );
// returns NaN

v = entropy( -1.0, 1.0 );
// returns NaN

If provided beta <= 0, the function returns NaN.

var v = entropy( 1.0, 0.0 );
// returns NaN

v = entropy( 1.0, -1.0 );
// returns NaN

Examples

var randu = require( '@stdlib/random-base-randu' );
var EPS = require( '@stdlib/constants-float64-eps' );
var entropy = require( '@stdlib/stats-base-dists-gamma-entropy' );

var alpha;
var beta;
var v;
var i;

for ( i = 0; i < 10; i++ ) {
    alpha = ( randu()*10.0 ) + EPS;
    beta = ( randu()*10.0 ) + EPS;
    v = entropy( alpha, beta );
    console.log( 'α: %d, β: %d, h(X;α,β): %d', alpha.toFixed( 4 ), beta.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

Chat


License

See LICENSE.

Copyright © 2016-2023. The Stdlib Authors.

Package Sidebar

Install

npm i @stdlib/stats-base-dists-gamma-entropy

Homepage

stdlib.io

Weekly Downloads

41

Version

0.1.0

License

Apache-2.0

Unpacked Size

38.9 kB

Total Files

12

Last publish

Collaborators

  • stdlib-bot
  • kgryte
  • planeshifter
  • rreusser