LogarithmicSeriesDistribution.Sample Method

Definition

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

Overload List

Sample()	Returns a random sample from the distribution.
Sample(Int32)	Returns a vector of random samples from the distribution.
Sample(Random)	Returns a random sample from the distribution.
Sample(Int32, Random)	Returns a vector of random samples from the distribution.
Sample(Random, Int32[])	Fills an Int32 array with random numbers.
Sample(Random, Double)	Returns a single random sample from a logarithmic series distribution with the specified probability of success.
Sample(Random, Int32[], Int32, Int32)	Fills an Int32 array with random numbers from this DiscreteDistribution.

Sample(Random, Double)

Returns a single random sample from a logarithmic series distribution with the specified probability of success.

public static int Sample(
	Random random,
	double probabilityOfSuccess
)

Visual Basic

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

C++/CLI

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

Int32
A 32-bit signed integer sample from the logarithmic series distribution with the specified parameters.

Remarks

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.

Exceptions

ArgumentOutOfRangeException	probabilityOfSuccess is less than zero or greater than 1.
ArgumentNullException	random is null.