RayleighDistribution (FsODE)

FsODE

Documentation for 0.0.2

RayleighDistribution Type

Namespace: Altaxo.Calc.Probability
Assembly: AltaxoCore.Redist.dll
Base Type: ContinuousDistribution

Provides generation of rayleigh distributed random numbers.

The implementation of the RayleighDistribution type bases upon information presented on Wikipedia - Rayleigh Distribution.

Constructors

Constructor Description


                
                  
                    
                      RayleighDistribution()

Full Usage: RayleighDistribution()

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


                
                  
                    
                      RayleighDistribution(generator)

Full Usage: RayleighDistribution(generator)

Parameters:

generator : Generator - A Generator object.

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

generator : Generator: A Generator object.

ArgumentNullException

generator is NULL ( in Visual Basic).


                
                  
                    
                      RayleighDistribution(sigma)

Full Usage: RayleighDistribution(sigma)

Parameters:

sigma : float

sigma : float


                
                  
                    
                      RayleighDistribution(sigma, generator)

Full Usage: RayleighDistribution(sigma, generator)

Parameters:

sigma : float

generator : Generator

sigma : float
generator : Generator

Instance members

Instance member	Description
`this.CDF` Full Usage: `this.CDF` Parameters: x : `float` Returns: `float` Modifiers: abstract	x : `float` Returns: `float`
`this.Initialize` Full Usage: `this.Initialize` Parameters: sigma : `float`	Updates the helper variables that store intermediate results for generation of rayleigh distributed random numbers. sigma : `float`
`this.IsValidSigma` Full Usage: `this.IsValidSigma` Parameters: value : `float` - The value to check. Returns: `bool` if value is greater than 0.0; otherwise, .	Determines whether the specified value is valid for parameter RayleighDistribution.Sigma. value : `float` The value to check. Returns: `bool` if value is greater than 0.0; otherwise, .
`this.Maximum` Full Usage: `this.Maximum` Returns: `float` Modifiers: abstract	Gets the maximum possible value of rayleigh distributed random numbers. Returns: `float`
`this.Mean` Full Usage: `this.Mean` Returns: `float` Modifiers: abstract	Gets the mean value of rayleigh distributed random numbers. Returns: `float`
`this.Median` Full Usage: `this.Median` Returns: `float` Modifiers: abstract	Gets the median of rayleigh distributed random numbers. Returns: `float`
`this.Minimum` Full Usage: `this.Minimum` Returns: `float` Modifiers: abstract	Gets the minimum possible value of rayleigh distributed random numbers. Returns: `float`
`this.Mode` Full Usage: `this.Mode` Returns: `float[]` Modifiers: abstract	Gets the mode of rayleigh distributed random numbers. Returns: `float[]`
`this.NextDouble` Full Usage: `this.NextDouble` Returns: `float` A rayleigh distributed double-precision floating point number. Modifiers: abstract	Returns a rayleigh distributed floating point random number. Returns: `float` A rayleigh distributed double-precision floating point number.
`this.PDF` Full Usage: `this.PDF` Parameters: x : `float` Returns: `float` Modifiers: abstract	x : `float` Returns: `float`
`this.Quantile` Full Usage: `this.Quantile` Parameters: p : `float` Returns: `float` Modifiers: abstract	p : `float` Returns: `float`
`this.Sigma` Full Usage: `this.Sigma`	Gets or sets the parameter sigma which is used for generation of rayleigh distributed random numbers. Call RayleighDistribution.IsValidSigma to determine whether a value is valid and therefor assignable.
`this.Variance` Full Usage: `this.Variance` Returns: `float` Modifiers: abstract	Gets the variance of rayleigh distributed random numbers. Returns: `float`

Static members

Static member	Description
`RayleighDistribution.CDF(x, sigma)` Full Usage: `RayleighDistribution.CDF(x, sigma)` Parameters: x : `float` sigma : `float` Returns: `float`	x : `float` sigma : `float` Returns: `float`
`RayleighDistribution.PDF(x, sigma)` Full Usage: `RayleighDistribution.PDF(x, sigma)` Parameters: x : `float` sigma : `float` Returns: `float`	x : `float` sigma : `float` Returns: `float`
`RayleighDistribution.Quantile(p, sigma)` Full Usage: `RayleighDistribution.Quantile(p, sigma)` Parameters: p : `float` sigma : `float` Returns: `float`	p : `float` sigma : `float` Returns: `float`