HyperbolicSecantDistribution.InverseDistributionFunction Method

Definition

Namespace: Numerics.NET.Statistics.Distributions
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 9.0.7

Overload List

InverseDistributionFunction(Double) Returns the inverse of the DistributionFunction(Double).
InverseDistributionFunction(Double, Double, Double) Returns the inverse of the cumulative distribution function.

InverseDistributionFunction(Double)

Returns the inverse of the DistributionFunction(Double).
C# 
public override double InverseDistributionFunction(
	double probability
)

Parameters

probability  Double
A real number between 0 and 1.

Return Value

Double
The sample value at the specified percentile. For a bounded distribution, the method retuns the lower bound if probability is zero, and the upper bound if probability is equal to 1.

Remarks

This method returns the value x for which the probability of obtaining a sample less than or equal to x is equal to probability.

The InverseDistributionFunction(Double) function is the inverse of the Cumulative Distribution Function.

Exceptions

ArgumentOutOfRangeException

probability is less than zero or greater than 1.

InverseDistributionFunction(Double, Double, Double)

Returns the inverse of the cumulative distribution function.
C# 
public static double InverseDistributionFunction(
	double probability,
	double location,
	double scale
)

Parameters

probability  Double
A real number between 0 and 1.
location  Double
The location parameter.
scale  Double
The scale parameter.

Return Value

Double
The value x for which P(X >= x) = probability.

Exceptions

ArgumentOutOfRangeException

probability is less than 0 or greater than 1.

-or-

scale is less than or equal to zero.

See Also