# NAG Library Routine Document

## 1Purpose

f02gcf computes selected eigenvalues and eigenvectors of a complex general matrix.

## 2Specification

Fortran Interface
 Subroutine f02gcf ( crit, n, a, lda, wl, wu, mest, m, w, v, ldv, work,
 Integer, Intent (In) :: n, lda, mest, ldv, lwork Integer, Intent (Inout) :: ifail Integer, Intent (Out) :: m, iwork(n) Real (Kind=nag_wp), Intent (In) :: wl, wu Real (Kind=nag_wp), Intent (Out) :: rwork(2*n) Complex (Kind=nag_wp), Intent (Inout) :: a(lda,*), v(ldv,mest) Complex (Kind=nag_wp), Intent (Out) :: w(n), work(lwork) Logical, Intent (Out) :: bwork(n) Character (1), Intent (In) :: crit
#include <nagmk26.h>
 void f02gcf_ (const char *crit, const Integer *n, Complex a[], const Integer *lda, const double *wl, const double *wu, const Integer *mest, Integer *m, Complex w[], Complex v[], const Integer *ldv, Complex work[], const Integer *lwork, double rwork[], Integer iwork[], logical bwork[], Integer *ifail, const Charlen length_crit)

## 3Description

f02gcf computes selected eigenvalues and the corresponding right eigenvectors of a complex general matrix $A$:
 $Axi=λixi.$
Eigenvalues ${\lambda }_{i}$ may be selected either by modulus, satisfying
 $wl≤λi≤wu,$
or by real part, satisfying
 $wl≤Reλi≤wu.$

## 4References

Golub G H and Van Loan C F (1996) Matrix Computations (3rd Edition) Johns Hopkins University Press, Baltimore

## 5Arguments

1:     $\mathbf{crit}$ – Character(1)Input
On entry: indicates the criterion for selecting eigenvalues.
${\mathbf{crit}}=\text{'M'}$
Eigenvalues are selected according to their moduli: ${w}_{l}\le \left|{\lambda }_{i}\right|\le {w}_{u}$.
${\mathbf{crit}}=\text{'R'}$
Eigenvalues are selected according to their real parts: ${w}_{l}\le \mathrm{Re}\left({\lambda }_{i}\right)\le {w}_{u}$.
Constraint: ${\mathbf{crit}}=\text{'M'}$ or $\text{'R'}$.
2:     $\mathbf{n}$ – IntegerInput
On entry: $n$, the order of the matrix $A$.
Constraint: ${\mathbf{n}}\ge 0$.
3:     $\mathbf{a}\left({\mathbf{lda}},*\right)$ – Complex (Kind=nag_wp) arrayInput/Output
Note: the second dimension of the array a must be at least $\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{n}}\right)$.
On entry: the $n$ by $n$ general matrix $A$.
On exit: contains the Hessenberg form of the balanced input matrix ${A}^{\prime }$ (see Section 9).
4:     $\mathbf{lda}$ – IntegerInput
On entry: the first dimension of the array a as declared in the (sub)program from which f02gcf is called.
Constraint: ${\mathbf{lda}}\ge \mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{n}}\right)$.
5:     $\mathbf{wl}$ – Real (Kind=nag_wp)Input
6:     $\mathbf{wu}$ – Real (Kind=nag_wp)Input
On entry: ${w}_{l}$ and ${w}_{u}$, the lower and upper bounds on the criterion for the selected eigenvalues (see crit).
Constraint: ${\mathbf{wu}}>{\mathbf{wl}}$.
7:     $\mathbf{mest}$ – IntegerInput
On entry: the second dimension of the array v as declared in the (sub)program from which f02gcf is called. mest must be an upper bound on $m$, the number of eigenvalues and eigenvectors selected. No eigenvectors are computed if ${\mathbf{mest}}.
Constraint: ${\mathbf{mest}}\ge \mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,m\right)$.
8:     $\mathbf{m}$ – IntegerOutput
On exit: $m$, the number of eigenvalues actually selected.
9:     $\mathbf{w}\left({\mathbf{n}}\right)$ – Complex (Kind=nag_wp) arrayOutput
On exit: the first m elements of w hold the selected eigenvalues; elements ${\mathbf{m}}+1$ to n contain the other eigenvalues.
10:   $\mathbf{v}\left({\mathbf{ldv}},{\mathbf{mest}}\right)$ – Complex (Kind=nag_wp) arrayOutput
On exit: contains the selected eigenvectors, with the $i$th column holding the eigenvector associated with the eigenvalue ${\lambda }_{i}$ (stored in ${\mathbf{w}}\left(i\right)$).
11:   $\mathbf{ldv}$ – IntegerInput
On entry: the first dimension of the array v as declared in the (sub)program from which f02gcf is called.
Constraint: ${\mathbf{ldv}}\ge \mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{n}}\right)$.
12:   $\mathbf{work}\left({\mathbf{lwork}}\right)$ – Complex (Kind=nag_wp) arrayWorkspace
13:   $\mathbf{lwork}$ – IntegerInput
On entry: the dimension of the array work as declared in the (sub)program from which f02gcf is called.
Constraint: ${\mathbf{lwork}}\ge \mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{n}}×\left({\mathbf{n}}+2\right)\right)$.
14:   $\mathbf{rwork}\left(2×{\mathbf{n}}\right)$ – Real (Kind=nag_wp) arrayWorkspace
15:   $\mathbf{iwork}\left({\mathbf{n}}\right)$ – Integer arrayWorkspace
16:   $\mathbf{bwork}\left({\mathbf{n}}\right)$ – Logical arrayWorkspace
17:   $\mathbf{ifail}$ – IntegerInput/Output
On entry: ifail must be set to $0$, . 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  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  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{crit}}=〈\mathit{\text{value}}〉$.
Constraint: ${\mathbf{crit}}=\text{'M'}$ or $\text{'R'}$.
On entry, ${\mathbf{lda}}=〈\mathit{\text{value}}〉$ and ${\mathbf{n}}=〈\mathit{\text{value}}〉$.
Constraint: ${\mathbf{lda}}\ge \mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{n}}\right)$.
On entry, ${\mathbf{ldv}}=〈\mathit{\text{value}}〉$ and ${\mathbf{n}}=〈\mathit{\text{value}}〉$.
Constraint: ${\mathbf{ldv}}\ge \mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{n}}\right)$.
On entry, ${\mathbf{lwork}}=〈\mathit{\text{value}}〉$ and ${\mathbf{n}}=〈\mathit{\text{value}}〉$.
Constraint: ${\mathbf{lwork}}\ge \mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{n}}×\left({\mathbf{n}}+2\right)\right)$.
On entry, ${\mathbf{mest}}=〈\mathit{\text{value}}〉$.
Constraint: ${\mathbf{mest}}\ge 1$.
On entry, ${\mathbf{n}}=〈\mathit{\text{value}}〉$.
Constraint: ${\mathbf{n}}\ge 0$.
On entry, ${\mathbf{wu}}=〈\mathit{\text{value}}〉$ and ${\mathbf{wl}}=〈\mathit{\text{value}}〉$.
Constraint: ${\mathbf{wu}}>{\mathbf{wl}}$.
${\mathbf{ifail}}=2$
The $QR$ algorithm failed to converge: only $〈\mathit{\text{value}}〉$ eigenvalues have been computed; no eigenvectors have been computed.
${\mathbf{ifail}}=3$
There are more than mest eigenvalues in the specified range. m (number of eigenvalues in range) $\text{}=〈\mathit{\text{value}}〉$ and ${\mathbf{mest}}=〈\mathit{\text{value}}〉$. No eigenvectors have been computed. Rerun with second dimension of ${\mathbf{v}}={\mathbf{mest}}\ge {\mathbf{m}}$.
${\mathbf{ifail}}=4$
Inverse iteration failed to compute all the specified eigenvectors. The number of eigenvectors which failed to converge is $〈\mathit{\text{value}}〉$. The corresponding columns of v are set to zero.
${\mathbf{ifail}}=-99$
See Section 3.9 in How to Use the NAG Library and its Documentation for further information.
${\mathbf{ifail}}=-399$
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.
${\mathbf{ifail}}=-999$
Dynamic memory allocation failed.
See Section 3.7 in How to Use the NAG Library and its Documentation for further information.

## 7Accuracy

If ${\lambda }_{i}$ is an exact eigenvalue, and ${\stackrel{~}{\lambda }}_{i}$ is the corresponding computed value, then
 $λ~i - λi ≤ cnεA′2si,$
where $c\left(n\right)$ is a modestly increasing function of $n$, $\epsilon$ is the machine precision, and ${s}_{i}$ is the reciprocal condition number of ${\lambda }_{i}$; ${A}^{\prime }$ is the balanced form of the original matrix $A$ (see Section 9), and $‖{A}^{\prime }‖\le ‖A‖$.
If ${x}_{i}$ is the corresponding exact eigenvector, and ${\stackrel{~}{x}}_{i}$ is the corresponding computed eigenvector, then the angle $\theta \left({\stackrel{~}{x}}_{i},{x}_{i}\right)$ between them is bounded as follows:
 $θx~i,xi≤cnεA′2sepi$
where ${\mathit{sep}}_{i}$ is the reciprocal condition number of ${x}_{i}$.
The condition numbers ${s}_{i}$ and ${\mathit{sep}}_{i}$ may be computed from the Hessenberg form of the balanced matrix ${A}^{\prime }$ which is returned in the array a. This requires calling f08psf (zhseqr) with ${\mathbf{job}}=\text{'S'}$ to compute the Schur form of ${A}^{\prime }$, followed by f08qyf (ztrsna).

## 8Parallelism and Performance

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

f02gcf calls routines from LAPACK in Chapter F08. It first balances the matrix, using a diagonal similarity transformation to reduce its norm; and then reduces the balanced matrix ${A}^{\prime }$ to upper Hessenberg form $H$, using a unitary similarity transformation: ${A}^{\prime }=QH{Q}^{\mathrm{H}}$. The routine uses the Hessenberg $QR$ algorithm to compute all the eigenvalues of $H$, which are the same as the eigenvalues of $A$. It computes the eigenvectors of $H$ which correspond to the selected eigenvalues, using inverse iteration. It premultiplies the eigenvectors by $Q$ to form the eigenvectors of ${A}^{\prime }$; and finally transforms the eigenvectors to those of the original matrix $A$.
Each eigenvector $x$ is normalized so that ${‖x‖}_{2}=1$, and the element of largest absolute value is real.
The inverse iteration routine may make a small perturbation to the real parts of close eigenvalues, and this may shift their moduli just outside the specified bounds. If you are relying on eigenvalues being within the bounds, you should test them on return from f02gcf.
The time taken by the routine is approximately proportional to ${n}^{3}$.
The routine can be used to compute all eigenvalues and eigenvectors, by setting wl large and negative, and wu large and positive.

## 10Example

This example computes those eigenvalues of the matrix $A$ which lie in the range $\left[-5.5,+5.5\right]$, and their corresponding eigenvectors, where
 $A = -3.97-5.04i -4.11+3.70i -0.34+1.01i 1.29-0.86i 0.34-1.50i 1.52-0.43i 1.88-5.38i 3.36+0.65i 3.31-3.85i 2.50+3.45i 0.88-1.08i 0.64-1.48i -1.10+0.82i 1.81-1.59i 3.25+1.33i 1.57-3.44i .$

### 10.1Program Text

Program Text (f02gcfe.f90)

### 10.2Program Data

Program Data (f02gcfe.d)

### 10.3Program Results

Program Results (f02gcfe.r)