|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.commons.math3.distribution.AbstractIntegerDistribution
org.apache.commons.math3.distribution.UniformIntegerDistribution
public class UniformIntegerDistribution
Implementation of the uniform integer distribution.
| Field Summary |
|---|
| Fields inherited from class org.apache.commons.math3.distribution.AbstractIntegerDistribution |
|---|
random, randomData |
| Constructor Summary | |
|---|---|
UniformIntegerDistribution(int lower,
int upper)
Creates a new uniform integer distribution using the given lower and upper bounds (both inclusive). |
|
UniformIntegerDistribution(RandomGenerator rng,
int lower,
int upper)
Creates a new uniform integer distribution using the given lower and upper bounds (both inclusive). |
|
| Method Summary | |
|---|---|
double |
cumulativeProbability(int x)
For a random variable X whose values are distributed according
to this distribution, this method returns P(X <= x). |
double |
getNumericalMean()
Use this method to get the numerical value of the mean of this distribution. |
double |
getNumericalVariance()
Use this method to get the numerical value of the variance of this distribution. |
int |
getSupportLowerBound()
Access the lower bound of the support. |
int |
getSupportUpperBound()
Access the upper bound of the support. |
boolean |
isSupportConnected()
Use this method to get information about whether the support is connected, i.e. |
double |
probability(int x)
For a random variable X whose values are distributed according
to this distribution, this method returns P(X = x). |
int |
sample()
Generate a random value sampled from this distribution. |
| Methods inherited from class org.apache.commons.math3.distribution.AbstractIntegerDistribution |
|---|
cumulativeProbability, inverseCumulativeProbability, reseedRandomGenerator, sample, solveInverseCumulativeProbability |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public UniformIntegerDistribution(int lower,
int upper)
throws NumberIsTooLargeException
lower - Lower bound (inclusive) of this distribution.upper - Upper bound (inclusive) of this distribution.
NumberIsTooLargeException - if lower >= upper.
public UniformIntegerDistribution(RandomGenerator rng,
int lower,
int upper)
throws NumberIsTooLargeException
rng - Random number generator.lower - Lower bound (inclusive) of this distribution.upper - Upper bound (inclusive) of this distribution.
NumberIsTooLargeException - if lower >= upper.| Method Detail |
|---|
public double probability(int x)
X whose values are distributed according
to this distribution, this method returns P(X = x). In other
words, this method represents the probability mass function (PMF)
for the distribution.
x - the point at which the PMF is evaluated
xpublic double cumulativeProbability(int x)
X whose values are distributed according
to this distribution, this method returns P(X <= x). In other
words, this method represents the (cumulative) distribution function
(CDF) for this distribution.
x - the point at which the CDF is evaluated
xpublic double getNumericalMean()
lower and upper bound upper, the mean is
0.5 * (lower + upper).
Double.NaN if it is not definedpublic double getNumericalVariance()
lower and upper bound upper, and
n = upper - lower + 1, the variance is (n^2 - 1) / 12.
Double.POSITIVE_INFINITY or
Double.NaN if it is not defined)public int getSupportLowerBound()
inverseCumulativeProbability(0). In other words, this
method must return
inf {x in Z | P(X <= x) > 0}.
public int getSupportUpperBound()
inverseCumulativeProbability(1). In other words, this
method must return
inf {x in R | P(X <= x) = 1}.
public boolean isSupportConnected()
truepublic int sample()
sample in interface IntegerDistributionsample in class AbstractIntegerDistribution
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||