Class NakagamiDistribution
- java.lang.Object
-
- org.apache.commons.statistics.distribution.NakagamiDistribution
-
- All Implemented Interfaces:
ContinuousDistribution
public final class NakagamiDistribution extends Object
Implementation of the Nakagami distribution.The probability density function of \( X \) is:
\[ f(x; \mu, \Omega) = \frac{2\mu^\mu}{\Gamma(\mu)\Omega^\mu}x^{2\mu-1}\exp\left(-\frac{\mu}{\Omega}x^2\right) \]
for \( \mu > 0 \) the shape, \( \Omega > 0 \) the scale, and \( x \in (0, \infty) \).
- See Also:
- Nakagami distribution (Wikipedia)
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.apache.commons.statistics.distribution.ContinuousDistribution
ContinuousDistribution.Sampler
-
-
Method Summary
All Methods Static 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.doublegetScale()Gets the scale parameter of this distribution.doublegetShape()Gets the shape parameter of this distribution.doublegetSupportLowerBound()Gets the lower bound of the support.doublegetSupportUpperBound()Gets the upper bound of the support.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.static NakagamiDistributionof(double mu, double omega)Creates a Nakagami distribution.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).
-
-
-
Method Detail
-
of
public static NakagamiDistribution of(double mu, double omega)
Creates a Nakagami distribution.- Parameters:
mu- Shape parameter (must be positive).omega- Scale parameter (must be positive). Controls the spread of the distribution.- Returns:
- the distribution
- Throws:
IllegalArgumentException- ifmu <= 0or ifomega <= 0.
-
getShape
public double getShape()
Gets the shape parameter of this distribution.- Returns:
- the shape parameter.
-
getScale
public double getScale()
Gets the scale parameter of this distribution.- Returns:
- the scale parameter.
-
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 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.
-
logDensity
public double logDensity(double x)
Returns 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)
For 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.
-
survivalProbability
public double survivalProbability(double x)
For 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.
-
getMean
public double getMean()
Gets the mean of this distribution.For shape parameter \( \mu \) and scale parameter \( \Omega \), the mean is:
\[ \frac{\Gamma(m+\frac{1}{2})}{\Gamma(m)}\left(\frac{\Omega}{m}\right)^{1/2} \]
- Returns:
- the mean.
-
getVariance
public double getVariance()
Gets the variance of this distribution.For shape parameter \( \mu \) and scale parameter \( \Omega \), the variance is:
\[ \Omega\left(1-\frac{1}{m}\left(\frac{\Gamma(m+\frac{1}{2})}{\Gamma(m)}\right)^2\right) \]
- Returns:
- the variance.
-
getSupportLowerBound
public double getSupportLowerBound()
Gets the lower bound of the support. It must return the same value asinverseCumulativeProbability(0), i.e. \( \inf \{ x \in \mathbb R : P(X \le x) \gt 0 \} \).The lower bound of the support is always 0.
- Returns:
- 0.
-
getSupportUpperBound
public double getSupportUpperBound()
Gets the upper bound of the support. It must return the same value asinverseCumulativeProbability(1), i.e. \( \inf \{ x \in \mathbb R : P(X \le x) = 1 \} \).The upper bound of the support is always positive infinity.
- Returns:
- positive infinity.
-
createSampler
public ContinuousDistribution.Sampler createSampler(org.apache.commons.rng.UniformRandomProvider rng)
Creates a sampler.- Specified by:
createSamplerin interfaceContinuousDistribution- Parameters:
rng- Generator of uniformly distributed numbers.- Returns:
- a sampler that produces random numbers according this distribution.
-
probability
public double probability(double x0, double x1)For 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- 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.
-
inverseCumulativeProbability
public double inverseCumulativeProbability(double p)
Computes 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- Parameters:
p- Cumulative probability.- Returns:
- the smallest
p-quantile of this distribution (largest 0-quantile forp = 0). - Throws:
IllegalArgumentException- ifp < 0orp > 1
-
inverseSurvivalProbability
public double inverseSurvivalProbability(double p)
Computes 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- Parameters:
p- Survival probability.- Returns:
- the smallest
(1-p)-quantile of this distribution (largest 0-quantile forp = 1). - Throws:
IllegalArgumentException- ifp < 0orp > 1
-
-