org.apache.commons.math.distribution
Class ExponentialDistributionImpl

java.lang.Object
  extended by org.apache.commons.math.distribution.AbstractDistribution
      extended by org.apache.commons.math.distribution.AbstractContinuousDistribution
          extended by org.apache.commons.math.distribution.ExponentialDistributionImpl
All Implemented Interfaces:
java.io.Serializable, ContinuousDistribution, Distribution, ExponentialDistribution

public class ExponentialDistributionImpl
extends AbstractContinuousDistribution
implements ExponentialDistribution, java.io.Serializable

The default implementation of ExponentialDistribution.

See Also:
Serialized Form

Constructor Summary
ExponentialDistributionImpl(double mean)
          Create a exponential distribution with the given mean.
 
Method Summary
 double cumulativeProbability(double x)
          For this disbution, X, this method returns P(X < x).
 double getMean()
          Access the mean.
 double inverseCumulativeProbability(double p)
          For this distribution, X, this method returns the critical point x, such that P(X < x) = p.
 void setMean(double mean)
          Modify the mean.
 
Methods inherited from class org.apache.commons.math.distribution.AbstractDistribution
cumulativeProbability
 
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.Distribution
cumulativeProbability
 

Constructor Detail

ExponentialDistributionImpl

public ExponentialDistributionImpl(double mean)
Create a exponential distribution with the given mean.

Parameters:
mean - mean of this distribution.
Method Detail

setMean

public void setMean(double mean)
Modify the mean.

Specified by:
setMean in interface ExponentialDistribution
Parameters:
mean - the new mean.
Throws:
java.lang.IllegalArgumentException - if mean is not positive.

getMean

public double getMean()
Access the mean.

Specified by:
getMean in interface ExponentialDistribution
Returns:
the mean.

cumulativeProbability

public double cumulativeProbability(double x)
                             throws MathException
For this disbution, X, this method returns P(X < x). The implementation of this method is based on:

Specified by:
cumulativeProbability in interface Distribution
Parameters:
x - the value at which the CDF is evaluated.
Returns:
CDF for this distribution.
Throws:
MathException - if the cumulative probability can not be computed due to convergence or other numerical errors.

inverseCumulativeProbability

public double inverseCumulativeProbability(double p)
                                    throws MathException
For this distribution, X, this method returns the critical point x, such that P(X < x) = p.

Returns 0 for p=0 and Double.POSITIVE_INFINITY for p=1.

Specified by:
inverseCumulativeProbability in interface ContinuousDistribution
Overrides:
inverseCumulativeProbability in class AbstractContinuousDistribution
Parameters:
p - the desired probability
Returns:
x, such that P(X < x) = p
Throws:
MathException - if the inverse cumulative probability can not be computed due to convergence or other numerical errors.
java.lang.IllegalArgumentException - if p < 0 or p > 1.


jHepWork 1.1 (C) Chekanov