Pareto Distribution.Sample Method
Definition
Namespace: Numerics.NET.Statistics.Distributions
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 9.0.2
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 9.0.2
Overload List
Sample() | Returns a random sample from the distribution. |
Sample( | Returns a vector of random samples from the distribution. |
Sample( | Returns a random sample from the distribution. |
Sample( | Returns a vector of random samples from the distribution. |
Sample( | Returns a single random sample from a Pareto distribution with the specified parameters. |
Sample(Random)
Returns a random sample from the distribution.
public override double Sample(
Random random
)
Parameters
- random Random
- A Random object that specifies the uniform random number generator that is to be used to generate the samples.
Return Value
DoubleA double-precision floating-point number.
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
Argument | random is null. |
Sample(Random, Double, Double)
Returns a single random sample from a Pareto distribution
with the specified parameters.
public static double Sample(
Random random,
double shape,
double scale
)
Parameters
- random Random
- The Random derived random number generator used to generate the sample.
- shape Double
- The shape parameter of the distribution. Must be greater than zero.
- scale Double
- The scale parameter of the distribution. Must be greater than zero.
Return Value
DoubleA double-precision floating-point number that is a sample from the Pareto distribution with the specified parameters.
Remarks
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.
Exceptions
Argument | random is null. |
Argument | shape is less than or equal to zero. -or- scale is less than or equal to zero. |