Class ExponentialDistribution
- All Implemented Interfaces:
Serializable
,RealDistribution
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final double
Default inverse cumulative probability accuracy.Fields inherited from class org.apache.commons.math3.distribution.AbstractRealDistribution
random, randomData, SOLVER_DEFAULT_ABSOLUTE_ACCURACY
-
Constructor Summary
ConstructorsConstructorDescriptionExponentialDistribution
(double mean) Create an exponential distribution with the given mean.ExponentialDistribution
(double mean, double inverseCumAccuracy) Create an exponential distribution with the given mean.ExponentialDistribution
(RandomGenerator rng, double mean) Creates an exponential distribution.ExponentialDistribution
(RandomGenerator rng, double mean, double inverseCumAccuracy) Creates an exponential distribution. -
Method Summary
Modifier and TypeMethodDescriptiondouble
cumulativeProbability
(double x) For a random variableX
whose values are distributed according to this distribution, this method returnsP(X <= x)
.double
density
(double x) Returns the probability density function (PDF) of this distribution evaluated at the specified pointx
.double
getMean()
Access the mean.double
Use this method to get the numerical value of the mean of this distribution.double
Use this method to get the numerical value of the variance of this distribution.protected double
Returns the solver absolute accuracy for inverse cumulative computation.double
Access the lower bound of the support.double
Access the upper bound of the support.double
inverseCumulativeProbability
(double p) Computes the quantile function of this distribution.boolean
Use this method to get information about whether the support is connected, i.e.boolean
Whether or not the lower bound of support is in the domain of the density function.boolean
Whether or not the upper bound of support is in the domain of the density function.double
logDensity
(double x) Returns the natural logarithm of the probability density function (PDF) of this distribution evaluated at the specified pointx
.double
sample()
Generate a random value sampled from this distribution.Methods inherited from class org.apache.commons.math3.distribution.AbstractRealDistribution
cumulativeProbability, probability, probability, reseedRandomGenerator, sample
-
Field Details
-
DEFAULT_INVERSE_ABSOLUTE_ACCURACY
public static final double DEFAULT_INVERSE_ABSOLUTE_ACCURACYDefault inverse cumulative probability accuracy.- Since:
- 2.1
- See Also:
-
-
Constructor Details
-
ExponentialDistribution
public ExponentialDistribution(double mean) Create an exponential distribution with the given mean.Note: this constructor will implicitly create an instance of
Well19937c
as random generator to be used for sampling only (seesample()
andAbstractRealDistribution.sample(int)
). In case no sampling is needed for the created distribution, it is advised to passnull
as random generator via the appropriate constructors to avoid the additional initialisation overhead.- Parameters:
mean
- mean of this distribution.
-
ExponentialDistribution
public ExponentialDistribution(double mean, double inverseCumAccuracy) Create an exponential distribution with the given mean.Note: this constructor will implicitly create an instance of
Well19937c
as random generator to be used for sampling only (seesample()
andAbstractRealDistribution.sample(int)
). In case no sampling is needed for the created distribution, it is advised to passnull
as random generator via the appropriate constructors to avoid the additional initialisation overhead.- Parameters:
mean
- Mean of this distribution.inverseCumAccuracy
- Maximum absolute error in inverse cumulative probability estimates (defaults toDEFAULT_INVERSE_ABSOLUTE_ACCURACY
).- Throws:
NotStrictlyPositiveException
- ifmean <= 0
.- Since:
- 2.1
-
ExponentialDistribution
public ExponentialDistribution(RandomGenerator rng, double mean) throws NotStrictlyPositiveException Creates an exponential distribution.- Parameters:
rng
- Random number generator.mean
- Mean of this distribution.- Throws:
NotStrictlyPositiveException
- ifmean <= 0
.- Since:
- 3.3
-
ExponentialDistribution
public ExponentialDistribution(RandomGenerator rng, double mean, double inverseCumAccuracy) throws NotStrictlyPositiveException Creates an exponential distribution.- Parameters:
rng
- Random number generator.mean
- Mean of this distribution.inverseCumAccuracy
- Maximum absolute error in inverse cumulative probability estimates (defaults toDEFAULT_INVERSE_ABSOLUTE_ACCURACY
).- Throws:
NotStrictlyPositiveException
- ifmean <= 0
.- Since:
- 3.1
-
-
Method Details
-
getMean
public double getMean()Access the mean.- Returns:
- the mean.
-
density
public double density(double x) Returns the probability density function (PDF) of this distribution evaluated at the specified pointx
. In general, the PDF is the derivative of theCDF
. If the derivative does not exist atx
, then an appropriate replacement should be returned, e.g.Double.POSITIVE_INFINITY
,Double.NaN
, or the limit inferior or limit superior of the difference quotient.- Parameters:
x
- the point at which the PDF is evaluated- Returns:
- the value of the probability density function at point
x
-
logDensity
public double logDensity(double x) Returns the natural logarithm of the probability density function (PDF) of this distribution evaluated at the specified pointx
. In general, the PDF is the derivative of theCDF
. If the derivative does not exist atx
, then an appropriate replacement should be returned, e.g.Double.POSITIVE_INFINITY
,Double.NaN
, or the limit inferior or limit superior of the difference quotient. Note that due to the floating point precision and under/overflow issues, this method will for some distributions be more precise and faster than computing the logarithm ofRealDistribution.density(double)
. The default implementation simply computes the logarithm ofdensity(x)
.- Overrides:
logDensity
in classAbstractRealDistribution
- Parameters:
x
- the point at which the PDF is evaluated- Returns:
- the logarithm of the value of the probability density function at point
x
-
cumulativeProbability
public double cumulativeProbability(double x) For a random variableX
whose values are distributed according to this distribution, this method returnsP(X <= x)
. In other words, this method represents the (cumulative) distribution function (CDF) for this distribution. The implementation of this method is based on:- Exponential Distribution, equation (1).
- Parameters:
x
- the point at which the CDF is evaluated- Returns:
- the probability that a random variable with this
distribution takes a value less than or equal to
x
-
inverseCumulativeProbability
Computes the quantile function of this distribution. For a random variableX
distributed according to this distribution, the returned value isinf{x in R | P(Xinvalid input: '<'=x) >= p}
for0 < p <= 1
,inf{x in R | P(Xinvalid input: '<'=x) > 0}
forp = 0
.
RealDistribution.getSupportLowerBound()
forp = 0
,RealDistribution.getSupportUpperBound()
forp = 1
.
0
whenp= = 0
andDouble.POSITIVE_INFINITY
whenp == 1
.- Specified by:
inverseCumulativeProbability
in interfaceRealDistribution
- Overrides:
inverseCumulativeProbability
in classAbstractRealDistribution
- Parameters:
p
- the cumulative probability- Returns:
- the smallest
p
-quantile of this distribution (largest 0-quantile forp = 0
) - Throws:
OutOfRangeException
- ifp < 0
orp > 1
-
sample
public double sample()Generate a random value sampled from this distribution. The default implementation uses the inversion method.Algorithm Description: this implementation uses the Inversion Method to generate exponentially distributed random values from uniform deviates.
- Specified by:
sample
in interfaceRealDistribution
- Overrides:
sample
in classAbstractRealDistribution
- Returns:
- a random value.
- Since:
- 2.2
-
getSolverAbsoluteAccuracy
protected double getSolverAbsoluteAccuracy()Returns the solver absolute accuracy for inverse cumulative computation. You can override this method in order to use a Brent solver with an absolute accuracy different from the default.- Overrides:
getSolverAbsoluteAccuracy
in classAbstractRealDistribution
- Returns:
- the maximum absolute error in inverse cumulative probability estimates
-
getNumericalMean
public double getNumericalMean()Use this method to get the numerical value of the mean of this distribution. For mean parameterk
, the mean isk
.- Returns:
- the mean or
Double.NaN
if it is not defined
-
getNumericalVariance
public double getNumericalVariance()Use this method to get the numerical value of the variance of this distribution. For mean parameterk
, the variance isk^2
.- Returns:
- the variance (possibly
Double.POSITIVE_INFINITY
as for certain cases inTDistribution
) orDouble.NaN
if it is not defined
-
getSupportLowerBound
public double getSupportLowerBound()Access the lower bound of the support. This method must return the same value asinverseCumulativeProbability(0)
. In other words, this method must return
The lower bound of the support is always 0 no matter the mean parameter.inf {x in R | P(X invalid input: '<'= x) > 0}
.- Returns:
- lower bound of the support (always 0)
-
getSupportUpperBound
public double getSupportUpperBound()Access the upper bound of the support. This method must return the same value asinverseCumulativeProbability(1)
. In other words, this method must return
The upper bound of the support is always positive infinity no matter the mean parameter.inf {x in R | P(X invalid input: '<'= x) = 1}
.- Returns:
- upper bound of the support (always Double.POSITIVE_INFINITY)
-
isSupportLowerBoundInclusive
public boolean isSupportLowerBoundInclusive()Whether or not the lower bound of support is in the domain of the density function. Returns true iffgetSupporLowerBound()
is finite anddensity(getSupportLowerBound())
returns a non-NaN, non-infinite value.- Returns:
- true if the lower bound of support is finite and the density function returns a non-NaN, non-infinite value there
-
isSupportUpperBoundInclusive
public boolean isSupportUpperBoundInclusive()Whether or not the upper bound of support is in the domain of the density function. Returns true iffgetSupportUpperBound()
is finite anddensity(getSupportUpperBound())
returns a non-NaN, non-infinite value.- Returns:
- true if the upper bound of support is finite and the density function returns a non-NaN, non-infinite value there
-
isSupportConnected
public boolean isSupportConnected()Use this method to get information about whether the support is connected, i.e. whether all values between the lower and upper bound of the support are included in the support. The support of this distribution is connected.- Returns:
true
-