NAG Toolbox: nag_lapack_zhbev (f08hn)

Purpose

Syntax

Description

References

Parameters

Compulsory Input Parameters

1:     $\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'}$.

2:     $\mathrm{uplo}$ – string (length ≥ 1)

If $\mathbf{uplo}=\text{'U'}$, the upper triangular part of $A$ is stored.

If $\mathbf{uplo}=\text{'L'}$, the lower triangular part of $A$ is stored.

Constraint: $\mathbf{uplo}=\text{'U'}$ or $\text{'L'}$.

3:     $\mathrm{kd}$ – int64int32nag_int scalar

If $\mathbf{uplo}=\text{'U'}$, the number of superdiagonals, $k_d$, of the matrix $A$.

If $\mathbf{uplo}=\text{'L'}$, the number of subdiagonals, $k_d$, of the matrix $A$.

Constraint: $\mathbf{kd}\ge 0$.

4:     $\mathrm{ab}\left(\mathit{ldab},:\right)$ – complex array

The first dimension of the array ab must be at least $\mathbf{kd}+1$.

The second dimension of the array ab must be at least $\max \left(1,\mathbf{n}\right)$.

The upper or lower triangle of the $n$ by $n$ Hermitian band matrix $A$.

The matrix is stored in rows $1$ to $k_d+1$, more precisely,

• if $\mathbf{uplo}=\text{'U'}$, the elements of the upper triangle of $A$ within the band must be stored with element $A_{ij}$ in $\mathbf{ab}\left(k_d+1+i-j,j\right)\text{ for }\max \left(1,j-k_d\right)\le i\le j$;
• if $\mathbf{uplo}=\text{'L'}$, the elements of the lower triangle of $A$ within the band must be stored with element $A_{ij}$ in $\mathbf{ab}\left(1+i-j,j\right)\text{ for }j\le i\le \min \left(n,j+k_d\right)\text{.}$

Optional Input Parameters

1:     $\mathrm{n}$ – int64int32nag_int scalar

Default: the second dimension of the array ab.

$n$, the order of the matrix $A$.

Constraint: $\mathbf{n}\ge 0$.

Output Parameters

1:     $\mathrm{ab}\left(\mathit{ldab},:\right)$ – complex array

The first dimension of the array ab will be $\mathbf{kd}+1$.

The second dimension of the array ab will be $\max \left(1,\mathbf{n}\right)$.

ab stores values generated during the reduction to tridiagonal form.

The first superdiagonal or subdiagonal and the diagonal of the tridiagonal matrix $T$ are returned in ab using the same storage format as described above.

2:     $\mathrm{w}\left(\mathbf{n}\right)$ – double array

The eigenvalues in ascending order.

3:     $\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}=\max \left(1,\mathbf{n}\right)$;
• otherwise $\mathit{ldz}=1$.

The second dimension of the array z will be $\max \left(1,\mathbf{n}\right)$ if $\mathbf{jobz}=\text{'V'}$ and $1$ otherwise.

If $\mathbf{jobz}=\text{'V'}$, z contains the orthonormal eigenvectors of the matrix $A$, with the $i$th column of $Z$ holding the eigenvector associated with $\mathbf{w}\left(i\right)$.

If $\mathbf{jobz}=\text{'N'}$, z is not referenced.

4:     $\mathrm{info}$ – int64int32nag_int scalar

$\mathbf{info}=0$ unless the function detects an error (see Error Indicators and Warnings).

Error Indicators and Warnings

   $\mathbf{info}=-i$

If $\mathbf{info}=-i$, parameter $i$ had an illegal value on entry. The parameters are numbered as follows:

1: jobz, 2: uplo, 3: n, 4: kd, 5: ab, 6: ldab, 7: w, 8: z, 9: ldz, 10: work, 11: rwork, 12: 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.

   $\mathbf{info}>0$

If $\mathbf{info}=i$, the algorithm failed to converge; $i$ off-diagonal elements of an intermediate tridiagonal form did not converge to zero.

Accuracy

Further Comments

Example

Open in the MATLAB editor: f08hn_example

function f08hn_example


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

% Hermitian band matrix A, stored on symmetric banded format
uplo = 'U';
kd   = int64(2);
n    = int64(4);
ab = [0,       0 + 0i,  3 - 1i,  4 - 2i,  5 - 3i;
      0 + 0i,  2 - 1i,  3 - 2i,  4 - 3i,  5 - 4i;
      1 + 0i,  2 + 0i,  3 + 0i,  4 + 0i,  5 + 0i];

% All eigenvalues and eigenvectors of A
jobz = 'Vectors';
[~, w, z, info] = f08hn( ...
                         jobz, uplo, kd, ab);

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

disp('Eigenvalues');
disp(w');
[ifail] = x04da( ...
                 'General', ' ', z, 'Eigenvectors');

% Eigenvalue error bound
errbnd = x02aj*max(abs(w(1)),abs(w(end)));
% Eigenvector condition numbers
[rcondz, info] = f08fl( ...
		        'Eigenvectors', n, n, w);

% Eigenvector error bounds
zerrbd = errbnd./rcondz;

fprintf('\nError estimate for the eigenvalues\n');
fprintf('%12.1e\n',errbnd);
disp('Error estimates for the eigenvectors');
fprintf('%12.1e',zerrbd);
fprintf('\n');

f08hn example results

Eigenvalues
   -6.4185   -1.4094    1.4421    4.4856   16.9002

 Eigenvectors
          1       2       3       4       5
 1  -0.2534 -0.4188 -0.2560  0.4767  0.1439
    -0.0538  0.4797  0.3721 -0.2748  0.0000

 2  -0.0662 -0.0122  0.5344  0.5524  0.3060
     0.4301 -0.3529  0.0000  0.0000  0.0411

 3   0.5274  0.4621 -0.4245  0.2076  0.4681
     0.0000  0.0000  0.0915 -0.0660  0.2306

 4   0.1061 -0.1642  0.4964 -0.1379  0.4098
    -0.4981  0.3146 -0.1546  0.1026  0.3832

 5  -0.4519 -0.0360 -0.1979 -0.2651  0.1819
     0.0424 -0.3593 -0.1114 -0.4948  0.5136

Error estimate for the eigenvalues
     1.9e-15
Error estimates for the eigenvectors
     3.7e-16     6.6e-16     6.6e-16     6.2e-16