lognormal#
Generates lognormally distributed random numbers.
Description#
The lognormal class object is used in the generate function to provide random numbers with average
of distribution (m, a) and standard deviation (s, σ) of subject normal distribution,
displacement (displ, b), and scalefactor (scale, β), where
\(a, \sigma, b, \beta \in R; \sigma, \beta > 0;\).
The probability density function is given by:
The cumulative distribution function is as follows:
API#
Syntax#
namespace oneapi::mkl::rng {
template<typename RealType = float,
typename Method = lognormal_method::by_default>
class lognormal {
public:
using method_type = Method;
using result_type = RealType;
lognormal(): lognormal((RealType)0.0, (RealType)1.0,
(RealType) 0.0, (RealType)1.0){}
explicit lognormal(RealType m, RealType s,
RealType displ = (RealType)0.0,
RealType scale = (RealType)1.0);
explicit lognormal(const param_type& pt);
RealType m() const;
RealType s() const;
RealType displ() const;
RealType scale() const;
param_type param() const;
void param(const param_type& pt);
};
}
Devices supported: CPU and GPU.
Include Files#
oneapi/mkl/rng.hpp
Template Parameters#
|
Type of the produced values. The specific values are as follows:
|
|
Generation method. The specific values are as follows:
See brief descriptions of the methods in Distributions Template Parameter Method. |
Input Parameters#
Name |
Type |
Description |
|---|---|---|
m |
|
Average |
s |
|
Standard deviation |
displ |
|
Displacement |
scale |
|
Scalefactor |