geometric#
Generates geometrically distributed random values.
Description#
The geometric class object is used in the generate function
to provide geometrically distributed random numbers with probability p of a single trial success,
where \(p \in R; 0 \leq p \leq 1\).
The probability distribution is given by:
The cumulative distribution function is as follows:
API#
Syntax#
namespace oneapi::mkl::rng::device {
template<typename IntType, typename Method>
class geometric {
public:
using method_type = Method;
using result_type = IntType;
geometric(): geometric(0.5f){}
explicit geometric(float p);
explicit geometric(const param_type& pt);
float p() 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. |
Input Parameters#
Name |
Type |
Description |
|---|---|---|
p |
|
Success probability |