randmultinomial() - 5.2 English - 68552

AOCL API Guide (68552)

Document ID
68552
Release Date
2025-12-29
Version
5.2 English
void SRANDMULTINOMIAL(rng_int_t *n, rng_int_t *m, float *p, rng_int_t *k, rng_int_t *state, rng_int_t *x, rng_int_t *ldx, rng_int_t *info)#
void DRANDMULTINOMIAL(rng_int_t *n, rng_int_t *m, double *p, rng_int_t *k, rng_int_t *state, rng_int_t *x, rng_int_t *ldx, rng_int_t *info)#
void srandmultinomial_(rng_int_t *n, rng_int_t *m, float *p, rng_int_t *k, rng_int_t *state, rng_int_t *x, rng_int_t *ldx, rng_int_t *info)#
void drandmultinomial_(rng_int_t *n, rng_int_t *m, double *p, rng_int_t *k, rng_int_t *state, rng_int_t *x, rng_int_t *ldx, rng_int_t *info)#
void srandmultinomial(rng_int_t n, rng_int_t m, float *p, rng_int_t k, rng_int_t *state, rng_int_t *x, rng_int_t ldx, rng_int_t *info)#
void drandmultinomial(rng_int_t n, rng_int_t m, double *p, rng_int_t k, rng_int_t *state, rng_int_t *x, rng_int_t ldx, rng_int_t *info)#

Returns an array of pseudo-random integers from a multinomial distribution.

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

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

  • p[in] Vector of probabilities, where p(i) is the probability of observing outcome i. 0 <= p(i) <= 1, for all i and p(1)+…+p(k) = 1, p(k)

  • k[in] Number of possible outcomes, k >= 2

  • 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] Array of n- values from the multinomial distribution, x(ldx,k)

  • ldx[in] Lead dimension of x in the calling routine, ldx >= n

  • info[out]

    Error code

    0 = Everything OK

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