FDistribution.Sample Method

protected override double Sample<TGenerator>(
	ref TGenerator generator
)
where TGenerator : struct, new(), IRandomGenerator

Protected Overrides Function Sample(Of TGenerator As {Structure, New, IRandomGenerator}) ( 
	ByRef generator As TGenerator
) As Double

protected:
generic<typename TGenerator>
where TGenerator : value class, gcnew(), IRandomGenerator
virtual double Sample(
	TGenerator% generator
) override

abstract Sample : 
        generator : 'TGenerator byref -> float  when 'TGenerator : struct, new() and IRandomGenerator
override Sample : 
        generator : 'TGenerator byref -> float  when 'TGenerator : struct, new() and IRandomGenerator

Parameters

generator  TGenerator

A reference to a struct implementing IRandomGenerator used to produce uniform variates.

Type Parameters

TGenerator

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

Return Value

Implementations may override this method to provide a more efficient or specialized sampling algorithm that consumes raw uniform variates from generator.

public static double Sample(
	IRandomSource random,
	double numeratorDegreesOfFreedom,
	double denominatorDegreesOfFreedom
)

Public Shared Function Sample ( 
	random As IRandomSource,
	numeratorDegreesOfFreedom As Double,
	denominatorDegreesOfFreedom As Double
) As Double

public:
static double Sample(
	IRandomSource^ random, 
	double numeratorDegreesOfFreedom, 
	double denominatorDegreesOfFreedom
)

static member Sample : 
        random : IRandomSource * 
        numeratorDegreesOfFreedom : float * 
        denominatorDegreesOfFreedom : float -> float 

Parameters

random  IRandomSource

The random number generator used to generate the sample.

numeratorDegreesOfFreedom  Double

The number of degrees of freedom for the variance of the sample for the numerator.

denominatorDegreesOfFreedom  Double

The number of degrees of freedom for the variance of the sample for the denominator.

Return Value

numeratorDegreesOfFreedom and denominatorDegreesOfFreedom 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.

public static double Sample<TGenerator>(
	IRandomSource<TGenerator> random,
	double numeratorDegreesOfFreedom,
	double denominatorDegreesOfFreedom
)
where TGenerator : struct, new(), IRandomGenerator

Public Shared Function Sample(Of TGenerator As {Structure, New, IRandomGenerator}) ( 
	random As IRandomSource(Of TGenerator),
	numeratorDegreesOfFreedom As Double,
	denominatorDegreesOfFreedom As Double
) As Double

public:
generic<typename TGenerator>
where TGenerator : value class, gcnew(), IRandomGenerator
static double Sample(
	IRandomSource<TGenerator>^ random, 
	double numeratorDegreesOfFreedom, 
	double denominatorDegreesOfFreedom
)

static member Sample : 
        random : IRandomSource<'TGenerator> * 
        numeratorDegreesOfFreedom : float * 
        denominatorDegreesOfFreedom : float -> float  when 'TGenerator : struct, new() and IRandomGenerator

Parameters

random  IRandomSource<TGenerator>

The random number generator used to generate the sample.

numeratorDegreesOfFreedom  Double

The number of degrees of freedom for the variance of the sample for the numerator.

denominatorDegreesOfFreedom  Double

The number of degrees of freedom for the variance of the sample for the denominator.

Type Parameters

TGenerator

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

Return Value

numeratorDegreesOfFreedom and denominatorDegreesOfFreedom 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.

public static double Sample(
	Random random,
	double numeratorDegreesOfFreedom,
	double denominatorDegreesOfFreedom
)

Public Shared Function Sample ( 
	random As Random,
	numeratorDegreesOfFreedom As Double,
	denominatorDegreesOfFreedom As Double
) As Double

public:
static double Sample(
	Random^ random, 
	double numeratorDegreesOfFreedom, 
	double denominatorDegreesOfFreedom
)

static member Sample : 
        random : Random * 
        numeratorDegreesOfFreedom : float * 
        denominatorDegreesOfFreedom : float -> float 

Parameters

random  Random

The random number generator used to generate the sample.

numeratorDegreesOfFreedom  Double

The number of degrees of freedom for the variance of the sample for the numerator.

denominatorDegreesOfFreedom  Double

The number of degrees of freedom for the variance of the sample for the denominator.

Return Value

numeratorDegreesOfFreedom and denominatorDegreesOfFreedom 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.

Reference