g02bf computes means and standard deviations of variables, sums of squares and cross-products about zero and correlation-like coefficients for a set of data omitting cases with missing values from only those calculations involving the variables for which the values are missing.

Syntax

C#
public static void g02bf(
	int n,
	int m,
	double[,] x,
	int[] miss,
	double[] xmiss,
	double[] xbar,
	double[] std,
	double[,] sspz,
	double[,] rz,
	out int ncases,
	double[,] cnt,
	out int ifail
)
Visual Basic
Public Shared Sub g02bf ( _
	n As Integer, _
	m As Integer, _
	x As Double(,), _
	miss As Integer(), _
	xmiss As Double(), _
	xbar As Double(), _
	std As Double(), _
	sspz As Double(,), _
	rz As Double(,), _
	<OutAttribute> ByRef ncases As Integer, _
	cnt As Double(,), _
	<OutAttribute> ByRef ifail As Integer _
)
Visual C++
public:
static void g02bf(
	int n, 
	int m, 
	array<double,2>^ x, 
	array<int>^ miss, 
	array<double>^ xmiss, 
	array<double>^ xbar, 
	array<double>^ std, 
	array<double,2>^ sspz, 
	array<double,2>^ rz, 
	[OutAttribute] int% ncases, 
	array<double,2>^ cnt, 
	[OutAttribute] int% ifail
)
F#
static member g02bf : 
        n : int * 
        m : int * 
        x : float[,] * 
        miss : int[] * 
        xmiss : float[] * 
        xbar : float[] * 
        std : float[] * 
        sspz : float[,] * 
        rz : float[,] * 
        ncases : int byref * 
        cnt : 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.
miss
Type: array<System..::..Int32>[]()[][]
An array of size [m]
On entry: miss[j-1] must be set equal to 1 if a missing value, xmj, is to be specified for the jth variable in the array x, or set equal to 0 otherwise. Values of miss must be given for all m variables in the array x.
xmiss
Type: array<System..::..Double>[]()[][]
An array of size [m]
On entry: xmiss[j-1] must be set to the missing value, xmj, to be associated with the jth variable in the array x, for those variables for which missing values are specified by means of the array miss (see [Accuracy]).
xbar
Type: array<System..::..Double>[]()[][]
An array of size [m]
On exit: the mean value, x-j, of the jth variable, for j=1,2,,m.
std
Type: array<System..::..Double>[]()[][]
An array of size [m]
On exit: the standard deviation, sj, of the jth variable, for j=1,2,,m.
sspz
Type: array<System..::..Double,2>[,](,)[,][,]
An array of size [dim1, m]
Note: dim1 must satisfy the constraint: dim1m
On exit: sspz[j-1,k-1] is the cross-product about zero, S~jk, for j=1,2,,m and k=1,2,,m.
rz
Type: array<System..::..Double,2>[,](,)[,][,]
An array of size [dim1, m]
Note: dim1 must satisfy the constraint: dim1m
On exit: rz[j-1,k-1] is the correlation-like coefficient, R~jk, between the jth and kth variables, for j=1,2,,m and k=1,2,,m.
ncases
Type: System..::..Int32%
On exit: the minimum number of cases used in the calculation of any of the sums of squares and cross-products and correlation-like coefficients (when cases involving missing values have been eliminated).
cnt
Type: array<System..::..Double,2>[,](,)[,][,]
An array of size [dim1, m]
Note: dim1 must satisfy the constraint: dim1m
On exit: cnt[j-1,k-1] is the number of cases, cjk, actually used in the calculation of S~jk, and R~jk, the sum of cross-products and correlation-like coefficient for the jth and kth variables, for j=1,2,,m and k=1,2,,m.
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 consists 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. In addition, each of the m variables may optionally have associated with it a value which is to be considered as representing a missing observation for that variable; the missing value for the jth variable is denoted by xmj. Missing values need not be specified for all variables.
Let wij=0 if the ith observation for the jth variable is a missing value, i.e., if a missing value, xmj, has been declared for the jth variable, and xij=xmj (see also [Accuracy]); and wij=1 otherwise, for i=1,2,,n and j=1,2,,m.
The quantities calculated are:
(a) Means:
x-j=i=1nwijxiji=1nwij,  j=1,2,,m.
(b) Standard deviations:
sj=i=1nwijxij-x-j2i=1nwij-1,  j=1,2,,m.
(c) Sums of squares and cross-products about zero:
S~jk=i=1nwijwikxijxik,  j,k=1,2,,m.
(d) Correlation-like coefficients:
R~jk=S~jkS~jjkjkS~kkj,  j,k=1,2,,m,
where S~jjk=i=1nwijwikxij2 and S~kkj=i=1nwikwijxik2 
(i.e., the sums of squares about zero are based on the same set of observations as are used in the calculation of the numerator).
If S~jjk or S~kkj is zero, R~jk is set to zero.
(e) The number of cases used in the calculation of each of the correlation-like coefficients:
cjk=i=1nwijwik,  j,k=1,2,,m.
(The diagonal terms, cjj, for j=1,2,,m, also give the number of cases used in the calculation of the means x-j and the standard deviations sj.)

References

None.

Error Indicators and Warnings

Note: g02bf may return useful information for one or more of the following detected errors or warnings.
Errors or warnings detected by the method:
Some error messages may refer to parameters that are dropped from this interface (LDX, LDSSPZ, LDRZ, LDCNT) 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,m<2.
ifail=4
After observations with missing values were omitted, fewer than two cases remained for at least one pair of variables. (The pairs of variables involved can be determined by examination of the contents of the array cnt). All means, standard deviations, sums of squares and cross-products, and correlation-like coefficients based on two or more cases are returned by the method even if ifail=4.
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

g02bf does not use additional precision arithmetic for the accumulation of scalar products, so there may be a loss of significant figures for large n.
You are warned of the need to exercise extreme care in your selection of missing values. g02bf treats all values in the inclusive range 1±0.1x02be-2×xmj, where xmj is the missing value for variable j specified in xmiss.
You must therefore ensure that the missing value chosen for each variable is sufficiently different from all valid values for that variable so that none of the valid values fall within the range indicated above.

Parallelism and Performance

None.

Further Comments

The time taken by g02bf depends on n and m, and the occurrence of missing values.
The method uses a two-pass algorithm.

Example

This example reads in a set of data consisting of five observations on each of three variables. Missing values of 0.0, -1.0 and 0.0 are declared for the first, second and third variables respectively. The means, standard deviations, sums of squares and cross-products about zero, and correlation-like coefficients for all three variables are then calculated and printed, omitting cases with missing values from only those calculations involving the variables for which the values are missing. The program therefore omits cases 4 and 5 in calculating the correlation between the first and second variables, and cases 3 and 4 for the first and third variables, etc.

Example program (C#): g02bfe.cs

Example program data: g02bfe.d

Example program results: g02bfe.r

See Also