NAG Library Routine Document

G02CEF

▸▿ Contents

1 Purpose

2 Specification

3 Description

4 References

5 Parameters

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

1 Purpose

G02CEF takes selected elements from two vectors (typically vectors of means and standard deviations) to form two smaller vectors, and selected rows and columns from two matrices (typically either matrices of sums of squares and cross-products of deviations from means and Pearson product-moment correlation coefficients, or matrices of sums of squares and cross-products about zero and correlation-like coefficients) to form two smaller matrices, allowing reordering of elements in the process.

2 Specification

SUBROUTINE G02CEF (

N, XBAR, STD, SSP, LDSSP, R, LDR, M, KORDER, XBAR2, STD2, SSP2, LDSSP2, R2, LDR2, IFAIL)

INTEGER	N, LDSSP, LDR, M, KORDER(M), LDSSP2, LDR2, IFAIL
REAL (KIND=nag_wp)	XBAR(N), STD(N), SSP(LDSSP,N), R(LDR,N), XBAR2(M), STD2(M), SSP2(LDSSP2,M), R2(LDR2,M)

3 Description

Input to the routine consists of:

(a)

A vector of means:

({\bar{x}}_{1}, {\bar{x}}_{2}, {\bar{x}}_{3}, \dots, {\bar{x}}_{n}),

where

n

is the number of input variables.

(b)

A vector of standard deviations:

(s_{1}, s_{2}, s_{3}, \dots, s_{n}) .

(c)

A matrix of sums of squares and cross-products of deviations from means:

(\begin{matrix} S_{11} & S_{12} & S_{13} & . & . & . & S_{1 n} \\ S_{21} & S_{22} & S_{2 n} \\ S_{31} & . \\ . & . \\ . & . \\ . & . \\ S_{n 1} & S_{n 2} & . & . & . & . & S_{n n} \end{matrix}) .

(d)

A matrix of correlation coefficients:

(\begin{matrix} R_{11} & R_{12} & R_{13} & . & . & . & R_{1 n} \\ R_{21} & R_{22} & R_{2 n} \\ R_{31} & . \\ . & . \\ . & . \\ . & . \\ R_{n 1} & R_{n 2} & . & . & . & . & R_{n n} \end{matrix}) .

(e)

The number of variables,

m

, in the required subset, and their row/column numbers in the input data,

i_{1}, i_{2}, i_{3}, \dots, i_{m}

i \leq i_{k} \leq n for k = 1, 2, \dots, m (n \geq 2, m \geq 1 and m \leq n) .

New vectors and matrices are output containing the following information:

(i)

A vector of means:

({\bar{x}}_{i_{1}}, {\bar{x}}_{i_{2}}, {\bar{x}}_{i_{3}}, \dots, {\bar{x}}_{i_{m}}) .

(ii)

A vector of standard deviations:

(s_{i_{1}}, s_{i_{2}}, s_{i_{3}}, \dots, s_{i_{m}}) .

(iii)

A matrix of sums of squares and cross-products of deviations from means:

(\begin{matrix} S_{i_{1} i_{1}} & S_{i_{1} i_{2}} & S_{i_{1} i_{3}} & . & . & . & S_{i_{1} i_{m}} \\ S_{i_{2} i_{1}} & S_{i_{2} i_{2}} & . \\ S_{i_{3} i_{1}} & . \\ . & . \\ . & . \\ . & . \\ S_{i_{m} i_{1}} & S_{i_{m} i_{2}} & . & . & . & . & S_{i_{m} i_{m}} \end{matrix}) .

(iv)

A matrix of correlation coefficients:

(\begin{matrix} R_{i_{1} i_{1}} & R_{i_{1} i_{2}} & R_{i_{1} i_{3}} & . & . & . & R_{i_{1} i_{m}} \\ R_{i_{2} i_{1}} & R_{i_{2} i_{2}} & . \\ R_{i_{3} i_{1}} & . \\ . & . \\ . & . \\ . & . \\ R_{i_{m} i_{1}} & R_{i_{m} i_{2}} & . & . & . & . & R_{i_{m} i_{m}} \end{matrix}) .

Note: for sums of squares of cross-products of deviations about zero and correlation-like coefficients

S_{i j}

and

R_{i j}

should be replaced by

{\tilde{S}}_{i j}

and

{\tilde{R}}_{i j}

in the description of the input and output above.

4 References

None.

5 Parameters

1: $N$ – INTEGERInput: On entry: $n$ , the number of variables in the input data.

Constraint: $N \geq 2$ .
2: $XBAR (N)$ – REAL (KIND=nag_wp) arrayInput: On entry: $XBAR (i)$ must be set to ${\bar{x}}_{i}$ , the mean of variable $i$ , for $i = 1, 2, \dots, n$ .
3: $STD (N)$ – REAL (KIND=nag_wp) arrayInput: On entry: $STD (i)$ must be set to $s_{i}$ , the standard deviation of variable $i$ , for $i = 1, 2, \dots, n$ .
4: $SSP (LDSSP, N)$ – REAL (KIND=nag_wp) arrayInput: On entry: $SSP (i, j)$ must be set to the sum of cross-products of deviations from means $S_{i j}$ (or about zero, ${\tilde{S}}_{i j}$ ) for variables $i$ and $j$ , for $i = 1, 2, \dots, n$ and $j = 1, 2, \dots, n$ .
5: $LDSSP$ – INTEGERInput: On entry: the first dimension of the array SSP as declared in the (sub)program from which G02CEF is called.

Constraint: $LDSSP \geq N$ .
6: $R (LDR, N)$ – REAL (KIND=nag_wp) arrayInput: On entry: $R (i, j)$ must be set to the Pearson product-moment correlation coefficient $R_{i j}$ (or the correlation-like coefficient, ${\tilde{R}}_{i j}$ ) for variables $i$ and $j$ , for $i = 1, 2, \dots, n$ and $j = 1, 2, \dots, n$ .
7: $LDR$ – INTEGERInput: On entry: the first dimension of the array R as declared in the (sub)program from which G02CEF is called.

Constraint: $LDR \geq N$ .
8: $M$ – INTEGERInput: On entry: the number of variables $m$ , required in the reduced vectors and matrices.

Constraint: $1 \leq M \leq N$ .
9: $KORDER (M)$ – INTEGER arrayInput: On entry: $KORDER (i)$ must be set to the number of the original variable which is to be the $i$ th variable in the output vectors and matrices, for $i = 1, 2, \dots, m$ .

Constraint: $1 \leq KORDER (i) \leq N$ , for $i = 1, 2, \dots, m$ .
10: $XBAR2 (M)$ – REAL (KIND=nag_wp) arrayOutput: On exit: the mean of variable $i$ , $XBAR (i)$ , where $i = KORDER (k)$ , for $k = 1, 2, \dots, m$ . (The array XBAR2 must differ from XBAR and STD.)
11: $STD2 (M)$ – REAL (KIND=nag_wp) arrayOutput: On exit: the standard deviation of variable $i$ , $STD (i)$ , where $i = KORDER (k)$ , for $k = 1, 2, \dots, m$ . (The array STD2 must differ from both XBAR and STD.)
12: $SSP2 (LDSSP2, M)$ – REAL (KIND=nag_wp) arrayOutput: On exit: $SSP2 (k, l)$ contains the value of $SSP (i, j)$ , where $i = KORDER (k)$ and $j = KORDER (l)$ , for $k = 1, 2, \dots, m$ and $l = 1, 2, \dots, m$ . (The array SSP2 must differ from both SSP and R.)
That is to say: on exit, $SSP2 (k, l)$ contains the sum of cross-products of deviations from means $S_{i j}$ (or about zero, ${\tilde{S}}_{i j}$ ).
13: $LDSSP2$ – INTEGERInput: On entry: the first dimension of the array SSP2 as declared in the (sub)program from which G02CEF is called.

Constraint: $LDSSP2 \geq M$ .
14: $R2 (LDR2, M)$ – REAL (KIND=nag_wp) arrayOutput: On exit: $R2 (k, l)$ contains the value of $R (i, j)$ , where $i = KORDER (k)$ and $j = KORDER (l)$ , for $k = 1, 2, \dots, m$ and $l = 1, 2, \dots, m$ . (The array R2 must differ from both SSP and R.)
That is to say: on exit, $R2 (k, l)$ contains the Pearson product-moment coefficient $R_{i j}$ (or the correlation-like coefficient, ${\tilde{R}}_{i j}$ ).
15: $LDR2$ – INTEGERInput: On entry: the first dimension of the array R2 as declared in the (sub)program from which G02CEF is called.

Constraint: $LDR2 \geq M$ .
16: $IFAIL$ – INTEGERInput/Output: On entry: IFAIL must be set to $0$ , $- 1 or 1$ . If you are unfamiliar with this parameter you should refer to Section 3.3 in the Essential Introduction for details.
For environments where it might be inappropriate to halt program execution when an error is detected, the value $- 1 or 1$ is recommended. If the output of error messages is undesirable, then the value $1$ is recommended. Otherwise, if you are not familiar with this parameter, the recommended value is $0$ . 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 = 1$

On entry,	$N < 2$ ,
or	$M < 1$ .

$IFAIL = 2$

On entry,

N < M

$IFAIL = 3$

On entry,	$LDSSP < N$ ,
or	$LDR < N$ ,
or	$LDSSP < M$ ,
or	$LDR2 < M$ .

$IFAIL = 4$

On entry,	$KORDER (i) < 1$ ,
or	$KORDER (i) > N$ for some $i = 1, 2, \dots, m$ .

$IFAIL = - 99$: An unexpected error has been triggered by this routine. Please contact NAG.
See Section 3.8 in the Essential Introduction for further information.

$IFAIL = - 399$: Your licence key may have expired or may not have been installed correctly.
See Section 3.7 in the Essential Introduction for further information.

$IFAIL = - 999$: Dynamic memory allocation failed.
See Section 3.6 in the Essential Introduction for further information.

7 Accuracy

Not applicable.

8 Parallelism and Performance

Not applicable.

9 Further Comments

The time taken by G02CEF depends on

n

and

m

The routine is intended primarily for use when a subset of variables from a larger set of variables is to be used in a regression, and is described accordingly. There is however no reason why the routine should not also be used to select specific rows and columns from vectors and arrays which contain any other non-statistical information; the matrices need not be symmetric.

The routine may be used either with sums of squares and cross-products of deviations from means and Pearson product-moment correlation coefficients in connection with a regression involving a constant, or with sums of squares and cross-products about zero and correlation-like coefficients in connection with a regression with no constant.

10 Example

This example reads in the means, standard deviations, sums of squares and cross-products, and correlation coefficients for four variables. New vectors and matrices are created containing the means, standard deviations, sums of squares and cross-products, and correlation coefficients for the fourth, first and second variables (in that order). Finally these new vectors and matrices are printed.

NAG Library Routine DocumentG02CEF