@stdlib/stats-base-dists-weibull-entropy
v0.3.1
Published
Weibull distribution differential entropy.
Readme
Entropy
Weibull distribution differential entropy.
The differential entropy (in nats) for a Weibull random variable is
where λ > 0 is the shape parameter, k > 0 is the scale parameter, and Ɣ denotes the Euler–Mascheroni constant.
Installation
npm install @stdlib/stats-base-dists-weibull-entropyUsage
var entropy = require( '@stdlib/stats-base-dists-weibull-entropy' );entropy( k, lambda )
Returns the differential entropy of a Weibull distribution with shape parameter k and scale parameter lambda (in nats).
var v = entropy( 1.0, 1.0 );
// returns 1.0
v = entropy( 4.0, 12.0 );
// returns ~2.532
v = entropy( 8.0, 2.0 );
// returns ~0.119If provided NaN as any argument, the function returns NaN.
var v = entropy( NaN, 2.0 );
// returns NaN
v = entropy( 2.0, NaN );
// returns NaNIf provided k <= 0, the function returns NaN.
var v = entropy( 0.0, 1.0 );
// returns NaN
v = entropy( -1.0, 1.0 );
// returns NaNIf provided lambda <= 0, the function returns NaN.
var v = entropy( 1.0, 0.0 );
// returns NaN
v = entropy( 1.0, -1.0 );
// returns NaNExamples
var uniform = require( '@stdlib/random-array-uniform' );
var logEachMap = require( '@stdlib/console-log-each-map' );
var EPS = require( '@stdlib/constants-float64-eps' );
var entropy = require( '@stdlib/stats-base-dists-weibull-entropy' );
var opts = {
'dtype': 'float64'
};
var lambda = uniform( 10, EPS, 10.0, opts );
var k = uniform( 10, EPS, 10.0, opts );
logEachMap( 'k: %0.4f, λ: %0.4f, h(X;k,λ): %0.4f', k, lambda, entropy );C APIs
Usage
#include "stdlib/stats/base/dists/weibull/entropy.h"stdlib_base_dists_weibull_entropy( k, lambda )
Returns the differential entropy of a Weibull distribution.
double out = stdlib_base_dists_weibull_entropy( 4.0, 12.0 );
// returns ~2.532The function accepts the following arguments:
- k:
[in] doubleshape parameter. - lambda:
[in] doublescale parameter.
double stdlib_base_dists_weibull_entropy( const double k, const double lambda );Examples
#include "stdlib/stats/base/dists/weibull/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 lambda;
double k;
double y;
int i;
for ( i = 0; i < 25; i++ ) {
k = random_uniform( 0.0, 10.0 );
lambda = random_uniform( 0.0, 10.0 );
y = stdlib_base_dists_weibull_entropy( k, lambda );
printf( "k: %lf, λ: %lf, h(X;k,λ): %lf\n", k, lambda, 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.
