C# Class YAMP.Numerics.RayleighDistribution

Provides generation of rayleigh distributed random numbers.
The implementation of the RayleighDistribution type bases upon information presented on Wikipedia - Rayleigh Distribution.
Inheritance: Distribution
Mostra file Open project: FlorianRappl/YAMP

Public Methods

Method Description
IsValidSigma ( double value ) : bool

Determines whether the specified value is valid for parameter Sigma.

NextDouble ( ) : double

Returns a rayleigh distributed floating point random number.

RayleighDistribution ( ) : System

Initializes a new instance of the RayleighDistribution class, using a StandardGenerator as underlying random number generator.

RayleighDistribution ( Generator generator ) : System

Initializes a new instance of the RayleighDistribution class, using the specified Generator as underlying random number generator.

Reset ( ) : bool

Resets the chi distribution, so that it produces the same random number sequence again.

Private Methods

Method Description
UpdateHelpers ( ) : void

Updates the helper variables that store intermediate results for generation of rayleigh distributed random numbers.

Method Details

IsValidSigma() public method

Determines whether the specified value is valid for parameter Sigma.
public IsValidSigma ( double value ) : bool
value double The value to check.
return bool

NextDouble() public method

Returns a rayleigh distributed floating point random number.
public NextDouble ( ) : double
return double

RayleighDistribution() public method

Initializes a new instance of the RayleighDistribution class, using a StandardGenerator as underlying random number generator.
public RayleighDistribution ( ) : System
return System

RayleighDistribution() public method

Initializes a new instance of the RayleighDistribution class, using the specified Generator as underlying random number generator.
/// is NULL ( in Visual Basic). ///
public RayleighDistribution ( Generator generator ) : System
generator Generator A object.
return System

Reset() public method

Resets the chi distribution, so that it produces the same random number sequence again.
public Reset ( ) : bool
return bool