NAG Library Routine Document
f08gqf (zhpevd)
1
Purpose
f08gqf (zhpevd) computes all the eigenvalues and, optionally, all the eigenvectors of a complex Hermitian matrix held in packed storage.
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
Fortran Interface
Subroutine f08gqf ( |
job, uplo, n, ap, w, z, ldz, work, lwork, rwork, lrwork, iwork, liwork, info) |
Integer, Intent (In) | :: | n, ldz, lwork, lrwork, liwork | Integer, Intent (Out) | :: | iwork(max(1,liwork)), info | Real (Kind=nag_wp), Intent (Inout) | :: | w(*) | Real (Kind=nag_wp), Intent (Out) | :: | rwork(max(1,lrwork)) | Complex (Kind=nag_wp), Intent (Inout) | :: | ap(*), z(ldz,*) | Complex (Kind=nag_wp), Intent (Out) | :: | work(max(1,lwork)) | Character (1), Intent (In) | :: | job, uplo |
|
C Header Interface
#include <nagmk26.h>
void |
f08gqf_ (const char *job, const char *uplo, const Integer *n, Complex ap[], double w[], Complex z[], const Integer *ldz, Complex work[], const Integer *lwork, double rwork[], const Integer *lrwork, Integer iwork[], const Integer *liwork, Integer *info, const Charlen length_job, const Charlen length_uplo) |
|
The routine may be called by its
LAPACK
name zhpevd.
3
Description
f08gqf (zhpevd) computes all the eigenvalues and, optionally, all the eigenvectors of a complex Hermitian matrix
(held in packed storage).
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
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: 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: – Complex (Kind=nag_wp) arrayInput/Output
-
Note: the dimension of the array
ap
must be at least
.
On entry: the upper or lower triangle of the
by
Hermitian matrix
, packed by columns.
More precisely,
- if , the upper triangle of must be stored with element in for ;
- if , the lower triangle of must be stored with element in for .
On exit:
ap is overwritten by the values generated during the reduction to tridiagonal form. The elements of the diagonal and the off-diagonal of the tridiagonal matrix overwrite the corresponding elements of
.
- 5: – 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.
- 6: – 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
.
If
,
z is not referenced.
- 7: – IntegerInput
-
On entry: the first dimension of the array
z as declared in the (sub)program from which
f08gqf (zhpevd) is called.
Constraints:
- if , ;
- if , .
- 8: – Complex (Kind=nag_wp) arrayWorkspace
-
On exit: if
,
contains the required minimal size of
lwork.
- 9: – IntegerInput
-
On entry: the dimension of the array
work as declared in the (sub)program from which
f08gqf (zhpevd) 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 .
- 10: – Real (Kind=nag_wp) arrayWorkspace
-
On exit: if , contains the required minimal size of .
- 11: – IntegerInput
-
On entry: the dimension of the array
rwork as declared in the (sub)program from which
f08gqf (zhpevd) 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 .
- 12: – Integer arrayWorkspace
-
On exit: if
,
contains the required minimal size of
liwork.
- 13: – IntegerInput
-
On entry: the dimension of the array
iwork as declared in the (sub)program from which
f08gqf (zhpevd) 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 .
- 14: – 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
f08gqf (zhpevd) is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.
f08gqf (zhpevd) 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
f08gcf (dspevd).
10
Example
This example computes all the eigenvalues and eigenvectors of the Hermitian matrix
, where
10.1
Program Text
Program Text (f08gqfe.f90)
10.2
Program Data
Program Data (f08gqfe.d)
10.3
Program Results
Program Results (f08gqfe.r)