HyperbolicDistribution Class

Represents the hyperbolic distribution.

Definition

Namespace: Numerics.NET.Statistics.Distributions
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 9.0.3
C#
[SerializableAttribute]
public class HyperbolicDistribution : ContinuousDistribution
Inheritance
Object  →  Distribution  →  ContinuousDistribution  →  HyperbolicDistribution

Remarks

The hyperbolic distribution has a probability density whose logarithm is a hyperbola. It has heavier tails than the normal distribution.

The hyperbolic distribution has a location parameter, a scale parameter, and two shape parameters.

Constructors

HyperbolicDistribution Constructs a new HyperbolicDistribution object.

Properties

AsymmetryParameter Gets the first shape parameter for the distribution.
Capabilities Gets a value that indicates the capabilities of the distribution class.
(Inherited from Distribution)
Entropy Gets the entropy of the distribution.
(Inherited from Distribution)
InterQuartileRange Returns the inter-quartile range of this distribution.
(Inherited from ContinuousDistribution)
IsSymmetrical Gets whether the distribution is known to be symmetrical around the mean.
(Inherited from ContinuousDistribution)
IsUnimodal Gets whether the distribution has one or more modes.
(Inherited from ContinuousDistribution)
Kurtosis Gets the kurtosis of the distribution.
(Inherited from Distribution)
LocationParameter Gets the location parameter for the distribution.
Mean Gets the mean or expectation value of the distribution.
(Overrides Distribution.Mean)
Median Gets the median of the distribution.
(Inherited from ContinuousDistribution)
Mode Gets the mode of the distribution.
(Overrides ContinuousDistribution.Mode)
NumberOfModes Gets the number of modes of the distribution.
(Inherited from ContinuousDistribution)
ScaleParameter Gets the scale parameter for the distribution.
Skewness Gets the skewness of the distribution.
(Inherited from Distribution)
StandardDeviation Gets the standard deviation of the distribution.
(Inherited from Distribution)
StatisticSymbol Gets the common symbol to describe a statistic from the distribution.
(Inherited from Distribution)
Support Gets the support of the distribution.
(Inherited from ContinuousDistribution)
TailHeavinessParameter Gets the first shape parameter for the distribution.
Variance Gets the variance of the distribution.
(Overrides Distribution.Variance)

Methods

Cdf Evaluates the cumulative distribution function (CDF) of this distribution for the specified value.
(Inherited from ContinuousDistribution)
DistributionFunction Evaluates the cumulative distribution function (CDF) of this distribution for the specified value.
(Overrides ContinuousDistribution.DistributionFunction(Double))
EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
GetAllModes Returns an array that contains all the modes of the distribution.
(Inherited from ContinuousDistribution)
GetExpectationValue(Func<Double, Double>) Returns the expectation value of a function.
(Inherited from ContinuousDistribution)
GetExpectationValue(Func<Double, Double>, Double, Double) Returns the un-normalized expectation value of a function over the specified interval.
(Inherited from ContinuousDistribution)
GetExpectedHistogram(Double[], Double) Gets a vector containing a histogram of the expected number of samples for a given total number of samples.
(Inherited from ContinuousDistribution)
GetExpectedHistogram(IntervalIndex<Double>, Double) Gets a vector containing a histogram of the expected number of samples for a given total number of samples.
(Inherited from ContinuousDistribution)
GetExpectedHistogram(Double, Double, Int32, Double) Gets a vector whose bins contain the expected number of samples for a given total number of samples.
(Inherited from ContinuousDistribution)
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetRandomSequence() Returns a sequence of random samples from the distribution.
(Inherited from ContinuousDistribution)
GetRandomSequence(Random) Returns a sequence of random samples from the distribution.
(Inherited from ContinuousDistribution)
GetRandomSequence(Random, Int32) Returns a sequence of random samples of the specified length from the distribution.
(Inherited from ContinuousDistribution)
GetTypeGets the Type of the current instance.
(Inherited from Object)
HazardFunction Returns the probability of failure at the specified value.
(Inherited from ContinuousDistribution)
InverseCdf Returns the inverse of the DistributionFunction(Double).
(Inherited from ContinuousDistribution)
InverseDistributionFunction Returns the inverse of the DistributionFunction(Double).
(Inherited from ContinuousDistribution)
LeftTailProbability Returns the probability that a sample from the distribution is less than the specified value.
(Inherited from ContinuousDistribution)
LogProbabilityDensityFunction Returns the logarithm of the probability density function (PDF) of this distribution for the specified value.
(Inherited from ContinuousDistribution)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
MomentFunction Returns the value of the moment function of the specified order.
(Inherited from ContinuousDistribution)
Pdf Returns the value of the probability density function (PDF) of this distribution for the specified value.
(Inherited from ContinuousDistribution)
Probability Returns the probability that a sample taken from the distribution lies inside the specified interval.
(Inherited from ContinuousDistribution)
ProbabilityDensityFunction Returns the value of the probability density function (PDF) of this distribution for the specified value.
(Overrides ContinuousDistribution.ProbabilityDensityFunction(Double))
RightTailProbability Returns the probability that a sample from the distribution is larger than the specified value.
(Inherited from ContinuousDistribution)
Sample() Returns a random sample from the distribution.
(Inherited from ContinuousDistribution)
Sample(Int32) Returns a vector of random samples from the distribution.
(Inherited from ContinuousDistribution)
Sample(Random) Returns a random sample from the distribution.
(Inherited from ContinuousDistribution)
Sample(Int32, Random) Returns a vector of random samples from the distribution.
(Inherited from ContinuousDistribution)
SampleInto(Random, IList<Double>) Fills a list with random numbers from the distribution.
(Inherited from ContinuousDistribution)
SampleInto(Random, Double[]) Fills a list with random numbers from the distribution.
(Inherited from ContinuousDistribution)
SampleInto(Random, Span<Double>) Fills a span with random numbers from the distribution.
(Inherited from ContinuousDistribution)
SampleInto(Random, IList<Double>, Int32, Int32) Fills part of a list with random numbers from the distribution.
(Inherited from ContinuousDistribution)
SurvivorDistributionFunction Evaluates the survivor distribution function (SDF) of this distribution for the specified value.
(Inherited from ContinuousDistribution)
ToStringReturns a string that represents the current object.
(Inherited from Object)
TwoTailedProbability Returns the probability that a sample from the distribution deviates from the mean more than the specified value.
(Inherited from ContinuousDistribution)

See Also