GumbelDistribution..::..Sample Method (Random, Double, Double)

GumbelDistribution Class See Also

Returns a single random sample from a Gumbel distribution with the specified parameters.

Namespace: Extreme.Statistics.Distributions
Assembly: Extreme.Numerics.Net40 (in Extreme.Numerics.Net40.dll) Version: 4.2.11333.0 (4.2.12253.0)

Syntax

C#
public static double Sample( Random random, double location, double scale )

Visual Basic (Declaration)
Public Shared Function Sample ( _ random As Random, _ location As Double, _ scale As Double _ ) As Double

Visual C++
public: static double Sample( Random^ random, double location, double scale )

F#
static member Sample : random:Random * location:float * scale:float -> float

Parameters

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

location: Type: System..::..Double
Location parameter of the distribution.

scale: Type: System..::..Double
Scale parameter of the distribution.

Return Value

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(Random, Double, Double) method repeatedly.

Exceptions

Exception	Condition
System..::..ArgumentNullException	random is nullNothingnullptra null reference (Nothing in Visual Basic).
System..::..ArgumentOutOfRangeException	scale is less than or equal to zero.