DiscreteUniformDistribution.Sample Method

protected override int 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 Integer

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

abstract Sample : 
        generator : 'TGenerator byref -> int  when 'TGenerator : struct, new() and IRandomGenerator
override Sample : 
        generator : 'TGenerator byref -> int  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 int Sample(
	IRandomSource random,
	int maxValue
)

Public Shared Function Sample ( 
	random As IRandomSource,
	maxValue As Integer
) As Integer

public:
static int Sample(
	IRandomSource^ random, 
	int maxValue
)

static member Sample : 
        random : IRandomSource * 
        maxValue : int -> int 

Parameters

random  IRandomSource

 

maxValue  Int32

Maximum value (exclusive).

Return Value

public static int Sample(
	Random random,
	int maxValue
)

Public Shared Function Sample ( 
	random As Random,
	maxValue As Integer
) As Integer

public:
static int Sample(
	Random^ random, 
	int maxValue
)

static member Sample : 
        random : Random * 
        maxValue : int -> int 

Parameters

random  Random

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

maxValue  Int32

The upper bound (one larger than the largest possible value) of the interval.

Return Value

The lower bound of the interval is zero. The upper bound is exclusive: only values strictly less than maxValue will be returned.

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 int Sample(
	IRandomSource random,
	int minValue,
	int maxValue
)

Public Shared Function Sample ( 
	random As IRandomSource,
	minValue As Integer,
	maxValue As Integer
) As Integer

public:
static int Sample(
	IRandomSource^ random, 
	int minValue, 
	int maxValue
)

static member Sample : 
        random : IRandomSource * 
        minValue : int * 
        maxValue : int -> int 

Parameters

random  IRandomSource

 

minValue  Int32

Minimum value (inclusive).

maxValue  Int32

Maximum value (exclusive).

Return Value

public static int Sample(
	Random random,
	int minValue,
	int maxValue
)

Public Shared Function Sample ( 
	random As Random,
	minValue As Integer,
	maxValue As Integer
) As Integer

public:
static int Sample(
	Random^ random, 
	int minValue, 
	int maxValue
)

static member Sample : 
        random : Random * 
        minValue : int * 
        maxValue : int -> int 

Parameters

random  Random

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

minValue  Int32

The minimum value (inclusive).

maxValue  Int32

The maximum value (exclusive).

Return Value

The upper bound is exclusive: only values strictly less than maxValue will be returned.

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