org.apache.commons.math.distribution
Class AbstractDistribution

java.lang.Object
  extended by org.apache.commons.math.distribution.AbstractDistribution
All Implemented Interfaces:
java.io.Serializable, Distribution
Direct Known Subclasses:
AbstractContinuousDistribution, AbstractIntegerDistribution

public abstract class AbstractDistribution
extends java.lang.Object
implements Distribution, java.io.Serializable

Base class for probability distributions.

Version:
$Revision: 772119 $ $Date: 2009-05-06 05:43:28 -0400 (Wed, 06 May 2009) $
See Also:
Serialized Form

Field Summary
private static long serialVersionUID
          Serializable version identifier
 
Constructor Summary
protected AbstractDistribution()
          Default constructor.
 
Method Summary
 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).
 
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.Distribution
cumulativeProbability
 

Field Detail

serialVersionUID

private static final long serialVersionUID
Serializable version identifier

See Also:
Constant Field Values
Constructor Detail

AbstractDistribution

protected AbstractDistribution()
Default constructor.

Method Detail

cumulativeProbability

public double cumulativeProbability(double x0,
                                    double x1)
                             throws MathException
For a random variable X whose values are distributed according to this distribution, this method returns P(x0 ≤ X ≤ x1).

The default implementation uses the identity

P(x0 ≤ X ≤ x1) = P(X ≤ x1) - P(X ≤ x0)

Specified by:
cumulativeProbability in interface Distribution
Parameters:
x0 - the (inclusive) lower bound
x1 - the (inclusive) upper bound
Returns:
the probability that a random variable with this distribution will take a value between x0 and x1, including the endpoints.
Throws:
MathException - if the cumulative probability can not be computed due to convergence or other numerical errors.
java.lang.IllegalArgumentException - if x0 > x1


Copyright (c) 2003-2009 Apache Software Foundation