GeneralizedParetoDistribution.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 shape,
	double scale
)

Public Shared Function Sample ( 
	random As IRandomSource,
	shape As Double,
	scale As Double
) As Double

public:
static double Sample(
	IRandomSource^ random, 
	double shape, 
	double scale
)

static member Sample : 
        random : IRandomSource * 
        shape : float * 
        scale : float -> float 

Parameters

random  IRandomSource

The random number generator used to generate the sample.

shape  Double

Shape parameter of the distribution.

scale  Double

Scale parameter.

Return Value

scale must be strictly greater than zero. The location parameter of the distribution is set to 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 shape,
	double scale
)
where TGenerator : struct, new(), IRandomGenerator

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

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

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

Parameters

random  IRandomSource<TGenerator>

The random number generator used to generate the sample.

shape  Double

Shape parameter of the distribution.

scale  Double

Scale parameter.

Type Parameters

TGenerator

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

Return Value

scale must be strictly greater than zero. The location parameter of the distribution is set to 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 shape,
	double scale
)

Public Shared Function Sample ( 
	random As Random,
	shape As Double,
	scale As Double
) As Double

public:
static double Sample(
	Random^ random, 
	double shape, 
	double scale
)

static member Sample : 
        random : Random * 
        shape : float * 
        scale : float -> float 

Parameters

random  Random

The random number generator used to generate the sample.

shape  Double

Shape parameter of the distribution.

scale  Double

Scale parameter.

Return Value

scale must be strictly greater than zero. The location parameter of the distribution is set to 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(
	IRandomSource random,
	double shape,
	double scale,
	double location
)

Public Shared Function Sample ( 
	random As IRandomSource,
	shape As Double,
	scale As Double,
	location As Double
) As Double

public:
static double Sample(
	IRandomSource^ random, 
	double shape, 
	double scale, 
	double location
)

static member Sample : 
        random : IRandomSource * 
        shape : float * 
        scale : float * 
        location : float -> float 

Parameters

random  IRandomSource

The random number generator used to generate the sample.

shape  Double

Shape parameter of the distribution.

scale  Double

Scale parameter.

location  Double

Location parameter of the distribution.

Return Value

scale 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 shape,
	double scale,
	double location
)
where TGenerator : struct, new(), IRandomGenerator

Public Shared Function Sample(Of TGenerator As {Structure, New, IRandomGenerator}) ( 
	random As IRandomSource(Of TGenerator),
	shape As Double,
	scale As Double,
	location As Double
) As Double

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

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

Parameters

random  IRandomSource<TGenerator>

The random number generator used to generate the sample.

shape  Double

Shape parameter of the distribution.

scale  Double

Scale parameter.

location  Double

Location parameter of the distribution.

Type Parameters

TGenerator

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

Return Value

scale 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 shape,
	double scale,
	double location
)

Public Shared Function Sample ( 
	random As Random,
	shape As Double,
	scale As Double,
	location As Double
) As Double

public:
static double Sample(
	Random^ random, 
	double shape, 
	double scale, 
	double location
)

static member Sample : 
        random : Random * 
        shape : float * 
        scale : float * 
        location : float -> float 

Parameters

random  Random

The random number generator used to generate the sample.

shape  Double

Shape parameter of the distribution.

scale  Double

Scale parameter.

location  Double

Location parameter of the distribution.

Return Value

scale 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