CauchyDistribution Class

Provides generation of cauchy distributed random numbers.

Inheritance Hierarchy

Namespace: Altaxo.Calc.Probability
Assembly: AltaxoCore (in AltaxoCore.dll) Version: 4.8.3179.0 (4.8.3179.0)

Syntax

public class CauchyDistribution : ContinuousDistribution

The CauchyDistribution type exposes the following members.

Constructors

	Name	Description
	CauchyDistribution	Initializes a new instance of the CauchyDistribution class, using a StandardGenerator as underlying random number generator.
	CauchyDistribution(Generator)	Initializes a new instance of the CauchyDistribution class, using the specified Generator as underlying random number generator.
	CauchyDistribution(Double, Double)	Initializes a new instance of the CauchyDistribution class, using the default random number generator.
	CauchyDistribution(Double, Double, Generator)	Initializes a new instance of the CauchyDistribution class, using the specified Generator as underlying random number generator.

Properties

	Name	Description
	Alpha	Gets or sets the parameter alpha (location parameter - designates the median) of cauchy distributed random numbers which is used for their generation.
	CanReset	Gets a value indicating whether the random number distribution can be reset, so that it produces the same random number sequence again. (Inherited from Distribution)
	Gamma	Gets or sets the parameter gamma (scale parameter - designates half with at half maximum) which is used for generation of cauchy distributed random numbers.
	Generator	Gets or sets a Generator object that can be used as underlying random number generator. (Inherited from Distribution)
	Maximum	Gets the maximum possible value of cauchy distributed random numbers. (Overrides DistributionMaximum)
	Mean	Gets the mean value of cauchy distributed random numbers. It's undefined, so the return value is NaN. (Overrides DistributionMean)
	Median	Gets the median of cauchy distributed random numbers. (Overrides DistributionMedian)
	Minimum	Gets the minimum possible value of cauchy distributed random numbers. (Overrides DistributionMinimum)
	Mode	Gets the mode of cauchy distributed random numbers. (Overrides DistributionMode)
	Variance	Gets the variance of cauchy distributed random numbers. (Overrides DistributionVariance)

Methods

	Name	Description
	CDF(Double)	(Overrides ContinuousDistributionCDF(Double))
	CDF(Double, Double, Double)
	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)
	Initialize
	IsValidAlpha	Determines whether the specified value is valid for parameter Alpha.
	IsValidGamma	Determines whether the specified value is valid for parameter Gamma.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	NextDouble	Returns a cauchy distributed floating point random number. (Overrides DistributionNextDouble)
	PDF(Double)	(Overrides ContinuousDistributionPDF(Double))
	PDF(Double, Double, Double)
	Quantile(Double)	(Overrides ContinuousDistributionQuantile(Double))
	Quantile(Double, Double, Double)
	Reset	Resets the random number distribution, so that it produces the same random number sequence again. (Inherited from Distribution)
	ToString	Returns a string that represents the current object. (Inherited from Object)

Fields

	Name	Description
	generator	Stores a Generator object that can be used as underlying random number generator. (Inherited from Distribution)

Remarks

The implementation of the CauchyDistribution type bases upon information presented on Wikipedia - Cauchy distribution and Xycoon - Cauchy Distribution.