Constructs a random number generator for a Rayleigh distribution using the specified distribution parameters.

Namespace:  CenterSpace.NMath.Core
Assembly:  NMath (in NMath.dll) Version: 5.1.0.0

Syntax

C#
public FloatRandomRayleighDistribution(
	float displacement,
	float scale,
	FloatRandomRayleighDistribution..::.GenerationMethod method
)
Visual Basic (Declaration)
Public Sub New ( _
	displacement As Single, _
	scale As Single, _
	method As FloatRandomRayleighDistribution..::.GenerationMethod _
)
Visual C++
public:
FloatRandomRayleighDistribution(
	float displacement, 
	float scale, 
	FloatRandomRayleighDistribution..::.GenerationMethod method
)

Parameters

displacement
Type: System..::.Single
Displacement.
scale
Type: System..::.Single
Scale factor.
method
Type: CenterSpace.NMath.Core..::.FloatRandomRayleighDistribution..::.GenerationMethod
The generation method to use.

Exceptions

ExceptionCondition
CenterSpace.NMath.Core..::.InvalidArgumentExceptionThrown if the scale factor is not greater than 0.

See Also