NAG FL Interface
f08hnf (zhbev)
1
Purpose
f08hnf computes all the eigenvalues and, optionally, all the eigenvectors of a complex by Hermitian band matrix of bandwidth .
2
Specification
Fortran Interface
Subroutine f08hnf ( |
jobz, uplo, n, kd, ab, ldab, w, z, ldz, work, rwork, info) |
Integer, Intent (In) |
:: |
n, kd, ldab, ldz |
Integer, Intent (Out) |
:: |
info |
Real (Kind=nag_wp), Intent (Out) |
:: |
w(n), rwork(3*n-2) |
Complex (Kind=nag_wp), Intent (Inout) |
:: |
ab(ldab,*), z(ldz,*) |
Complex (Kind=nag_wp), Intent (Out) |
:: |
work(n) |
Character (1), Intent (In) |
:: |
jobz, uplo |
|
C Header Interface
#include <nag.h>
void |
f08hnf_ (const char *jobz, const char *uplo, const Integer *n, const Integer *kd, Complex ab[], const Integer *ldab, double w[], Complex z[], const Integer *ldz, Complex work[], double rwork[], Integer *info, const Charlen length_jobz, const Charlen length_uplo) |
|
C++ Header Interface
#include <nag.h> extern "C" {
void |
f08hnf_ (const char *jobz, const char *uplo, const Integer &n, const Integer &kd, Complex ab[], const Integer &ldab, double w[], Complex z[], const Integer &ldz, Complex work[], double rwork[], Integer &info, const Charlen length_jobz, const Charlen length_uplo) |
}
|
The routine may be called by the names f08hnf, nagf_lapackeig_zhbev or its LAPACK name zhbev.
3
Description
The Hermitian band matrix is first reduced to real tridiagonal form, using unitary similarity transformations, and then the algorithm is applied to the tridiagonal matrix to compute the eigenvalues and (optionally) the eigenvectors.
4
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
https://www.netlib.org/lapack/lug
Golub G H and Van Loan C F (1996) Matrix Computations (3rd Edition) Johns Hopkins University Press, Baltimore
5
Arguments
-
1:
– Character(1)
Input
-
On entry: indicates whether eigenvectors are computed.
- Only eigenvalues are computed.
- Eigenvalues and eigenvectors are computed.
Constraint:
or .
-
2:
– Character(1)
Input
-
On entry: if
, the upper triangular part of
is stored.
If , the lower triangular part of is stored.
Constraint:
or .
-
3:
– Integer
Input
-
On entry: , the order of the matrix .
Constraint:
.
-
4:
– Integer
Input
-
On entry: if
, the number of superdiagonals,
, of the matrix
.
If , the number of subdiagonals, , of the matrix .
Constraint:
.
-
5:
– Complex (Kind=nag_wp) array
Input/Output
-
Note: the second dimension of the array
ab
must be at least
.
On entry: the upper or lower triangle of the
by
Hermitian band matrix
.
The matrix is stored in rows
to
, more precisely,
- if , the elements of the upper triangle of within the band must be stored with element in ;
- if , the elements of the lower triangle of within the band must be stored with element in
On exit:
ab is overwritten by values generated during the reduction to tridiagonal form.
The first superdiagonal or subdiagonal and the diagonal of the tridiagonal matrix
are returned in
ab using the same storage format as described above.
-
6:
– Integer
Input
-
On entry: the first dimension of the array
ab as declared in the (sub)program from which
f08hnf is called.
Constraint:
.
-
7:
– Real (Kind=nag_wp) array
Output
-
On exit: the eigenvalues in ascending order.
-
8:
– Complex (Kind=nag_wp) array
Output
-
Note: the second dimension of the array
z
must be at least
if
, and at least
otherwise.
On exit: if
,
z contains the orthonormal eigenvectors of the matrix
, with the
th column of
holding the eigenvector associated with
.
If
,
z is not referenced.
-
9:
– Integer
Input
-
On entry: the first dimension of the array
z as declared in the (sub)program from which
f08hnf is called.
Constraints:
- if , ;
- otherwise .
-
10:
– Complex (Kind=nag_wp) array
Workspace
-
-
11:
– Real (Kind=nag_wp) array
Workspace
-
-
12:
– Integer
Output
On exit:
unless the routine detects an error (see
Section 6).
6
Error Indicators and Warnings
If , argument had an illegal value. An explanatory message is output, and execution of the program is terminated.
-
The algorithm failed to converge; off-diagonal elements of an intermediate tridiagonal form did not converge to zero.
7
Accuracy
The computed eigenvalues and eigenvectors are exact for a nearby matrix
, where
and
is the
machine precision. See Section 4.7 of
Anderson et al. (1999) for further details.
8
Parallelism and Performance
f08hnf is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.
f08hnf 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.
The total number of floating-point operations is proportional to if and is proportional to otherwise.
The real analogue of this routine is
f08haf.
10
Example
This example finds all the eigenvalues and eigenvectors of the Hermitian band matrix
together with approximate error bounds for the computed eigenvalues and eigenvectors.
10.1
Program Text
10.2
Program Data
10.3
Program Results