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

Syntax

C#
public static void g02bg(
	int n,
	int m,
	double[,] x,
	int nvars,
	int[] kvar,
	double[] xbar,
	double[] std,
	double[,] ssp,
	double[,] r,
	out int ifail
)
Visual Basic
Public Shared Sub g02bg ( _
	n As Integer, _
	m As Integer, _
	x As Double(,), _
	nvars As Integer, _
	kvar As Integer(), _
	xbar As Double(), _
	std As Double(), _
	ssp As Double(,), _
	r As Double(,), _
	<OutAttribute> ByRef ifail As Integer _
)
Visual C++
public:
static void g02bg(
	int n, 
	int m, 
	array<double,2>^ x, 
	int nvars, 
	array<int>^ kvar, 
	array<double>^ xbar, 
	array<double>^ std, 
	array<double,2>^ ssp, 
	array<double,2>^ r, 
	[OutAttribute] int% ifail
)
F#
static member g02bg : 
        n : int * 
        m : int * 
        x : float[,] * 
        nvars : int * 
        kvar : int[] * 
        xbar : float[] * 
        std : float[] * 
        ssp : float[,] * 
        r : float[,] * 
        ifail : int byref -> unit 

Parameters

n
Type: System..::..Int32
On entry: n, the number of observations or cases.
Constraint: n2.
m
Type: System..::..Int32
On entry: m, the number of variables.
Constraint: m2.
x
Type: array<System..::..Double,2>[,](,)[,][,]
An array of size [dim1, m]
Note: dim1 must satisfy the constraint: dim1n
On entry: x[i-1,j-1] must be set to xij, the value of the ith observation on the jth variable, for i=1,2,,n and j=1,2,,m.
nvars
Type: System..::..Int32
On entry: p, the number of variables for which information is required.
Constraint: 2nvarsm.
kvar
Type: array<System..::..Int32>[]()[][]
An array of size [nvars]
On entry: kvar[j] must be set to the column number in x of the jth variable for which information is required, for j=0,1,,p-1.
Constraint: 1kvar[j]m, for j=0,1,,p-1.
xbar
Type: array<System..::..Double>[]()[][]
An array of size [nvars]
On exit: the mean value, x-j, of the variable specified in kvar[j-1], for j=1,2,,p.
std
Type: array<System..::..Double>[]()[][]
An array of size [nvars]
On exit: the standard deviation, sj, of the variable specified in kvar[j-1], for j=1,2,,p.
ssp
Type: array<System..::..Double,2>[,](,)[,][,]
An array of size [dim1, nvars]
Note: dim1 must satisfy the constraint: dim1nvars
On exit: ssp[j-1,k-1] is the cross-product of deviations, Sjk, for the variables specified in kvar[j-1] and kvar[k-1], for j=1,2,,p and k=1,2,,p.
r
Type: array<System..::..Double,2>[,](,)[,][,]
An array of size [dim1, nvars]
Note: dim1 must satisfy the constraint: dim1nvars
On exit: r[j-1,k-1] is the product-moment correlation coefficient, Rjk, between the variables specified in kvar[j-1] and kvar[k-1], for j=1,2,,p and k=1,2,,p.
ifail
Type: System..::..Int32%
On exit: ifail=0 unless the method detects an error or a warning has been flagged (see [Error Indicators and Warnings]).

Description

The input data consist of n observations for each of m variables, given as an array
xij,  i=1,2,,nn2,j=1,2,,mm2,
where xij is the ith observation on the jth variable, together with the subset of these variables, v1,v2,,vp, for which information is required.
The quantities calculated are:
(a) Means:
x-j=1ni=1nxij,  j=v1,v2,,vp.
(b) Standard deviations:
sj=1n-1i=1nxij-x-j2,  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 Sjj or Skk is zero, Rjk is set to zero.

References

None.

Error Indicators and Warnings

Errors or warnings detected by the method:
Some error messages may refer to parameters that are dropped from this interface (LDX, LDSSP, LDR) In these cases, an error in another parameter has usually caused an incorrect value to be inferred.
ifail=1
On entry,n<2.
ifail=2
On entry,nvars<2,
ornvars>m.
ifail=4
On entry,kvar[j-1]<1,
orkvar[j-1]>m for some j=1,2,,nvars.
ifail=-9000
An error occured, see message report.
ifail=-6000
Invalid Parameters value
ifail=-4000
Invalid dimension for array value
ifail=-8000
Negative dimension for array value
ifail=-6000
Invalid Parameters value

Accuracy

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

Parallelism and Performance

None.

Further Comments

The time taken by g02bg depends on n and p.
The method uses a two pass algorithm.

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.

Example program (C#): g02bge.cs

Example program data: g02bge.d

Example program results: g02bge.r

See Also