NAG Library Routine Document

f11grf (complex_herm_basic_setup)


f11grf is a setup routine, the first in a suite of three routines for the iterative solution of a complex Hermitian system of simultaneous linear equations. f11grf must be called before f11gsf, the iterative solver. The third routine in the suite, f11gtf, can be used to return additional information about the computation.
These three routines are suitable for the solution of large sparse complex Hermitian systems of equations.


Fortran Interface
Integer, Intent (In):: iterm, n, maxitn, maxits, monit, lwork
Integer, Intent (Inout):: ifail
Integer, Intent (Out):: lwreq
Real (Kind=nag_wp), Intent (In):: tol, anorm, sigmax, sigtol
Complex (Kind=nag_wp), Intent (Out):: work(lwork)
Character (*), Intent (In):: method
Character (1), Intent (In):: precon, sigcmp, norm, weight
C Header Interface
#include <nagmk26.h>
void  f11grf_ (const char *method, const char *precon, const char *sigcmp, const char *norm, const char *weight, const Integer *iterm, const Integer *n, const double *tol, const Integer *maxitn, const double *anorm, const double *sigmax, const double *sigtol, const Integer *maxits, const Integer *monit, Integer *lwreq, Complex work[], const Integer *lwork, Integer *ifail, const Charlen length_method, const Charlen length_precon, const Charlen length_sigcmp, const Charlen length_norm, const Charlen length_weight)


The suite consisting of the routines f11grf, f11gsf and f11gtf is designed to solve the complex Hermitian system of simultaneous linear equations Ax=b of order n, where n is large and the matrix of the coefficients A is sparse.
f11grf is a setup routine which must be called before the iterative solver f11gsf. f11gtf, the third routine in the suite, can be used to return additional information about the computation. Either of two methods can be used:
1. Conjugate Gradient Method (CG)
For this method (see Hestenes and Stiefel (1952), Golub and Van Loan (1996), Barrett et al. (1994) and Dias da Cunha and Hopkins (1994)), the matrix A should ideally be positive definite. The application of the Conjugate Gradient method to indefinite matrices may lead to failure or to lack of convergence.
2. Lanczos Method (SYMMLQ)
This method, based upon the algorithm SYMMLQ (see Paige and Saunders (1975) and Barrett et al. (1994)), is suitable for both positive definite and indefinite matrices. It is more robust than the Conjugate Gradient method but less efficient when A is positive definite.
Both CG and SYMMLQ methods start from the residual r0=b-Ax0, where x0 is an initial estimate for the solution (often x0=0), and generate an orthogonal basis for the Krylov subspace spanAkr0, for k=0,1,, by means of three-term recurrence relations (see Golub and Van Loan (1996)). A sequence of real symmetric tridiagonal matrices Tk is also generated. Here and in the following, the index k denotes the iteration count. The resulting real symmetric tridiagonal systems of equations are usually more easily solved than the original problem. A sequence of solution iterates xk is thus generated such that the sequence of the norms of the residuals rk converges to a required tolerance. Note that, in general, the convergence is not monotonic.
In exact arithmetic, after n iterations, this process is equivalent to an orthogonal reduction of A to real symmetric tridiagonal form, Tn=QHAQ; the solution xn would thus achieve exact convergence. In finite-precision arithmetic, cancellation and round-off errors accumulate causing loss of orthogonality. These methods must therefore be viewed as genuinely iterative methods, able to converge to a solution within a prescribed tolerance.
The orthogonal basis is not formed explicitly in either method. The basic difference between the two methods lies in the method of solution of the resulting real symmetric tridiagonal systems of equations: the conjugate gradient method is equivalent to carrying out an LDLH (Cholesky) factorization whereas the Lanczos method (SYMMLQ) uses an LQ factorization.
Faster convergence can be achieved using a preconditioner (see Golub and Van Loan (1996) and Barrett et al. (1994)). A preconditioner maps the original system of equations onto a different system, say
A-x-=b-, (1)
with, hopefully, better characteristics with respect to its speed of convergence: for example, the condition number of the matrix of the coefficients can be improved or eigenvalues in its spectrum can be made to coalesce. An orthogonal basis for the Krylov subspace spanA-kr-0, for k=0,1,, is generated and the solution proceeds as outlined above. The algorithms used are such that the solution and residual iterates of the original system are produced, not their preconditioned counterparts. Note that an unsuitable preconditioner or no preconditioning at all may result in a very slow rate, or lack, of convergence. However, preconditioning involves a trade-off between the reduction in the number of iterations required for convergence and the additional computational costs per iteration. Also, setting up a preconditioner may involve non-negligible overheads.
A preconditioner must be Hermitian and positive definite, i.e., representable by M=EEH, where M is nonsingular, and such that A-=E-1AE-HIn in (1), where In is the identity matrix of order n. Also, we can define r-=E-1r and x-=EHx. These are formal definitions, used only in the design of the algorithms; in practice, only the means to compute the matrix-vector products v=Au and to solve the preconditioning equations Mv=u are required, that is, explicit information about M, E or their inverses is not required at any stage.
The first termination criterion
rkp τ bp + Ap × xkp (2)
is available for both conjugate gradient and Lanczos (SYMMLQ) methods. In (2), p=1, or 2 and τ denotes a user-specified tolerance subject to max10,nετ<1, where ε is the machine precision. Facilities are provided for the estimation of the norm of the matrix of the coefficients A1=A, when this is not known in advance, used in (2), by applying Higham's method (see Higham (1988)). Note that A2 cannot be estimated internally. This criterion uses an error bound derived from backward error analysis to ensure that the computed solution is the exact solution of a problem as close to the original as the termination tolerance requires. Termination criteria employing bounds derived from forward error analysis could be used, but any such criteria would require information about the condition number κA which is not easily obtainable.
The second termination criterion
r-k2 τ max1.0, b2 / r02 r-02 + σ1 A- × Δx-k2 (3)
is available only for the Lanczos method (SYMMLQ). In (3), σ1A-=A-2 is the largest singular value of the (preconditioned) iteration matrix A-. This termination criterion monitors the progress of the solution of the preconditioned system of equations and is less expensive to apply than criterion (2). When σ1A- is not supplied, facilities are provided for its estimation by σ1A-maxkσ1Tk. The interlacing property σ1Tk-1σ1Tk and Gerschgorin's theorem provide lower and upper bounds from which σ1Tk can be easily computed by bisection. Alternatively, the less expensive estimate σ1A-maxkTk1 can be used, where σ1A-Tk1 by Gerschgorin's theorem. Note that only order of magnitude estimates are required by the termination criterion.
Termination criterion (2) is the recommended choice, despite its (small) additional costs per iteration when using the Lanczos method (SYMMLQ). Also, if the norm of the initial estimate is much larger than the norm of the solution, that is, if x0x, a dramatic loss of significant digits could result in complete lack of convergence. The use of criterion (2) will enable the detection of such a situation, and the iteration will be restarted at a suitable point. No such restart facilities are provided for criterion (3).
Optionally, a vector w of user-specified weights can be used in the computation of the vector norms in termination criterion (2), i.e., vpw=v w p, where v w i=wi vi, for i=1,2,,n. Note that the use of weights increases the computational costs.
The sequence of calls to the routines comprising the suite is enforced: first, the setup routine f11grf must be called, followed by the solver f11gsf. f11gtf can be called either when f11gsf is carrying out a monitoring step or after f11gsf has completed its tasks. Incorrect sequencing will raise an error condition.


Barrett R, Berry M, Chan T F, Demmel J, Donato J, Dongarra J, Eijkhout V, Pozo R, Romine C and Van der Vorst H (1994) Templates for the Solution of Linear Systems: Building Blocks for Iterative Methods SIAM, Philadelphia
Dias da Cunha R and Hopkins T (1994) PIM 1.1 — the parallel iterative method package for systems of linear equations user's guide — Fortran 77 version Technical Report Computing Laboratory, University of Kent at Canterbury, Kent, UK
Golub G H and Van Loan C F (1996) Matrix Computations (3rd Edition) Johns Hopkins University Press, Baltimore
Hestenes M and Stiefel E (1952) Methods of conjugate gradients for solving linear systems J. Res. Nat. Bur. Stand. 49 409–436
Higham N J (1988) FORTRAN codes for estimating the one-norm of a real or complex matrix, with applications to condition estimation ACM Trans. Math. Software 14 381–396
Paige C C and Saunders M A (1975) Solution of sparse indefinite systems of linear equations SIAM J. Numer. Anal. 12 617–629


1:     method – Character(*)Input
On entry: the iterative method to be used.
Conjugate gradient method.
Lanczos method (SYMMLQ).
Constraint: method='CG' or 'SYMMLQ'.
2:     precon – Character(1)Input
On entry: determines whether preconditioning is used.
No preconditioning.
Constraint: precon='N' or 'P'.
3:     sigcmp – Character(1)Input
On entry: determines whether an estimate of σ1A-=E-1AE-H2, the largest singular value of the preconditioned matrix of the coefficients, is to be computed using the bisection method on the sequence of tridiagonal matrices Tk generated during the iteration. Note that A-=A when a preconditioner is not used.
If sigmax>0.0 (see below), i.e., when σ1A- is supplied, the value of sigcmp is ignored.
σ1A- is to be computed using the bisection method.
The bisection method is not used.
If the termination criterion (3) is used, requiring σ1A-, an inexpensive estimate is computed and used (see Section 3).
Suggested value: sigcmp='N'.
Constraint: sigcmp='S' or 'N'.
4:     norm – Character(1)Input
On entry: defines the matrix and vector norm to be used in the termination criteria.
Use the l1 norm.
Use the l norm.
Use the l2 norm.
Suggested values:
  • if iterm=1, norm='I';
  • if iterm=2, norm='2'.
  • if iterm=1, norm='1', 'I' or '2';
  • if iterm=2, norm='2'.
5:     weight – Character(1)Input
On entry: specifies whether a vector w of user-supplied weights is to be used in the vector norms used in the computation of termination criterion (2) (iterm=1): vpw=v w p, where vi w =wi vi, for i=1,2,,n. The suffix p=1,2, denotes the vector norm used, as specified by the argument norm. Note that weights cannot be used when iterm=2, i.e., when criterion (3) is used.
User-supplied weights are to be used and must be supplied on initial entry to f11gsf.
All weights are implicitly set equal to one. Weights do not need to be supplied on initial entry to f11gsf.
Suggested value: weight='N'.
  • if iterm=1, weight='W' or 'N';
  • if iterm=2, weight='N'.
6:     iterm – IntegerInput
On entry: defines the termination criterion to be used.
Use the termination criterion defined in (2) (both conjugate gradient and Lanczos (SYMMLQ) methods).
Use the termination criterion defined in (3) (Lanczos method (SYMMLQ) only).
Suggested value: iterm=1.
  • if method='CG', iterm=1;
  • if method='SYMMLQ', iterm=1 or 2.
7:     n – IntegerInput
On entry: n, the order of the matrix A.
Constraint: n>0.
8:     tol – Real (Kind=nag_wp)Input
On entry: the tolerance τ for the termination criterion.
If tol0.0, τ=maxε,nε is used, where ε is the machine precision.
Otherwise τ=maxtol,10ε,nε is used.
Constraint: tol<1.0.
9:     maxitn – IntegerInput
On entry: the maximum number of iterations.
Constraint: maxitn>0.
10:   anorm – Real (Kind=nag_wp)Input
On entry: if anorm>0.0, the value of Ap to be used in the termination criterion (2) (iterm=1).
If anorm0.0, iterm=1 and norm='1' or 'I', A1=A is estimated internally by f11gsf.
If iterm=2, anorm is not referenced.
Constraint: if iterm=1 and norm=2, anorm>0.0.
11:   sigmax – Real (Kind=nag_wp)Input
On entry: if sigmax>0.0, the value of σ1A-=E-1AE-H2.
If sigmax0.0, σ1A- is estimated by f11gsf when either sigcmp='S' or termination criterion (3) (iterm=2) is employed, though it will be used only in the latter case.
Otherwise, sigmax is not referenced.
12:   sigtol – Real (Kind=nag_wp)Input
On entry: the tolerance used in assessing the convergence of the estimate of σ1A-=A-2 when the bisection method is used.
If sigtol0.0, the default value sigtol=0.01 is used. The actual value used is maxsigtol,ε.
If sigcmp='N' or sigmax>0.0, sigtol is not referenced.
Suggested value: sigtol=0.01 should be sufficient in most cases.
Constraint: if sigcmp='S' and sigmax0.0, sigtol<1.0.
13:   maxits – IntegerInput
On entry: the maximum iteration number k=maxits for which σ1Tk is computed by bisection (see also Section 3). If sigcmp='N' or sigmax>0.0, maxits is not referenced.
Suggested value: maxits=min10,n when sigtol is of the order of its default value 0.01.
Constraint: if sigcmp='S' and sigmax0.0, 1maxitsmaxitn.
14:   monit – IntegerInput
On entry: if monit>0, the frequency at which a monitoring step is executed by f11gsf: the current solution and residual iterates will be returned by f11gsf and a call to f11gtf made possible every monit iterations, starting from iteration number monit. Otherwise, no monitoring takes place. There are some additional computational costs involved in monitoring the solution and residual vectors when the Lanczos method (SYMMLQ) is used.
Constraint: monitmaxitn.
15:   lwreq – IntegerOutput
On exit: the minimum amount of workspace required by f11gsf. (See also Section 5 in f11gsf.)
16:   worklwork – Complex (Kind=nag_wp) arrayCommunication Array
On exit: the array work is initialized by f11grf. It must not be modified before calling the next routine in the suite, namely f11gsf.
17:   lwork – IntegerInput
On entry: the dimension of the array work as declared in the (sub)program from which f11grf is called.
Constraint: lwork120.
Note:  although the minimum value of lwork ensures the correct functioning of f11grf, a larger value is required by the other routines in the suite, namely f11gsf and f11gtf. The required value is as follows:
Method Requirements
CG lwork=120+5n+p
SYMMLQ lwork=120+6n+p
  • p=2×maxits+1, when an estimate of σ1A (sigmax) is computed;
  • p=0, otherwise.
18:   ifail – IntegerInput/Output
On entry: ifail must be set to 0, -1 or 1. If you are unfamiliar with this argument you should refer to Section 3.4 in How to Use the NAG Library and its Documentation for details.
For environments where it might be inappropriate to halt program execution when an error is detected, the value -1 or 1 is recommended. If the output of error messages is undesirable, then the value 1 is recommended. Otherwise, if you are not familiar with this argument, the recommended value is 0. 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).

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:
f11grf has been called out of sequence: either f11grf has been called twice or f11gsf has not terminated its current task.
On entry, method=value.
Constraint: method='CG' or 'SYMMLQ'.
On entry, precon=value.
Constraint: precon='N' or 'P'.
On entry, sigcmp=value.
Constraint: sigcmp='N' or 'S'.
On entry, norm=value.
Constraint: norm='1', 'I' or '2'.
On entry, iterm=value and weight=value.
Constraint: if iterm=2, weight='N'.
On entry, weight=value.
Constraint: weight='N' or 'W'.
On entry, iterm=value.
Constraint: iterm=1 or 2.
On entry, iterm=value and method=value.
Constraint: if iterm=2, method='SYMMLQ'.
On entry, iterm=value and norm=value.
Constraint: if iterm=2, norm='2' or 'I'.
On entry, n=value.
Constraint: n>0.
On entry, tol=value.
Constraint: tol<1.0.
On entry, maxitn=value.
Constraint: maxitn>0.
On entry, norm=value, iterm=value, and anorm=value.
Constraint: if iterm=1 and norm='2' or 'I', anorm>0.0.
On entry, sigcmp=value, sigtol=value, and sigmax=value.
Constraint: if sigcmp='S' and sigmax0.0, sigtol<1.0.
On entry, maxits=value, maxitn=value, sigcmp=value, and sigmax=value.
Constraint: if sigcmp='S' and sigmax0.0, 1maxitsmaxitn.
On entry, monit=value and maxitn=value.
Constraint: monitmaxitn.
On entry, lwork=value.
Constraint: lwork120.
An unexpected error has been triggered by this routine. Please contact NAG.
See Section 3.9 in How to Use the NAG Library and its Documentation for further information.
Your licence key may have expired or may not have been installed correctly.
See Section 3.8 in How to Use the NAG Library and its Documentation for further information.
Dynamic memory allocation failed.
See Section 3.7 in How to Use the NAG Library and its Documentation for further information.


Not applicable.

Parallelism and Performance

f11grf is not threaded in any implementation.

Further Comments

When σ1A- is not supplied (sigmax0.0) but it is required, it is estimated by f11gsf using either of the two methods described in Section 3, as specified by the argument sigcmp. In particular, if sigcmp='S', then the computation of σ1A- is deemed to have converged when the differences between three successive values of σ1Tk differ, in a relative sense, by less than the tolerance sigtol, i.e., when
max σ 1 k - σ 1 k - 1 σ 1 k , σ 1 k - σ 1 k - 2 σ 1 k sigtol .  
The computation of σ1A- is also terminated when the iteration count exceeds the maximum value allowed, i.e., kmaxits.
Bisection is increasingly expensive with increasing iteration count. A reasonably large value of sigtol, of the order of the suggested value, is recommended and an excessive value of maxits should be avoided. Under these conditions, σ1A- usually converges within very few iterations.


This example solves a complex Hermitian system of simultaneous linear equations using the conjugate gradient method, where the matrix of the coefficients A, has a random sparsity pattern. An incomplete Cholesky preconditioner is used (f11jaf and f11jbf).

Program Text

Program Text (f11grfe.f90)

Program Data

Program Data (f11grfe.d)

Program Results

Program Results (f11grfe.r)