|
|||||||||
PREV CLASS NEXT CLASS | All Classes | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.commons.math.distribution.AbstractDistribution
org.apache.commons.math.distribution.AbstractIntegerDistribution
public abstract class AbstractIntegerDistribution
Base class for integer-valued discrete distributions. Default implementations are provided for some of the methods that do not vary from distribution to distribution.
Method Summary | |
---|---|
double |
cumulativeProbability(double x)
For a random variable X whose values are distributed according to this distribution, this method returns P(X ≤ x). |
double |
cumulativeProbability(double x0,
double x1)
For a random variable X whose values are distributed according to this distribution, this method returns P(x0 ≤ X ≤ x1). |
abstract double |
cumulativeProbability(int x)
For a random variable X whose values are distributed according to this distribution, this method returns P(X ≤ x). |
double |
cumulativeProbability(int x0,
int x1)
For a random variable X whose values are distributed according to this distribution, this method returns P(x0 ≤ X ≤ x1). |
int |
inverseCumulativeProbability(double p)
For a random variable X whose values are distributed according to this distribution, this method returns the largest x, such that P(X ≤ x) ≤ p . |
boolean |
isSupportLowerBoundInclusive()
Use this method to get information about whether the lower bound of the support is inclusive or not. |
boolean |
isSupportUpperBoundInclusive()
Use this method to get information about whether the upper bound of the support is inclusive or not. |
double |
probability(double x)
For a random variable X whose values are distributed according to this distribution, this method returns P(X = x). |
void |
reseedRandomGenerator(long seed)
Reseeds the random generator used to generate samples. |
int |
sample()
Generates a random value sampled from this distribution. |
int[] |
sample(int sampleSize)
Generates a random sample from the distribution. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.apache.commons.math.distribution.IntegerDistribution |
---|
probability |
Method Detail |
---|
public double cumulativeProbability(double x) throws MathException
If x
does not represent an integer value, the CDF is
evaluated at the greatest integer less than x.
cumulativeProbability
in interface Distribution
x
- the value at which the distribution function is evaluated.
x
MathException
- if the cumulative probability can not be
computed due to convergence or other numerical errors.public double cumulativeProbability(double x0, double x1) throws MathException
cumulativeProbability
in interface Distribution
cumulativeProbability
in class AbstractDistribution
x0
- the (inclusive) lower boundx1
- the (inclusive) upper bound
x0
and x1
,
including the endpoints.
MathException
- if the cumulative probability can not be
computed due to convergence or other numerical errors.
IllegalArgumentException
- if x0 > x1
public abstract double cumulativeProbability(int x) throws MathException
cumulativeProbability
in interface IntegerDistribution
x
- the value at which the PDF is evaluated.
MathException
- if the cumulative probability can not be
computed due to convergence or other numerical errors.public double probability(double x)
If x
does not represent an integer value, 0 is returned.
probability
in interface DiscreteDistribution
x
- the value at which the probability density function is evaluated
public double cumulativeProbability(int x0, int x1) throws MathException
cumulativeProbability
in interface IntegerDistribution
x0
- the inclusive, lower boundx1
- the inclusive, upper bound
MathException
- if the cumulative probability can not be
computed due to convergence or other numerical errors.
IllegalArgumentException
- if x0 > x1public int inverseCumulativeProbability(double p) throws MathException
p
.
inverseCumulativeProbability
in interface IntegerDistribution
p
- the desired probability
MathException
- if the inverse cumulative probability can not be
computed due to convergence or other numerical errors.
IllegalArgumentException
- if p < 0 or p > 1public void reseedRandomGenerator(long seed)
seed
- the new seedpublic int sample() throws MathException
MathException
- if an error occurs generating the random valuepublic int[] sample(int sampleSize) throws MathException
sample()
in a loop.
sampleSize
- number of random values to generate
MathException
- if an error occurs generating the sample
IllegalArgumentException
- if sampleSize is not positivepublic boolean isSupportLowerBoundInclusive()
public boolean isSupportUpperBoundInclusive()
|
|||||||||
PREV CLASS NEXT CLASS | All Classes | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |