|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| 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.
| Field Summary | |
|---|---|
protected RandomDataImpl |
randomData
RandomData instance used to generate samples from the distribution |
| Constructor Summary | |
|---|---|
protected |
AbstractIntegerDistribution()
Default constructor. |
| 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). |
protected abstract int |
getDomainLowerBound(double p)
Access the domain value lower bound, based on p, used to
bracket a PDF root. |
protected abstract int |
getDomainUpperBound(double p)
Access the domain value upper bound, based on p, used to
bracket a PDF root. |
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 |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface org.apache.commons.math.distribution.IntegerDistribution |
|---|
probability |
| Field Detail |
|---|
protected final RandomDataImpl randomData
| Constructor Detail |
|---|
protected AbstractIntegerDistribution()
| 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 Distributionx - 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 DistributioncumulativeProbability in class AbstractDistributionx0 - 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 IntegerDistributionx - 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 DiscreteDistributionx - the value at which the probability density function is evaluated
public double cumulativeProbability(int x0,
int x1)
throws MathException
cumulativeProbability in interface IntegerDistributionx0 - 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 > x1
public int inverseCumulativeProbability(double p)
throws MathException
p.
inverseCumulativeProbability in interface IntegerDistributionp - 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 seed
public int sample()
throws MathException
MathException - if an error occurs generating the random value
public 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 positiveprotected abstract int getDomainLowerBound(double p)
p, used to
bracket a PDF root. This method is used by
inverseCumulativeProbability(double) to find critical values.
p - the desired probability for the critical value
pprotected abstract int getDomainUpperBound(double p)
p, used to
bracket a PDF root. This method is used by
inverseCumulativeProbability(double) to find critical values.
p - the desired probability for the critical value
ppublic boolean isSupportLowerBoundInclusive()
public boolean isSupportUpperBoundInclusive()
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||