SkewedGeneralizedError Class

Continuous Univariate Skewed Generalized Error Distribution (SGED). Implements the univariate Skewed Generalized Error Distribution. For details about this distribution, see Wikipedia - Generalized Error Distribution. It includes Laplace, Normal and Student-t distributions. This is the SkewedGeneralizedT distribution with q=Inf.

Inheritance Hierarchy

SystemObject
Altaxo.Calc.DistributionsSkewedGeneralizedError

Namespace: Altaxo.Calc.Distributions
Assembly: AltaxoCore (in AltaxoCore.dll) Version: 4.8.3572.0 (4.8.3572.0)

Syntax

Copy

public class SkewedGeneralizedError : IContinuousDistribution, 
	IUnivariateDistribution, IDistribution

The SkewedGeneralizedError type exposes the following members.

Constructors

	Name	Description
	SkewedGeneralizedError	Initializes a new instance of the SkewedGeneralizedError class. This is a generalized error distribution with location=0.0, scale=1.0, skew=0.0 and p=2.0 (a standard normal distribution).
	SkewedGeneralizedError(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

	Name	Description
	Entropy	Gets the entropy of the distribution.
	Location	Gets the location (μ) of the Skewed Generalized t-distribution.
	Maximum	Gets the largest element in the domain of the distribution which can be represented by a double.
	Mean	Gets the mean of the distribution.
	Median	Gets the median of the distribution.
	Minimum	Gets the smallest element in the domain of the distribution which can be represented by a double.
	Mode	Gets the mode of the distribution.
	P	Gets the parameter that controls the kurtosis of the distribution. Range: p > 0.
	RandomSource	Gets or sets the random number generator which is used to draw random samples.
	Scale	Gets the scale (σ) of the Skewed Generalized t-distribution. Range: σ > 0.
	Skew	Gets the skew (λ) of the Skewed Generalized t-distribution. Range: 1 > λ > -1.
	Skewness	Gets the skewness of the distribution.
	StdDev	Gets the standard deviation of the distribution.
	Variance	Gets the variance of the distribution.

Top

Methods

	Name	Description
	CDF	Computes the cumulative distribution of the distribution at x.
	CumulativeDistribution	Computes the cumulative distribution (CDF) of the distribution at x, i.e. P(X ≤ x).
	Density	Computes the probability density of the distribution (PDF) at x, i.e. ∂P(X ≤ x)/∂x.
	DensityLn	Computes the log probability density of the distribution (lnPDF) at x, i.e. ln(∂P(X ≤ x)/∂x).
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object)
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	InvCDF	Computes the inverse cumulative distribution for the specified probability.
	InverseCumulativeDistribution	Computes the inverse cumulative distribution function for the current distribution.
	IsValidParameterSet	Tests whether the provided values are valid parameters for this distribution.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	PDF	Computes the probability density of the distribution at x.
	PDFLn	Computes the logarithm of the probability density of the distribution at x.
	Sample	Draws a random sample from the distribution.
	Sample(Double, Double, Double, Double)	Generates a sample from the Skew Generalized Error distribution.
	Sample(Random, Double, Double, Double, Double)	Generates a sample from the Skew Generalized Error distribution.
	Samples	Draws a sequence of random samples from the distribution.
	Samples(Double)	Fills an array with samples generated from the distribution.
	Samples(Double, Double, Double, Double)	Generates a sequence of samples from the Skew Generalized Error distribution using inverse transform.
	Samples(Double, Double, Double, Double, Double)	Fills an array with samples from the Skew Generalized Error distribution using inverse transform.
	Samples(Random, Double, Double, Double, Double)	Generates a sequence of samples from the Skew Generalized Error distribution using inverse transform.
	Samples(Random, Double, Double, Double, Double, Double)	Fills an array with samples from the Skew Generalized Error distribution using inverse transform.
	ToString	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.

Reference

Altaxo.Calc.Distributions Namespace