Class HalfNormalDistribution
java.lang.Object
org.hipparchus.distribution.continuous.AbstractRealDistribution
org.hipparchus.distribution.continuous.HalfNormalDistribution
- All Implemented Interfaces:
Serializable,RealDistribution
Implementation of the half normal (gaussian) distribution.
- See Also:
-
Field Summary
Fields inherited from class org.hipparchus.distribution.continuous.AbstractRealDistribution
DEFAULT_SOLVER_ABSOLUTE_ACCURACY -
Constructor Summary
ConstructorsConstructorDescriptionHalfNormalDistribution(double scale) Create a half normal distribution using the scale parameter of the distribution. -
Method Summary
Modifier and TypeMethodDescriptiondoublecumulativeProbability(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()Access the mean.doubleUse this method to get the numerical value of the mean of this distribution.doubleUse this method to get the numerical value of the variance of this distribution.doubleAccess the standard deviation.doubleAccess the lower bound of the support.doubleAccess the upper bound of the support.doubleinverseCumulativeProbability(double p) Computes the quantile function of this distribution.booleanUse 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.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).Methods inherited from class org.hipparchus.distribution.continuous.AbstractRealDistribution
getSolverAbsoluteAccuracy
-
Constructor Details
-
HalfNormalDistribution
Create a half normal distribution using the scale parameter of the distribution.- Parameters:
scale- Scale parameter of the distribution.- Throws:
MathIllegalArgumentException- ifscale <= 0.
-
-
Method Details
-
getMean
public double getMean()Access the mean.- Returns:
- the mean for this distribution.
-
getStandardDeviation
public double getStandardDeviation()Access the standard deviation.- Returns:
- the standard deviation for this distribution.
-
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
-
logDensity
public double logDensity(double x) Returns the natural logarithm of 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. Note that due to the floating point precision and under/overflow issues, this method will for some distributions be more precise and faster than computing the logarithm ofRealDistribution.density(double).The default implementation simply computes the logarithm of
density(x).- Specified by:
logDensityin interfaceRealDistribution- Overrides:
logDensityin classAbstractRealDistribution- Parameters:
x- the point at which the PDF is evaluated- Returns:
- the logarithm of the value of the probability density function at point
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- 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 variableXdistributed 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:
inverseCumulativeProbabilityin interfaceRealDistribution- Overrides:
inverseCumulativeProbabilityin classAbstractRealDistribution- Parameters:
p- the cumulative probability- Returns:
- the smallest
p-quantile of this distribution (largest 0-quantile forp = 0) - Throws:
MathIllegalArgumentException- ifp < 0orp > 1
-
probability
For a random variableXwhose values are distributed according to this distribution, this method returnsP(x0 < X <= x1).- Specified by:
probabilityin interfaceRealDistribution- Overrides:
probabilityin classAbstractRealDistribution- Parameters:
x0- Lower bound (excluded).x1- Upper bound (included).- Returns:
- the probability that a random variable with this distribution
takes a value between
x0andx1, excluding the lower and including the upper endpoint. - Throws:
MathIllegalArgumentException- ifx0 > x1. The default implementation uses the identityP(x0 < X <= x1) = P(X <= x1) - P(X <= x0)
-
getNumericalMean
public double getNumericalMean()Use this method to get the numerical value of the mean of this distribution. Get the mean of the distribution.- Returns:
- the mean or
Double.NaNif it is not defined
-
getNumericalVariance
public double getNumericalVariance()Use this method to get the numerical value of the variance of this distribution. Get the variance of the distribution.- Returns:
- the variance (possibly
Double.POSITIVE_INFINITYas for certain cases inTDistribution) orDouble.NaNif 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 always zero no matter the parameters.inf {x in R | P(X <= x) > 0}.- Returns:
- lower bound of the support (always zero)
-
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 always positive infinity no matter the parameters.inf {x in R | P(X <= x) = 1}.- Returns:
- upper bound of the support (always
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. The support of this distribution is connected.- Returns:
true
-