Class LogisticDistribution
- java.lang.Object
-
- org.apache.commons.statistics.distribution.AbstractContinuousDistribution
-
- org.apache.commons.statistics.distribution.LogisticDistribution
-
- All Implemented Interfaces:
ContinuousDistribution
public final class LogisticDistribution extends AbstractContinuousDistribution
Implementation of the logistic distribution.The probability density function of \( X \) is:
\[ f(x; \mu, s) = \frac{e^{-(x-\mu)/s}} {s\left(1+e^{-(x-\mu)/s}\right)^2} \]
for \( \mu \) the location, \( s > 0 \) the scale, and \( x \in (-\infty, \infty) \).
-
-
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 double
logScale
Logarithm of "scale".private double
mu
Location parameter.private static double
PI_SQUARED_OVER_THREE
π2/3.private double
scale
Scale parameter.private static double
SUPPORT_HI
Support upper bound.private static double
SUPPORT_LO
Support lower bound.
-
Constructor Summary
Constructors Modifier Constructor Description private
LogisticDistribution(double mu, double scale)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description double
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
getLocation()
Gets the location parameter of this distribution.double
getMean()
Gets the mean of this distribution.(package private) double
getMedian()
Gets the median.double
getScale()
Gets the scale parameter of this distribution.double
getSupportLowerBound()
Gets the lower bound of the support.double
getSupportUpperBound()
Gets the upper bound of the support.double
getVariance()
Gets the variance of this distribution.double
inverseCumulativeProbability(double p)
Computes the quantile function of this distribution.double
inverseSurvivalProbability(double p)
Computes the inverse survival probability function of this distribution.double
logDensity(double x)
Returns the natural logarithm of the probability density function (PDF) of this distribution evaluated at the specified pointx
.static LogisticDistribution
of(double mu, double scale)
Creates a logistic distribution.double
survivalProbability(double x)
For a random variableX
whose values are distributed according to this distribution, this method returnsP(X > x)
.-
Methods inherited from class org.apache.commons.statistics.distribution.AbstractContinuousDistribution
createSampler, isSupportConnected, probability
-
-
-
-
Field Detail
-
SUPPORT_LO
private static final double SUPPORT_LO
Support lower bound.- See Also:
- Constant Field Values
-
SUPPORT_HI
private static final double SUPPORT_HI
Support upper bound.- See Also:
- Constant Field Values
-
PI_SQUARED_OVER_THREE
private static final double PI_SQUARED_OVER_THREE
π2/3. https://oeis.org/A195055.- See Also:
- Constant Field Values
-
mu
private final double mu
Location parameter.
-
scale
private final double scale
Scale parameter.
-
logScale
private final double logScale
Logarithm of "scale".
-
-
Method Detail
-
of
public static LogisticDistribution of(double mu, double scale)
Creates a logistic distribution.- Parameters:
mu
- Location parameter.scale
- Scale parameter (must be positive).- Returns:
- the distribution
- Throws:
java.lang.IllegalArgumentException
- ifscale <= 0
.
-
getLocation
public double getLocation()
Gets the location parameter of this distribution.- Returns:
- the location 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 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.- 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 variableX
whose 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
.
-
inverseCumulativeProbability
public double inverseCumulativeProbability(double p)
Computes the quantile function of this distribution. For a random variableX
distributed 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:
inverseCumulativeProbability
in interfaceContinuousDistribution
- Overrides:
inverseCumulativeProbability
in classAbstractContinuousDistribution
- Parameters:
p
- Cumulative probability.- Returns:
- the smallest
p
-quantile of this distribution (largest 0-quantile forp = 0
).
-
inverseSurvivalProbability
public double inverseSurvivalProbability(double p)
Computes the inverse survival probability function of this distribution. For a random variableX
distributed 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:
inverseSurvivalProbability
in interfaceContinuousDistribution
- Overrides:
inverseSurvivalProbability
in classAbstractContinuousDistribution
- Parameters:
p
- Survival probability.- Returns:
- the smallest
(1-p)
-quantile of this distribution (largest 0-quantile forp = 1
).
-
getMean
public double getMean()
Gets the mean of this distribution.The mean is equal to the location.
- Returns:
- the mean.
-
getVariance
public double getVariance()
Gets the variance of this distribution.For scale parameter \( s \), the variance is:
\[ \frac{s^2 \pi^2}{3} \]
- 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 negative infinity.
- Returns:
- negative infinity.
-
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.
-
getMedian
double getMedian()
Gets the median. This is used to determine if the arguments to theAbstractContinuousDistribution.probability(double, double)
function are in the upper or lower domain.The default implementation calls
AbstractContinuousDistribution.inverseCumulativeProbability(double)
with a value of 0.5.- Overrides:
getMedian
in classAbstractContinuousDistribution
- Returns:
- the median
-
-