lognormal

oneMKL - Data Parallel C++ Developer Reference

Download PDF

ID 772045

Date 6/24/2024

Version

Public

A newer version of this document is available. Customers should click here to go to the newest version.

Visible to Intel only — GUID: GUID-980EB69E-9E07-45D1-8F1B-7A4AD9811A3B

View Details

lognormal

Generates lognormally distributed random numbers.

Description
API

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 .

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

typename Type

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

float
double

typename Method

Generation method. The specific values are as follows:

oneapi::mkl::rng::device::lognormal_method::by_default
oneapi::mkl::rng::device::lognormal_method::box_muller2

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	`RealType (float, double)`	Average `a` of the subject normal distribution.
s	`RealType (float, double)`	Standard deviation of the subject normal distribution.
displ	`RealType (float, double)`	Displacement `displ`.
scale	`RealType (float, double)`	Scalefactor `scale`.

Select Your Language

Using Intel.com Search

Quick Links

Recent Searches

Advanced Search

Only search in

oneMKL - Data Parallel C++ Developer Reference

lognormal

Description

API