Intel® oneAPI Math Kernel Library Developer Reference - C
Generates random numbers with negative binomial distribution.
status = viRngNegbinomial( method, stream, n, r, a, p );
Name |
Type |
Description |
---|---|---|
method |
const MKL_INT |
Generation method. The specific value is: VSL_RNG_METHOD_NEGBINOMIAL_NBAR
See brief description of the NBAR method in Table "Values of <method> in method parameter" |
stream |
VSLStreamStatePtr |
pointer to the stream state structure |
n |
const MKL_INT |
Number of random values to be generated |
a |
const double |
The first distribution parameter a |
p |
const double |
The second distribution parameter p |
Name |
Type |
Description |
---|---|---|
r |
int* |
Vector of n random values with negative binomial distribution. |
The vRngNegBinomial function generates random numbers with negative binomial distribution and distribution parameters a and p, where p, a∈R; 0 < p < 1; a > 0.
If the first distribution parameter a∈N, this distribution is the same as Pascal distribution. If a∈N, the distribution can be interpreted as the expected time of a-th success in a sequence of Bernoulli trials, when the probability of success is p.
The probability distribution is given by:
The cumulative distribution function is as follows:
Optimization Notice |
---|
Intel's compilers may or may not optimize to the same degree for non-Intel microprocessors for optimizations that are not unique to Intel microprocessors. These optimizations include SSE2, SSE3, and SSSE3 instruction sets and other optimizations. Intel does not guarantee the availability, functionality, or effectiveness of any optimization on microprocessors not manufactured by Intel. Microprocessor-dependent optimizations in this product are intended for use with Intel microprocessors. Certain optimizations not specific to Intel microarchitecture are reserved for Intel microprocessors. Please refer to the applicable product User and Reference Guides for more information regarding the specific instruction sets covered by this notice. Notice revision #20110804 |
Indicates no error, execution is successful.
stream is a NULL pointer.
stream is not a valid random stream.
Callback function for an abstract BRNG returns an invalid number of updated entries in a buffer, that is, < 0 or > nmax.
Callback function for an abstract BRNG returns 0 as the number of updated entries in a buffer.
Period of the generator has been exceeded.
ARS-5 random number generator is not supported on the CPU running the application.