Class CauchyDistribution

Provides generation of cauchy distributed random numbers.

Inheritance
System.Object
Distribution
CauchyDistribution
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Experior.Core.Mathematics.Statistics.Generators.Continuous
Assembly: Experior.Core.dll
Syntax
public class CauchyDistribution : Distribution
Remarks

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

Constructors

CauchyDistribution()

Initializes a new instance of the CauchyDistribution class, using a StandardGenerator as underlying random number generator.

Declaration
public CauchyDistribution()

CauchyDistribution(Generator)

Initializes a new instance of the CauchyDistribution class, using the specified Generator as underlying random number generator.

Declaration
public CauchyDistribution(Generator generator)
Parameters
Type Name Description
Generator generator

A Generator object.

Properties

Alpha

Gets or sets the parameter alpha of cauchy distributed random numbers which is used for their generation.

Declaration
public double Alpha { get; set; }
Property Value
Type Description
System.Double

The alpha.
Remarks

Call IsValidAlpha(Double) to determine whether a value is valid and therefor assignable.

Gamma

Gets or sets the parameter gamma which is used for generation of cauchy distributed random numbers.

Declaration
public double Gamma { get; set; }
Property Value
Type Description
System.Double

The gamma.
Remarks

Call IsValidGamma(Double) to determine whether a value is valid and therefor assignable.

Maximum

Gets the maximum possible value of cauchy distributed random numbers.

Declaration
public override double Maximum { get; }
Property Value
Type Description
System.Double

The maximum.
Overrides

Mean

Gets the mean value of cauchy distributed random numbers.

Declaration
public override double Mean { get; }
Property Value
Type Description
System.Double

The mean.
Overrides

Median

Gets the median of cauchy distributed random numbers.

Declaration
public override double Median { get; }
Property Value
Type Description
System.Double

The median.
Overrides

Minimum

Gets the minimum possible value of cauchy distributed random numbers.

Declaration
public override double Minimum { get; }
Property Value
Type Description
System.Double

The minimum.
Overrides

Mode

Gets the mode of cauchy distributed random numbers.

Declaration
public override double[] Mode { get; }
Property Value
Type Description
System.Double[]

The mode.
Overrides

Variance

Gets the variance of cauchy distributed random numbers.

Declaration
public override double Variance { get; }
Property Value
Type Description
System.Double

The variance.
Overrides

Methods

IsValidAlpha(Double)

Determines whether the specified value is valid for parameter Alpha.

Declaration
public bool IsValidAlpha(double value)
Parameters
Type Name Description
System.Double value

The value to check.
Returns
Type Description
System.Boolean

true.

IsValidGamma(Double)

Determines whether the specified value is valid for parameter Gamma.

Declaration
public bool IsValidGamma(double value)
Parameters
Type Name Description
System.Double value

The value to check.
Returns
Type Description
System.Boolean

true if value is greater than 0.0; otherwise, false.

NextDouble()

Returns a cauchy distributed floating point random number.

Declaration
public override double NextDouble()
Returns
Type Description
System.Double

A cauchy distributed double-precision floating point number.
Overrides