Multivariate Continuous Distribution APIs#

Multivariate Continuous Distribution Functions#

randmultinormal()#

void SRANDMULTINORMAL(rng_int_t *n, rng_int_t *m, float *xmu, float *c, rng_int_t *ldc, rng_int_t *state, float *x, rng_int_t *ldx, rng_int_t *info)#
void DRANDMULTINORMAL(rng_int_t *n, rng_int_t *m, double *xmu, double *c, rng_int_t *ldc, rng_int_t *state, double *x, rng_int_t *ldx, rng_int_t *info)#
void srandmultinormal_(rng_int_t *n, rng_int_t *m, float *xmu, float *c, rng_int_t *ldc, rng_int_t *state, float *x, rng_int_t *ldx, rng_int_t *info)#
void drandmultinormal_(rng_int_t *n, rng_int_t *m, double *xmu, double *c, rng_int_t *ldc, rng_int_t *state, double *x, rng_int_t *ldx, rng_int_t *info)#
void srandmultinormal(rng_int_t n, rng_int_t m, float *xmu, float *c, rng_int_t ldc, rng_int_t *state, float *x, rng_int_t ldx, rng_int_t *info)#
void drandmultinormal(rng_int_t n, rng_int_t m, double *xmu, double *c, rng_int_t ldc, rng_int_t *state, double *x, rng_int_t ldx, rng_int_t *info)#

Returns a vector of double precision pseudo-random numbers from multivariate normal distribution.

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

  • m – [in] Number of dimensions to the multivariate distribution, m >= 1

  • xmu – [in] Means, xmu(m)

  • c – [in] Covariance matrix, c(ldc,m)

  • ldc – [in] Lead dimension of c in the calling routine, ldc >= m

  • 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- values from a multivariate normal distribution, x(ldx,m)

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

  • info – [out]

    Error code

    1 = Everything OK, but reference vector not set up, due to lref being -1 on entry

    0 = Everything OK

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

randmultistudentst()#

void SRANDMULTISTUDENTST(rng_int_t *n, rng_int_t *m, rng_int_t *df, float *xmu, float *c, rng_int_t *ldc, rng_int_t *state, float *x, rng_int_t *ldx, rng_int_t *info)#
void DRANDMULTISTUDENTST(rng_int_t *n, rng_int_t *m, rng_int_t *df, double *xmu, double *c, rng_int_t *ldc, rng_int_t *state, double *x, rng_int_t *ldx, rng_int_t *info)#
void srandmultistudentst_(rng_int_t *n, rng_int_t *m, rng_int_t *df, float *xmu, float *c, rng_int_t *ldc, rng_int_t *state, float *x, rng_int_t *ldx, rng_int_t *info)#
void drandmultistudentst_(rng_int_t *n, rng_int_t *m, rng_int_t *df, double *xmu, double *c, rng_int_t *ldc, rng_int_t *state, double *x, rng_int_t *ldx, rng_int_t *info)#
void srandmultistudentst(rng_int_t n, rng_int_t m, rng_int_t df, float *xmu, float *c, rng_int_t ldc, rng_int_t *state, float *x, rng_int_t ldx, rng_int_t *info)#
void drandmultistudentst(rng_int_t n, rng_int_t m, rng_int_t df, double *xmu, double *c, rng_int_t ldc, rng_int_t *state, double *x, rng_int_t ldx, rng_int_t *info)#

Returns a vector of double precision pseudo-random numbers from multivariate students t distribution.

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

  • m – [in] Number of dimensions to the multivariate distribution, m >= 1

  • df – [in] Degrees of freedom, df >= 2

  • xmu – [in] Means, xmu(m)

  • c – [in] Covariance matrix, c(ldc,m)

  • ldc – [in] Lead dimension of c in the calling routine, ldc >= m

  • 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- values from a multivariate normal distribution, x(ldx,m)

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

  • info – [out]

    Error code

    1 = Everything OK, but reference vector not set up, due to lref being -1 on entry

    0 = Everything OK

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

randmultinormalreference()#

void SRANDMULTINORMALREFERENCE(rng_int_t *m, float *xmu, float *c, rng_int_t *ldc, float *ref, rng_int_t *lref, rng_int_t *info)#
void DRANDMULTINORMALREFERENCE(rng_int_t *m, double *xmu, double *c, rng_int_t *ldc, double *ref, rng_int_t *lref, rng_int_t *info)#
void srandmultinormalreference_(rng_int_t *m, float *xmu, float *c, rng_int_t *ldc, float *ref, rng_int_t *lref, rng_int_t *info)#
void drandmultinormalreference_(rng_int_t *m, double *xmu, double *c, rng_int_t *ldc, double *ref, rng_int_t *lref, rng_int_t *info)#
void srandmultinormalreference(rng_int_t m, float *xmu, float *c, rng_int_t ldc, float *ref, rng_int_t *lref, rng_int_t *info)#
void drandmultinormalreference(rng_int_t m, double *xmu, double *c, rng_int_t ldc, double *ref, rng_int_t *lref, rng_int_t *info)#

Setups a reference vector for generating a vector of random variates from a multivariate normal distribution via calls drandmultinormalr.

Parameters:
  • m – [in] Number of dimensions to the multivariate distribution, m >= 1

  • xmu – [in] Means, xmu(m)

  • c – [in] Covariance matrix, c(ldc,m)

  • ldc – [in] Lead dimension of c in the calling routine

  • ref – [out] Reference vector, ref(lref)

  • lref – [inout] On Entry: Either -1, or Length of ref. lref >= 6 + m*m+m On Exit: If lref = -1 then lref is set to a recommended value and the function returns; otherwise lref is not altered

  • info – [out]

    Error code

    1 = Everything OK, but reference vector not set up, due to lref being -1 on entry

    0 = Everything OK

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

randmultinormalr()#

void SRANDMULTINORMALR(rng_int_t *n, float *ref, rng_int_t *state, float *x, rng_int_t *ldx, rng_int_t *info)#
void DRANDMULTINORMALR(rng_int_t *n, double *ref, rng_int_t *state, double *x, rng_int_t *ldx, rng_int_t *info)#
void srandmultinormalr_(rng_int_t *n, float *ref, rng_int_t *state, float *x, rng_int_t *ldx, rng_int_t *info)#
void drandmultinormalr_(rng_int_t *n, double *ref, rng_int_t *state, double *x, rng_int_t *ldx, rng_int_t *info)#
void srandmultinormalr(rng_int_t n, float *ref, rng_int_t *state, float *x, rng_int_t ldx, rng_int_t *info)#
void drandmultinormalr(rng_int_t n, double *ref, rng_int_t *state, double *x, rng_int_t ldx, rng_int_t *info)#

Generates double precision values from multivariate normal distribution using a reference vector previously set-up via a call to drandmultinormalreference.

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

  • ref – [in] Reference vector, generated by a call to drandmultinormalreference

  • 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- values from a multivariate normal distribution, x(ldx,M)

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

  • info – [out]

    Error code

    1 = Everything OK, but reference vector not set up, due to lref being -1 on entry

    0 = Everything OK

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

randmultistudentstreference()#

void SRANDMULTISTUDENTSTREFERENCE(rng_int_t *m, rng_int_t *df, float *xmu, float *c, rng_int_t *ldc, float *ref, rng_int_t *lref, rng_int_t *info)#
void DRANDMULTISTUDENTSTREFERENCE(rng_int_t *m, rng_int_t *df, double *xmu, double *c, rng_int_t *ldc, double *ref, rng_int_t *lref, rng_int_t *info)#
void srandmultistudentstreference_(rng_int_t *m, rng_int_t *df, float *xmu, float *c, rng_int_t *ldc, float *ref, rng_int_t *lref, rng_int_t *info)#
void drandmultistudentstreference_(rng_int_t *m, rng_int_t *df, double *xmu, double *c, rng_int_t *ldc, double *ref, rng_int_t *lref, rng_int_t *info)#
void srandmultistudentstreference(rng_int_t m, rng_int_t df, float *xmu, float *c, rng_int_t ldc, float *ref, rng_int_t *lref, rng_int_t *info)#
void drandmultistudentstreference(rng_int_t m, rng_int_t df, double *xmu, double *c, rng_int_t ldc, double *ref, rng_int_t *lref, rng_int_t *info)#

Setups a reference vector for generating a vector of random variates from a multivariate normal distribution via calls to drandmultistudentstr.

Parameters:
  • m – [in] Number of dimensions to the multivariate distribution, m >= 1

  • df – [in] Degrees of freedom, df >= 2

  • xmu – [in] Means, xmu(m)

  • c – [in] Covariance matrix, c(ldc,m)

  • ldc – [in] Lead dimension of c in the calling routine

  • ref – [out] Reference vector, ref(lref)

  • lref – [inout] On Entry: Either -1, or Length of ref. lref >= 6 + m*m+m On Exit: If lref = -1 then lref is set to a recommended value and the function returns; otherwise lref is not altered

  • info – [out]

    Error code

    1 = Everything OK, but reference vector not set up, due to lref being -1 on entry

    0 = Everything OK

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

randmultistudentstr()#

void SRANDMULTISTUDENTSTR(rng_int_t *n, float *ref, rng_int_t *state, float *x, rng_int_t *ldx, rng_int_t *info)#
void DRANDMULTISTUDENTSTR(rng_int_t *n, double *ref, rng_int_t *state, double *x, rng_int_t *ldx, rng_int_t *info)#
void srandmultistudentstr_(rng_int_t *n, float *ref, rng_int_t *state, float *x, rng_int_t *ldx, rng_int_t *info)#
void drandmultistudentstr_(rng_int_t *n, double *ref, rng_int_t *state, double *x, rng_int_t *ldx, rng_int_t *info)#
void srandmultistudentstr(rng_int_t n, float *ref, rng_int_t *state, float *x, rng_int_t ldx, rng_int_t *info)#
void drandmultistudentstr(rng_int_t n, double *ref, rng_int_t *state, double *x, rng_int_t ldx, rng_int_t *info)#

Generates double precision values from multivariate students t distribution using a reference vector previously set-up via a call to drandmultistudentstreference.

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

  • ref – [in] Reference vector, generated by a call to drandmultistudentstreference

  • 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 a multivariate normal distribution, x(ldx,M)

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

  • info – [out]

    Error code

    1 = Everything OK, but reference vector not set up, due to lref being -1 on entry

    0 = Everything OK

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