ChiSquareDistribution.Sample Method

Definition

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

Overload List

Sample() Returns a single random sample drawn from this distribution.
Sample(Int32) Returns a vector containing the specified number of independent random samples drawn from this distribution.
Sample(IRandomSource) Returns a random sample from the distribution using a Random instance.
Sample(Random) Returns a random sample from the distribution using a Random instance.
Sample(Int32, IRandomSource) Returns a vector containing the specified number of independent random samples drawn from this distribution using the provided IRandomSource.
Sample(Int32, Random) Returns a vector of random samples from the distribution.
Sample(IRandomSource, Double) Returns a single random sample from a chi-squared distribution with the specified degrees of freedom.
Sample(Random, Double) Returns a single random sample from a chi-squared distribution with the specified degrees of freedom.
Sample<TGenerator>(IRandomSource<TGenerator>) Returns a random sample from the distribution using the supplied IRandomSource<TGenerator>.
Sample<TGenerator>(TGenerator) Returns a random sample from the distribution using the provided generator.
Sample<TGenerator>(Int32, IRandomSource<TGenerator>) Returns a vector containing the specified number of independent random samples drawn from this distribution using the supplied IRandomSource<TGenerator>.
Sample<TGenerator>(IRandomSource<TGenerator>, Double) Returns a single random sample from a chi-squared distribution with the specified degrees of freedom.

Sample(IRandomSource, Double)

Returns a single random sample from a chi-squared distribution with the specified degrees of freedom.
C#
public static double Sample(
	IRandomSource random,
	double degreesOfFreedom
)

Parameters

random  IRandomSource
The random number generator used to generate the sample.
degreesOfFreedom  Double
The degrees of freedom of the distribution.

Return Value

Double
A double-precision floating-point sample from the chi-squared distribution with the specified degrees of freedom.

Remarks

degreesOfFreedom 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

degreesOfFreedom is less than or equal to zero.

Sample<TGenerator>(IRandomSource<TGenerator>, Double)

Returns a single random sample from a chi-squared distribution with the specified degrees of freedom.
C#
public static double Sample<TGenerator>(
	IRandomSource<TGenerator> random,
	double degreesOfFreedom
)
where TGenerator : struct, new(), IRandomGenerator

Parameters

random  IRandomSource<TGenerator>
The random number generator used to generate the sample.
degreesOfFreedom  Double
The degrees of freedom of the distribution.

Type Parameters

TGenerator
The underlying generator type of the random source, used to enable optimizations like inlining.

Return Value

Double
A double-precision floating-point sample from the chi-squared distribution with the specified degrees of freedom.

Remarks

degreesOfFreedom 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

degreesOfFreedom is less than or equal to zero.

Sample(Random, Double)

Returns a single random sample from a chi-squared distribution with the specified degrees of freedom.
C#
public static double Sample(
	Random random,
	double degreesOfFreedom
)

Parameters

random  Random
The random number generator used to generate the sample.
degreesOfFreedom  Double
The degrees of freedom of the distribution.

Return Value

Double
A double-precision floating-point sample from the chi-squared distribution with the specified degrees of freedom.

Remarks

degreesOfFreedom 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

degreesOfFreedom is less than or equal to zero.

See Also