# NAG CL Interfaceg02asc (corrmat_​fixed)

## 1Purpose

g02asc computes the nearest correlation matrix, in the Frobenius norm, while fixing elements and optionally with bounds on the eigenvalues, to a given square input matrix.

## 2Specification

 #include
 void g02asc (double g[], Integer pdg, Integer n, double alpha, const Integer h[], Integer pdh, double errtol, Integer maxit, Integer m, double x[], Integer pdx, Integer *its, double *fnorm, NagError *fail)
The function may be called by the names: g02asc or nag_correg_corrmat_fixed.

## 3Description

g02asc finds the nearest correlation matrix, $X$, to a matrix, $G$, in the Frobenius norm. It uses an alternating projections algorithm with Anderson acceleration. Elements in the input matrix can be fixed by supplying the value $1$ in the corresponding element of the matrix $H$. However, note that the algorithm may fail to converge if the fixed elements do not form part of a valid correlation matrix. You can optionally specify a lower bound, $\alpha$, on the eigenvalues of the computed correlation matrix, forcing the matrix to be positive definite with $0\le \alpha <1$.

## 4References

Anderson D G (1965) Iterative Procedures for Nonlinear Integral Equations J. Assoc. Comput. Mach. 12 547–560
Higham N J and Strabić N (2016) Anderson acceleration of the alternating projections method for computing the nearest correlation matrix Numer. Algor. 72 1021–1042

## 5Arguments

1: $\mathbf{g}\left[{\mathbf{pdg}}×{\mathbf{n}}\right]$double Input/Output
Note: the $\left(i,j\right)$th element of the matrix $G$ is stored in ${\mathbf{g}}\left[\left(j-1\right)×{\mathbf{pdg}}+i-1\right]$.
On entry: $\stackrel{~}{G}$, the initial matrix.
On exit: the symmetric matrix $G=\frac{1}{2}\left(\stackrel{~}{G}+{\stackrel{~}{G}}^{\mathrm{T}}\right)$ with the diagonal elements set to $1.0$.
2: $\mathbf{pdg}$Integer Input
On entry: the stride separating matrix row elements in the array g.
Constraint: ${\mathbf{pdg}}\ge {\mathbf{n}}$.
3: $\mathbf{n}$Integer Input
On entry: the order of the matrix $G$.
Constraint: ${\mathbf{n}}>0$.
4: $\mathbf{alpha}$double Input
On entry: the value of $\alpha$.
If ${\mathbf{alpha}}<0.0$, a value of $0.0$ is used.
Constraint: ${\mathbf{alpha}}<1.0$.
5: $\mathbf{h}\left[{\mathbf{pdh}}×{\mathbf{n}}\right]$const Integer Input
Note: the $\left(i,j\right)$th element of the matrix $H$ is stored in ${\mathbf{h}}\left[\left(j-1\right)×{\mathbf{pdh}}+i-1\right]$.
On entry: the symmetric matrix $H$. If an element of $H$ is $1$ then the corresponding element in $G$ is fixed in the output $X$. Only the strictly lower triangular part of $H$ need be set.
6: $\mathbf{pdh}$Integer Input
On entry: the stride separating matrix row elements in the array h.
Constraint: ${\mathbf{pdh}}\ge {\mathbf{n}}$.
7: $\mathbf{errtol}$double 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.
If ${\mathbf{maxit}}\le 0$, a value of $200$ is used.
9: $\mathbf{m}$Integer Input
On entry: the number of previous iterates to use in the Anderson acceleration. If ${\mathbf{m}}=0$, Anderson acceleration is not used. See Section 7 for further details.
If ${\mathbf{m}}<0$, a value of $4$ is used.
Constraint: ${\mathbf{m}}\le {\mathbf{n}}×{\mathbf{n}}$.
10: $\mathbf{x}\left[{\mathbf{pdx}}×{\mathbf{n}}\right]$double Output
Note: the $\left(i,j\right)$th element of the matrix $X$ is stored in ${\mathbf{x}}\left[\left(j-1\right)×{\mathbf{pdx}}+i-1\right]$.
On exit: contains the matrix $X$.
11: $\mathbf{pdx}$Integer Input
On entry: the stride separating matrix row elements in the array x.
Constraint: ${\mathbf{pdx}}\ge {\mathbf{n}}$.
12: $\mathbf{its}$Integer * Output
On exit: the number of iterations taken.
13: $\mathbf{fnorm}$double * Output
On exit: the value of ${‖G-X‖}_{F}$ after the final iteration.
14: $\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_ALG_FAIL
Failure during Anderson acceleration.
Consider setting ${\mathbf{m}}=0$ and recomputing.
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_CONVERGENCE
Function failed to converge in $〈\mathit{\text{value}}〉$ iterations.
A solution may not exist, however, try increasing maxit.
NE_INT
On entry, ${\mathbf{n}}=〈\mathit{\text{value}}〉$.
Constraint: ${\mathbf{n}}>0$.
NE_INT_2
On entry, ${\mathbf{m}}=〈\mathit{\text{value}}〉$ and ${\mathbf{n}}=〈\mathit{\text{value}}〉$.
Constraint: ${\mathbf{m}}\le {\mathbf{n}}×{\mathbf{n}}$.
On entry, ${\mathbf{pdg}}=〈\mathit{\text{value}}〉$ and ${\mathbf{n}}=〈\mathit{\text{value}}〉$.
Constraint: ${\mathbf{pdg}}\ge {\mathbf{n}}$.
On entry, ${\mathbf{pdh}}=〈\mathit{\text{value}}〉$ and ${\mathbf{n}}=〈\mathit{\text{value}}〉$.
Constraint: ${\mathbf{pdh}}\ge {\mathbf{n}}$.
On entry, ${\mathbf{pdx}}=〈\mathit{\text{value}}〉$ and ${\mathbf{n}}=〈\mathit{\text{value}}〉$.
Constraint: ${\mathbf{pdx}}\ge {\mathbf{n}}$.
The fixed element ${G}_{ij}$, lies outside the interval $\left[-1,1\right]$, for $i=〈\mathit{\text{value}}〉$ and $j=〈\mathit{\text{value}}〉$.
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_REAL
On entry, ${\mathbf{alpha}}=〈\mathit{\text{value}}〉$.
Constraint: ${\mathbf{alpha}}<1.0$.

## 7Accuracy

Alternating projections is an iterative process where at each iteration the new iterate, ${X}_{k}$, can be improved by using Anderson acceleration to reduce the overall number of iterations. The alternating projections algorithm terminates at the $k$th iteration when
 $Xk - Yk F Xk F ≤ errtol$
where ${Y}_{k}$ is the result of the first of two projections computed at each step.
Without Anderson acceleration this algorithm is guaranteed to converge. There is no theoretical guarantee of convergence of Anderson acceleration and therefore, when it is used, no guarantee of convergence of g02asc. However, in practice it can be seen to significantly reduce the number of alternating projection iterations. Anderson acceleration is not used when m is set to zero. See c05mdc and Higham and Strabić (2016) and Anderson (1965) for further information.

## 8Parallelism and Performance

g02asc is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.
g02asc 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.

Arrays are internally allocated by g02asc. The total size of these arrays does not exceed $12×{n}^{2}$ real elements. All allocated memory is freed before return of g02asc.

## 10Example

This example finds the nearest correlation matrix, $X$, to the input, $G$, whilst fixing two diagonal blocks as given by $H$. The minimum eigenvalue of $X$ is stipulated to be $0.04$.
 $G = 1.0000 -0.0991 0.5665 -0.5653 -0.3441 -0.0991 1.0000 -0.4273 0.8474 0.4975 0.5665 -0.4273 1.0000 -0.1837 -0.0585 -0.5653 0.8474 -0.1837 1.0000 -0.2713 -0.3441 0.4975 -0.0585 -0.2713 1.0000$
and
 $H = 1 1 0 0 0 1 1 0 0 0 0 0 1 0 0 0 0 0 1 1 0 0 0 1 1 .$
Only the strictly lower half of $H$ is supplied in the example.

### 10.1Program Text

Program Text (g02asce.c)

### 10.2Program Data

Program Data (g02asce.d)

### 10.3Program Results

Program Results (g02asce.r)