PowerDistribution (FsODE)

FsODE

Documentation for 0.0.2

PowerDistribution Type

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

Provides generation of power distributed random numbers.

The implementation of the PowerDistribution and the order of parameters is based on the implementation in Mathematica.

Constructors

Constructor Description


                
                  
                    
                      PowerDistribution()

Full Usage: PowerDistribution()

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


                
                  
                    
                      PowerDistribution(generator)

Full Usage: PowerDistribution(generator)

Parameters:

generator : Generator - A Generator object.

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

generator : Generator: A Generator object.

ArgumentNullException

generator is NULL ( in Visual Basic).


                
                  
                    
                      PowerDistribution(k, a)

Full Usage: PowerDistribution(k, a)

Parameters:

k : float - The domain parameter k.

a : float - The shape parameter a.

Initializes a new instance of the PowerDistribution class with domain parameter k and shape parameter a.

k : float: The domain parameter k.
a : float: The shape parameter a.


                
                  
                    
                      PowerDistribution(k, a, generator)

Full Usage: PowerDistribution(k, a, generator)

Parameters:

k : float - The domain parameter k.

a : float - The shape parameter a.

generator : Generator - The random number generator.

Initializes a new instance of the PowerDistribution class with domain parameter k and shape parameter a using the specified random number generator.

k : float: The domain parameter k.
a : float: The shape parameter a.
generator : Generator: The random number generator.

Instance members

Instance member	Description
`this.A` Full Usage: `this.A`	Gets or sets the parameter alpha which is used for generation of power distributed random numbers. Call PowerDistribution.IsValidAlpha to determine whether a value is valid and therefor assignable.
`this.CDF` Full Usage: `this.CDF` Parameters: x : `float` - Argument. Returns: `float` The probability that the random variable of this probability distribution will be found at a value less than or equal to x. Modifiers: abstract	Calculates the cumulative distribution function. x : `float` Argument. Returns: `float` The probability that the random variable of this probability distribution will be found at a value less than or equal to x.
`this.Initialize` Full Usage: `this.Initialize` Parameters: k : `float` a : `float`	Updates the helper variables that store intermediate results for generation of power distributed random numbers. k : `float` a : `float`
`this.IsValidAlpha` Full Usage: `this.IsValidAlpha` 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 PowerDistribution.A. value : `float` The value to check. Returns: `bool` if value is greater than 0.0; otherwise, .
`this.IsValidBeta` Full Usage: `this.IsValidBeta` 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 PowerDistribution.K. value : `float` The value to check. Returns: `bool` if value is greater than 0.0; otherwise, .
`this.K` Full Usage: `this.K`	Gets or sets the domain parameter k which is used for generation of power distributed random numbers. Call PowerDistribution.IsValidBeta to determine whether a value is valid and therefor assignable.
`this.Maximum` Full Usage: `this.Maximum` Returns: `float` Modifiers: abstract	Gets the maximum possible value of power distributed random numbers. Returns: `float`
`this.Mean` Full Usage: `this.Mean` Returns: `float` Modifiers: abstract	Gets the mean value of power distributed random numbers. Returns: `float`
`this.Median` Full Usage: `this.Median` Returns: `float` Modifiers: abstract	Gets the median of power distributed random numbers. Returns: `float`
`this.Minimum` Full Usage: `this.Minimum` Returns: `float` Modifiers: abstract	Gets the minimum possible value of power distributed random numbers. Returns: `float`
`this.Mode` Full Usage: `this.Mode` Returns: `float[]` Modifiers: abstract	Gets the mode of power distributed random numbers. Returns: `float[]`
`this.NextDouble` Full Usage: `this.NextDouble` Returns: `float` A power distributed double-precision floating point number. Modifiers: abstract	Returns a power distributed floating point random number. Returns: `float` A power distributed double-precision floating point number.
`this.PDF` Full Usage: `this.PDF` Parameters: x : `float` - Argument. Returns: `float` The relative likelihood for the random variable to occur at the point x. Modifiers: abstract	Calculates the probability density function. x : `float` Argument. Returns: `float` The relative likelihood for the random variable to occur at the point x.
`this.Quantile` Full Usage: `this.Quantile` Parameters: p : `float` - The probability p. Returns: `float` The point x at which the cumulative distribution function PowerDistribution.CDF of argument x is equal to p. Modifiers: abstract	Calculates the quantile of the distribution function. p : `float` The probability p. Returns: `float` The point x at which the cumulative distribution function PowerDistribution.CDF of argument x is equal to p.
`this.Variance` Full Usage: `this.Variance` Returns: `float` Modifiers: abstract	Gets the variance of power distributed random numbers. Returns: `float`

Static members

Static member	Description
`PowerDistribution.CDF(x, k, a)` Full Usage: `PowerDistribution.CDF(x, k, a)` Parameters: x : `float` - The x. k : `float` - The domain parameter k. a : `float` - The shape parameter a. Returns: `float`	Calculates the cumulative distribution function at the specified x. x : `float` The x. k : `float` The domain parameter k. a : `float` The shape parameter a. Returns: `float`
`PowerDistribution.PDF(x, k, a)` Full Usage: `PowerDistribution.PDF(x, k, a)` Parameters: x : `float` - The x. k : `float` - The domain parameter k. a : `float` - The shape parameter a. Returns: `float`	Calculates the probability dennsity at the specified x. x : `float` The x. k : `float` The domain parameter k. a : `float` The shape parameter a. Returns: `float`
`PowerDistribution.Quantile(p, k, a)` Full Usage: `PowerDistribution.Quantile(p, k, a)` Parameters: p : `float` - The probability. k : `float` - The domain parameter k. a : `float` - The shape parameter a. Returns: `float` The quantile at the specified probability p.	Calculates the quantile at the specified probability p. p : `float` The probability. k : `float` The domain parameter k. a : `float` The shape parameter a. Returns: `float` The quantile at the specified probability p.