onemkl::rng::poisson

Generates Poisson distributed random values.

Syntax

template<typename T = std::int32_t, method Method      = ptpe>
  class poisson {
  public:
    poisson(): poisson(0.5){}
    poisson(double lambda)
    poisson(const poisson<T, Method>& other)
    double lambda() const
    poisson<T, Method>& operator=(const poisson<T,      Method>& other)
  }

Include Files

  • mkl_sycl.hpp

Description

The onemkl::rng::poisson class object is used in the onemkl::rng::generate function to provide Poisson distributed random numbers with distribution parameter λ, where λ∈R; λ > 0.

The probability distribution is given by:


image0
k∈ {0, 1, 2, …}.

The cumulative distribution function is as follows:


image1

Input Parameters

Name

Type

Description

method

onemkl::rng::method

Generation method. The specific values are as follows: onemkl::rng::ptpe onemkl::rng::gaussian_inverse See brief descriptions of the methods in Distributions Template Parameter onemkl::rng::method Values.

lambda

double

Distribution parameter λ.