BurrDistribution.Sample Method

Definition

Namespace: Numerics.NET.Statistics.Distributions
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 9.1.4

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 Burr distribution with the specified parameters.

Sample(Random, Double, Double, Double)

Returns a single random sample from a Burr distribution with the specified parameters.
C#
public static double Sample(
	Random random,
	double c,
	double k,
	double scale = 1
)

Parameters

random  Random
The Random derived random number generator used to generate the sample.
c  Double
The first shape parameter of the distribution.
k  Double
The second shape parameter of the distribution.
scale  Double  (Optional)
The scale parameter of the distribution.

Return Value

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

Remarks

c and k 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

ArgumentNullException

random is null.

ArgumentOutOfRangeException

scale is less than or equal to zero.

-or-

shape is less than or equal to zero.

See Also