mkl::rng::rayleigh

Generates Rayleigh distributed random values.

Syntax

template<typename RealType = float, typename Method = mkl::rng::rayleigh_method::by_default>

class rayleigh {

public:

using method_type = Method;

using result_type = RealType;

rayleigh(): rayleigh((RealType)0.0, (RealType)1.0){}

explicit rayleigh(RealType a, RealType b);

explicit rayleigh(const rayleigh<RealType, Method>& other);

RealType a() const;

RealType b() const;

rayleigh<RealType, Method>& operator=(const rayleigh<RealType, Method>& other);

};

Devices supported: Host, CPU, and GPU.

Include Files

Description

The mkl::rng::rayleigh class object is used by the mkl::rng::generate function to provide Rayleigh distributed random numbers with displacement (a) and scalefactor (b, β), where a, βR ; β > 0.

The Rayleigh distribution is a special case of the Weibull distribution, where the shape parameter α = 2.

The probability density function is given by:


Equation

The cumulative distribution function is as follows:


Equation

Optimization Notice

Intel's compilers may or may not optimize to the same degree for non-Intel microprocessors for optimizations that are not unique to Intel microprocessors. These optimizations include SSE2, SSE3, and SSSE3 instruction sets and other optimizations. Intel does not guarantee the availability, functionality, or effectiveness of any optimization on microprocessors not manufactured by Intel. Microprocessor-dependent optimizations in this product are intended for use with Intel microprocessors. Certain optimizations not specific to Intel microarchitecture are reserved for Intel microprocessors. Please refer to the applicable product User and Reference Guides for more information regarding the specific instruction sets covered by this notice.

Notice revision #20110804

This notice covers the following instruction sets: SSE2, SSE4.2, AVX2, AVX-512.

Template Parameters

typename RealType = float

Type of the produced values. The specific values are as follows:

float

double

typename Method = mkl::rng::rayleigh_method::by_default

Generation method. The specific values are as follows:

mkl::rng::rayleigh_method::icdf

mkl::rng::rayleigh_method::icdf_accurate

See brief descriptions of the methods in Distributions Template Parameter Method Values

Input Parameters

Name

Type

Description

a

RealType (float, double)

Displacement a.

b

RealType (float, double)

Scalefactor b.