LogarithmicSeriesDistribution.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,
	double probabilityOfSuccess
)

Public Shared Function Sample ( 
	random As IRandomSource,
	probabilityOfSuccess As Double
) As Integer

public:
static int Sample(
	IRandomSource^ random, 
	double probabilityOfSuccess
)

static member Sample : 
        random : IRandomSource * 
        probabilityOfSuccess : float -> int 

Parameters

random  IRandomSource

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

probabilityOfSuccess  Double

The probability of a trial resulting in success.

Return Value

This method is useful when only a single random number 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<TGenerator>(
	IRandomSource<TGenerator> random,
	double probabilityOfSuccess
)
where TGenerator : struct, new(), IRandomGenerator

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

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

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

Parameters

random  IRandomSource<TGenerator>

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

probabilityOfSuccess  Double

The probability of a trial resulting in success.

Type Parameters

TGenerator

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

Return Value

This method is useful when only a single random number 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(
	Random random,
	double probabilityOfSuccess
)

Public Shared Function Sample ( 
	random As Random,
	probabilityOfSuccess As Double
) As Integer

public:
static int Sample(
	Random^ random, 
	double probabilityOfSuccess
)

static member Sample : 
        random : Random * 
        probabilityOfSuccess : float -> int 

Parameters

random  Random

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

probabilityOfSuccess  Double

The probability of a trial resulting in success.

Return Value

This method is useful when only a single random number 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