CauchyDistribution.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) Returns a single random sample from a Cauchy distribution with the specified scale parameter.

CauchyDistribution.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.

CauchyDistribution.Sample(Random, Double)

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

Parameters

random  Random
The Random derived random number generator used to generate the sample.
scale  Double
A scale parameter.

Return Value

Double
A double-precision floating-point sample from the Cauchy distribution with the specified scale parameter.

Remarks

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