@stdlib/stats-base-dists-discrete-uniform

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!

Discrete Uniform

Discrete uniform distribution.

Installation

npm install @stdlib/stats-base-dists-discrete-uniform

Usage

var discreteUniform = require( '@stdlib/stats-base-dists-discrete-uniform' );

discreteUniform

Discrete uniform distribution.

var dist = discreteUniform;
// returns {...}

The namespace contains the following distribution functions:

• cdf( x, a, b ): discrete uniform distribution cumulative distribution function.
• logcdf( x, a, b ): evaluate the natural logarithm of the cumulative distribution function for a discrete uniform distribution.
• logpmf( x, a, b ): evaluate the natural logarithm of the probability mass function (PMF) for a discrete uniform distribution.
• mgf( t, a, b ): discrete uniform distribution moment-generating function (MGF).
• pmf( x, a, b ): discrete uniform distribution probability mass function (PMF).
• quantile( p, a, b ): discrete uniform distribution quantile function.

The namespace contains the following functions for calculating distribution properties:

• entropy( a, b ): discrete uniform distribution entropy.
• kurtosis( a, b ): discrete uniform distribution excess kurtosis.
• mean( a, b ): discrete uniform distribution expected value.
• median( a, b ): discrete uniform distribution median.
• skewness( a, b ): discrete uniform distribution skewness.
• stdev( a, b ): discrete uniform distribution standard deviation.
• variance( a, b ): discrete uniform distribution variance.

The namespace contains a constructor function for creating a discrete uniform distribution object.

• DiscreteUniform( [a, b] ): discrete uniform distribution constructor.

var DiscreteUniform = require( '@stdlib/stats-base-dists-discrete-uniform' ).DiscreteUniform;

var dist = new DiscreteUniform( 2, 4 );

var y = dist.pmf( 3, 0 );
// returns ~0.333

Examples

var objectKeys = require( '@stdlib/utils-keys' );
var discreteUniform = require( '@stdlib/stats-base-dists-discrete-uniform' );

console.log( objectKeys( discreteUniform ) );

---

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.