Class LogisticDistribution
java.lang.Object
org.hipparchus.distribution.continuous.AbstractRealDistribution
org.hipparchus.distribution.continuous.LogisticDistribution
- All Implemented Interfaces:
Serializable
,RealDistribution
This class implements the Logistic distribution.
-
Field Summary
Fields inherited from class org.hipparchus.distribution.continuous.AbstractRealDistribution
DEFAULT_SOLVER_ABSOLUTE_ACCURACY
-
Constructor Summary
-
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
Access the location parameter,mu
.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.double
getScale()
Access the scale parameter,s
.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.Methods inherited from class org.hipparchus.distribution.continuous.AbstractRealDistribution
getSolverAbsoluteAccuracy, logDensity, probability
-
Constructor Details
-
LogisticDistribution
Build a new instance.- Parameters:
mu
- location parameters
- scale parameter (must be positive)- Throws:
MathIllegalArgumentException
- ifbeta <= 0
-
-
Method Details
-
getLocation
public double getLocation()Access the location parameter,mu
.- Returns:
- the location parameter.
-
getScale
public double getScale()Access the scale parameter,s
.- 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 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
-
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
- 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(X<=x) >= p}
for0 < p <= 1
,inf{x in R | P(X<=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:
MathIllegalArgumentException
- ifp < 0
orp > 1
-
getNumericalMean
public double getNumericalMean()Use this method to get the numerical value of the mean of this distribution.- 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.- 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 returninf {x in R | P(X <= x) > 0}
.- Returns:
- lower bound of the support (might be
Double.NEGATIVE_INFINITY
)
-
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 returninf {x in R | P(X <= x) = 1}
.- Returns:
- upper bound of the support (might be
Double.POSITIVE_INFINITY
)
-
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.- Returns:
- whether the support is connected or not
-