Integer type:  int32  int64  nag_int  show int32  show int32  show int64  show int64  show nag_int  show nag_int

Chapter Contents
Chapter Introduction
NAG Toolbox

# NAG Toolbox: nag_lapack_zhpgvx (f08tp)

## Purpose

nag_lapack_zhpgvx (f08tp) computes selected eigenvalues and, optionally, eigenvectors of a complex generalized Hermitian-definite eigenproblem, of the form
 $Az=λBz , ABz=λz or BAz=λz ,$
where $A$ and $B$ are Hermitian, stored in packed format, and $B$ is also positive definite. Eigenvalues and eigenvectors can be selected by specifying either a range of values or a range of indices for the desired eigenvalues.

## Syntax

[ap, bp, m, w, z, jfail, info] = f08tp(itype, jobz, range, uplo, n, ap, bp, vl, vu, il, iu, abstol)
[ap, bp, m, w, z, jfail, info] = nag_lapack_zhpgvx(itype, jobz, range, uplo, n, ap, bp, vl, vu, il, iu, abstol)

## Description

nag_lapack_zhpgvx (f08tp) first performs a Cholesky factorization of the matrix $B$ as $B={U}^{\mathrm{H}}U$, when ${\mathbf{uplo}}=\text{'U'}$ or $B=L{L}^{\mathrm{H}}$, when ${\mathbf{uplo}}=\text{'L'}$. The generalized problem is then reduced to a standard symmetric eigenvalue problem
 $Cx=λx ,$
which is solved for the desired eigenvalues and eigenvectors; the eigenvectors are then backtransformed to give the eigenvectors of the original problem.
For the problem $Az=\lambda Bz$, the eigenvectors are normalized so that the matrix of eigenvectors, $Z$, satisfies
 $ZH A Z = Λ and ZH B Z = I ,$
where $\Lambda$ is the diagonal matrix whose diagonal elements are the eigenvalues. For the problem $ABz=\lambda z$ we correspondingly have
 $Z-1 A Z-H = Λ and ZH B Z = I ,$
and for $BAz=\lambda z$ we have
 $ZH A Z = Λ and ZH B-1 Z = I .$

## References

Anderson E, Bai Z, Bischof C, Blackford S, Demmel J, Dongarra J J, Du Croz J J, Greenbaum A, Hammarling S, McKenney A and Sorensen D (1999) LAPACK Users' Guide (3rd Edition) SIAM, Philadelphia http://www.netlib.org/lapack/lug
Demmel J W and Kahan W (1990) Accurate singular values of bidiagonal matrices SIAM J. Sci. Statist. Comput. 11 873–912
Golub G H and Van Loan C F (1996) Matrix Computations (3rd Edition) Johns Hopkins University Press, Baltimore

## Parameters

### Compulsory Input Parameters

1:     $\mathrm{itype}$int64int32nag_int scalar
Specifies the problem type to be solved.
${\mathbf{itype}}=1$
$Az=\lambda Bz$.
${\mathbf{itype}}=2$
$ABz=\lambda z$.
${\mathbf{itype}}=3$
$BAz=\lambda z$.
Constraint: ${\mathbf{itype}}=1$, $2$ or $3$.
2:     $\mathrm{jobz}$ – string (length ≥ 1)
Indicates whether eigenvectors are computed.
${\mathbf{jobz}}=\text{'N'}$
Only eigenvalues are computed.
${\mathbf{jobz}}=\text{'V'}$
Eigenvalues and eigenvectors are computed.
Constraint: ${\mathbf{jobz}}=\text{'N'}$ or $\text{'V'}$.
3:     $\mathrm{range}$ – string (length ≥ 1)
If ${\mathbf{range}}=\text{'A'}$, all eigenvalues will be found.
If ${\mathbf{range}}=\text{'V'}$, all eigenvalues in the half-open interval $\left({\mathbf{vl}},{\mathbf{vu}}\right]$ will be found.
If ${\mathbf{range}}=\text{'I'}$, the ilth to iuth eigenvalues will be found.
Constraint: ${\mathbf{range}}=\text{'A'}$, $\text{'V'}$ or $\text{'I'}$.
4:     $\mathrm{uplo}$ – string (length ≥ 1)
If ${\mathbf{uplo}}=\text{'U'}$, the upper triangles of $A$ and $B$ are stored.
If ${\mathbf{uplo}}=\text{'L'}$, the lower triangles of $A$ and $B$ are stored.
Constraint: ${\mathbf{uplo}}=\text{'U'}$ or $\text{'L'}$.
5:     $\mathrm{n}$int64int32nag_int scalar
$n$, the order of the matrices $A$ and $B$.
Constraint: ${\mathbf{n}}\ge 0$.
6:     $\mathrm{ap}\left(:\right)$ – complex array
The dimension of the array ap must be at least $\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{n}}×\left({\mathbf{n}}+1\right)/2\right)$
The upper or lower triangle of the $n$ by $n$ Hermitian matrix $A$, packed by columns.
More precisely,
• if ${\mathbf{uplo}}=\text{'U'}$, the upper triangle of $A$ must be stored with element ${A}_{ij}$ in ${\mathbf{ap}}\left(i+j\left(j-1\right)/2\right)$ for $i\le j$;
• if ${\mathbf{uplo}}=\text{'L'}$, the lower triangle of $A$ must be stored with element ${A}_{ij}$ in ${\mathbf{ap}}\left(i+\left(2n-j\right)\left(j-1\right)/2\right)$ for $i\ge j$.
7:     $\mathrm{bp}\left(:\right)$ – complex array
The dimension of the array bp must be at least $\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{n}}×\left({\mathbf{n}}+1\right)/2\right)$
The upper or lower triangle of the $n$ by $n$ Hermitian matrix $B$, packed by columns.
More precisely,
• if ${\mathbf{uplo}}=\text{'U'}$, the upper triangle of $B$ must be stored with element ${B}_{ij}$ in ${\mathbf{bp}}\left(i+j\left(j-1\right)/2\right)$ for $i\le j$;
• if ${\mathbf{uplo}}=\text{'L'}$, the lower triangle of $B$ must be stored with element ${B}_{ij}$ in ${\mathbf{bp}}\left(i+\left(2n-j\right)\left(j-1\right)/2\right)$ for $i\ge j$.
8:     $\mathrm{vl}$ – double scalar
9:     $\mathrm{vu}$ – double scalar
If ${\mathbf{range}}=\text{'V'}$, the lower and upper bounds of the interval to be searched for eigenvalues.
If ${\mathbf{range}}=\text{'A'}$ or $\text{'I'}$, vl and vu are not referenced.
Constraint: if ${\mathbf{range}}=\text{'V'}$, ${\mathbf{vl}}<{\mathbf{vu}}$.
10:   $\mathrm{il}$int64int32nag_int scalar
11:   $\mathrm{iu}$int64int32nag_int scalar
If ${\mathbf{range}}=\text{'I'}$, the indices (in ascending order) of the smallest and largest eigenvalues to be returned.
If ${\mathbf{range}}=\text{'A'}$ or $\text{'V'}$, il and iu are not referenced.
Constraints:
• if ${\mathbf{range}}=\text{'I'}$ and ${\mathbf{n}}=0$, ${\mathbf{il}}=1$ and ${\mathbf{iu}}=0$;
• if ${\mathbf{range}}=\text{'I'}$ and ${\mathbf{n}}>0$, $1\le {\mathbf{il}}\le {\mathbf{iu}}\le {\mathbf{n}}$.
12:   $\mathrm{abstol}$ – double scalar
The absolute error tolerance for the eigenvalues. An approximate eigenvalue is accepted as converged when it is determined to lie in an interval $\left[a,b\right]$ of width less than or equal to
 $abstol+ε maxa,b ,$
where $\epsilon$ is the machine precision. If abstol is less than or equal to zero, then $\epsilon {‖T‖}_{1}$ will be used in its place, where $T$ is the tridiagonal matrix obtained by reducing $C$ to tridiagonal form. Eigenvalues will be computed most accurately when abstol is set to twice the underflow threshold , not zero. If this function returns with ${\mathbf{info}}={\mathbf{1}} \text{to} {\mathbf{n}}$, indicating that some eigenvectors did not converge, try setting abstol to . See Demmel and Kahan (1990).

None.

### Output Parameters

1:     $\mathrm{ap}\left(:\right)$ – complex array
The dimension of the array ap will be $\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{n}}×\left({\mathbf{n}}+1\right)/2\right)$
The contents of ap are destroyed.
2:     $\mathrm{bp}\left(:\right)$ – complex array
The dimension of the array bp will be $\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{n}}×\left({\mathbf{n}}+1\right)/2\right)$
The triangular factor $U$ or $L$ from the Cholesky factorization $B={U}^{\mathrm{H}}U$ or $B=L{L}^{\mathrm{H}}$, in the same storage format as $B$.
3:     $\mathrm{m}$int64int32nag_int scalar
The total number of eigenvalues found. $0\le {\mathbf{m}}\le {\mathbf{n}}$.
If ${\mathbf{range}}=\text{'A'}$, ${\mathbf{m}}={\mathbf{n}}$.
If ${\mathbf{range}}=\text{'I'}$, ${\mathbf{m}}={\mathbf{iu}}-{\mathbf{il}}+1$.
4:     $\mathrm{w}\left({\mathbf{n}}\right)$ – double array
The first m elements contain the selected eigenvalues in ascending order.
5:     $\mathrm{z}\left(\mathit{ldz},:\right)$ – complex array
The first dimension, $\mathit{ldz}$, of the array z will be
• if ${\mathbf{jobz}}=\text{'V'}$, $\mathit{ldz}=\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{n}}\right)$;
• otherwise $\mathit{ldz}=1$.
The second dimension of the array z will be $\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{m}}\right)$ if ${\mathbf{jobz}}=\text{'V'}$ and $1$ otherwise.
If ${\mathbf{jobz}}=\text{'V'}$, then
• if ${\mathbf{info}}={\mathbf{0}}$, the first m columns of $Z$ contain the orthonormal eigenvectors of the matrix $A$ corresponding to the selected eigenvalues, with the $i$th column of $Z$ holding the eigenvector associated with ${\mathbf{w}}\left(i\right)$. The eigenvectors are normalized as follows:
• if ${\mathbf{itype}}=1$ or $2$, ${Z}^{\mathrm{H}}BZ=I$;
• if ${\mathbf{itype}}=3$, ${Z}^{\mathrm{H}}{B}^{-1}Z=I$;
• if an eigenvector fails to converge (${\mathbf{info}}={\mathbf{1}} \text{to} {\mathbf{n}}$), then that column of $Z$ contains the latest approximation to the eigenvector, and the index of the eigenvector is returned in jfail.
If ${\mathbf{jobz}}=\text{'N'}$, z is not referenced.
6:     $\mathrm{jfail}\left(:\right)$int64int32nag_int array
The dimension of the array jfail will be $\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{n}}\right)$
If ${\mathbf{jobz}}=\text{'V'}$, then
• if ${\mathbf{info}}={\mathbf{0}}$, the first m elements of jfail are zero;
• if ${\mathbf{info}}={\mathbf{1}} \text{to} {\mathbf{n}}$, jfail contains the indices of the eigenvectors that failed to converge.
If ${\mathbf{jobz}}=\text{'N'}$, jfail is not referenced.
7:     $\mathrm{info}$int64int32nag_int scalar
${\mathbf{info}}=0$ unless the function detects an error (see Error Indicators and Warnings).

## Error Indicators and Warnings

Cases prefixed with W are classified as warnings and do not generate an error of type NAG:error_n. See nag_issue_warnings.

${\mathbf{info}}=-i$
If ${\mathbf{info}}=-i$, parameter $i$ had an illegal value on entry. The parameters are numbered as follows:
1: itype, 2: jobz, 3: range, 4: uplo, 5: n, 6: ap, 7: bp, 8: vl, 9: vu, 10: il, 11: iu, 12: abstol, 13: m, 14: w, 15: z, 16: ldz, 17: work, 18: rwork, 19: iwork, 20: jfail, 21: info.
It is possible that info refers to a parameter that is omitted from the MATLAB interface. This usually indicates that an error in one of the other input parameters has caused an incorrect value to be inferred.
W  ${\mathbf{info}}=1 \text{to} {\mathbf{n}}$
If ${\mathbf{info}}=i$, nag_lapack_zhpevx (f08gp) failed to converge; $i$ eigenvectors failed to converge. Their indices are stored in array jfail.
${\mathbf{info}}>{\mathbf{n}}$
nag_lapack_zpptrf (f07gr) returned an error code; i.e., if ${\mathbf{info}}={\mathbf{n}}+i$, for $1\le i\le {\mathbf{n}}$, then the leading minor of order $i$ of $B$ is not positive definite. The factorization of $B$ could not be completed and no eigenvalues or eigenvectors were computed.

## Accuracy

If $B$ is ill-conditioned with respect to inversion, then the error bounds for the computed eigenvalues and vectors may be large, although when the diagonal elements of $B$ differ widely in magnitude the eigenvalues and eigenvectors may be less sensitive than the condition of $B$ would suggest. See Section 4.10 of Anderson et al. (1999) for details of the error bounds.

The total number of floating-point operations is proportional to ${n}^{3}$.
The real analogue of this function is nag_lapack_dspgvx (f08tb).

## Example

This example finds the eigenvalues in the half-open interval $\left(-3,3\right]$, and corresponding eigenvectors, of the generalized Hermitian eigenproblem $Az=\lambda Bz$, where
 $A = -7.36i+0.00 0.77-0.43i -0.64-0.92i 3.01-6.97i 0.77+0.43i 3.49i+0.00 2.19+4.45i 1.90+3.73i -0.64+0.92i 2.19-4.45i 0.12i+0.00 2.88-3.17i 3.01+6.97i 1.90-3.73i 2.88+3.17i -2.54i+0.00$
and
 $B = 3.23i+0.00 1.51-1.92i 1.90+0.84i 0.42+2.50i 1.51+1.92i 3.58i+0.00 -0.23+1.11i -1.18+1.37i 1.90-0.84i -0.23-1.11i 4.09i+0.00 2.33-0.14i 0.42-2.50i -1.18-1.37i 2.33+0.14i 4.29i+0.00 .$
The example program for nag_lapack_zhpgvd (f08tq) illustrates solving a generalized symmetric eigenproblem of the form $ABz=\lambda z$.
```function f08tp_example

fprintf('f08tp example results\n\n');

% Hermitian matrices A and B stored in packed (Upper) format
n = int64(4);
uplo = 'U';
ap = [-7.36;
0.77 - 0.43i;  3.49 + 0i;
-0.64 - 0.92i;  2.19 + 4.45i;  0.12 + 0i;
3.01 - 6.97i;  1.90 + 3.73i;  2.88 - 3.17i; -2.54 + 0i];
bp = [ 3.23;
1.51 - 1.92i;  3.58 + 0i;
1.90 + 0.84i; -0.23 + 1.11i;  4.09 + 0i;
0.42 + 2.50i; -1.18 + 1.37i;  2.33 - 0.14i;  4.29 + 0i];

% Eigenvalues in range [-3,3] and corresponding eigenvectors for Az=lambda Bz
itype = int64(1);
jobz  = 'Vectors';
range = 'Values in range';
vl = -3;         vu = 3;
il = int64(0); iu = il;
abstol = 0;
[~, ~, m, w, z, jfail, info] = ...
f08tp( ...
itype, jobz, range, uplo, n, ap, bp, vl, vu, il, iu, abstol);

disp('Selected Eigenvalues');
disp(w(1:m)');

% Normalize eigenvectors: largest elements are real
for i = 1:m
[~,k] = max(abs(real(z(:,i)))+abs(imag(z(:,i))));
z(:,i) = z(:,i)*conj(z(k,i))/abs(z(k,i));
end
disp('Corresponding Eigenvectors');
disp(z);

```
```f08tp example results

Selected Eigenvalues
-2.9936    0.5047

Corresponding Eigenvectors
-0.6626 + 0.2258i   0.6462 + 0.0000i
-0.1164 - 0.0178i   0.1216 - 0.4788i
0.9098 + 0.0000i  -0.1344 - 0.3059i
-0.6120 - 0.5348i   0.2924 + 0.5987i

```