randnegativebinomial() - 5.2 English - 68552

AOCL API Guide (68552)

Document ID
68552
Release Date
2025-12-29
Version
5.2 English
void SRANDNEGATIVEBINOMIAL(rng_int_t *n, rng_int_t *m, float *p, rng_int_t *state, rng_int_t *x, rng_int_t *info)#
void DRANDNEGATIVEBINOMIAL(rng_int_t *n, rng_int_t *m, double *p, rng_int_t *state, rng_int_t *x, rng_int_t *info)#
void srandnegativebinomial_(rng_int_t *n, rng_int_t *m, float *p, rng_int_t *state, rng_int_t *x, rng_int_t *info)#
void drandnegativebinomial_(rng_int_t *n, rng_int_t *m, double *p, rng_int_t *state, rng_int_t *x, rng_int_t *info)#
void srandnegativebinomial(rng_int_t n, rng_int_t m, float p, rng_int_t *state, rng_int_t *x, rng_int_t *info)#
void drandnegativebinomial(rng_int_t n, rng_int_t m, double p, rng_int_t *state, rng_int_t *x, rng_int_t *info)#

Returns a vector of pseudo-random integers from negtive binomial distribution.

Parameters:
  • n[in] Number of integers to generate, n > 0

  • m[in] Number of failures, m >= 0

  • p[in] Probability of success, 0 <= p < 1

  • state[inout] On Entry: Current state of the base generator being used. state must have first been initialized with a call to drandinitialize On Exit: State of generator after n- values are generated

  • x[out] Vector of n- integers from the negtive binomial distribution, x(n)

  • info[out]

    Error code

    0 = Everything OK

    -1 to -4 = Error in parameter, abs(info)