GumbelDistribution.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) Returns a single random sample from a Gumbel distribution with the specified parameters.

Sample(Random, Double, Double)

Returns a single random sample from a Gumbel distribution with the specified parameters.
C#
public static double Sample(
	Random random,
	double location,
	double scale
)

Parameters

random  Random
The Random derived random number generator used to generate the sample.
location  Double
Location parameter of the distribution.
scale  Double
Scale parameter of the distribution.

Return Value

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

Remarks

scale must be 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.
ArgumentOutOfRangeExceptionscale is less than or equal to zero.

See Also