# NAG FL Interfaceg02ajf (corrmat_​h_​weight)

## ▸▿ Contents

Settings help

FL Name Style:

FL Specification Language:

## 1Purpose

g02ajf computes the nearest correlation matrix, using element-wise weighting in the Frobenius norm and optionally with bounds on the eigenvalues, to a given square, input matrix.

## 2Specification

Fortran Interface
 Subroutine g02ajf ( g, ldg, n, h, ldh, x, ldx, iter, norm,
 Integer, Intent (In) :: ldg, n, ldh, maxit, ldx Integer, Intent (Inout) :: ifail Integer, Intent (Out) :: iter Real (Kind=nag_wp), Intent (In) :: alpha, errtol Real (Kind=nag_wp), Intent (Inout) :: g(ldg,*), h(ldh,*), x(ldx,*) Real (Kind=nag_wp), Intent (Out) :: norm
C Header Interface
#include <nag.h>
 void g02ajf_ (double g[], const Integer *ldg, const Integer *n, const double *alpha, double h[], const Integer *ldh, const double *errtol, const Integer *maxit, double x[], const Integer *ldx, Integer *iter, double *norm, Integer *ifail)
The routine may be called by the names g02ajf or nagf_correg_corrmat_h_weight.

## 3Description

g02ajf finds the nearest correlation matrix, $X$, to an approximate correlation matrix, $G$, using element-wise weighting, this minimizes ${‖H\circ \left(G-X\right)‖}_{F}$, where $C=A\circ B$ denotes the matrix $C$ with elements ${C}_{ij}={A}_{ij}×{B}_{ij}$.
You can optionally specify a lower bound on the eigenvalues, $\alpha$, of the computed correlation matrix, forcing the matrix to be strictly positive definite, if $0<\alpha <1$.
Zero elements in $H$ should be used when you wish to put no emphasis on the corresponding element of $G$. The algorithm scales $H$ so that the maximum element is $1$. It is this scaled matrix that is used in computing the norm above and for the stopping criteria described in Section 7.
Note that if the elements in $H$ vary by several orders of magnitude from one another the algorithm may fail to converge.
Borsdorf R and Higham N J (2010) A preconditioned (Newton) algorithm for the nearest correlation matrix IMA Journal of Numerical Analysis 30(1) 94–107
Jiang K, Sun D and Toh K-C (2012) An inexact accelerated proximal gradient method for large scale linearly constrained convex SDP SIAM J. Optim. 22(3) 1042–1064
Qi H and Sun D (2006) A quadratically convergent Newton method for computing the nearest correlation matrix SIAM J. Matrix AnalAppl 29(2) 360–385

## 5Arguments

1: $\mathbf{g}\left({\mathbf{ldg}},*\right)$Real (Kind=nag_wp) array Input/Output
Note: the second dimension of the array g must be at least ${\mathbf{n}}$.
On entry: $G$, the initial matrix.
On exit: $G$ is overwritten.
2: $\mathbf{ldg}$Integer Input
On entry: the first dimension of the array g as declared in the (sub)program from which g02ajf is called.
Constraint: ${\mathbf{ldg}}\ge {\mathbf{n}}$.
3: $\mathbf{n}$Integer Input
On entry: the order of the matrix $G$.
Constraint: ${\mathbf{n}}>0$.
4: $\mathbf{alpha}$Real (Kind=nag_wp) Input
On entry: the value of $\alpha$.
If ${\mathbf{alpha}}<0.0$, $0.0$ is used.
Constraint: ${\mathbf{alpha}}<1.0$.
5: $\mathbf{h}\left({\mathbf{ldh}},*\right)$Real (Kind=nag_wp) array Input/Output
Note: the second dimension of the array h must be at least ${\mathbf{n}}$.
On entry: the matrix of weights $H$.
On exit: a symmetric matrix $\frac{1}{2}\left(H+{H}^{\mathrm{T}}\right)$ with its diagonal elements set to zero and the remaining elements scaled so that the maximum element is $1.0$.
Constraint: $\mathit{H}\left(\mathit{i},\mathit{j}\right)\ge 0.0$, for all $i$ and $j=1,2,\dots ,n$, $i\ne j$.
6: $\mathbf{ldh}$Integer Input
On entry: the first dimension of the array h as declared in the (sub)program from which g02ajf is called.
Constraint: ${\mathbf{ldh}}\ge {\mathbf{n}}$.
7: $\mathbf{errtol}$Real (Kind=nag_wp) Input
On entry: the termination tolerance for the iteration. If ${\mathbf{errtol}}\le 0.0$, is used. See Section 7 for further details.
8: $\mathbf{maxit}$Integer Input
On entry: specifies the maximum number of iterations to be used.
If ${\mathbf{maxit}}\le 0$, $200$ is used.
9: $\mathbf{x}\left({\mathbf{ldx}},*\right)$Real (Kind=nag_wp) array Output
Note: the second dimension of the array x must be at least ${\mathbf{n}}$.
On exit: contains the nearest correlation matrix.
10: $\mathbf{ldx}$Integer Input
On entry: the first dimension of the array x as declared in the (sub)program from which g02ajf is called.
Constraint: ${\mathbf{ldx}}\ge {\mathbf{n}}$.
11: $\mathbf{iter}$Integer Output
On exit: the number of iterations taken.
12: $\mathbf{norm}$Real (Kind=nag_wp) Output
On exit: the value of ${‖H\circ \left(G-X\right)‖}_{F}$ after the final iteration.
13: $\mathbf{ifail}$Integer Input/Output
On entry: ifail must be set to $0$, $-1$ or $1$ to set behaviour on detection of an error; these values have no effect when no error is detected.
A value of $0$ causes the printing of an error message and program execution will be halted; otherwise program execution continues. A value of $-1$ means that an error message is printed while a value of $1$ means that it is not.
If halting is not appropriate, the value $-1$ or $1$ is recommended. If message printing is undesirable, then the value $1$ is recommended. Otherwise, the value $0$ is recommended. When the value $-\mathbf{1}$ 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).

## 6Error Indicators and Warnings

If on entry ${\mathbf{ifail}}=0$ or $-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}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{n}}>0$.
${\mathbf{ifail}}=2$
On entry, ${\mathbf{ldg}}=⟨\mathit{\text{value}}⟩$ and ${\mathbf{n}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{ldg}}\ge {\mathbf{n}}$.
${\mathbf{ifail}}=3$
On entry, ${\mathbf{ldh}}=⟨\mathit{\text{value}}⟩$ and ${\mathbf{n}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{ldh}}\ge {\mathbf{n}}$.
${\mathbf{ifail}}=4$
On entry, ${\mathbf{ldx}}=⟨\mathit{\text{value}}⟩$ and ${\mathbf{n}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{ldx}}\ge {\mathbf{n}}$.
${\mathbf{ifail}}=5$
On entry, ${\mathbf{alpha}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{alpha}}<1.0$.
${\mathbf{ifail}}=6$
On entry, one or more of the off-diagonal elements of $H$ were negative.
${\mathbf{ifail}}=7$
Routine failed to converge in $⟨\mathit{\text{value}}⟩$ iterations.
Increase maxit or check the call to the routine.
${\mathbf{ifail}}=8$
Failure to solve intermediate eigenproblem. This should not occur. Please contact NAG with details of your call.
${\mathbf{ifail}}=-99$
An unexpected error has been triggered by this routine. Please contact NAG.
See Section 7 in the Introduction to the NAG Library FL Interface for further information.
${\mathbf{ifail}}=-399$
Your licence key may have expired or may not have been installed correctly.
See Section 8 in the Introduction to the NAG Library FL Interface for further information.
${\mathbf{ifail}}=-999$
Dynamic memory allocation failed.
See Section 9 in the Introduction to the NAG Library FL Interface for further information.

## 7Accuracy

The returned accuracy is controlled by errtol and limited by machine precision. If ${e}_{i}$ is the value of norm at the $i$th iteration, that is
 $ei = ‖H∘(G-X)‖F ,$
where $H$ has been scaled as described above, then the algorithm terminates when:
 $|ei-ei-1| 1+ max(ei,ei-1) ≤ errtol .$

## 8Parallelism and Performance

g02ajf is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.
g02ajf 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 routine. Please also consult the Users' Note for your implementation for any additional implementation-specific information.

## 9Further Comments

Arrays are internally allocated by g02ajf. The total size of these arrays is $15×{\mathbf{n}}+5×{\mathbf{n}}×{\mathbf{n}}+\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(2×{\mathbf{n}}×{\mathbf{n}}+6×{\mathbf{n}}+1,120+9×{\mathbf{n}}\right)$ real elements and $5×{\mathbf{n}}+3$ integer elements. All allocated memory is freed before return of g02ajf.

## 10Example

This example finds the nearest correlation matrix to:
 $G = ( 2 -1 0 0 -1 2 -1 0 0 -1 2 -1 0 0 -1 2 )$
weighted by:
 $H = ( 0.0 10.0 0.0 0.0 10.0 0.0 1.5 1.5 0.0 1.5 0.0 0.0 0.0 1.5 0.0 0.0 )$
with minimum eigenvalue $0.04$.

### 10.1Program Text

Program Text (g02ajfe.f90)

### 10.2Program Data

Program Data (g02ajfe.d)

### 10.3Program Results

Program Results (g02ajfe.r)