CauchyDistribution Class

Provides generation of Cauchy distributed random numbers.

Inheritance Hierarchy

SystemObject
  Altaxo.Calc.ProbabilityDistribution
    Altaxo.Calc.ProbabilityContinuousDistribution
      Altaxo.Calc.ProbabilityCauchyDistribution

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

Syntax

Copy

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.

Top

Properties

	Name	Description
	Alpha	Gets or sets the parameter alpha (location parameter; designates the median) which is used for generation of Cauchy distributed random numbers.
	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 the half-width 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 the underlying random number generator. (Inherited from Distribution)
	Maximum	Gets the maximum possible value of distributed random numbers. (Overrides DistributionMaximum)
	Mean	Gets the mean of distributed random numbers. (Overrides DistributionMean)
	Median	Gets the median of distributed random numbers. (Overrides DistributionMedian)
	Minimum	Gets the minimum possible value of distributed random numbers. (Overrides DistributionMinimum)
	Mode	Gets the mode of distributed random numbers. (Overrides DistributionMode)
	Variance	Gets the variance of distributed random numbers. (Overrides DistributionVariance)

Top

Methods

	Name	Description
	CDF(Double)	Calculates the cumulative distribution function. (Overrides ContinuousDistributionCDF(Double))
	CDF(Double, Double, Double)	Calculates the cumulative distribution function for the specified parameters.
	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	Initializes this instance with the specified parameters.
	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 distributed floating-point random number. (Overrides DistributionNextDouble)
	PDF(Double)	Calculates the probability density function. (Overrides ContinuousDistributionPDF(Double))
	PDF(Double, Double, Double)	Calculates the probability density function for the specified parameters.
	Quantile(Double)	Calculates the quantile of the distribution function. (Overrides ContinuousDistributionQuantile(Double))
	Quantile(Double, Double, Double)	Calculates the quantile function for the specified parameters.
	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)

Top

Fields

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

Top

Remarks

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

Reference

Altaxo.Calc.Probability Namespace