RayleighDistribution Class

Provides generation of rayleigh distributed random numbers.

Inheritance Hierarchy

Namespace: Altaxo.Calc.Probability
Assembly: AltaxoCore (in AltaxoCore.dll) Version: 4.8.3179.0 (4.8.3179.0)

Syntax

public class RayleighDistribution : ContinuousDistribution

The RayleighDistribution type exposes the following members.

Constructors

	Name	Description
	RayleighDistribution	Initializes a new instance of the RayleighDistribution class, using a StandardGenerator as underlying random number generator.
	RayleighDistribution(Double)	Initializes a new instance of the RayleighDistribution class
	RayleighDistribution(Generator)	Initializes a new instance of the RayleighDistribution class, using the specified Generator as underlying random number generator.
	RayleighDistribution(Double, Generator)	Initializes a new instance of the RayleighDistribution class

Properties

	Name	Description
	CanReset	Gets a value indicating whether the random number distribution can be reset, so that it produces the same random number sequence again. (Inherited from Distribution)
	Generator	Gets or sets a Generator object that can be used as underlying random number generator. (Inherited from Distribution)
	Maximum	Gets the maximum possible value of rayleigh distributed random numbers. (Overrides DistributionMaximum)
	Mean	Gets the mean value of rayleigh distributed random numbers. (Overrides DistributionMean)
	Median	Gets the median of rayleigh distributed random numbers. (Overrides DistributionMedian)
	Minimum	Gets the minimum possible value of rayleigh distributed random numbers. (Overrides DistributionMinimum)
	Mode	Gets the mode of rayleigh distributed random numbers. (Overrides DistributionMode)
	Sigma	Gets or sets the parameter sigma which is used for generation of rayleigh distributed random numbers.
	Variance	Gets the variance of rayleigh distributed random numbers. (Overrides DistributionVariance)

Methods

	Name	Description
	CDF(Double)	(Overrides ContinuousDistributionCDF(Double))
	CDF(Double, Double)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object)
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	Initialize	Updates the helper variables that store intermediate results for generation of rayleigh distributed random numbers.
	IsValidSigma	Determines whether the specified value is valid for parameter Sigma.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	NextDouble	Returns a rayleigh distributed floating point random number. (Overrides DistributionNextDouble)
	PDF(Double)	(Overrides ContinuousDistributionPDF(Double))
	PDF(Double, Double)
	Quantile(Double)	(Overrides ContinuousDistributionQuantile(Double))
	Quantile(Double, Double)
	Reset	Resets the random number distribution, so that it produces the same random number sequence again. (Inherited from Distribution)
	ToString	Returns a string that represents the current object. (Inherited from Object)

Fields

	Name	Description
	generator	Stores a Generator object that can be used as underlying random number generator. (Inherited from Distribution)

Remarks

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