oneapi::mkl::rng::poisson

Intel® oneAPI Math Kernel Library (oneMKL) - Data Parallel C++ Developer Reference

Download PDF

ID 772045

Date 12/16/2022

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-765BE9CD-20E2-4779-A5EC-ACBFC1E1F5D6

View Details

oneapi::mkl::rng::poisson_v

Generates Poisson distributed random values with varying mean.

Description
API

Description

The oneapi::mkl::rng::poisson_v class object is used in the oneapi::mkl::rng::generate function to provide n Poisson distributed random numbers x_i(i = 1, …, n) with distribution parameter λ_i, where λ_i∈R; λ_i> 0.

The probability distribution is given by:

The cumulative distribution function is as follows:

Product and Performance Information
Performance varies by use, configuration, and other factors. Learn more at https://www.intel.com/PerformanceIndex. Notice revision #20201201

API

Syntax

template<typename IntType = std::int32_t, typename Method = poisson_v_method::by_default>
class poisson_v {
public:
  using method_type = Method;
  using result_type = IntType;
  explicit poisson_v(std::vector<double> lambda); // deprecated since oneMKL 2023.0
  explicit poisson_v(sycl::span<double> lambda);
  explicit poisson_v(const param_type& pt);
  std::vector<double> lambda() const;
  param_type param() const;
  void param(const param_type& pt);
};

Devices supported: CPU and GPU

Include Files

oneapi/mkl/rng.hpp

Template Parameters

typename IntType = std::int32_t

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

std::int32_t

std::uint32_t

typename Method = oneapi::mkl::rng::poisson_v_method:: by_default

Generation method. The specific values are as follows:

oneapi::mkl::rng::poisson_v_method::gaussian_icdf_based

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

Input Parameters

Name	Type	Description
lambda	`sycl::span<double>`	Array of `n` distribution parameters λ.

NOTE:

explicit poisson_v(std::vector<double> lambda); is deprecated and will be removed in one of the next releases. Use explicit poisson_v(sycl::span<double> lambda); instead.
When passing a sycl::span that is constructed over a user’s memory to the constructor, users must manage the memory under sycl::span by themselves. They must not destroy the memory while data are processed.

Select Your Language

Using Intel.com Search

Quick Links

Recent Searches

Advanced Search

Only search in

Intel® oneAPI Math Kernel Library (oneMKL) - Data Parallel C++ Developer Reference

oneapi::mkl::rng::poisson_v

Description

API