Class ChiDistribution

Provides generation of chi distributed random numbers.

Inheritance
System.Object
Distribution
ChiDistribution
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 ChiDistribution : Distribution
Remarks

The implementation of the ChiDistribution type bases upon information presented on Wikipedia - Chi distribution.

Constructors

ChiDistribution()

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

Declaration
public ChiDistribution()

ChiDistribution(Generator)

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

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

A Generator object.

Properties

Alpha

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

Declaration
public int Alpha { get; set; }
Property Value
Type Description
System.Int32

The alpha.
Remarks

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

Maximum

Gets the maximum possible value of chi distributed random numbers.

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

The maximum.
Overrides

Mean

Gets the mean value of chi distributed random numbers.

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

The mean.
Overrides

Median

Gets the median of chi 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 chi distributed random numbers.

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

The minimum.
Overrides

Mode

Gets the mode of chi distributed random numbers.

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

The mode.
Overrides

Variance

Gets the variance of chi distributed random numbers.

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

The variance.
Overrides

Methods

IsValidAlpha(Int32)

Determines whether the specified value is valid for parameter Alpha.

Declaration
public bool IsValidAlpha(int value)
Parameters
Type Name Description
System.Int32 value

The value to check.
Returns
Type Description
System.Boolean

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

NextDouble()

Returns a chi distributed floating point random number.

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

A chi distributed double-precision floating point number.
Overrides

Reset()

Resets the chi distribution, so that it produces the same random number sequence again.

Declaration
public override bool Reset()
Returns
Type Description
System.Boolean

true, if the chi distribution was reset; otherwise, false.
Overrides