Class RayleighDistribution

Provides generation of rayleigh distributed random numbers.

Inheritance

System.Object

Distribution

RayleighDistribution

Inherited Members

Distribution.CanReset

Distribution.Generator

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Experior.Core.Mathematics.Statistics.Generators.Continuous

Assembly: Experior.Core.dll

Syntax

public class RayleighDistribution : Distribution

Remarks

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

Constructors

RayleighDistribution()

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

Declaration

public RayleighDistribution()

RayleighDistribution(Generator)

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

Declaration

public RayleighDistribution(Generator generator)

Parameters

Type	Name	Description
Generator	generator	A Generator object.

Properties

Maximum

Gets the maximum possible value of rayleigh distributed random numbers.

Declaration

public override double Maximum { get; }

Property Value

Type	Description
System.Double	The maximum.

Overrides

Distribution.Maximum

Mean

Gets the mean value of rayleigh distributed random numbers.

Declaration

public override double Mean { get; }

Property Value

Type	Description
System.Double	The mean.

Overrides

Distribution.Mean

Median

Gets the median of rayleigh distributed random numbers.

Declaration

public override double Median { get; }

Property Value

Type	Description
System.Double	The median.

Overrides

Distribution.Median

Minimum

Gets the minimum possible value of rayleigh distributed random numbers.

Declaration

public override double Minimum { get; }

Property Value

Type	Description
System.Double	The minimum.

Overrides

Distribution.Minimum

Mode

Gets the mode of rayleigh distributed random numbers.

Declaration

public override double[] Mode { get; }

Property Value

Type	Description
System.Double[]	The mode.

Overrides

Distribution.Mode

Sigma

Gets or sets the parameter sigma which is used for generation of rayleigh distributed random numbers.

Declaration

public double Sigma { get; set; }

Property Value

Type	Description
System.Double	The sigma.

Remarks

Call IsValidSigma(Double) to determine whether a value is valid and therefor assignable.

Variance

Gets the variance of rayleigh distributed random numbers.

Declaration

public override double Variance { get; }

Property Value

Type	Description
System.Double	The variance.

Overrides

Distribution.Variance

Methods

IsValidSigma(Double)

Determines whether the specified value is valid for parameter Sigma.

Declaration

public bool IsValidSigma(double value)

Parameters

Type	Name	Description
System.Double	value	The value to check.

Returns

Type	Description
System.Boolean	true if value is greater than 0.0; otherwise, false.

NextDouble()

Returns a rayleigh distributed floating point random number.

Declaration

public override double NextDouble()

Returns

Type	Description
System.Double	A rayleigh distributed double-precision floating point number.

Overrides

Distribution.NextDouble()

Reset()

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

Declaration

public override bool Reset()

Returns

Type	Description
System.Boolean	true, if the chi distribution was reset; otherwise, false.

Overrides

Distribution.Reset()