One of the initialization functions nag_rand_init_repeat (g05kf) (for a repeatable sequence if computed sequentially) or nag_rand_init_nonrepeat (g05kg) (for a non-repeatable sequence) must be called prior to the first call to nag_rand_copula_frank (g05rj).

References

Marshall A W and Olkin I (1988) Families of multivariate distributions Journal of the American Statistical Association 83 403

Nelsen R B (2006) An Introduction to Copulas (2nd Edition) Springer Series in Statistics

Parameters

Compulsory Input Parameters

1: $n$ – int64int32nag_int scalar: $n$ , the number of pseudorandom uniform variates to generate.

Constraint: $n \geq 0$ .
2: $m$ – int64int32nag_int scalar: $m$ , the number of dimensions.

Constraint: $m \geq 2$ .
3: $theta$ – double scalar: $θ$ , the copula parameter.

Constraint: $theta \geq 1.0 \times 10^{- 6}$ .
4: $sorder$ – int64int32nag_int scalar: Determines the storage order of variates; the $(i, j)$ th variate is stored in $x (i, j)$ if $sorder = 1$ , and $x (j, i)$ if $sorder = 2$ , for $i = 1, 2, \dots, n$ and $j = 1, 2, \dots, m$ .

Constraint: $sorder = 1$ or $2$ .
5: $state (:)$ – int64int32nag_int array: Note: the actual argument supplied must be the array state supplied to the initialization routines nag_rand_init_repeat (g05kf) or nag_rand_init_nonrepeat (g05kg).

Contains information on the selected base generator and its current state.

Optional Input Parameters

None.

Output Parameters

1: $state (:)$ – int64int32nag_int array: Contains updated information on the state of the generator.
2: $x (ldx, sdx)$ – double array: The pseudorandom uniform variates with joint distribution described by $C_{θ}$ , with $x (i, j)$ holding the $i$ th value for the $j$ th dimension if $sorder = 1$ and the $j$ th value for the $i$ th dimension of $sorder = 2$ .
3: $ifail$ – int64int32nag_int scalar: $ifail = 0$ unless the function detects an error (see Error Indicators and Warnings).

Error Indicators and Warnings

Errors or warnings detected by the function:

$ifail = 1$: On entry, corrupt state argument.

$ifail = 2$: Constraint: $theta \geq 1.0 \times 10^{- 6}$ .

$ifail = 3$: Constraint: $n \geq 0$ .

$ifail = 4$: Constraint: $m \geq 2$ .

$ifail = 5$: On entry, invalid sorder.
Constraint: $sorder = 1$ or $2$ .

$ifail = 7$: On entry, ldx is too small: $ldx =_$ .

$ifail = 8$: On entry, sdx is too small: $sdx =_$ .

$ifail = - 99$: An unexpected error has been triggered by this routine. Please contact NAG.

$ifail = - 399$: Your licence key may have expired or may not have been installed correctly.

$ifail = - 999$: Dynamic memory allocation failed.

Accuracy

Not applicable.

Further Comments

In practice, the need for numerical stability restricts the range of

θ

such that:

the function requires $θ \geq 1.0 \times 10^{- 6}$ ;
if $θ > - \ln ε$ , the function returns pseudorandom uniform variates with $C_{\infty}$ joint distribution;

where

ε

is the machine precision returned by nag_machine_precision (x02aj).

Example

This example generates thirteen four-dimensional variates for copula

C_{4.0}

Open in the MATLAB editor: g05rj_example

function g05rj_example


fprintf('g05rj example results\n\n');

% Initialize the base generator to a repeatable sequence
seed  = [int64(1762543)];
genid = int64(1);
subid = int64(1);
[state, ifail] = g05kf( ...
                        genid, subid, seed);

% Sample size
n = int64(13);
m = int64(4);
% Sample order
sorder = int64(1);

% Parameter
theta = 4;

% Generate variates
[state, x, ifail] = g05rj( ...
                           n, m, theta, sorder, state);

disp('Variates from a Frank copula');
disp(x);

g05rj example results

Variates from a Frank copula
    0.5679    0.1977    0.8682    0.2664
    0.0965    0.3532    0.9773    0.3102
    0.5526    0.2562    0.6341    0.6267
    0.8036    0.4747    0.7310    0.5515
    0.2043    0.9797    0.3628    0.4968
    0.4777    0.8146    0.3922    0.4005
    0.4162    0.5002    0.5074    0.2008
    0.3703    0.0971    0.0527    0.0278
    0.4354    0.4880    0.4096    0.4259
    0.2693    0.1169    0.0639    0.1555
    0.0127    0.3080    0.2352    0.4659
    0.0730    0.3239    0.2020    0.0568
    0.2369    0.0817    0.3118    0.4370

PDF version (NAG web site, 64-bit version, 64-bit version)

Chapter Contents

Chapter Introduction

NAG Toolbox