Integer, Intent (In)	::	xlrcomm, xlicomm, yicomm(*)
Integer, Intent (Inout)	::	xicomm(xlicomm), ifail
Real (Kind=nag_wp), Intent (In)	::	yrcomm(*)
Real (Kind=nag_wp), Intent (Inout)	::	xrcomm(xlrcomm)
Type (c_ptr), Intent (In)	::	hlmm

C Header Interface

#include <nag.h>

void	g02jgf_ (void *hlmm, double xrcomm[], const Integer xlrcomm, Integer xicomm[], const Integer xlicomm, const double yrcomm[], const Integer yicomm[], Integer ifail)

The routine may be called by the names g02jgf or nagf_correg_lmm_init_combine.

3 Description

Let

D_{x}

and

D_{y}

denote two sets of data, each with

m

variables and

n_{x}

and

n_{y}

observations respectively. Let

C_{x}

and

C_{y}

denote two sets of communication arrays constructed by g02jff or g02jcf from datasets

D_{x}

and

D_{y}

respectively. Then, given

C_{x}

and

C_{y}

, g02jgf constructs a set of communication arrays,

C_{w}

, as if a dataset

D_{z}

, with

m

variables and

n_{x} + n_{y}

observations were supplied to g02jff or g02jcf, with

D_{z}

constructed as

D_{z} = (\begin{matrix} D_{x} \\ D_{y} \end{matrix}) .

Splitting, and then recombining, the data in this manner allows for datasets with an arbitrarily large number of observations (

n

) to be analysed and the preprocessing routines, g02jff or g02jcf, to be run in parallel.

It should be noted that, while the information in

C_{z}

, should be consistent with the information in the communication arrays obtained by supplying

D_{z}

to g02jff or g02jcf, the ordering of that information may change. In practice, this means that whilst an analysis run using a set of communication arrays constructed using g02jgf should give similar results to an analysis run using a set of communication arrays constructed directly from g02jff or g02jcf they will not necessarily be identical. In addition, the order of the parameter estimates,

ν

and

β

may differ.

4 References

None.

5 Arguments

1: $hlmm$ – Type (c_ptr) Input: On entry: if the two sets of communication arrays were generated using g02jff, then a G22 handle as generated by one of the calls to g02jff.
If the two sets of communication arrays were generated using g02jcf, then this argument is not referenced and need not be set.
2: $xrcomm (xlrcomm)$ – Real (Kind=nag_wp) array Communication Array: On entry: communication array as returned by g02jff or g02jcf for the dataset, $D_{x}$ .

On exit: communication array for the combined dataset, $D_{W}$ .
3: $xlrcomm$ – Integer Input: On entry: the dimension of the array xrcomm as declared in the (sub)program from which g02jgf is called. Ideally this should be large enough to hold the information for the combined dataset $D_{w}$ .

If xlicomm or xlrcomm are not large enough to hold the information for the combined dataset then $ifail = 52$ is returned and the minimum size for xicomm is returned in $xicomm (1)$ and the minimum size for xrcomm in $xicomm (2)$ . In this case xicomm and xrcomm must be reallocated to these new sizes, preserving their contents, for example by allocating two new arrays and copying the old values across, and the routine called again.
4: $xicomm (xlicomm)$ – Integer array Communication Array: On entry: communication array as returned by g02jff or g02jcf for the dataset, $D_{x}$ .

On exit: communication array for the combined dataset, $D_{z}$ .
5: $xlicomm$ – Integer Input: On entry: the dimension of the array xicomm as declared in the (sub)program from which g02jgf is called. Ideally this should be large enough to hold the information for the combined dataset $D_{w}$ .

If xlicomm or xlrcomm are not large enough to hold the information for the combined dataset then $ifail = 52$ is returned and the minimum size for xicomm is returned in $xicomm (1)$ and the minimum size for xrcomm in $xicomm (2)$ . In this case xicomm and xrcomm must be reallocated to these new sizes, preserving their contents, for example by allocating two new arrays and copying the old values across, and the routine called again.
6: $yrcomm (*)$ – Real (Kind=nag_wp) array Communication Array: On entry: communication array as returned by g02jff or g02jcf for the dataset, $D_{y}$ .
7: $yicomm (*)$ – Integer array Communication Array: On entry: communication array as returned by g02jff or g02jcf for the dataset, $D_{y}$ .
8: $ifail$ – Integer Input/Output: On entry: ifail must be set to $0$ , $−1$ or $1$ to set behaviour on detection of an error; these values have no effect when no error is detected.
A value of $0$ causes the printing of an error message and program execution will be halted; otherwise program execution continues. A value of $−1$ means that an error message is printed while a value of $1$ means that it is not.

If halting is not appropriate, the value $−1$ or $1$ is recommended. If message printing is undesirable, then the value $1$ is recommended. Otherwise, the value $0$ is recommended. When the value $- 1$ or $1$ is used it is essential to test the value of ifail on exit.

On exit: $ifail = 0$ unless the routine detects an error or a warning has been flagged (see Section 6).

6 Error Indicators and Warnings

If on entry

ifail = 0

−1

, explanatory error messages are output on the current error message unit (as defined by x04aaf).

Errors or warnings detected by the routine:

$ifail = 11$: hlmm has not been initialized or is corrupt.

$ifail = 12$: hlmm is not a G22 handle as generated by g02jff.

$ifail = 31$: On entry, $xlrcomm = ⟨ value ⟩$ and $k = ⟨ value ⟩$ .
Constraint: xlrcomm is not compatible with information stored in xicomm, was expecting $xlrcomm \geq k$ .

$ifail = 41$: On entry, xicomm has not been initialized correctly.

$ifail = 42$: On entry, the information stored in xicomm and yicomm is not compatible.
Check that the same model was used when generating xicomm and yicomm.

$ifail = 51$: On entry, $xlicomm = ⟨ value ⟩$ and $k = ⟨ value ⟩$ .
Constraint: xlicomm is not compatible with information stored in xicomm, was expecting $xlicomm \geq k$ .

$ifail = 52$: On entry, $xlicomm = ⟨ value ⟩$ and $xlrcomm = ⟨ value ⟩$
Constraint: $xlicomm \geq ⟨ value ⟩$ and $xlrcomm \geq ⟨ value ⟩$ .
The communication arrays must be large enough to hold the information for the combined dataset $D_{w}$ . The minimum size for xicomm is returned in $xicomm (1)$ and the minimum size for xrcomm in $xicomm (2)$ . The parameters xicomm and xrcomm must be reallocated to these new sizes, preserving their contents, and the routine called again.

$ifail = 53$: On entry, $xlicomm = ⟨ value ⟩$ and $xlrcomm = ⟨ value ⟩$
Constraint: $xlicomm \geq ⟨ value ⟩$ and $xlrcomm \geq ⟨ value ⟩$ .
The communication arrays must be large enough to hold the information for the combined dataset $D_{w}$ . In addition, $xlicomm < 2$ and so the minimum sizes cannot be returned.

$ifail = 71$: On entry, yicomm has not been initialized correctly.

$ifail = - 99$: An unexpected error has been triggered by this routine. Please contact NAG.
See Section 7 in the Introduction to the NAG Library FL Interface for further information.

$ifail = - 399$: Your licence key may have expired or may not have been installed correctly.
See Section 8 in the Introduction to the NAG Library FL Interface for further information.

$ifail = - 999$: Dynamic memory allocation failed.
See Section 9 in the Introduction to the NAG Library FL Interface for further information.

7 Accuracy

Not applicable.

8 Parallelism and Performance

Background information to multithreading can be found in the Multithreading documentation.

g02jgf is not threaded in any implementation.

9 Further Comments

The data preprocessing routines, g02jcf and g02jff return the quantities, fnlsv, nff, rnlsv, nrf and nvpr. These values are data dependent and, therefore, the values obtained when preprocessing the datasets,

D_{x}

and

D_{y}

are likely to be different to those obtained if you had preprocessed the combined dataset

D_{z}

. In order to obtain these values for

D_{z}

you can call g02zlf after the call to g02jgf. Valid values for optstr are:

FNLSV, in which case g02zlf will return fnlsv for the combined dataset $D_{z}$ .
NFF, in which case g02zlf will return nff for the combined dataset $D_{z}$ .
RNLSV, in which case g02zlf will return rnlsv for the combined dataset $D_{z}$ .
NRF, in which case g02zlf will return nrf for the combined dataset $D_{z}$ .
NVPR, in which case g02zlf will return nvpr for the combined dataset $D_{z}$ .

10 Example

This example fits a random effects model to a simulated dataset. The dataset is split into four blocks, with

10, 31

40

and

9

observations respectively. Each block is read in, processed by g02jff and then combined using g02jgf. Once all four blocks have been processed the model is fitted using g02jhf and the results are printed.

g02jg: FL CL CPP AD PY MB

NAG FL Interfaceg02jgf (lmm_​init_​combine)

▸▿ Contents

1 Purpose

2 Specification

3 Description

4 References

5 Arguments

6 Error Indicators and Warnings

7 Accuracy

8 Parallelism and Performance

9 Further Comments

10 Example

10.1 Program Text

10.2 Program Data

10.3 Program Results

NAG FL Interface
g02jgf (lmm_init_combine)