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, \(\sigma\)) of
subject normal distribution, displacement (displ, b), and scalefactor
(scale, \(\beta\)), where
\(a, \sigma, b, \beta \in \mathbb{R}; \sigma > 0, \beta > 0\).
The probability density function is given by:
The cumulative distribution function is as follows:
API#
Syntax#
template<typename RealType, typename Method>
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);
};
Include Files#
oneapi/mkl/rng/device.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. |
Note: To enable oneapi::mkl::rng::device::lognormal_method::box_muller2
based on Vector Math functions, define the MKL_RNG_USE_BINARY_CODE macro and
link static oneMKL libraries according to the output produced by
Intel® oneAPI Math Kernel Library Link Line Advisor.
It may improve performance on some hardware.
Input Parameters#
Name |
Type |
Description |
|---|---|---|
m |
|
Average |
s |
|
Standard deviation \(\sigma\) of the subject normal distribution. |
displ |
|
Displacement |
scale |
|
Scalefactor |