GammaDistribution Constructor

Definition

Namespace: Numerics.NET.Statistics.Distributions
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 9.0.4
Constructs a new GammaDistribution.

Overload List

GammaDistribution(Double) Constructs a new standard GammaDistribution with the specified order parameter.
GammaDistribution(Vector<Double>) Estimates the parameters of the distribution of a variable assuming it follows a gamma distribution using the methodof matching moments.
GammaDistribution(Double, Double) Constructs a new GammaDistribution with the specified order and scale parameter.
GammaDistribution(Vector<Double>, EstimationMethod) Estimates the parameters of the distribution of a variable assuming it follows a gamma distribution.
GammaDistribution(Double, Double, Double) Constructs a new GammaDistribution with the specified order, scale, and location parameters.

GammaDistribution(Double)

Constructs a new standard GammaDistribution with the specified order parameter.
C# 
public GammaDistribution(
	double order
)

Parameters

order  Double
The order of the distribution. Must be strictly greater than zero.

Remarks

order must be strictly greater than zero. The location parameter of the distribution is set to zero. The scale parameter is set to 1.

Exceptions

ArgumentOutOfRangeException

The order order is less than or equal to zero.

GammaDistribution(Vector<Double>)

Estimates the parameters of the distribution of a variable assuming it follows a gamma distribution using the methodof matching moments.
C# 
public GammaDistribution(
	Vector<double> variable
)

Parameters

variable  Vector<Double>
A vector.

Return Value

A GammaDistribution that best matches the distribution of variable.

Remarks

Use this constructor to create a GammaDistribution whose parameters are estimated from variable. By default, the maximum likelihood estimate is returned, if it is available.

Exceptions

ArgumentNullException

variable is null.

GammaDistribution(Double, Double)

Constructs a new GammaDistribution with the specified order and scale parameter.
C# 
public GammaDistribution(
	double order,
	double scale
)

Parameters

order  Double
The order of the distribution. Must be strictly greater than zero.
scale  Double
The scale parameter. Must be strictly greater than zero.

Remarks

order and scale must be strictly greater than zero. The location parameter of the distribution is set to zero.

Exceptions

ArgumentOutOfRangeException

The order order or the scale factor scale is less than or equal to zero.

GammaDistribution(Vector<Double>, EstimationMethod)

Estimates the parameters of the distribution of a variable assuming it follows a gamma distribution.
C# 
public GammaDistribution(
	Vector<double> variable,
	EstimationMethod method
)

Parameters

variable  Vector<Double>
A vector.
method  EstimationMethod
A EstimationMethod value that specifies the method used to estimate the distribution's parameters.

Return Value

The GammaDistribution that best matches the distribution of variable.

Remarks

Use this constructor to create a GammaDistribution whose parameters are estimated from variable. By default, the maximum likelihood estimate is returned, if it is available.

Exceptions

ArgumentNullException

variable is null.

GammaDistribution(Double, Double, Double)

Constructs a new GammaDistribution with the specified order, scale, and location parameters.
C# 
public GammaDistribution(
	double order,
	double scale,
	double location
)

Parameters

order  Double
The order of the distribution. Must be strictly greater than zero.
scale  Double
The scale parameter. Must be strictly greater than zero.
location  Double
The location parameter.

Remarks

order and scale must be strictly greater than zero.

Exceptions

ArgumentOutOfRangeException

The order order or the scale factor scale is less than or equal to zero.

See Also