Class TrapezoidalDistribution.DelegatedTrapezoidalDistribution
- java.lang.Object
-
- org.apache.commons.statistics.distribution.AbstractContinuousDistribution
-
- org.apache.commons.statistics.distribution.TrapezoidalDistribution
-
- org.apache.commons.statistics.distribution.TrapezoidalDistribution.DelegatedTrapezoidalDistribution
-
- All Implemented Interfaces:
ContinuousDistribution
- Direct Known Subclasses:
TrapezoidalDistribution.TriangularTrapezoidalDistribution,TrapezoidalDistribution.UniformTrapezoidalDistribution
- Enclosing class:
- TrapezoidalDistribution
private static class TrapezoidalDistribution.DelegatedTrapezoidalDistribution extends TrapezoidalDistribution
Specialisation of the trapezoidal distribution used when the distribution simplifies to an alternative distribution.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.apache.commons.statistics.distribution.ContinuousDistribution
ContinuousDistribution.Sampler
-
-
Field Summary
Fields Modifier and Type Field Description private ContinuousDistributiondelegateDistribution delegate.-
Fields inherited from class org.apache.commons.statistics.distribution.TrapezoidalDistribution
a, b, c, d
-
-
Constructor Summary
Constructors Constructor Description DelegatedTrapezoidalDistribution(double a, double b, double c, double d, ContinuousDistribution delegate)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ContinuousDistribution.SamplercreateSampler(org.apache.commons.rng.UniformRandomProvider rng)Creates a sampler.doublecumulativeProbability(double x)For a random variableXwhose values are distributed according to this distribution, this method returnsP(X <= x).doubledensity(double x)Returns the probability density function (PDF) of this distribution evaluated at the specified pointx.doublegetMean()Gets the mean of this distribution.doublegetVariance()Gets the variance of this distribution.doubleinverseCumulativeProbability(double p)Computes the quantile function of this distribution.doubleinverseSurvivalProbability(double p)Computes the inverse survival probability function of this distribution.doublelogDensity(double x)Returns the natural logarithm of the probability density function (PDF) of this distribution evaluated at the specified pointx.doubleprobability(double x0, double x1)For a random variableXwhose values are distributed according to this distribution, this method returnsP(x0 < X <= x1).doublesurvivalProbability(double x)For a random variableXwhose values are distributed according to this distribution, this method returnsP(X > x).-
Methods inherited from class org.apache.commons.statistics.distribution.TrapezoidalDistribution
getB, getC, getSupportLowerBound, getSupportUpperBound, of
-
Methods inherited from class org.apache.commons.statistics.distribution.AbstractContinuousDistribution
getMedian, isSupportConnected
-
-
-
-
Field Detail
-
delegate
private final ContinuousDistribution delegate
Distribution delegate.
-
-
Constructor Detail
-
DelegatedTrapezoidalDistribution
DelegatedTrapezoidalDistribution(double a, double b, double c, double d, ContinuousDistribution delegate)- Parameters:
a- Lower limit of this distribution (inclusive).b- Start of the trapezoid constant density.c- End of the trapezoid constant density.d- Upper limit of this distribution (inclusive).delegate- Distribution delegate.
-
-
Method Detail
-
density
public double density(double x)
Description copied from interface:ContinuousDistributionReturns the probability density function (PDF) of this distribution evaluated at the specified pointx. In general, the PDF is the derivative of the CDF. 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- Point at which the PDF is evaluated.- Returns:
- the value of the probability density function at
x.
-
probability
public double probability(double x0, double x1)Description copied from class:AbstractContinuousDistributionFor a random variableXwhose values are distributed according to this distribution, this method returnsP(x0 < X <= x1). The default implementation uses the identityP(x0 < X <= x1) = P(X <= x1) - P(X <= x0)- Specified by:
probabilityin interfaceContinuousDistribution- Overrides:
probabilityin classAbstractContinuousDistribution- Parameters:
x0- Lower bound (exclusive).x1- Upper bound (inclusive).- Returns:
- the probability that a random variable with this distribution
takes a value between
x0andx1, excluding the lower and including the upper endpoint.
-
logDensity
public double logDensity(double x)
Description copied from interface:ContinuousDistributionReturns the natural logarithm of the probability density function (PDF) of this distribution evaluated at the specified pointx.- Parameters:
x- Point at which the PDF is evaluated.- Returns:
- the logarithm of the value of the probability density function
at
x.
-
cumulativeProbability
public double cumulativeProbability(double x)
Description copied from interface:ContinuousDistributionFor a random variableXwhose 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.- Parameters:
x- 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
public double inverseCumulativeProbability(double p)
Description copied from class:AbstractContinuousDistributionComputes the quantile function of this distribution. For a random variableXdistributed according to this distribution, the returned value is:\[ x = \begin{cases} \inf \{ x \in \mathbb R : P(X \le x) \ge p\} & \text{for } 0 \lt p \le 1 \\ \inf \{ x \in \mathbb R : P(X \le x) \gt 0 \} & \text{for } p = 0 \end{cases} \]
The default implementation returns:
ContinuousDistribution.getSupportLowerBound()forp = 0,ContinuousDistribution.getSupportUpperBound()forp = 1, or- the result of a search for a root between the lower and upper bound using
cumulativeProbability(x) - p. The bounds may be bracketed for efficiency.
- Specified by:
inverseCumulativeProbabilityin interfaceContinuousDistribution- Overrides:
inverseCumulativeProbabilityin classAbstractContinuousDistribution- Parameters:
p- Cumulative probability.- Returns:
- the smallest
p-quantile of this distribution (largest 0-quantile forp = 0).
-
survivalProbability
public double survivalProbability(double x)
Description copied from interface:ContinuousDistributionFor a random variableXwhose values are distributed according to this distribution, this method returnsP(X > x). In other words, this method represents the complementary cumulative distribution function.By default, this is defined as
1 - cumulativeProbability(x), but the specific implementation may be more accurate.- Parameters:
x- Point at which the survival function is evaluated.- Returns:
- the probability that a random variable with this
distribution takes a value greater than
x.
-
inverseSurvivalProbability
public double inverseSurvivalProbability(double p)
Description copied from class:AbstractContinuousDistributionComputes the inverse survival probability function of this distribution. For a random variableXdistributed according to this distribution, the returned value is:\[ x = \begin{cases} \inf \{ x \in \mathbb R : P(X \gt x) \le p\} & \text{for } 0 \le p \lt 1 \\ \inf \{ x \in \mathbb R : P(X \gt x) \lt 1 \} & \text{for } p = 1 \end{cases} \]
By default, this is defined as
inverseCumulativeProbability(1 - p), but the specific implementation may be more accurate.The default implementation returns:
ContinuousDistribution.getSupportLowerBound()forp = 1,ContinuousDistribution.getSupportUpperBound()forp = 0, or- the result of a search for a root between the lower and upper bound using
survivalProbability(x) - p. The bounds may be bracketed for efficiency.
- Specified by:
inverseSurvivalProbabilityin interfaceContinuousDistribution- Overrides:
inverseSurvivalProbabilityin classAbstractContinuousDistribution- Parameters:
p- Survival probability.- Returns:
- the smallest
(1-p)-quantile of this distribution (largest 0-quantile forp = 1).
-
getMean
public double getMean()
Description copied from class:TrapezoidalDistributionGets the mean of this distribution.For lower limit \( a \), start of the density constant region \( b \), end of the density constant region \( c \) and upper limit \( d \), the mean is:
\[ \frac{1}{3(d+c-b-a)}\left(\frac{d^3-c^3}{d-c}-\frac{b^3-a^3}{b-a}\right) \]
- Specified by:
getMeanin interfaceContinuousDistribution- Specified by:
getMeanin classTrapezoidalDistribution- Returns:
- the mean.
-
getVariance
public double getVariance()
Description copied from class:TrapezoidalDistributionGets the variance of this distribution.For lower limit \( a \), start of the density constant region \( b \), end of the density constant region \( c \) and upper limit \( d \), the variance is:
\[ \frac{1}{6(d+c-b-a)}\left(\frac{d^4-c^4}{d-c}-\frac{b^4-a^4}{b-a}\right) - \mu^2 \]
where \( \mu \) is the mean.
- Specified by:
getVariancein interfaceContinuousDistribution- Specified by:
getVariancein classTrapezoidalDistribution- Returns:
- the variance.
-
createSampler
public ContinuousDistribution.Sampler createSampler(org.apache.commons.rng.UniformRandomProvider rng)
Description copied from class:AbstractContinuousDistributionCreates a sampler.- Specified by:
createSamplerin interfaceContinuousDistribution- Overrides:
createSamplerin classAbstractContinuousDistribution- Parameters:
rng- Generator of uniformly distributed numbers.- Returns:
- a sampler that produces random numbers according this distribution.
-
-