# NAG CL Interfacef11gdc (real_​symm_​basic_​setup)

Settings help

CL Name Style:

## 1Purpose

f11gdc is a setup function, the first in a suite of three functions for the iterative solution of a symmetric system of simultaneous linear equations. f11gdc must be called before the iterative solver, f11gec. The third function in the suite, f11gfc, can be used to return additional information about the computation.
These three functions are suitable for the solution of large sparse symmetric systems of equations.

## 2Specification

 #include
 void f11gdc (Nag_SparseSym_Method method, Nag_SparseSym_PrecType precon, Nag_SparseSym_Bisection sigcmp, Nag_NormType norm, Nag_SparseSym_Weight weight, Integer iterm, Integer n, double tol, Integer maxitn, double anorm, double sigmax, double sigtol, Integer maxits, Integer monit, Integer *lwreq, double work[], Integer lwork, NagError *fail)
The function may be called by the names: f11gdc, nag_sparse_real_symm_basic_setup or nag_sparse_sym_basic_setup.

## 3Description

The suite consisting of the functions f11gdc, f11gec and f11gfc is designed to solve the symmetric system of simultaneous linear equations $Ax=b$ of order $n$, where $n$ is large and the matrix of the coefficients $A$ is sparse.
f11gdc is a setup function which must be called before f11gec, the iterative solver. The third function in the suite, f11gfc can be used to return additional information about the computation. One of the following methods can be used:
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. 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.
3. 3.Minimum Residual Method (MINRES)
This method may be used when the matrix is indefinite. It seeks to reduce the norm of the residual at each iteration and often takes fewer iterations than the other methods. It does however require slightly more memory.
The CG and SYMMLQ methods start from the residual ${r}_{0}=b-A{x}_{0}$, where ${x}_{0}$ is an initial estimate for the solution (often ${x}_{0}=0$), and generate an orthogonal basis for the Krylov subspace $\mathrm{span}\left\{{A}^{\mathit{k}}{r}_{0}\right\}$, for $\mathit{k}=0,1,\dots$, by means of three-term recurrence relations (see Golub and Van Loan (1996)). A sequence of symmetric tridiagonal matrices $\left\{{T}_{k}\right\}$ is also generated. Here and in the following, the index $k$ denotes the iteration count. The resulting symmetric tridiagonal systems of equations are usually more easily solved than the original problem. A sequence of solution iterates $\left\{{x}_{k}\right\}$ is thus generated such that the sequence of the norms of the residuals $\left\{‖{r}_{k}‖\right\}$ 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 symmetric tridiagonal form, ${T}_{n}={Q}^{\mathrm{T}}AQ$; the solution ${x}_{n}$ 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 Conjugate Gradient and Lanczos methods lies in the method of solution of the resulting symmetric tridiagonal systems of equations: the conjugate gradient method is equivalent to carrying out an $LD{L}^{\mathrm{T}}$ (Cholesky) factorization whereas the Lanczos method (SYMMLQ) uses an $LQ$ factorization.
Faster convergence for all the methods 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 $\mathrm{span}\left\{{\overline{A}}^{\mathit{k}}{\overline{r}}_{0}\right\}$, for $\mathit{k}=0,1,\dots$, 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 symmetric and positive definite, i.e., representable by $M=E{E}^{\mathrm{T}}$, where $M$ is nonsingular, and such that $\overline{A}={E}^{-1}A{E}^{-\mathrm{T}}\sim {I}_{n}$ in (1), where ${I}_{n}$ is the identity matrix of order $n$. Also, we can define $\overline{r}={E}^{-1}r$ and $\overline{x}={E}^{\mathrm{T}}x$. 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
 $‖rk‖p ≤ τ ( ‖b‖p + ‖A‖p ×‖xk‖p)$ (2)
is available for both conjugate gradient and Lanczos (SYMMLQ) methods. In (2), $p=1,\infty$ or $2$ and $\tau$ denotes a user-specified tolerance subject to $\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(10,\sqrt{n}\right)\epsilon \le \tau <1$, where $\epsilon$ is the machine precision. Facilities are provided for the estimation of the norm of the matrix of the coefficients ${‖A‖}_{1}={‖A‖}_{\infty }$, when this is not known in advance, used in (2), by applying Higham's method (see Higham (1988)). Note that ${‖A‖}_{2}$ 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 $\kappa \left(A\right)$ which is not easily obtainable.
The second termination criterion
 $‖r¯k‖2 ≤ τ max(1.0, ‖b‖2 / ‖r0‖2 ) ( ‖r¯0‖2 + σ1 (A¯) ×‖Δx¯k‖2)$ (3)
is available only for the Lanczos method (SYMMLQ). In (3), ${\sigma }_{1}\left(\overline{A}\right)={‖\overline{A}‖}_{2}$ is the largest singular value of the (preconditioned) iteration matrix $\overline{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 ${\sigma }_{1}\left(\overline{A}\right)$ is not supplied, facilities are provided for its estimation by ${\sigma }_{1}\left(\overline{A}\right)\sim \underset{k}{\mathrm{max}}\phantom{\rule{0.25em}{0ex}}{\sigma }_{1}\left({T}_{k}\right)$. The interlacing property ${\sigma }_{1}\left({T}_{k-1}\right)\le {\sigma }_{1}\left({T}_{k}\right)$ and Gerschgorin's theorem provide lower and upper bounds from which ${\sigma }_{1}\left({T}_{k}\right)$ can be easily computed by bisection. Alternatively, the less expensive estimate ${\sigma }_{1}\left(\overline{A}\right)\sim \underset{k}{\mathrm{max}}\phantom{\rule{0.25em}{0ex}}{‖{T}_{k}‖}_{1}$ can be used, where ${\sigma }_{1}\left(\overline{A}\right)\le {‖{T}_{k}‖}_{1}$ 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 $‖{x}_{0}‖\gg ‖x‖$, 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., ${{‖v‖}_{p}}^{\left(w\right)}={‖{v}^{\left(w\right)}‖}_{p}$, where ${\left({v}^{\left(w\right)}\right)}_{\mathit{i}}={w}_{\mathit{i}}{v}_{\mathit{i}}$, for $\mathit{i}=1,2,\dots ,n$. Note that the use of weights increases the computational costs.
The MINRES algorithm terminates when the norm of the residual of the preconditioned system $F$, ${‖F‖}_{2}\le \tau ×{‖\overline{A}‖}_{2}×{‖{x}_{k}‖}_{2}$, where $\overline{A}$ is the preconditioned matrix.
The termination criteria discussed are not robust in the presence of a non-trivial nullspace of $A$, i.e., when $A$ is singular. It is then possible for ${‖{x}_{k}‖}_{p}$ to grow without limit, spuriously satisfying the termination criterion. If singularity is suspected, more robust functions can be found in Chapter E04.
The sequence of calls to the functions comprising the suite is enforced: first, the setup function f11gdc must be called, followed by the solver f11gec. The diagnostic function f11gfc can be called either when f11gec is carrying out a monitoring step or after f11gec 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

## 5Arguments

1: $\mathbf{method}$Nag_SparseSym_Method Input
On entry: the iterative method to be used.
${\mathbf{method}}=\mathrm{Nag_SparseSym_CG}$
${\mathbf{method}}=\mathrm{Nag_SparseSym_SYMMLQ}$
Lanczos method (SYMMLQ).
${\mathbf{method}}=\mathrm{Nag_SparseSym_MINRES}$
Minimum residual method (MINRES).
Constraint: ${\mathbf{method}}=\mathrm{Nag_SparseSym_CG}$, $\mathrm{Nag_SparseSym_SYMMLQ}$ or $\mathrm{Nag_SparseSym_MINRES}$.
2: $\mathbf{precon}$Nag_SparseSym_PrecType Input
On entry: determines whether preconditioning is used.
${\mathbf{precon}}=\mathrm{Nag_SparseSym_NoPrec}$
No preconditioning.
${\mathbf{precon}}=\mathrm{Nag_SparseSym_Prec}$
Preconditioning.
Constraint: ${\mathbf{precon}}=\mathrm{Nag_SparseSym_NoPrec}$ or $\mathrm{Nag_SparseSym_Prec}$.
3: $\mathbf{sigcmp}$Nag_SparseSym_Bisection Input
On entry: determines whether an estimate of ${\sigma }_{1}\left(\overline{A}\right)={‖{E}^{-1}A{E}^{-\mathrm{T}}‖}_{2}$, 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 $\left\{{T}_{k}\right\}$ generated during the iteration. Note that $\overline{A}=A$ when a preconditioner is not used.
If ${\mathbf{sigmax}}>0.0$ (see sigmax), i.e., when ${\sigma }_{1}\left(\overline{A}\right)$ is supplied, the value of sigcmp is ignored.
${\mathbf{sigcmp}}=\mathrm{Nag_SparseSym_Bisect}$
${\sigma }_{1}\left(\overline{A}\right)$ is to be computed using the bisection method.
${\mathbf{sigcmp}}=\mathrm{Nag_SparseSym_NoBisect}$
The bisection method is not used.
If the termination criterion (3) is used, requiring ${\sigma }_{1}\left(\overline{A}\right)$, an inexpensive estimate is computed and used (see Section 3).
It is not used if ${\mathbf{method}}=\mathrm{Nag_SparseSym_MINRES}$.
Suggested value: ${\mathbf{sigcmp}}=\mathrm{Nag_SparseSym_NoBisect}$.
Constraint: ${\mathbf{sigcmp}}=\mathrm{Nag_SparseSym_Bisect}$ or $\mathrm{Nag_SparseSym_NoBisect}$.
4: $\mathbf{norm}$Nag_NormType Input
On entry: if ${\mathbf{method}}=\mathrm{Nag_SparseSym_CG}$ or $\mathrm{Nag_SparseSym_SYMMLQ}$, norm defines the matrix and vector norm to be used in the termination criteria.
${\mathbf{norm}}=\mathrm{Nag_OneNorm}$
Use the ${l}_{1}$ norm.
${\mathbf{norm}}=\mathrm{Nag_InfNorm}$
Use the ${l}_{\infty }$ norm.
${\mathbf{norm}}=\mathrm{Nag_TwoNorm}$
Use the ${l}_{2}$ norm.
It has no effect if ${\mathbf{method}}=\mathrm{Nag_SparseSym_MINRES}$.
Suggested values:
• if ${\mathbf{iterm}}=1$, ${\mathbf{norm}}=\mathrm{Nag_InfNorm}$;
• if ${\mathbf{iterm}}=2$, ${\mathbf{norm}}=\mathrm{Nag_TwoNorm}$.
Constraints:
• if ${\mathbf{iterm}}=1$, ${\mathbf{norm}}=\mathrm{Nag_OneNorm}$, $\mathrm{Nag_InfNorm}$ or $\mathrm{Nag_TwoNorm}$;
• if ${\mathbf{iterm}}=2$, ${\mathbf{norm}}=\mathrm{Nag_TwoNorm}$.
5: $\mathbf{weight}$Nag_SparseSym_Weight 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) (${\mathbf{iterm}}=1$): ${{‖v‖}_{p}}^{\left(w\right)}={‖{v}^{\left(w\right)}‖}_{p}$, where ${v}_{\mathit{i}}^{\left(w\right)}={w}_{\mathit{i}}{v}_{\mathit{i}}$, for $\mathit{i}=1,2,\dots ,n$. The suffix $p=1,2,\infty$ denotes the vector norm used, as specified by the argument norm. Note that weights cannot be used when ${\mathbf{iterm}}=2$, i.e., when criterion (3) is used.
${\mathbf{weight}}=\mathrm{Nag_SparseSym_Weighted}$
User-supplied weights are to be used and must be supplied on initial entry to f11gec.
${\mathbf{weight}}=\mathrm{Nag_SparseSym_UnWeighted}$
All weights are implicitly set equal to one. Weights do not need to be supplied on initial entry to f11gec.
It has no effect if ${\mathbf{method}}=\mathrm{Nag_SparseSym_MINRES}$.
Suggested value: ${\mathbf{weight}}=\mathrm{Nag_SparseSym_UnWeighted}$.
Constraints:
• if ${\mathbf{iterm}}=1$, ${\mathbf{weight}}=\mathrm{Nag_SparseSym_Weighted}$ or $\mathrm{Nag_SparseSym_UnWeighted}$;
• if ${\mathbf{iterm}}=2$, ${\mathbf{weight}}=\mathrm{Nag_SparseSym_UnWeighted}$.
6: $\mathbf{iterm}$Integer Input
On entry: defines the termination criterion to be used.
${\mathbf{iterm}}=1$
Use the termination criterion defined in (2) (both conjugate gradient and Lanczos (SYMMLQ) methods).
${\mathbf{iterm}}=2$
Use the termination criterion defined in (3) (Lanczos method (SYMMLQ) only).
It has no effect if ${\mathbf{method}}=\mathrm{Nag_SparseSym_MINRES}$.
Suggested value: ${\mathbf{iterm}}=1$.
Constraints:
• if ${\mathbf{method}}=\mathrm{Nag_SparseSym_CG}$, ${\mathbf{iterm}}=1$;
• if ${\mathbf{method}}=\mathrm{Nag_SparseSym_SYMMLQ}$, ${\mathbf{iterm}}=1$ or $2$.
7: $\mathbf{n}$Integer Input
On entry: $n$, the order of the matrix $A$.
Constraint: ${\mathbf{n}}>0$.
8: $\mathbf{tol}$double Input
On entry: the tolerance $\tau$ for the termination criterion.
If ${\mathbf{tol}}\le 0.0$, $\tau =\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(\sqrt{\epsilon },\sqrt{n}\epsilon \right)$ is used, where $\epsilon$ is the machine precision.
Otherwise $\tau =\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left({\mathbf{tol}},10\epsilon ,\sqrt{n}\epsilon \right)$ is used.
Constraint: ${\mathbf{tol}}<1.0$.
9: $\mathbf{maxitn}$Integer Input
On entry: the maximum number of iterations.
Constraint: ${\mathbf{maxitn}}>0$.
10: $\mathbf{anorm}$double Input
On entry: if ${\mathbf{anorm}}>0.0$, the value of ${‖A‖}_{p}$ to be used in the termination criterion (2) (${\mathbf{iterm}}=1$).
If ${\mathbf{anorm}}\le 0.0$, ${\mathbf{iterm}}=1$ and ${\mathbf{norm}}=\mathrm{Nag_OneNorm}$ or $\mathrm{Nag_InfNorm}$, ${‖A‖}_{1}={‖A‖}_{\infty }$ is estimated internally by f11gec.
If ${\mathbf{iterm}}=2$, anorm is not referenced.
It has no effect if ${\mathbf{method}}=\mathrm{Nag_SparseSym_MINRES}$.
Constraint: if ${\mathbf{iterm}}=1$ and ${\mathbf{norm}}=\mathrm{Nag_TwoNorm}$, ${\mathbf{anorm}}>0.0$.
11: $\mathbf{sigmax}$double Input
On entry: if ${\mathbf{sigmax}}>0.0$, the value of ${\sigma }_{1}\left(\overline{A}\right)={‖{E}^{-1}A{E}^{-\mathrm{T}}‖}_{2}$.
If ${\mathbf{sigmax}}\le 0.0$, ${\sigma }_{1}\left(\overline{A}\right)$ is estimated by f11gec when either ${\mathbf{sigcmp}}=\mathrm{Nag_SparseSym_Bisect}$ or termination criterion (3) (${\mathbf{iterm}}=2$) is employed, though it will be used only in the latter case.
Otherwise, or if ${\mathbf{method}}=\mathrm{Nag_SparseSym_MINRES}$, sigmax is not referenced.
12: $\mathbf{sigtol}$double Input
On entry: the tolerance used in assessing the convergence of the estimate of ${\sigma }_{1}\left(\overline{A}\right)={‖\overline{A}‖}_{2}$ when the bisection method is used.
If ${\mathbf{sigtol}}\le 0.0$, the default value ${\mathbf{sigtol}}=0.01$ is used. The actual value used is $\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left({\mathbf{sigtol}},\epsilon \right)$.
If ${\mathbf{sigcmp}}=\mathrm{Nag_SparseSym_NoBisect}$ or ${\mathbf{sigmax}}>0.0$, sigtol is not referenced.
It has no effect if ${\mathbf{method}}=\mathrm{Nag_SparseSym_MINRES}$.
Suggested value: ${\mathbf{sigtol}}=0.01$ should be sufficient in most cases.
Constraint: if ${\mathbf{sigcmp}}=\mathrm{Nag_SparseSym_Bisect}$ and ${\mathbf{sigmax}}\le 0.0$, ${\mathbf{sigtol}}<1.0$.
13: $\mathbf{maxits}$Integer Input
On entry: the maximum iteration number $k={\mathbf{maxits}}$ for which ${\sigma }_{1}\left({T}_{k}\right)$ is computed by bisection (see also Section 3). If ${\mathbf{sigcmp}}=\mathrm{Nag_SparseSym_NoBisect}$ or ${\mathbf{sigmax}}>0.0$, or if ${\mathbf{method}}=\mathrm{Nag_SparseSym_MINRES}$, maxits is not referenced.
Suggested value: ${\mathbf{maxits}}=\mathrm{min}\phantom{\rule{0.125em}{0ex}}\left(10,n\right)$ when sigtol is of the order of its default value $\left(0.01\right)$.
Constraint: if ${\mathbf{sigcmp}}=\mathrm{Nag_SparseSym_Bisect}$ and ${\mathbf{sigmax}}\le 0.0$, $1\le {\mathbf{maxits}}\le {\mathbf{maxitn}}$.
14: $\mathbf{monit}$Integer Input
On entry: if ${\mathbf{monit}}>0$, the frequency at which a monitoring step is executed by f11gec: the current solution and residual iterates will be returned by f11gec and a call to f11gfc made possible every monit iterations, starting from the (monit)th. 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: ${\mathbf{monit}}\le {\mathbf{maxitn}}$.
15: $\mathbf{lwreq}$Integer * Output
On exit: the minimum amount of workspace required by f11gec. (See also Section 5 in f11gec.)
16: $\mathbf{work}\left[{\mathbf{lwork}}\right]$double Communication Array
On exit: the array work is initialized by f11gdc. It must not be modified before calling the next function in the suite, namely f11gec.
17: $\mathbf{lwork}$Integer Input
On entry: the dimension of the array work.
Constraint: ${\mathbf{lwork}}\ge 120$.
Note:  although the minimum value of lwork ensures the correct functioning of f11gdc, a larger value is required by the other functions in the suite, namely f11gec and f11gfc. The required value is as follows:
Method Requirements
CG ${\mathbf{lwork}}=120+5n+p$.
SYMMLQ ${\mathbf{lwork}}=120+6n+p$,
MINRES ${\mathbf{lwork}}=120+9n$,
where
• $p=2*\left({\mathbf{maxits}}+1\right)$, when an estimate of ${\sigma }_{1}\left(A\right)$ (sigmax) is computed;
• $p=0$, otherwise.
18: $\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_CONSTRAINT
On entry, ${\mathbf{iterm}}=1$, ${\mathbf{norm}}=\mathrm{Nag_TwoNorm}$ and ${\mathbf{anorm}}=⟨\mathit{\text{value}}⟩$.
Constraint: if ${\mathbf{iterm}}=1$ and ${\mathbf{norm}}=\mathrm{Nag_TwoNorm}$, ${\mathbf{anorm}}>0.0$.
On entry, ${\mathbf{sigcmp}}=\mathrm{Nag_SparseSym_Bisect}$, ${\mathbf{sigmax}}\le 0.0$ and ${\mathbf{maxits}}=⟨\mathit{\text{value}}⟩$.
Constraint: if ${\mathbf{sigcmp}}=\mathrm{Nag_SparseSym_Bisect}$ and ${\mathbf{sigmax}}\le 0.0$, ${\mathbf{maxits}}\ge 1$.
On entry, ${\mathbf{sigcmp}}=\mathrm{Nag_SparseSym_Bisect}$, ${\mathbf{sigmax}}\le 0.0$, ${\mathbf{maxits}}=⟨\mathit{\text{value}}⟩$ and ${\mathbf{maxitn}}=⟨\mathit{\text{value}}⟩$.
Constraint: if ${\mathbf{sigcmp}}=\mathrm{Nag_SparseSym_Bisect}$ and ${\mathbf{sigmax}}\le 0.0$, ${\mathbf{maxits}}\le {\mathbf{maxitn}}$.
NE_ENUM_INT
On entry, ${\mathbf{method}}=⟨\mathit{\text{value}}⟩$, ${\mathbf{weight}}=⟨\mathit{\text{value}}⟩$, ${\mathbf{norm}}=⟨\mathit{\text{value}}⟩$ and ${\mathbf{iterm}}=⟨\mathit{\text{value}}⟩$.
Constraint: if ${\mathbf{method}}=\mathrm{Nag_SparseSym_CG}$ or ${\mathbf{weight}}=\mathrm{Nag_SparseSym_Weighted}$ or ${\mathbf{norm}}\ne \mathrm{Nag_TwoNorm}$, ${\mathbf{iterm}}=1$. Otherwise, ${\mathbf{iterm}}=1$ or $2$.
NE_ENUM_REAL_2
On entry, ${\mathbf{sigcmp}}=\mathrm{Nag_SparseSym_Bisect}$, ${\mathbf{sigmax}}\le 0.0$ and ${\mathbf{sigtol}}=⟨\mathit{\text{value}}⟩$.
Constraint: if ${\mathbf{sigcmp}}=\mathrm{Nag_SparseSym_Bisect}$ and ${\mathbf{sigmax}}\le 0.0$, ${\mathbf{sigtol}}<1.0$.
NE_INT
On entry, ${\mathbf{lwork}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{lwork}}\ge 120$.
On entry, ${\mathbf{maxitn}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{maxitn}}>0$.
On entry, ${\mathbf{n}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{n}}>0$.
NE_INT_2
On entry, ${\mathbf{monit}}=⟨\mathit{\text{value}}⟩$ and ${\mathbf{maxitn}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{monit}}\le {\mathbf{maxitn}}$.
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_OUT_OF_SEQUENCE
f11gdc has been called out of sequence: either f11gdc has been called twice or f11gec has not terminated its current task.
NE_REAL
On entry, ${\mathbf{tol}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{tol}}<1.0$.

Not applicable.

## 8Parallelism and Performance

f11gdc is not threaded in any implementation.

When ${\sigma }_{1}\left(\overline{A}\right)$ is not supplied (${\mathbf{sigmax}}\le 0.0$) but it is required, it is estimated by f11gec using either of the two methods described in Section 3, as specified by the argument sigcmp. In particular, if ${\mathbf{sigcmp}}=\mathrm{Nag_SparseSym_Bisect}$, then the computation of ${\sigma }_{1}\left(\overline{A}\right)$ is deemed to have converged when the differences between three successive values of ${\sigma }_{1}\left({T}_{k}\right)$ 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 ${\sigma }_{1}\left(\overline{A}\right)$ is also terminated when the iteration count exceeds the maximum value allowed, i.e., $k\ge {\mathbf{maxits}}$.
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, ${\sigma }_{1}\left(\overline{A}\right)$ usually converges within very few iterations.

## 10Example

This example solves a symmetric 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 (f11jac and f11jbc).

### 10.1Program Text

Program Text (f11gdce.c)

### 10.2Program Data

Program Data (f11gdce.d)

### 10.3Program Results

Program Results (f11gdce.r)