# NAG CL Interfaceg02hmc (robustm_​corr_​user)

Settings help

CL Name Style:

## 1Purpose

g02hmc computes a robust estimate of the covariance matrix for user-supplied weight functions. The derivatives of the weight functions are not required.

## 2Specification

 #include
void  g02hmc (Nag_OrderType order,
 void (*ucv)(double t, double *u, double *w, Nag_Comm *comm),
Integer indm, Integer n, Integer m, const double x[], Integer pdx, double cov[], double a[], double wt[], double theta[], double bl, double bd, Integer maxit, Integer nitmon, const char *outfile, double tol, Integer *nit, Nag_Comm *comm, NagError *fail)
The function may be called by the names: g02hmc, nag_correg_robustm_corr_user or nag_robust_m_corr_user_fn_no_derr.

## 3Description

For a set of $n$ observations on $m$ variables in a matrix $X$, a robust estimate of the covariance matrix, $C$, and a robust estimate of location, $\theta$, are given by
 $C=τ2(ATA)−1,$
where ${\tau }^{2}$ is a correction factor and $A$ is a lower triangular matrix found as the solution to the following equations.
 $zi=A(xi-θ)$
 $1n ∑i= 1nw(‖zi‖2)zi=0$
and
 $1n∑i=1nu(‖zi‖2)zi ziT -v(‖zi‖2)I=0,$
 where ${x}_{i}$ is a vector of length $m$ containing the elements of the $i$th row of $X$, ${z}_{i}$ is a vector of length $m$, $I$ is the identity matrix and $0$ is the zero matrix. and $w$ and $u$ are suitable functions.
g02hmc covers two situations:
1. (i)$v\left(t\right)=1$ for all $t$,
2. (ii)$v\left(t\right)=u\left(t\right)$.
The robust covariance matrix may be calculated from a weighted sum of squares and cross-products matrix about $\theta$ using weights ${\mathit{wt}}_{i}=u\left(‖{z}_{i}‖\right)$. In case (i) a divisor of $n$ is used and in case (ii) a divisor of $\sum _{i=1}^{n}{\mathit{wt}}_{i}$ is used. If $w\left(.\right)=\sqrt{u\left(.\right)}$, then the robust covariance matrix can be calculated by scaling each row of $X$ by $\sqrt{{\mathit{wt}}_{i}}$ and calculating an unweighted covariance matrix about $\theta$.
In order to make the estimate asymptotically unbiased under a Normal model a correction factor, ${\tau }^{2}$, is needed. The value of the correction factor will depend on the functions employed (see Huber (1981) and Marazzi (1987)).
g02hmc finds $A$ using the iterative procedure as given by Huber; see Huber (1981).
 $Ak=(Sk+I)Ak-1$
and
 $θjk=bjD1+θjk- 1,$
where ${S}_{k}=\left({s}_{jl}\right)$, for $\mathit{j}=1,2,\dots ,m$ and $\mathit{l}=1,2,\dots ,m$ is a lower triangular matrix such that
 $sjl={ -min[max(hjl/D2,-BL),BL], j>l -min[max(12(hjj/D2-1),-BD),BD], j=l ,$
where
• ${D}_{1}=\sum _{i=1}^{n}w\left({‖{z}_{i}‖}_{2}\right)$
• ${D}_{2}=\sum _{i=1}^{n}u\left({‖{z}_{i}‖}_{2}\right)$
• ${h}_{jl}=\sum _{i=1}^{n}u\left({‖{z}_{i}‖}_{2}\right){z}_{ij}{z}_{il}$, for $j\ge l$
• ${b}_{j}=\sum _{i=1}^{n}w\left({‖{z}_{i}‖}_{2}\right)\left({x}_{ij}-{b}_{j}\right)$
and $\mathit{BD}$ and $\mathit{BL}$ are suitable bounds.
The value of $\tau$ may be chosen so that $C$ is unbiased if the observations are from a given distribution.
g02hmc is based on routines in ROBETH; see Marazzi (1987).

## 4References

Huber P J (1981) Robust Statistics Wiley
Marazzi A (1987) Weights for bounded influence regression in ROBETH Cah. Rech. Doc. IUMSP, No. 3 ROB 3 Institut Universitaire de Médecine Sociale et Préventive, Lausanne

## 5Arguments

1: $\mathbf{order}$Nag_OrderType Input
On entry: the order argument specifies the two-dimensional storage scheme being used, i.e., row-major ordering or column-major ordering. C language defined storage is specified by ${\mathbf{order}}=\mathrm{Nag_RowMajor}$. See Section 3.1.3 in the Introduction to the NAG Library CL Interface for a more detailed explanation of the use of this argument.
Constraint: ${\mathbf{order}}=\mathrm{Nag_RowMajor}$ or $\mathrm{Nag_ColMajor}$.
2: $\mathbf{ucv}$function, supplied by the user External Function
ucv must return the values of the functions $u$ and $w$ for a given value of its argument.
The specification of ucv is:
 void ucv (double t, double *u, double *w, Nag_Comm *comm)
1: $\mathbf{t}$double Input
On entry: the argument for which the functions $u$ and $w$ must be evaluated.
2: $\mathbf{u}$double * Output
On exit: the value of the $u$ function at the point t.
Constraint: ${\mathbf{u}}\ge 0.0$.
3: $\mathbf{w}$double * Output
On exit: the value of the $w$ function at the point t.
Constraint: ${\mathbf{w}}\ge 0.0$.
4: $\mathbf{comm}$Nag_Comm *
Pointer to structure of type Nag_Comm; the following members are relevant to ucv.
userdouble *
iuserInteger *
pPointer
The type Pointer will be void *. Before calling g02hmc you may allocate memory and initialize these pointers with various quantities for use by ucv when called from g02hmc (see Section 3.1.1 in the Introduction to the NAG Library CL Interface).
Note: ucv should not return floating-point NaN (Not a Number) or infinity values, since these are not handled by g02hmc. If your code inadvertently does return any NaNs or infinities, g02hmc is likely to produce unexpected results.
3: $\mathbf{indm}$Integer Input
On entry: indicates which form of the function $v$ will be used.
${\mathbf{indm}}=1$
$v=1$.
${\mathbf{indm}}\ne 1$
$v=u$.
4: $\mathbf{n}$Integer Input
On entry: $n$, the number of observations.
Constraint: ${\mathbf{n}}>1$.
5: $\mathbf{m}$Integer Input
On entry: $m$, the number of columns of the matrix $X$, i.e., number of independent variables.
Constraint: $1\le {\mathbf{m}}\le {\mathbf{n}}$.
6: $\mathbf{x}\left[\mathit{dim}\right]$const double Input
Note: the dimension, dim, of the array x must be at least
• $\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{pdx}}×{\mathbf{m}}\right)$ when ${\mathbf{order}}=\mathrm{Nag_ColMajor}$;
• $\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{n}}×{\mathbf{pdx}}\right)$ when ${\mathbf{order}}=\mathrm{Nag_RowMajor}$.
where ${\mathbf{X}}\left(i,j\right)$ appears in this document, it refers to the array element
• ${\mathbf{x}}\left[\left(j-1\right)×{\mathbf{pdx}}+i-1\right]$ when ${\mathbf{order}}=\mathrm{Nag_ColMajor}$;
• ${\mathbf{x}}\left[\left(i-1\right)×{\mathbf{pdx}}+j-1\right]$ when ${\mathbf{order}}=\mathrm{Nag_RowMajor}$.
On entry: ${\mathbf{X}}\left(\mathit{i},\mathit{j}\right)$ must contain 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$.
7: $\mathbf{pdx}$Integer Input
On entry: the stride separating row or column elements (depending on the value of order) in the array x.
Constraints:
• if ${\mathbf{order}}=\mathrm{Nag_ColMajor}$, ${\mathbf{pdx}}\ge {\mathbf{n}}$;
• if ${\mathbf{order}}=\mathrm{Nag_RowMajor}$, ${\mathbf{pdx}}\ge {\mathbf{m}}$.
8: $\mathbf{cov}\left[{\mathbf{m}}×\left({\mathbf{m}}+1\right)/2\right]$double Output
On exit: a robust estimate of the covariance matrix, $C$. The upper triangular part of the matrix $C$ is stored packed by columns (lower triangular stored by rows), that is ${C}_{ij}$ is returned in ${\mathbf{cov}}\left[j×\left(j-1\right)/2+i-1\right]$, $i\le j$.
9: $\mathbf{a}\left[{\mathbf{m}}×\left({\mathbf{m}}+1\right)/2\right]$double Input/Output
On entry: an initial estimate of the lower triangular real matrix $A$. Only the lower triangular elements must be given and these should be stored row-wise in the array.
The diagonal elements must be $\text{}\ne 0$, and in practice will usually be $\text{}>0$. If the magnitudes of the columns of $X$ are of the same order, the identity matrix will often provide a suitable initial value for $A$. If the columns of $X$ are of different magnitudes, the diagonal elements of the initial value of $A$ should be approximately inversely proportional to the magnitude of the columns of $X$.
Constraint: ${\mathbf{a}}\left[\mathit{j}×\left(\mathit{j}-1\right)/2+\mathit{j}\right]\ne 0.0$, for $\mathit{j}=0,1,\dots ,m-1$.
On exit: the lower triangular elements of the inverse of the matrix $A$, stored row-wise.
10: $\mathbf{wt}\left[{\mathbf{n}}\right]$double Output
On exit: ${\mathbf{wt}}\left[\mathit{i}-1\right]$ contains the weights, ${\mathit{wt}}_{\mathit{i}}=u\left({‖{z}_{\mathit{i}}‖}_{2}\right)$, for $\mathit{i}=1,2,\dots ,n$.
11: $\mathbf{theta}\left[{\mathbf{m}}\right]$double Input/Output
On entry: an initial estimate of the location parameter, ${\theta }_{\mathit{j}}$, for $\mathit{j}=1,2,\dots ,m$.
In many cases an initial estimate of ${\theta }_{\mathit{j}}=0$, for $\mathit{j}=1,2,\dots ,m$, will be adequate. Alternatively medians may be used as given by g07dac.
On exit: contains the robust estimate of the location parameter, ${\theta }_{\mathit{j}}$, for $\mathit{j}=1,2,\dots ,m$.
12: $\mathbf{bl}$double Input
On entry: the magnitude of the bound for the off-diagonal elements of ${S}_{k}$, $BL$.
Suggested value: ${\mathbf{bl}}=0.9$.
Constraint: ${\mathbf{bl}}>0.0$.
13: $\mathbf{bd}$double Input
On entry: the magnitude of the bound for the diagonal elements of ${S}_{k}$, $BD$.
Suggested value: ${\mathbf{bd}}=0.9$.
Constraint: ${\mathbf{bd}}>0.0$.
14: $\mathbf{maxit}$Integer Input
On entry: the maximum number of iterations that will be used during the calculation of $A$.
Suggested value: ${\mathbf{maxit}}=150$.
Constraint: ${\mathbf{maxit}}>0$.
15: $\mathbf{nitmon}$Integer Input
On entry: indicates the amount of information on the iteration that is printed.
${\mathbf{nitmon}}>0$
The value of $A$, $\theta$ and $\delta$ (see Section 7) will be printed at the first and every nitmon iterations.
${\mathbf{nitmon}}\le 0$
No iteration monitoring is printed.
16: $\mathbf{outfile}$const char * Input
On entry: a null terminated character string giving the name of the file to which results should be printed. If ${\mathbf{outfile}}=\mathbf{NULL}$ or an empty string then the stdout stream is used. Note that the file will be opened in the append mode.
17: $\mathbf{tol}$double Input
On entry: the relative precision for the final estimate of the covariance matrix. Iteration will stop when maximum $\delta$ (see Section 7) is less than tol.
Constraint: ${\mathbf{tol}}>0.0$.
18: $\mathbf{nit}$Integer * Output
On exit: the number of iterations performed.
19: $\mathbf{comm}$Nag_Comm *
The NAG communication argument (see Section 3.1.1 in the Introduction to the NAG Library CL Interface).
20: $\mathbf{fail}$NagError * Input/Output
The NAG error argument (see Section 7 in the Introduction to the NAG Library CL Interface).

## 6Error Indicators and Warnings

NE_ALLOC_FAIL
Dynamic memory allocation failed.
See Section 3.1.2 in the Introduction to the NAG Library CL Interface for further information.
On entry, argument $⟨\mathit{\text{value}}⟩$ had an illegal value.
NE_CONST_COL
On entry, a variable has a constant value, i.e., all elements in column $⟨\mathit{\text{value}}⟩$ of x are identical.
NE_CONVERGENCE
Iterations to calculate weights failed to converge.
NE_FUN_RET_VAL
$u$ value returned by ${\mathbf{ucv}}<0.0$: $u\left(⟨\mathit{\text{value}}⟩\right)=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{u}}\ge 0.0$.
$w$ value returned by ${\mathbf{ucv}}<0.0$: $w\left(⟨\mathit{\text{value}}⟩\right)=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{w}}\ge 0.0$.
NE_INT
On entry, ${\mathbf{m}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{m}}\ge 1$.
On entry, ${\mathbf{maxit}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{maxit}}>0$.
On entry, ${\mathbf{n}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{n}}>1$.
On entry, ${\mathbf{pdx}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{pdx}}>0$.
NE_INT_2
On entry, ${\mathbf{m}}=⟨\mathit{\text{value}}⟩$ and ${\mathbf{n}}=⟨\mathit{\text{value}}⟩$.
Constraint: $1\le {\mathbf{m}}\le {\mathbf{n}}$.
On entry, ${\mathbf{n}}=⟨\mathit{\text{value}}⟩$ and ${\mathbf{m}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{n}}\ge {\mathbf{m}}$.
On entry, ${\mathbf{pdx}}=⟨\mathit{\text{value}}⟩$ and ${\mathbf{m}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{pdx}}\ge {\mathbf{m}}$.
On entry, ${\mathbf{pdx}}=⟨\mathit{\text{value}}⟩$ and ${\mathbf{n}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{pdx}}\ge {\mathbf{n}}$.
NE_INTERNAL_ERROR
An internal error has occurred in this function. Check the function call and any array sizes. If the call is correct then please contact NAG for assistance.
See Section 7.5 in the Introduction to the NAG Library CL Interface for further information.
NE_NO_LICENCE
Your licence key may have expired or may not have been installed correctly.
See Section 8 in the Introduction to the NAG Library CL Interface for further information.
NE_NOT_CLOSE_FILE
Cannot close file $⟨\mathit{\text{value}}⟩$.
NE_NOT_WRITE_FILE
Cannot open file $⟨\mathit{\text{value}}⟩$ for writing.
NE_REAL
On entry, ${\mathbf{bd}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{bd}}>0.0$.
On entry, ${\mathbf{bl}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{bl}}>0.0$.
On entry, ${\mathbf{tol}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{tol}}>0.0$.
NE_ZERO_DIAGONAL
On entry, $i=⟨\mathit{\text{value}}⟩$ and the $i$th diagonal element of $A$ is $0$.
Constraint: all diagonal elements of $A$ must be non-zero.
NE_ZERO_SUM
The sum ${D}_{1}$ is zero. Try either a larger initial estimate of $A$ or make $u$ and $w$ less strict.
The sum ${D}_{2}$ is zero. Try either a larger initial estimate of $A$ or make $u$ and $w$ less strict.

## 7Accuracy

On successful exit the accuracy of the results is related to the value of tol; see Section 5. At an iteration let
1. (i)$d1=\text{}$ the maximum value of $|{s}_{jl}|$
2. (ii)$d2=\text{}$ the maximum absolute change in $wt\left(i\right)$
3. (iii)$d3=\text{}$ the maximum absolute relative change in ${\theta }_{j}$
and let $\delta =\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(d1,d2,d3\right)$. Then the iterative procedure is assumed to have converged when $\delta <{\mathbf{tol}}$.

## 8Parallelism and Performance

g02hmc makes calls to BLAS and/or LAPACK routines, which may be threaded within the vendor library used by this implementation. Consult the documentation for the vendor library for further information.
Please consult the X06 Chapter Introduction for information on how to control and interrogate the OpenMP environment used within this function. Please also consult the Users' Note for your implementation for any additional implementation-specific information.

The existence of $A$ will depend upon the function $u$ (see Marazzi (1987)); also if $X$ is not of full rank a value of $A$ will not be found. If the columns of $X$ are almost linearly related, then convergence will be slow.
If derivatives of the $u$ and $w$ functions are available then the method used in g02hlc will usually give much faster convergence.

## 10Example

A sample of $10$ observations on three variables is read in along with initial values for $A$ and $\theta$ and parameter values for the $u$ and $w$ functions, ${c}_{u}$ and ${c}_{w}$. The covariance matrix computed by g02hmc is printed along with the robust estimate of $\theta$.
ucv computes the Huber's weight functions:
 $u(t)=1, if t≤cu2 u(t)= cut2, if t>cu2$
and
 $w(t)= 1, if t≤cw w(t)= cwt, if t>cw.$

### 10.1Program Text

Program Text (g02hmce.c)

### 10.2Program Data

Program Data (g02hmce.d)

### 10.3Program Results

Program Results (g02hmce.r)