NAG Library Routine Document
F08HQF (ZHBEVD)
1 Purpose
F08HQF (ZHBEVD) computes all the eigenvalues and, optionally, all the eigenvectors of a complex Hermitian band matrix.
If the eigenvectors are requested, then it uses a divide-and-conquer algorithm to compute eigenvalues and eigenvectors. However, if only eigenvalues are required, then it uses the Pal–Walker–Kahan variant of the or algorithm.
2 Specification
SUBROUTINE F08HQF ( |
JOB, UPLO, N, KD, AB, LDAB, W, Z, LDZ, WORK, LWORK, RWORK, LRWORK, IWORK, LIWORK, INFO) |
INTEGER |
N, KD, LDAB, LDZ, LWORK, LRWORK, IWORK(max(1,LIWORK)), LIWORK, INFO |
REAL (KIND=nag_wp) |
W(*), RWORK(max(1,LRWORK)) |
COMPLEX (KIND=nag_wp) |
AB(LDAB,*), Z(LDZ,*), WORK(max(1,LWORK)) |
CHARACTER(1) |
JOB, UPLO |
|
The routine may be called by its
LAPACK
name zhbevd.
3 Description
F08HQF (ZHBEVD) computes all the eigenvalues and, optionally, all the eigenvectors of a complex Hermitian band matrix
.
In other words, it can compute the spectral factorization of
as
where
is a real diagonal matrix whose diagonal elements are the eigenvalues
, and
is the (complex) unitary matrix whose columns are the eigenvectors
. Thus
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
http://www.netlib.org/lapack/lug
Golub G H and Van Loan C F (1996) Matrix Computations (3rd Edition) Johns Hopkins University Press, Baltimore
5 Parameters
- 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: indicates whether the upper or lower triangular part of
is stored.
- The upper triangular part of is stored.
- The lower triangular part of is stored.
Constraint:
or .
- 3: – INTEGERInput
-
On entry: , the order of the matrix .
Constraint:
.
- 4: – INTEGERInput
-
On entry: if
, the number of superdiagonals,
, of the matrix
.
If , the number of subdiagonals, , of the matrix .
Constraint:
.
- 5: – COMPLEX (KIND=nag_wp) arrayInput/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: – INTEGERInput
-
On entry: the first dimension of the array
AB as declared in the (sub)program from which F08HQF (ZHBEVD) is called.
Constraint:
.
- 7: – REAL (KIND=nag_wp) arrayOutput
-
Note: the dimension of the array
W
must be at least
.
On exit: the eigenvalues of the matrix in ascending order.
- 8: – COMPLEX (KIND=nag_wp) arrayOutput
-
Note: the second dimension of the array
Z
must be at least
if
and at least
if
.
On exit: if
,
Z is overwritten by the unitary matrix
which contains the eigenvectors of
. The
th column of
contains the eigenvector which corresponds to the eigenvalue
.
If
,
Z is not referenced.
- 9: – INTEGERInput
-
On entry: the first dimension of the array
Z as declared in the (sub)program from which F08HQF (ZHBEVD) is called.
Constraints:
- if , ;
- if , .
- 10: – COMPLEX (KIND=nag_wp) arrayWorkspace
-
On exit: if
, the real part of
contains the required minimal size of
LWORK.
- 11: – INTEGERInput
-
On entry: the dimension of the array
WORK as declared in the (sub)program from which F08HQF (ZHBEVD) is called.
If
, a workspace query is assumed; the routine only calculates the minimum dimension of the
WORK array, returns this value as the first entry of the
WORK array, and no error message related to
LWORK is issued.
Constraints:
- if , or ;
- if and , or ;
- if and , or .
- 12: – REAL (KIND=nag_wp) arrayWorkspace
-
On exit: if , contains the required minimal size of .
- 13: – INTEGERInput
-
On entry: the dimension of the array
RWORK as declared in the (sub)program from which F08HQF (ZHBEVD) is called.
If
, a workspace query is assumed; the routine only calculates the minimum dimension of the
RWORK array, returns this value as the first entry of the
RWORK array, and no error message related to
LRWORK is issued.
Constraints:
- if , or ;
- if and , or ;
- if and , or .
- 14: – INTEGER arrayWorkspace
-
On exit: if
,
contains the required minimal size of
LIWORK.
- 15: – INTEGERInput
-
On entry: the dimension of the array
IWORK as declared in the (sub)program from which F08HQF (ZHBEVD) is called.
If
, a workspace query is assumed; the routine only calculates the minimum dimension of the
IWORK array, returns this value as the first entry of the
IWORK array, and no error message related to
LIWORK is issued.
Constraints:
- if or , or ;
- if and , or .
- 16: – INTEGEROutput
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.
-
if and , the algorithm failed to converge; elements of an intermediate tridiagonal form did not converge to zero; if and , then the algorithm failed to compute an eigenvalue while working on the submatrix lying in rows and column through .
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
F08HQF (ZHBEVD) is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.
F08HQF (ZHBEVD) 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 real analogue of this routine is
F08HCF (DSBEVD).
10 Example
This example computes all the eigenvalues and eigenvectors of the Hermitian band matrix
, where
10.1 Program Text
Program Text (f08hqfe.f90)
10.2 Program Data
Program Data (f08hqfe.d)
10.3 Program Results
Program Results (f08hqfe.r)