Class GammaDistribution
Provides generation of gamma distributed random numbers.
Inherited Members
Namespace: Experior.Core.Mathematics.Statistics.Generators.Continuous
Assembly: Experior.Core.dll
Syntax
public class GammaDistribution : Distribution
Remarks
The implementation of the GammaDistribution type bases upon information presented on Wikipedia - Gamma distribution.
Constructors
GammaDistribution()
Initializes a new instance of the GammaDistribution class, using a StandardGenerator as underlying random number generator.
Declaration
public GammaDistribution()
GammaDistribution(Generator)
Initializes a new instance of the GammaDistribution class, using the specified Generator as underlying random number generator.
Declaration
public GammaDistribution(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 gamma distributed random numbers.
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.
Maximum
Gets the maximum possible value of gamma distributed random numbers.
Declaration
public override double Maximum { get; }
Property Value
Type | Description |
---|---|
System.Double | The maximum. |
Overrides
Mean
Gets the mean value of gamma distributed random numbers.
Declaration
public override double Mean { get; }
Property Value
Type | Description |
---|---|
System.Double | The mean. |
Overrides
Median
Gets the median of gamma 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 gamma distributed random numbers.
Declaration
public override double Minimum { get; }
Property Value
Type | Description |
---|---|
System.Double | The minimum. |
Overrides
Mode
Gets the mode of gamma distributed random numbers.
Declaration
public override double[] Mode { get; }
Property Value
Type | Description |
---|---|
System.Double[] | The mode. |
Overrides
Theta
Gets or sets the parameter theta which is used for generation of gamma distributed random numbers.
Declaration
public double Theta { get; set; }
Property Value
Type | Description |
---|---|
System.Double | The theta. |
Remarks
Call IsValidTheta(Double) to determine whether a value is valid and therefor assignable.
Variance
Gets the variance of gamma 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 if value is greater than 0.0; otherwise, false. |
IsValidTheta(Double)
Determines whether the specified value is valid for parameter Theta.
Declaration
public bool IsValidTheta(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 gamma distributed floating point random number.
Declaration
public override double NextDouble()
Returns
Type | Description |
---|---|
System.Double | A gamma distributed double-precision floating point number. |