Discrete uniform distribution constructor.
npm install @stdlib/stats-base-dists-discrete-uniform-ctor
Alternatively,
- To load the package in a website via a
script
tag without installation and bundlers, use the ES Module available on theesm
branch. - If you are using Deno, visit the
deno
branch. - For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the
umd
branch.
The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.
var DiscreteUniform = require( '@stdlib/stats-base-dists-discrete-uniform-ctor' );
Returns a discrete uniform distribution object.
var discreteUniform = new DiscreteUniform();
var mu = discreteUniform.mean;
// returns 0.5
By default, a = 0
and b = 1
. To create a distribution having a different a
(minimum support) and b
(maximum support), provide the corresponding arguments.
var discreteUniform = new DiscreteUniform( 2, 4 );
var mu = discreteUniform.mean;
// returns 3.0
A discrete uniform distribution object has the following properties and methods...
Minimum support of the distribution. a
must be an integer smaller than or equal to b
.
var discreteUniform = new DiscreteUniform( -2, 2 );
var a = discreteUniform.a;
// returns -2
discreteUniform.a = 0;
a = discreteUniform.a;
// returns 0
Maximum support of the distribution. b
must be an integer larger than or equal to a
.
var discreteUniform = new DiscreteUniform( 2, 4 );
var b = discreteUniform.b;
// returns 4
discreteUniform.b = 3;
b = discreteUniform.b;
// returns 3
Returns the differential entropy.
var discreteUniform = new DiscreteUniform( 4, 12 );
var entropy = discreteUniform.entropy;
// returns ~2.197
Returns the excess kurtosis.
var discreteUniform = new DiscreteUniform( 4, 12 );
var kurtosis = discreteUniform.kurtosis;
// returns -1.23
Returns the expected value.
var discreteUniform = new DiscreteUniform( 4, 12 );
var mu = discreteUniform.mean;
// returns 8.0
Returns the median.
var discreteUniform = new DiscreteUniform( 4, 12 );
var median = discreteUniform.median;
// returns 8.0
Returns the skewness.
var discreteUniform = new DiscreteUniform( 4, 12 );
var skewness = discreteUniform.skewness;
// returns 0.0
Returns the standard deviation.
var discreteUniform = new DiscreteUniform( 4, 12 );
var s = discreteUniform.stdev;
// returns ~2.582
Returns the variance.
var discreteUniform = new DiscreteUniform( 4, 12 );
var s2 = discreteUniform.variance;
// returns ~6.667
Evaluates the cumulative distribution function (CDF).
var discreteUniform = new DiscreteUniform( 2, 4 );
var y = discreteUniform.cdf( 2.5 );
// returns ~0.333
Evaluates the natural logarithm of the cumulative distribution function (CDF).
var discreteUniform = new DiscreteUniform( 2, 4 );
var y = discreteUniform.logcdf( 2.5 );
// returns ~-1.099
Evaluates the natural logarithm of the probability mass function (PMF).
var discreteUniform = new DiscreteUniform( 2, 4 );
var y = discreteUniform.logpmf( 4.0 );
// returns ~-1.099
Evaluates the probability mass function (PMF).
var discreteUniform = new DiscreteUniform( 2, 4 );
var y = discreteUniform.pmf( 3, 0 );
// returns ~0.333
Evaluates the quantile function at probability p
.
var discreteUniform = new DiscreteUniform( 2, 4 );
var y = discreteUniform.quantile( 0.5 );
// returns 3.0
y = discreteUniform.quantile( 1.9 );
// returns NaN
var DiscreteUniform = require( '@stdlib/stats-base-dists-discrete-uniform-ctor' );
var discreteUniform = new DiscreteUniform( -2, 2 );
var mu = discreteUniform.mean;
// returns 0.0
var median = discreteUniform.median;
// returns 0.0
var s2 = discreteUniform.variance;
// returns 2.0
var y = discreteUniform.cdf( 2.5 );
// returns 1.0
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.
Copyright © 2016-2023. The Stdlib Authors.