CauchyDistribution (FsODE)

FsODE

Documentation for 0.0.2

CauchyDistribution Type

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

Provides generation of cauchy distributed random numbers.

The implementation of the CauchyDistribution type bases upon information presented on Wikipedia - Cauchy distribution and Xycoon - Cauchy Distribution.

Constructors

Constructor Description


                
                  
                    
                      CauchyDistribution()

Full Usage: CauchyDistribution()

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


                
                  
                    
                      CauchyDistribution(generator)

Full Usage: CauchyDistribution(generator)

Parameters:

generator : Generator - A Generator object.

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

generator : Generator: A Generator object.

ArgumentNullException

generator is NULL ( in Visual Basic).


                
                  
                    
                      CauchyDistribution(alpha, gamma)

Full Usage: CauchyDistribution(alpha, gamma)

Parameters:

alpha : float - First parameter of the distribution.

gamma : float - Second parameter of the distribution.

Initializes a new instance of the CauchyDistribution class, using the default random number generator.

alpha : float: First parameter of the distribution.
gamma : float: Second parameter of the distribution.


                
                  
                    
                      CauchyDistribution(alpha, gamma, generator)

Full Usage: CauchyDistribution(alpha, gamma, generator)

Parameters:

alpha : float - First parameter of the distribution.

gamma : float - Second parameter of the distribution.

generator : Generator - A Generator object.

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

alpha : float: First parameter of the distribution.
gamma : float: Second parameter of the distribution.
generator : Generator: A Generator object.

ArgumentNullException

generator is NULL ( in Visual Basic).

Instance members

Instance member	Description
`this.Alpha` Full Usage: `this.Alpha`	Gets or sets the parameter alpha (location parameter - designates the median) of cauchy distributed random numbers which is used for their generation. Call CauchyDistribution.IsValidAlpha to determine whether a value is valid and therefor assignable.
`this.CDF` Full Usage: `this.CDF` Parameters: x : `float` Returns: `float` Modifiers: abstract	x : `float` Returns: `float`
`this.Gamma` Full Usage: `this.Gamma`	Gets or sets the parameter gamma (scale parameter - designates half with at half maximum) which is used for generation of cauchy distributed random numbers. Call CauchyDistribution.IsValidGamma to determine whether a value is valid and therefor assignable.
`this.Initialize` Full Usage: `this.Initialize` Parameters: alpha : `float` gamma : `float`	alpha : `float` gamma : `float`
`this.IsValidAlpha` Full Usage: `this.IsValidAlpha` Parameters: value : `float` - The value to check. Returns: `bool` .	Determines whether the specified value is valid for parameter CauchyDistribution.Alpha. value : `float` The value to check. Returns: `bool` .
`this.IsValidGamma` Full Usage: `this.IsValidGamma` 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 CauchyDistribution.Gamma. 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 cauchy distributed random numbers. Returns: `float`
`this.Mean` Full Usage: `this.Mean` Returns: `float` Modifiers: abstract	Gets the mean value of cauchy distributed random numbers. It's undefined, so the return value is Double.NaN. Returns: `float`
`this.Median` Full Usage: `this.Median` Returns: `float` Modifiers: abstract	Gets the median of cauchy distributed random numbers. Returns: `float`
`this.Minimum` Full Usage: `this.Minimum` Returns: `float` Modifiers: abstract	Gets the minimum possible value of cauchy distributed random numbers. Returns: `float`
`this.Mode` Full Usage: `this.Mode` Returns: `float[]` Modifiers: abstract	Gets the mode of cauchy distributed random numbers. Returns: `float[]`
`this.NextDouble` Full Usage: `this.NextDouble` Returns: `float` A cauchy distributed double-precision floating point number. Modifiers: abstract	Returns a cauchy distributed floating point random number. Returns: `float` A cauchy 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.Variance` Full Usage: `this.Variance` Returns: `float` Modifiers: abstract	Gets the variance of cauchy distributed random numbers. Returns: `float`

Static members

Static member	Description
`CauchyDistribution.CDF(x, a, b)` Full Usage: `CauchyDistribution.CDF(x, a, b)` Parameters: x : `float` a : `float` b : `float` Returns: `float`	x : `float` a : `float` b : `float` Returns: `float`
`CauchyDistribution.PDF(x, a, b)` Full Usage: `CauchyDistribution.PDF(x, a, b)` Parameters: x : `float` a : `float` b : `float` Returns: `float`	x : `float` a : `float` b : `float` Returns: `float`
`CauchyDistribution.Quantile(p, a, b)` Full Usage: `CauchyDistribution.Quantile(p, a, b)` Parameters: p : `float` a : `float` b : `float` Returns: `float`	p : `float` a : `float` b : `float` Returns: `float`