G02BGF (PDF version)
G02 Chapter Contents
G02 Chapter Introduction
NAG Library Manual

# NAG Library Routine DocumentG02BGF

Note:  before using this routine, please read the Users' Note for your implementation to check the interpretation of bold italicised terms and other implementation-dependent details.

## 1  Purpose

G02BGF computes means and standard deviations, sums of squares and cross-products of deviations from means, and Pearson product-moment correlation coefficients for selected variables.

## 2  Specification

 SUBROUTINE G02BGF ( N, M, X, LDX, NVARS, KVAR, XBAR, STD, SSP, LDSSP, R, LDR, IFAIL)
 INTEGER N, M, LDX, NVARS, KVAR(NVARS), LDSSP, LDR, IFAIL REAL (KIND=nag_wp) X(LDX,M), XBAR(NVARS), STD(NVARS), SSP(LDSSP,NVARS), R(LDR,NVARS)

## 3  Description

The input data consist of $n$ observations for each of $m$ variables, given as an array
 $xij, i=1,2,…,nn≥2,j=1,2,…,mm≥2,$
where ${x}_{ij}$ is the $i$th observation on the $j$th variable, together with the subset of these variables, ${v}_{1},{v}_{2},\dots ,{v}_{p}$, for which information is required.
The quantities calculated are:
(a) Means:
 $x-j=1n∑i=1nxij, j=v1,v2,…,vp.$
(b) Standard deviations:
 $sj=1n- 1 ∑i= 1n xij-x-j 2, j=v1,v2,…,vp.$
(c) Sums of squares and cross-products of deviations from zero:
 $Sjk=∑i=1nxij-x-jxik-x-k, j,k=v1,v2,…,vp.$
(d) Pearson product-moment correlation coefficients:
 $Rjk=SjkSjjSkk , j,k=v1,v2,…vp.$
If ${S}_{jj}$ or ${S}_{kk}$ is zero, ${R}_{jk}$ is set to zero.

None.

## 5  Parameters

1:     N – INTEGERInput
On entry: $n$, the number of observations or cases.
Constraint: ${\mathbf{N}}\ge 2$.
2:     M – INTEGERInput
On entry: $m$, the number of variables.
Constraint: ${\mathbf{M}}\ge 2$.
3:     X(LDX,M) – REAL (KIND=nag_wp) arrayInput
On entry: ${\mathbf{X}}\left(\mathit{i},\mathit{j}\right)$ must be set to ${x}_{\mathit{i}\mathit{j}}$, the value of the $\mathit{i}$th observation on the $\mathit{j}$th variable, for $\mathit{i}=1,2,\dots ,n$ and $\mathit{j}=1,2,\dots ,m$.
4:     LDX – INTEGERInput
On entry: the first dimension of the array X as declared in the (sub)program from which G02BGF is called.
Constraint: ${\mathbf{LDX}}\ge {\mathbf{N}}$.
5:     NVARS – INTEGERInput
On entry: $p$, the number of variables for which information is required.
Constraint: $2\le {\mathbf{NVARS}}\le {\mathbf{M}}$.
6:     KVAR(NVARS) – INTEGER arrayInput
On entry: ${\mathbf{KVAR}}\left(\mathit{j}\right)$ must be set to the column number in X of the $\mathit{j}$th variable for which information is required, for $\mathit{j}=1,2,\dots ,p$.
Constraint: $1\le {\mathbf{KVAR}}\left(\mathit{j}\right)\le {\mathbf{M}}$, for $\mathit{j}=1,2,\dots ,p$.
7:     XBAR(NVARS) – REAL (KIND=nag_wp) arrayOutput
On exit: the mean value, ${\stackrel{-}{x}}_{\mathit{j}}$, of the variable specified in ${\mathbf{KVAR}}\left(\mathit{j}\right)$, for $\mathit{j}=1,2,\dots ,p$.
8:     STD(NVARS) – REAL (KIND=nag_wp) arrayOutput
On exit: the standard deviation, ${s}_{\mathit{j}}$, of the variable specified in ${\mathbf{KVAR}}\left(\mathit{j}\right)$, for $\mathit{j}=1,2,\dots ,p$.
9:     SSP(LDSSP,NVARS) – REAL (KIND=nag_wp) arrayOutput
On exit: ${\mathbf{SSP}}\left(\mathit{j},\mathit{k}\right)$ is the cross-product of deviations, ${S}_{\mathit{j}\mathit{k}}$, for the variables specified in ${\mathbf{KVAR}}\left(\mathit{j}\right)$ and ${\mathbf{KVAR}}\left(\mathit{k}\right)$, for $\mathit{j}=1,2,\dots ,p$ and $\mathit{k}=1,2,\dots ,p$.
10:   LDSSP – INTEGERInput
On entry: the first dimension of the array SSP as declared in the (sub)program from which G02BGF is called.
Constraint: ${\mathbf{LDSSP}}\ge {\mathbf{NVARS}}$.
11:   R(LDR,NVARS) – REAL (KIND=nag_wp) arrayOutput
On exit: ${\mathbf{R}}\left(\mathit{j},\mathit{k}\right)$ is the product-moment correlation coefficient, ${R}_{\mathit{j}\mathit{k}}$, between the variables specified in ${\mathbf{KVAR}}\left(\mathit{j}\right)$ and ${\mathbf{KVAR}}\left(\mathit{k}\right)$, for $\mathit{j}=1,2,\dots ,p$ and $\mathit{k}=1,2,\dots ,p$.
12:   LDR – INTEGERInput
On entry: the first dimension of the array R as declared in the (sub)program from which G02BGF is called.
Constraint: ${\mathbf{LDR}}\ge {\mathbf{NVARS}}$.
13:   IFAIL – INTEGERInput/Output
On entry: IFAIL must be set to $0$, $-1\text{​ 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\text{​ 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 $-\mathbf{1}\text{​ or ​}\mathbf{1}$ is used it is essential to test the value of IFAIL on exit.
On exit: ${\mathbf{IFAIL}}={\mathbf{0}}$ unless the routine detects an error or a warning has been flagged (see Section 6).

## 6  Error Indicators and Warnings

If on entry ${\mathbf{IFAIL}}={\mathbf{0}}$ or $-{\mathbf{1}}$, explanatory error messages are output on the current error message unit (as defined by X04AAF).
Errors or warnings detected by the routine:
${\mathbf{IFAIL}}=1$
 On entry, ${\mathbf{N}}<2$.
${\mathbf{IFAIL}}=2$
 On entry, ${\mathbf{NVARS}}<2$, or ${\mathbf{NVARS}}>{\mathbf{M}}$.
${\mathbf{IFAIL}}=3$
 On entry, ${\mathbf{LDX}}<{\mathbf{N}}$, or ${\mathbf{LDSSP}}<{\mathbf{NVARS}}$, or ${\mathbf{LDR}}<{\mathbf{NVARS}}$.
${\mathbf{IFAIL}}=4$
 On entry, ${\mathbf{KVAR}}\left(j\right)<1$, or ${\mathbf{KVAR}}\left(j\right)>{\mathbf{M}}$ for some $j=1,2,\dots ,{\mathbf{NVARS}}$.

## 7  Accuracy

G02BGF does not use additional precision arithmetic for the accumulation of scalar products, so there may be a loss of significant figures for large $n$.

## 8  Further Comments

The time taken by G02BGF depends on $n$ and $p$.
The routine uses a two pass algorithm.

## 9  Example

This example reads in a set of data consisting of five observations on each of four variables. The means, standard deviations, sums of squares and cross-products of deviations from means, and Pearson product-moment correlation coefficients for the fourth, first and second variables are then calculated and printed.

### 9.1  Program Text

Program Text (g02bgfe.f90)

### 9.2  Program Data

Program Data (g02bgfe.d)

### 9.3  Program Results

Program Results (g02bgfe.r)

G02BGF (PDF version)
G02 Chapter Contents
G02 Chapter Introduction
NAG Library Manual