Rayleigh Distribution.Sample Method
Definition
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 10.3.0
Overload List
| Sample() | Returns a single random sample drawn from this distribution. |
| Sample( | Returns a vector containing the specified number of independent random samples drawn from this distribution. |
| Sample( | Returns a random sample from the distribution using a Random instance. |
| Sample( | Returns a random sample from the distribution using a Random instance. |
| Sample( | Returns a vector containing the specified number of independent random samples drawn from this distribution using the provided IRandomSource. |
| Sample( | Returns a vector of random samples from the distribution. |
| Sample( | Returns a single random sample from a student t distribution with the specified parameters. |
| Sample( | Returns a single random sample from a student t distribution with the specified parameters. |
| 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>(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<TGenerator>(IRandomSource<TGenerator>, Double) | Returns a single random sample from a student t distribution with the specified parameters. |
Sample(IRandomSource, Double)
public static double Sample(
IRandomSource random,
double scale
)Parameters
- random IRandomSource
- The Random derived random number generator used to generate the sample.
- scale Double
- Scale parameter.
Return Value
DoubleA double-precision floating-point sample from the Rayleigh 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 | scale is less than or equal to zero. |
Sample<TGenerator>(IRandomSource<TGenerator>, Double)
public static double Sample<TGenerator>(
IRandomSource<TGenerator> random,
double scale
)
where TGenerator : struct, new(), IRandomGenerator
Parameters
- random IRandomSource<TGenerator>
- The Random derived random number generator used to generate the sample.
- scale Double
- Scale parameter.
Type Parameters
- TGenerator
- The underlying generator type of the random source, used to enable optimizations like inlining.
Return Value
DoubleA double-precision floating-point sample from the Rayleigh 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 | scale is less than or equal to zero. |
Sample(Random, Double)
public static double Sample(
Random random,
double scale
)Parameters
- random Random
- The Random derived random number generator used to generate the sample.
- scale Double
- Scale parameter.
Return Value
DoubleA double-precision floating-point sample from the Rayleigh 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 | scale is less than or equal to zero. |