@stdlib/stats-base-dists-discrete-uniform-entropy
v0.3.0TypeScript
Discrete uniform distribution entropy.
0/weekUpdated 1 weeks agoApache-2.0Unpacked: 43.4 KB
Published by The Stdlib Authors
npm install @stdlib/stats-base-dists-discrete-uniform-entropyWe 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!
About stdlib...
Entropy
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> [Discrete uniform][discrete-uniform-distribution] distribution [entropy][entropy].
The [entropy][entropy] (in [nats][nats]) for a [discrete uniform][discrete-uniform-distribution] random variable is
where a is the minimum support and b is the maximum support. The parameters must satisfy a < b.
Installation
``bash`
npm install @stdlib/stats-base-dists-discrete-uniform-entropy
Usage
`javascript`
var entropy = require( '@stdlib/stats-base-dists-discrete-uniform-entropy' );
#### entropy( a, b )
Returns the [entropy][entropy] of a [discrete uniform][discrete-uniform-distribution] distribution with minimum support a and maximum support b (in [nats][nats]).
`javascript
var v = entropy( 0, 1 );
// returns ~0.693
v = entropy( 4, 12 );
// returns ~2.197
v = entropy( 2, 8 );
// returns ~1.946
`
If a or b is not an integer value, the function returns NaN.
`javascript
var v = entropy( 0.1, 2 );
// returns NaN
v = entropy( 0, 2.2 );
// returns NaN
v = entropy( NaN, 2 );
// returns NaN
v = entropy( 2, NaN );
// returns NaN
`
If provided a > b, the function returns NaN.
`javascript
var v = entropy( 3, 2 );
// returns NaN
v = entropy( -1, -2 );
// returns NaN
`
Examples
`javascript
var randint = require( '@stdlib/random-base-discrete-uniform' );
var entropy = require( '@stdlib/stats-base-dists-discrete-uniform-entropy' );
var randa = randint.factory( 0, 10 );
var randb = randint.factory();
var a;
var b;
var v;
var i;
for ( i = 0; i < 10; i++ ) {
a = randa();
b = randb( a, a+randa() );
v = entropy( a, b );
console.log( 'a: %d, b: %d, H(X;a,b): %d', a.toFixed( 4 ), b.toFixed( 4 ), v.toFixed( 4 ) );
}
`
*
C APIs
$3
`c`
#include "stdlib/stats/base/dists/discrete-uniform/entropy.h"
#### stdlib_base_dists_discrete_uniform_entropy( a, b )
Returns the [entropy][entropy] of a [discrete uniform][discrete-uniform-distribution] distribution with minimum support a and maximum support b (in [nats][nats]).
`c`
double out = stdlib_base_dists_discrete_uniform_entropy( 0, 1 );
// returns ~0.693
The function accepts the following arguments:
- a: [in] int32_t minimum support.[in] int32_t
- b: maximum support.
`c`
double stdlib_base_dists_discrete_uniform_entropy( const int32_t a, const int32_t b );
$3
`c
#include "stdlib/stats/base/dists/discrete-uniform/entropy.h"
#include "stdlib/math/base/special/round.h"
#include
#include
#include
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 ) {
int32_t a;
int32_t b;
double y;
int i;
for ( i = 0; i < 10; i++ ) {
a = stdlib_base_round( random_uniform( 0.0, 10.0 ) );
b = stdlib_base_round( random_uniform( 0.0, 10.0 ) ) + a;
y = stdlib_base_dists_discrete_uniform_entropy( a, b );
printf( "a: %d, b: %d, H(X;a,b): %lf\n", a, b, y );
}
}
`
*
Notice
This package is part of [stdlib][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][stdlib], see the main project [repository][stdlib].
#### Community
[![Chat][chat-image]][chat-url]
---
License
See [LICENSE][stdlib-license].
Copyright
Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/stats-base-dists-discrete-uniform-entropy.svg
[npm-url]: https://npmjs.org/package/@stdlib/stats-base-dists-discrete-uniform-entropy
[test-image]: https://github.com/stdlib-js/stats-base-dists-discrete-uniform-entropy/actions/workflows/test.yml/badge.svg?branch=v0.3.0
[test-url]: https://github.com/stdlib-js/stats-base-dists-discrete-uniform-entropy/actions/workflows/test.yml?query=branch:v0.3.0
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-base-dists-discrete-uniform-entropy/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/stats-base-dists-discrete-uniform-entropy?branch=main
[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg
[chat-url]: https://stdlib.zulipchat.com
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
[deno-url]: https://github.com/stdlib-js/stats-base-dists-discrete-uniform-entropy/tree/deno
[deno-readme]: https://github.com/stdlib-js/stats-base-dists-discrete-uniform-entropy/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/stats-base-dists-discrete-uniform-entropy/tree/umd
[umd-readme]: https://github.com/stdlib-js/stats-base-dists-discrete-uniform-entropy/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/stats-base-dists-discrete-uniform-entropy/tree/esm
[esm-readme]: https://github.com/stdlib-js/stats-base-dists-discrete-uniform-entropy/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/stats-base-dists-discrete-uniform-entropy/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/stats-base-dists-discrete-uniform-entropy/main/LICENSE
[discrete-uniform-distribution]: https://en.wikipedia.org/wiki/Discrete_uniform_distribution
[entropy]: https://en.wikipedia.org/wiki/Entropy_%28information_theory%29
[nats]: https://en.wikipedia.org/wiki/Nat_%28unit%29