NAG FL Interface
g02akf (corrmat_​nearest_​rank)

Settings help

FL Name Style:

FL Specification Language:

1 Purpose

g02akf computes the nearest correlation matrix of maximum prescribed rank, in the Frobenius norm, to a given square, input matrix.

2 Specification

Fortran Interface
Subroutine g02akf ( g, ldg, n, rank, errtol, ranktol, maxits, maxit, x, ldx, f, rankerr, nsub, ifail)
Integer, Intent (In) :: ldg, n, rank, maxits, maxit, ldx
Integer, Intent (Inout) :: ifail
Integer, Intent (Out) :: nsub
Real (Kind=nag_wp), Intent (In) :: errtol, ranktol
Real (Kind=nag_wp), Intent (Inout) :: g(ldg,n), x(ldx,n)
Real (Kind=nag_wp), Intent (Out) :: f, rankerr
C Header Interface
#include <nag.h>
void  g02akf_ (double g[], const Integer *ldg, const Integer *n, const Integer *rank, const double *errtol, const double *ranktol, const Integer *maxits, const Integer *maxit, double x[], const Integer *ldx, double *f, double *rankerr, Integer *nsub, Integer *ifail)
The routine may be called by the names g02akf or nagf_correg_corrmat_nearest_rank.

3 Description

g02akf finds the nearest correlation matrix X of maximum prescribed rank r to an approximate correlation matrix G in the Frobenius norm.
The solver is based on the Majorized Penalty Approach (MPA) proposed by Gao and Sun (2010). One of the key elements in this type of method is that the subproblems are similar to the nearest correlation matrix problem without rank constraint, and can be solved efficiently by g02aaf. The total number of subproblems solved is controlled by the arguments maxit and maxits. The algorithm behaviour and solver accuracy can be modified by these and other input arguments. The default values for these arguments are chosen to work well in the general case but it is recommended that you tune them to your particular problem. For a detailed description of the algorithm see Section 11.

4 References

Bai S, Qi H–D and Xiu N (2015) Constrained best Euclidean distance embedding on a sphere: A matrix optimization approach SIAM J. Optim. 25(1) 439–467
Gao Y and Sun D (2010) A majorized penalty approach for calibrating rank constrained correlation matrix problems Technical report Department of Mathematics, National University of Singapore
Qi H–D and Yuan X (2014) Computing the nearest Euclidean distance matrix with low embedding dimensions Mathematical Programming 147(1–2) 351–389

5 Arguments

1: g(ldg,n) Real (Kind=nag_wp) array Input/Output
On entry: G~, the initial matrix.
On exit: a symmetric matrix G=12(G~+G~T) with diagonal elements set to 1.0.
2: ldg Integer Input
On entry: the first dimension of the array g as declared in the (sub)program from which g02akf is called.
Constraint: ldgn.
3: n Integer Input
On entry: the order of the matrix G.
Constraint: n>0.
4: rank Integer Input
On entry: r, the upper bound for the rank of X.
Constraint: 0<rankn.
5: errtol Real (Kind=nag_wp) Input
On entry: the termination tolerance for the convergence measure of the objective function value.
If errtol0.0, then a value of 1.0E−5 is used. See Section 11 for further details.
6: ranktol Real (Kind=nag_wp) Input
On entry: the feasibility tolerance for the rank constraint.
If ranktol0.0, machine precision is used. See Section 11 for further details.
7: maxits Integer Input
On entry: specifies the maximum number of iterations used for the majorization approach to solve penalized problems at each level of penalty parameter.
If maxits0, then a value of 100 is used.
8: maxit Integer Input
On entry: specifies the maximum number of iterations for the penalty method, i.e., the maximum level of penalty parameter.
If maxit0, then a value of 200 is used.
9: x(ldx,n) Real (Kind=nag_wp) array Output
On exit: X, the nearest correlation matrix of rank r.
10: ldx Integer Input
On entry: the first dimension of the array x as declared in the (sub)program from which g02akf is called.
Constraint: ldxn.
11: f Real (Kind=nag_wp) Output
On exit: the difference between X and G given by 12 X-G F 2 .
12: rankerr Real (Kind=nag_wp) Output
On exit: the rank error of X, defined as i=r+1 n (λi), given that λi denote eigenvalues of X sorted in non-increasing order.
13: nsub Integer Output
On exit: the total number of majorized problems that have been solved, i.e., the total number of calls for g02aaf.
14: 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 -1 or 1 is used it is essential to test the value of ifail on exit.
On exit: ifail=0 unless the routine detects an error or a warning has been flagged (see Section 6).

6 Error Indicators and Warnings

If on entry 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:
On entry, n=value.
Constraint: n>0.
On entry, ldg=value and n=value.
Constraint: ldgn.
On entry, ldx=value and n=value.
Constraint: ldxn.
On entry, rank=value and n=value.
Constraint: 0<rankn.
Majorized penalty approach fails to converge in maxit level of penalty iterations.
Convergence is limited by machine precision. The objective function value or rank is decreasing very slowly.
The array returned in x may still be of interest.
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.
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.
Dynamic memory allocation failed.
See Section 9 in the Introduction to the NAG Library FL Interface for further information.

7 Accuracy

The returned accuracy is controlled by errtol and ranktol, and is limited by machine precision.

8 Parallelism and Performance

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

9 Further Comments

Arrays are internally allocated by g02akf. The total size of these arrays is 11×n+3×n×n+max(2×n×n+6×n+1,120+9×n) real elements and 5×n+3 integer elements.

10 Example

This example finds the nearest correlation matrix with target rank 2 to:
G = ( 2 -1 0 0 -1 2 -1 0 0 -1 2 -1 0 0 -1 2 )  

10.1 Program Text

Program Text (g02akfe.f90)

10.2 Program Data

Program Data (g02akfe.d)

10.3 Program Results

Program Results (g02akfe.r)

11 Algorithmic Details

g02akf is aimed at solving the rank constrained nearest correlation matrix problem formulated as follows:
min X𝕊n 12 X-G 2 s.t. Xii =1 ,   i=1,,n, X0, rank(X)r, (1)
where G is the input approximate correlation matrix, r is the upper bound of rank of the output nearest correlation matrix X, the expression X0 stands for a constraint on eigenvalues of X in the space of n×n symmetric matrices 𝕊n, namely, all the eigenvalues should be non-negative, i.e., the matrix should be positive semidefinite, · denotes the Frobenius norm. Note that the rank constraint is given as an inequality, which means if the intrinsic rank of the input matrix is already less than or equal to r, the solver will calculate a nearest correlation matrix without increasing the rank.
This section contains a short description of the algorithm used in g02akf which is based on the Majorized Penalty Approach (MPA) by Gao and Sun (2010). Further details on accuracy and stopping criterion are also included.

11.1 Penalty approach

Let λ(X) be the vector of the eigenvalues of X (arranged in the non-increasing order) and Pn×n be the corresponding matrix of orthonormal eigenvectors of X. The equivalent relationship for a positive semidefinite matrix X is as follows.
Therefore, problem (1) can be equivalently written as
minX𝕊n f(X)12X-G2 s.t. Xii=1,  i=1,n, X0, λr+1(X)++λn(X)=0. (2)
Introducing the penalty parameter c>0, we can obtain the following penalized problem by taking a trade-off between the rank constraint and the least square distance f(X).
minX𝕊n f(X) + c(λr+1(X)++λn(X)) s.t. Xii=1,  i=1,,n, X0. (3)
p(X) i=r+1 n λi(X) = I,X - i=1 r λi(X),  
where I is the identity matrix, ·,· is the standard trace inner product in 𝕊n. We can rewrite problem (3) as
minX𝕊n f(X)+cp(X) s.t. Xii=1,  i=1,,n, X0. (4)
The penalty parameter c is updated according to the progress of rank reduction. The input argument maxit controls the maximum number of updates of c.
The penalized problem (4) is not equivalent to the original problem (1) and the relationship can be described as follows. If the rank of the minimizer Xc* to problem (4) is not larger than r, then Xc* is a global optimal solution to problem (1), otherwise an ε-optimal solution to problem (1) is guaranteed given that parameter c satisfies some bound constraint. Please see Gao and Sun (2010) for more details.

11.2 Majorization approach

The focus now is on solving the penalty problem (4). Since p(X) is nonsmooth and concave, we majorize it by the linear function defined by its subgradient. For given Xk (the current iteration) and Ukp(Xk), we have
p(X) mkp(X) p(Xk) + Uk,X-Xk X.  
Now, instead of solving the nonconvex problem (4), we solve the following convex model:
minX𝕊n f(X) + cmkp(X) s.t. Xii = 1 ,   i=1,,n, X0. (5)
The framework combines ideas of a penalty method with majorization, it can be described as follows:
Majorized Penalty Algorithm (MPA)
  1. 1.Select a penalty parameter c>0 and a feasible point X0, set k0.
  2. 2.Solve subproblem (5) to get Xk+1 = argminX { f(X)+ cmkp(X) | Xii=1, ​ i=1,,n, ​ X0 }.
  3. 3.If Xk+1=Xk, stop; otherwise, update penalty parameter c, set kk+1 and go to step 2.
Let G¯=G-cUk, the subproblem (5) is actually a nearest correlation matrix problem with input G¯ without rank constraint, which can be solved efficiently by g02aaf. Input maxits controls the maximum number of iterations used in solving one problem (5) with fixed c.
For the convergence result of the algorithm, see Gao and Sun (2010). For other implementations as well as parameter setting strategies, see Qi and Yuan (2014) and Bai et al. (2015).

11.3 Stopping criteria

The algorithm shown in Table 1 is stopped when all the stopping criteria are satisfied to the requested accuracy, these are:
2f(Xk)-2f(Xk-1) max{100, 2f(Xk-1) } ε1,   (relative precision)  
i=r+1 n λi(Xk) ε2.   (rank feasibility)  
Here ε1 and ε2 may be set by arguments errtol and ranktol respectively in order to achieve various returned accuracy. The above quantity to measure rank feasibility does not scale well with the magnitude of Xk. To rectify this drawback, we also build in the third stopping criterion to control the percentage of the first r eigenvalues of Xk out of all the eigenvalues:
i=1 r λi(Xk) / i=1 n λi(Xk) 90% .