TransformedGammaDistribution.Sample Method

Definition

Namespace: Extreme.Statistics.Distributions
Assembly: Extreme.Numerics (in Extreme.Numerics.dll) Version: 8.1.23

Overload List

Sample() Returns a random sample from the distribution.
Sample(Int32) Returns a vector of random samples from the distribution.
Sample(Random) Returns a random sample from the distribution.
Sample(Int32, Random) Returns a vector of random samples from the distribution.
Sample(Random, Double, Double, Double) Returns a single random sample from a transformed gamma distribution with the specified parameters.

Sample(Random)

Returns a random sample from the distribution.
C#
public override double Sample(
	Random random
)

Parameters

random  Random
The Random derived random number generator used to generate the sample.

Return Value

Double
A double-precision floating-point number.

Remarks

This method uses the random number generator specified by random to generate a random sample from the distribution. The return values of successive calls to this method follow the distribution represented by this distribution.

Exceptions

ArgumentNullExceptionrandom is null.

Sample(Random, Double, Double, Double)

Returns a single random sample from a transformed gamma distribution with the specified parameters.
C#
public static double Sample(
	Random random,
	double shape1,
	double shape2,
	double scale
)

Parameters

random  Random
The Random derived random number generator used to generate the sample.
shape1  Double
The first shape parameter of the distribution. Must be strictly greater than zero.
shape2  Double
The second shape parameter of the distribution. Must be strictly greater than zero.
scale  Double
The scale parameter. Must be strictly greater than zero.

Return Value

Double
A double-precision floating-point number that is a sample from the transformed gamma distribution with the specified parameters.

Remarks

scale must be strictly greater than zero.

This method is useful when only a single random sample is required, or if the parameters of the distribution change often. To obtain a large number of samples from a distribution with identical parameters, create an instance of the class and call the Sample() method repeatedly.

Exceptions

ArgumentNullExceptionrandom is null.
ArgumentOutOfRangeExceptionshape1 is less than or equal to zero.

-or-

shape2 is less than or equal to zero.

-or-

scale is less than or equal to zero.

See Also