Class ChiSquareDistribution
Provides generation of chi-square distributed random numbers.
Inherited Members
Namespace: Experior.Core.Mathematics.Statistics.Generators.Continuous
Assembly: Experior.Core.dll
Syntax
public class ChiSquareDistribution : Distribution
Remarks
The implementation of the ChiSquareDistribution type bases upon information presented on Wikipedia - Chi-square distribution.
Constructors
ChiSquareDistribution()
Initializes a new instance of the ChiSquareDistribution class, using a StandardGenerator as underlying random number generator.
Declaration
public ChiSquareDistribution()
ChiSquareDistribution(Generator)
Initializes a new instance of the ChiSquareDistribution class, using the specified Generator as underlying random number generator.
Declaration
public ChiSquareDistribution(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-square 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-square 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-square distributed random numbers.
Declaration
public override double Mean { get; }
Property Value
Type | Description |
---|---|
System.Double | The mean. |
Overrides
Median
Gets the median of chi-square 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-square distributed random numbers.
Declaration
public override double Minimum { get; }
Property Value
Type | Description |
---|---|
System.Double | The minimum. |
Overrides
Mode
Gets the mode of chi-square distributed random numbers.
Declaration
public override double[] Mode { get; }
Property Value
Type | Description |
---|---|
System.Double[] | The mode. |
Overrides
Variance
Gets the variance of chi-square 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-square distributed floating point random number.
Declaration
public override double NextDouble()
Returns
Type | Description |
---|---|
System.Double | A chi-square distributed double-precision floating point number. |
Overrides
Reset()
Resets the chi-square 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-square distribution was reset; otherwise, false. |