Class TriangularDistribution
- All Implemented Interfaces:
Serializable
,RealDistribution
- Since:
- 3.0
- See Also:
-
Field Summary
Fields inherited from class org.apache.commons.math3.distribution.AbstractRealDistribution
random, randomData, SOLVER_DEFAULT_ABSOLUTE_ACCURACY
-
Constructor Summary
ConstructorsConstructorDescriptionTriangularDistribution
(double a, double c, double b) Creates a triangular real distribution using the given lower limit, upper limit, and mode.TriangularDistribution
(RandomGenerator rng, double a, double c, double b) Creates a triangular 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
getMode()
Returns the modec
of this distribution.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.Methods inherited from class org.apache.commons.math3.distribution.AbstractRealDistribution
cumulativeProbability, logDensity, probability, probability, reseedRandomGenerator, sample, sample
-
Constructor Details
-
TriangularDistribution
public TriangularDistribution(double a, double c, double b) throws NumberIsTooLargeException, NumberIsTooSmallException Creates a triangular real distribution using the given lower limit, upper limit, and mode.Note: this constructor will implicitly create an instance of
Well19937c
as random generator to be used for sampling only (seeAbstractRealDistribution.sample()
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:
a
- Lower limit of this distribution (inclusive).c
- Mode of this distribution.b
- Upper limit of this distribution (inclusive).- Throws:
NumberIsTooLargeException
- ifa >= b
or ifc > b
.NumberIsTooSmallException
- ifc < a
.
-
TriangularDistribution
public TriangularDistribution(RandomGenerator rng, double a, double c, double b) throws NumberIsTooLargeException, NumberIsTooSmallException Creates a triangular distribution.- Parameters:
rng
- Random number generator.a
- Lower limit of this distribution (inclusive).c
- Mode of this distribution.b
- Upper limit of this distribution (inclusive).- Throws:
NumberIsTooLargeException
- ifa >= b
or ifc > b
.NumberIsTooSmallException
- ifc < a
.- Since:
- 3.1
-
-
Method Details
-
getMode
public double getMode()Returns the modec
of this distribution.- Returns:
- the mode
c
of this distribution
-
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.For this distribution, the returned value is not really meaningful, since exact formulas are implemented for the computation of the
inverseCumulativeProbability(double)
(no solver is invoked).For lower limit
a
and upper limitb
, the current implementation returnsmax(ulp(a), ulp(b)
.- Overrides:
getSolverAbsoluteAccuracy
in classAbstractRealDistribution
- Returns:
- the maximum absolute error in inverse cumulative probability estimates
-
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. For lower limita
, upper limitb
and modec
, the PDF is given by2 * (x - a) / [(b - a) * (c - a)]
ifa <= x < c
,2 / (b - a)
ifx = c
,2 * (b - x) / [(b - a) * (b - c)]
ifc < x <= b
,0
otherwise.
- Parameters:
x
- the point at which the PDF is evaluated- Returns:
- 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. For lower limita
, upper limitb
and modec
, the CDF is given by0
ifx < a
,(x - a)^2 / [(b - a) * (c - a)]
ifa <= x < c
,(c - a) / (b - a)
ifx = c
,1 - (b - x)^2 / [(b - a) * (b - c)]
ifc < x <= b
,1
ifx > b
.
- 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
-
getNumericalMean
public double getNumericalMean()Use this method to get the numerical value of the mean of this distribution. For lower limita
, upper limitb
, and modec
, the mean is(a + b + c) / 3
.- 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 lower limita
, upper limitb
, and modec
, the variance is(a^2 + b^2 + c^2 - a * b - a * c - b * c) / 18
.- 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 equal to the lower limit parameterinf {x in R | P(X invalid input: '<'= x) > 0}
.a
of the distribution.- Returns:
- lower bound of the support
-
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 equal to the upper limit parameterinf {x in R | P(X invalid input: '<'= x) = 1}
.b
of the distribution.- Returns:
- upper bound of the support
-
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
-
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
.
- 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
-