DiscreteDistribution.Sample Method

Definition

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

Overload List

Sample()	Returns a random sample from the 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 an IRandomSource 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, Int32[])	Fills an Int32 array with random numbers. Obsolete
Sample(Random, Int32[])	Fills an Int32 array with random numbers. Obsolete
Sample(IRandomSource, Int32[], Int32, Int32)	Fills an Int32 array with random numbers from this DiscreteDistribution. Obsolete
Sample(Random, Int32[], Int32, Int32)	Fills an Int32 array with random numbers from this DiscreteDistribution. Obsolete
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

Returns a random sample from the distribution.

public int Sample()

Visual Basic

Public Function Sample As Integer

C++/CLI

public:
int Sample()

member Sample : unit -> int

Return Value

Int32
A signed 32-bit integer.

Remarks

This method uses the default random number generator specified by Instance to generate a random sample from the distribution. The return values of successive calls to this method follow the statistical distribution represented by this distribution.

Sample(Int32)

Returns a vector containing the specified number of independent random samples drawn from this distribution.

public Vector<int> Sample(
	int size
)

Visual Basic

Public Function Sample ( 
	size As Integer
) As Vector(Of Integer)

C++/CLI

public:
Vector<int>^ Sample(
	int size
)

member Sample : 
        size : int -> Vector<int>

Parameters

size Int32: The number of samples to generate. Must be greater than zero.

Return Value

Vector<Int32>
A Vector<T> of length size.

Remarks

This overload uses Instance as the source of randomness.

Exceptions

ArgumentOutOfRangeException

size is less than or equal to zero.

Sample(IRandomSource)

Returns a random sample from the distribution using an IRandomSource instance.

public int Sample(
	IRandomSource random
)

Visual Basic

Public Function Sample ( 
	random As IRandomSource
) As Integer

C++/CLI

public:
int Sample(
	IRandomSource^ random
)

member Sample : 
        random : IRandomSource -> int

Parameters

random IRandomSource: An IRandomSource that will be adapted to the internal generator abstraction.

Return Value

Int32
A signed 32-bit integer random variate.

Exceptions

ArgumentNullException

random is null.

Sample<TGenerator>(IRandomSource<TGenerator>)

Returns a random sample from the distribution using the supplied IRandomSource<TGenerator>.

public int Sample<TGenerator>(
	IRandomSource<TGenerator> random
)
where TGenerator : struct, new(), IRandomGenerator

Visual Basic

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

C++/CLI

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

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

Parameters

random IRandomSource<TGenerator>: The random source that exposes a 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

Int32
A signed 32-bit integer random variate.

Exceptions

ArgumentNullException

random is null.

Sample(Random)

Returns a random sample from the distribution using a Random instance.

public int Sample(
	Random random
)

Visual Basic

Public Function Sample ( 
	random As Random
) As Integer

C++/CLI

public:
int Sample(
	Random^ random
)

member Sample : 
        random : Random -> int

Parameters

random Random: A Random that will be adapted to the internal generator abstraction.

Return Value

Int32
A signed 32-bit integer random variate.

Exceptions

ArgumentNullException

random is null.

Sample<TGenerator>(TGenerator)

Returns a random sample from the distribution using the provided generator.

protected virtual int Sample<TGenerator>(
	ref TGenerator generator
)
where TGenerator : struct, new(), IRandomGenerator

Visual Basic

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

C++/CLI

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

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

Int32
A signed 32-bit integer random variate.

Remarks

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

Sample(Int32, IRandomSource)

Returns a vector containing the specified number of independent random samples drawn from this distribution using the provided IRandomSource.

public Vector<int> Sample(
	int size,
	IRandomSource random
)

Visual Basic

Public Function Sample ( 
	size As Integer,
	random As IRandomSource
) As Vector(Of Integer)

C++/CLI

public:
Vector<int>^ Sample(
	int size, 
	IRandomSource^ random
)

member Sample : 
        size : int * 
        random : IRandomSource -> Vector<int>

Parameters

size Int32: The number of samples to generate. Must be greater than zero.
random IRandomSource: The random source to use for generating uniform variates.

Return Value

Vector<Int32>
A Vector<T> of length size.

Remarks

This overload uses the provided random instance to obtain an internal generator suitable for bulk sampling.

Exceptions

ArgumentNullException	random is null.
ArgumentOutOfRangeException	size is less than or equal to zero.

Sample(Int32, Random)

Returns a vector of random samples from the distribution.

public Vector<int> Sample(
	int size,
	Random random
)

Visual Basic

Public Function Sample ( 
	size As Integer,
	random As Random
) As Vector(Of Integer)

C++/CLI

public:
Vector<int>^ Sample(
	int size, 
	Random^ random
)

member Sample : 
        size : int * 
        random : Random -> Vector<int>

Parameters

size Int32: The number of samples to return.
random Random: A Random object that specifies the uniform random number generator that is to be used to generate the samples.

Return Value

Vector<Int32>
A vector of size samples from the distribution.

Remarks

This method uses the random number generator specified by random to generate a random sample from the distribution. The return values of successive calls to this method follow the distribution represented by this Distribution.

Exceptions

ArgumentNullException	random is null.
ArgumentOutOfRangeException	size is less than zero.

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>.

public Vector<int> Sample<TGenerator>(
	int size,
	IRandomSource<TGenerator> random
)
where TGenerator : struct, new(), IRandomGenerator

Visual Basic

Public Function Sample(Of TGenerator As {Structure, New, IRandomGenerator}) ( 
	size As Integer,
	random As IRandomSource(Of TGenerator)
) As Vector(Of Integer)

C++/CLI

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

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

Parameters

size Int32: The number of samples to generate. Must be greater than zero.
random IRandomSource<TGenerator>: The random source that exposes a TGenerator generator.

Type Parameters

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

Return Value

Vector<Int32>
A Vector<T> containing size samples.

Remarks

This overload avoids extra allocations by obtaining a reference to the underlying generator and forwarding to a ref-based implementation.

Exceptions

ArgumentNullException	random is null.
ArgumentOutOfRangeException	size is less than or equal to zero.

Sample(IRandomSource, Int32[])

Note: This API is now obsolete.

Fills an Int32 array with random numbers.

[ObsoleteAttribute("Use the SampleInto method with Span<int> instead.")]
public void Sample(
	IRandomSource random,
	int[] samples
)

Visual Basic

<ObsoleteAttribute("Use the SampleInto method with Span<int> instead.")>
Public Sub Sample ( 
	random As IRandomSource,
	samples As Integer()
)

C++/CLI

public:
[ObsoleteAttribute(L"Use the SampleInto method with Span<int> instead.")]
void Sample(
	IRandomSource^ random, 
	array<int>^ samples
)

[<ObsoleteAttribute("Use the SampleInto method with Span<int> instead.")>]
member Sample : 
        random : IRandomSource * 
        samples : int[] -> unit

Parameters

random IRandomSource: A Random object that specifies the uniform random number generator that is to be used to generate the samples.
samples Int32[]: A Int32 array.

Remarks

This method fills the integer array samples with random samples from the distribution.

Exceptions

ArgumentNullException

random is null.

-or-

samples is null.

Sample(Random, Int32[])

Note: This API is now obsolete.

Fills an Int32 array with random numbers.

[ObsoleteAttribute("Use the SampleInto method with Span<int> instead.")]
public void Sample(
	Random random,
	int[] samples
)

Visual Basic

<ObsoleteAttribute("Use the SampleInto method with Span<int> instead.")>
Public Sub Sample ( 
	random As Random,
	samples As Integer()
)

C++/CLI

public:
[ObsoleteAttribute(L"Use the SampleInto method with Span<int> instead.")]
void Sample(
	Random^ random, 
	array<int>^ samples
)

[<ObsoleteAttribute("Use the SampleInto method with Span<int> instead.")>]
member Sample : 
        random : Random * 
        samples : int[] -> unit

Parameters

random Random: A Random object that specifies the uniform random number generator that is to be used to generate the samples.
samples Int32[]: A Int32 array.

Remarks

This method fills the integer array samples with random samples from the distribution.

Exceptions

ArgumentNullException

random is null.

-or-

samples is null.

Sample(IRandomSource, Int32[], Int32, Int32)

Note: This API is now obsolete.

Fills an Int32 array with random numbers from this DiscreteDistribution.

[ObsoleteAttribute("Use the SampleInto method with Span<int> instead.")]
public void Sample(
	IRandomSource random,
	int[] samples,
	int startIndex,
	int length
)

Visual Basic

<ObsoleteAttribute("Use the SampleInto method with Span<int> instead.")>
Public Sub Sample ( 
	random As IRandomSource,
	samples As Integer(),
	startIndex As Integer,
	length As Integer
)

C++/CLI

public:
[ObsoleteAttribute(L"Use the SampleInto method with Span<int> instead.")]
void Sample(
	IRandomSource^ random, 
	array<int>^ samples, 
	int startIndex, 
	int length
)

[<ObsoleteAttribute("Use the SampleInto method with Span<int> instead.")>]
member Sample : 
        random : IRandomSource * 
        samples : int[] * 
        startIndex : int * 
        length : int -> unit

Parameters

random IRandomSource: A IRandomSource object that specifies the uniform random number generator that is to be used to generate the samples.
samples Int32[]: A Int32 array.
startIndex Int32: The zero-based index at which to begin filling the samples array.
length Int32: The number of samples to provide.

Remarks

This method fills a block of length elements of samples, starting at index startIndex with random samples from the distribution.

Exceptions

ArgumentNullException

samples is null.

-or-

random is null.

ArgumentOutOfRangeException

startIndex is less than zero.

-or-

length is less than zero.

ArgumentException

length is greater than the number of elements from startIndex to the end of samples.

Sample(Random, Int32[], Int32, Int32)

Note: This API is now obsolete.

Fills an Int32 array with random numbers from this DiscreteDistribution.

[ObsoleteAttribute("Use the SampleInto method with Span<int> instead.")]
public void Sample(
	Random random,
	int[] samples,
	int startIndex,
	int length
)

Visual Basic

<ObsoleteAttribute("Use the SampleInto method with Span<int> instead.")>
Public Sub Sample ( 
	random As Random,
	samples As Integer(),
	startIndex As Integer,
	length As Integer
)

C++/CLI

public:
[ObsoleteAttribute(L"Use the SampleInto method with Span<int> instead.")]
void Sample(
	Random^ random, 
	array<int>^ samples, 
	int startIndex, 
	int length
)

[<ObsoleteAttribute("Use the SampleInto method with Span<int> instead.")>]
member Sample : 
        random : Random * 
        samples : int[] * 
        startIndex : int * 
        length : int -> unit

Parameters

random Random: A Random object that specifies the uniform random number generator that is to be used to generate the samples.
samples Int32[]: A Int32 array.
startIndex Int32: The zero-based index at which to begin filling the samples array.
length Int32: The number of samples to provide.

Remarks

This method fills a block of length elements of samples, starting at index startIndex with random samples from the distribution.

Exceptions

ArgumentNullException

samples is null.

-or-

random is null.

ArgumentOutOfRangeException

startIndex is less than zero.

-or-

length is less than zero.

ArgumentException

length is greater than the number of elements from startIndex to the end of samples.

DiscreteDistribution.Sample Method

Definition

Overload List

Sample

Return Value

Remarks

Sample(Int32)

Parameters

Return Value

Remarks

Exceptions

Sample(IRandomSource)

Parameters

Return Value

Exceptions

Sample<TGenerator>(IRandomSource<TGenerator>)

Parameters

Type Parameters

Return Value

Exceptions

Sample(Random)

Parameters

Return Value

Exceptions

Sample<TGenerator>(TGenerator)

Parameters

Type Parameters

Return Value

Remarks

Sample(Int32, IRandomSource)

Parameters

Return Value

Remarks

Exceptions

Sample(Int32, Random)

Parameters

Return Value

Remarks

Exceptions

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

Parameters

Type Parameters

Return Value

Remarks

Exceptions

Sample(IRandomSource, Int32[])

Parameters

Remarks

Exceptions

Sample(Random, Int32[])

Parameters

Remarks

Exceptions

Sample(IRandomSource, Int32[], Int32, Int32)

Parameters

Remarks

Exceptions

Sample(Random, Int32[], Int32, Int32)

Parameters

Remarks

Exceptions

See Also

Reference