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
Pareto (Type I) distribution differential entropy.
The differential entropy (in nats) for a Pareto (Type I) random variable is
where α > 0 is the shape parameter and β > 0 is the scale parameter.
Installation
npm install @stdlib/stats-base-dists-pareto-type1-entropy
Usage
var entropy = require( '@stdlib/stats-base-dists-pareto-type1-entropy' );
entropy( alpha, beta )
Returns the differential entropy of a Pareto (Type I) distribution with parameters shape parameter alpha and scale parameter beta (in nats).
var v = entropy( 2.0, 1.0 );
// returns ~0.807
v = entropy( 4.0, 12.0 );
// returns ~2.349
v = entropy( 8.0, 2.0 );
// returns ~-0.261
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 uniform = require( '@stdlib/random-array-uniform' );
var EPS = require( '@stdlib/constants-float64-eps' );
var logEachMap = require( '@stdlib/console-log-each-map' );
var entropy = require( '@stdlib/stats-base-dists-pareto-type1-entropy' );
var opts = {
'dtype': 'float64'
};
var alpha = uniform( 10, EPS, 10.0, opts );
var beta = uniform( 10, EPS, 10.0, opts );
logEachMap( 'α: %0.4f, β: %0.4f, h(X;α,β): %0.4f', alpha, beta, entropy );
C APIs
Usage
#include "stdlib/stats/base/dists/pareto-type1/entropy.h"
stdlib_base_dists_pareto_type1_entropy( alpha, beta )
Returns the differential entropy of a Pareto (Type I) distribution.
double out = stdlib_base_dists_pareto_type1_entropy( 4.0, 12.0 );
// returns ~2.349
The function accepts the following arguments:
- alpha:
[in] doubleshape parameter. - beta:
[in] doublescale parameter.
double stdlib_base_dists_pareto_type1_entropy( const double alpha, const double beta );
Examples
#include "stdlib/stats/base/dists/pareto-type1/entropy.h"
#include <stdlib.h>
#include <stdio.h>
static double random_uniform( const double min, const double max ) {
double v = (double)rand() / ( (double)RAND_MAX + 1.0 );
return min + ( v*(max-min) );
}
int main( void ) {
double alpha;
double beta;
double y;
int i;
for ( i = 0; i < 25; i++ ) {
alpha = random_uniform( 0.0, 10.0 );
beta = random_uniform( 0.0, 10.0 );
y = stdlib_base_dists_pareto_type1_entropy( alpha, beta );
printf( "α: %lf, β: %lf, h(X;α,β): %lf\n", alpha, beta, y );
}
}
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-2026. The Stdlib Authors.