oneapi::mkl::rng::device::bernoulli¶
Generates Bernoulli distributed random values.
Description¶
The oneapi::mkl::rng::device::bernoulli
class object is used in the oneapi::mkl::rng::device::generate
function
to provide Bernoulli distributed random numbers with probability p
of a single trial success,
where \(p \in R; 0 \leq p \leq 1\).
A variate is called Bernoulli distributed if after a trial it is equal to 1 with probability of success p
and to 0
with probability 1 - p
.
The probability distribution is given by:
P(X=1) = p
P(X=0) = 1 - p
The cumulative distribution function is as follows:
API¶
Syntax¶
template<typename IntType, typename Method>
class bernoulli {
public:
using method_type = Method;
using result_type = IntType;
bernoulli(): bernoulli(0.5f){}
explicit bernoulli(float p);
explicit bernoulli(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 |