Click or drag to resize

SkewedGeneralizedT Class

Continuous Univariate Skewed Generalized T-distribution. Implements the univariate Skewed Generalized t-distribution. For details about this distribution, see Wikipedia - Skewed generalized t-distribution. The skewed generalized t-distribution contains many different distributions within it as special cases based on the parameterization chosen.
Inheritance Hierarchy
SystemObject
  Altaxo.Calc.DistributionsSkewedGeneralizedT

Namespace: Altaxo.Calc.Distributions
Assembly: AltaxoCore (in AltaxoCore.dll) Version: 4.8.3572.0 (4.8.3572.0)
Syntax
C#
public class SkewedGeneralizedT : IContinuousDistribution, 
	IUnivariateDistribution, IDistribution

The SkewedGeneralizedT type exposes the following members.

Constructors
 NameDescription
Public methodSkewedGeneralizedT Initializes a new instance of the SkewedGeneralizedT class. This is a skewed generalized t-distribution with location=0.0, scale=1.0, skew=0.0, p=2.0 and q=Inf (a standard normal distribution).
Public methodSkewedGeneralizedT(Double, Double, Double, Double, Double) Initializes a new instance of the SkewedGeneralizedT class with a particular location, scale, skew and kurtosis parameters. Different parameterizations result in different distributions.
Top
Properties
 NameDescription
Public propertyEntropy Gets the entropy of the distribution.
Public propertyLocation Gets the location (μ) of the Skewed Generalized t-distribution.
Public propertyMaximum Gets the largest element in the domain of the distribution which can be represented by a double.
Public propertyMean Gets the mean of the distribution.
Public propertyMedian Gets the median of the distribution.
Public propertyMinimum Gets the smallest element in the domain of the distribution which can be represented by a double.
Public propertyMode Gets the mode of the distribution.
Public propertyP Gets the first parameter that controls the kurtosis of the distribution. Range: p > 0.
Public propertyQ Gets the second parameter that controls the kurtosis of the distribution. Range: q > 0.
Public propertyRandomSource Gets or sets the random number generator which is used to draw random samples.
Public propertyScale Gets the scale (σ) of the Skewed Generalized t-distribution. Range: σ > 0.
Public propertySkew Gets the skew (λ) of the Skewed Generalized t-distribution. Range: 1 > λ > -1.
Public propertySkewness Gets the skewness of the distribution.
Public propertyStdDev Gets the standard deviation of the distribution.
Public propertyVariance Gets the variance of the distribution.
Top
Methods
 NameDescription
Public methodStatic memberCDF Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x).
Public methodCumulativeDistribution Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x).
Public methodDensity Computes the probability density of the distribution (PDF) at x, i.e. ∂P(X ≤ x)/∂x.
Public methodDensityLn Computes the log probability density of the distribution (lnPDF) at x, i.e. ln(∂P(X ≤ x)/∂x).
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Public methodStatic memberFindSpecializedDistribution Given a parameter set, returns the distribution that matches this parameterization.
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodStatic memberInvCDF Computes the inverse of the cumulative distribution function (InvCDF) for the distribution at the given probability. This is also known as the quantile or percent point function.
Public methodInverseCumulativeDistribution Computes the inverse of the cumulative distribution function (InvCDF) for the distribution at the given probability. This is also known as the quantile or percent point function.
Public methodStatic memberIsValidParameterSet Tests whether the provided values are valid parameters for this distribution.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodStatic memberPDF Computes the probability density of the distribution (PDF) at x, i.e. ∂P(X ≤ x)/∂x.
Public methodStatic memberPDFLn Computes the log probability density of the distribution (lnPDF) at x, i.e. ln(∂P(X ≤ x)/∂x).
Public methodSample Draws a random sample from the distribution.
Public methodStatic memberSample(Double, Double, Double, Double, Double) Generates a sample from the Skew Generalized t-distribution.
Public methodStatic memberSample(Random, Double, Double, Double, Double, Double) Generates a sample from the Skew Generalized t-distribution.
Public methodSamples Draws a sequence of random samples from the distribution.
Public methodSamples(Double) Fills an array with samples generated from the distribution.
Public methodStatic memberSamples(Double, Double, Double, Double, Double) Generates a sequence of samples from the Skew Generalized t-distribution using inverse transform.
Public methodStatic memberSamples(Double, Double, Double, Double, Double, Double) Fills an array with samples from the Skew Generalized t-distribution using inverse transform.
Public methodStatic memberSamples(Random, Double, Double, Double, Double, Double) Generates a sequence of samples from the Skew Generalized t-distribution using inverse transform.
Public methodStatic memberSamples(Random, Double, Double, Double, Double, Double, Double) Fills an array with samples from the Skew Generalized t-distribution using inverse transform.
Public methodToString A string representation of the distribution.
(Overrides ObjectToString)
Top
Remarks

This implementation is based on the R package dsgt and corresponding vignette, see https://cran.r-project.org/web/packages/sgt/vignettes/sgt.pdf. Compared to that implementation, the options for mean adjustment and variance adjustment are always true. The location (μ) is the mean of the distribution. The scale (σ) squared is the variance of the distribution.

The distribution will use the Random by default. Users can get/set the random number generator by using the RandomSource property.

The statistics classes will check all the incoming parameters whether they are in the allowed range.

See Also