NAG Library Routine Document

f08spf  (zhegvx)

 Contents

    1  Purpose
    7  Accuracy

1
Purpose

f08spf (zhegvx) 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 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.

2
Specification

Fortran Interface
Subroutine f08spf ( itype, jobz, range, uplo, n, a, lda, b, ldb, vl, vu, il, iu, abstol, m, w, z, ldz, work, lwork, rwork, iwork, jfail, info)
Integer, Intent (In):: itype, n, lda, ldb, il, iu, ldz, lwork
Integer, Intent (Inout):: jfail(*)
Integer, Intent (Out):: m, iwork(5*n), info
Real (Kind=nag_wp), Intent (In):: vl, vu, abstol
Real (Kind=nag_wp), Intent (Out):: w(n), rwork(7*n)
Complex (Kind=nag_wp), Intent (Inout):: a(lda,*), b(ldb,*), z(ldz,*)
Complex (Kind=nag_wp), Intent (Out):: work(max(1,lwork))
Character (1), Intent (In):: jobz, range, uplo
C Header Interface
#include nagmk26.h
void  f08spf_ ( const Integer *itype, const char *jobz, const char *range, const char *uplo, const Integer *n, Complex a[], const Integer *lda, Complex b[], const Integer *ldb, const double *vl, const double *vu, const Integer *il, const Integer *iu, const double *abstol, Integer *m, double w[], Complex z[], const Integer *ldz, Complex work[], const Integer *lwork, double rwork[], Integer iwork[], Integer jfail[], Integer *info, const Charlen length_jobz, const Charlen length_range, const Charlen length_uplo)
The routine may be called by its LAPACK name zhegvx.

3
Description

f08spf (zhegvx) first performs a Cholesky factorization of the matrix B as B=UHU , when uplo='U' or B=LLH , when uplo='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=λBz , the eigenvectors are normalized so that the matrix of eigenvectors, Z, satisfies
ZH A Z = Λ   and   ZH B Z = I ,  
where Λ  is the diagonal matrix whose diagonal elements are the eigenvalues. For the problem A B z = λ z  we correspondingly have
Z-1 A Z-H = Λ   and   ZH B Z = I ,  
and for B A z = λ z  we have
ZH A Z = Λ   and   ZH B-1 Z = I .  

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
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

5
Arguments

1:     itype – IntegerInput
On entry: specifies the problem type to be solved.
itype=1
Az=λBz.
itype=2
ABz=λz.
itype=3
BAz=λz.
Constraint: itype=1, 2 or 3.
2:     jobz – Character(1)Input
On entry: indicates whether eigenvectors are computed.
jobz='N'
Only eigenvalues are computed.
jobz='V'
Eigenvalues and eigenvectors are computed.
Constraint: jobz='N' or 'V'.
3:     range – Character(1)Input
On entry: if range='A', all eigenvalues will be found.
If range='V', all eigenvalues in the half-open interval vl,vu will be found.
If range='I', the ilth to iuth eigenvalues will be found.
Constraint: range='A', 'V' or 'I'.
4:     uplo – Character(1)Input
On entry: if uplo='U', the upper triangles of A and B are stored.
If uplo='L', the lower triangles of A and B are stored.
Constraint: uplo='U' or 'L'.
5:     n – IntegerInput
On entry: n, the order of the matrices A and B.
Constraint: n0.
6:     alda* – Complex (Kind=nag_wp) arrayInput/Output
Note: the second dimension of the array a must be at least max1,n.
On entry: the n by n Hermitian matrix A.
  • If uplo='U', the upper triangular part of A must be stored and the elements of the array below the diagonal are not referenced.
  • If uplo='L', the lower triangular part of A must be stored and the elements of the array above the diagonal are not referenced.
On exit: the lower triangle (if uplo='L') or the upper triangle (if uplo='U') of a, including the diagonal, is overwritten.
7:     lda – IntegerInput
On entry: the first dimension of the array a as declared in the (sub)program from which f08spf (zhegvx) is called.
Constraint: ldamax1,n.
8:     bldb* – Complex (Kind=nag_wp) arrayInput/Output
Note: the second dimension of the array b must be at least max1,n.
On entry: the n by n Hermitian matrix B.
  • If uplo='U', the upper triangular part of B must be stored and the elements of the array below the diagonal are not referenced.
  • If uplo='L', the lower triangular part of B must be stored and the elements of the array above the diagonal are not referenced.
On exit: the triangular factor U or L from the Cholesky factorization B=UHU or B=LLH.
9:     ldb – IntegerInput
On entry: the first dimension of the array b as declared in the (sub)program from which f08spf (zhegvx) is called.
Constraint: ldbmax1,n.
10:   vl – Real (Kind=nag_wp)Input
11:   vu – Real (Kind=nag_wp)Input
On entry: if range='V', the lower and upper bounds of the interval to be searched for eigenvalues.
If range='A' or 'I', vl and vu are not referenced.
Constraint: if range='V', vl<vu.
12:   il – IntegerInput
13:   iu – IntegerInput
On entry: if range='I', the indices (in ascending order) of the smallest and largest eigenvalues to be returned.
If range='A' or 'V', il and iu are not referenced.
Constraints:
  • if range='I' and n=0, il=1 and iu=0;
  • if range='I' and n>0, 1 il iu n .
14:   abstol – Real (Kind=nag_wp)Input
On entry: the absolute error tolerance for the eigenvalues. An approximate eigenvalue is accepted as converged when it is determined to lie in an interval a,b  of width less than or equal to
abstol+ε maxa,b ,  
where ε  is the machine precision. If abstol is less than or equal to zero, then ε T1  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 2 × x02amf   , not zero. If this routine returns with info=1ton, indicating that some eigenvectors did not converge, try setting abstol to 2 × x02amf   . See Demmel and Kahan (1990).
15:   m – IntegerOutput
On exit: the total number of eigenvalues found. 0mn.
If range='A', m=n.
If range='I', m=iu-il+1.
16:   wn – Real (Kind=nag_wp) arrayOutput
On exit: the first m elements contain the selected eigenvalues in ascending order.
17:   zldz* – Complex (Kind=nag_wp) arrayOutput
Note: the second dimension of the array z must be at least max1,m if jobz='V', and at least 1 otherwise.
On exit: if jobz='V', then
  • if info=0, the first m columns of Z contain the orthonormal eigenvectors of the matrix A corresponding to the selected eigenvalues, with the ith column of Z holding the eigenvector associated with wi. The eigenvectors are normalized as follows:
    • if itype=1 or 2, ZHBZ=I;
    • if itype=3, ZHB-1Z=I;
  • if an eigenvector fails to converge (info=1ton), then that column of Z contains the latest approximation to the eigenvector, and the index of the eigenvector is returned in jfail.
If jobz='N', z is not referenced.
Note:  you must ensure that at least max1,m columns are supplied in the array z; if range='V', the exact value of m is not known in advance and an upper bound of at least n must be used.
18:   ldz – IntegerInput
On entry: the first dimension of the array z as declared in the (sub)program from which f08spf (zhegvx) is called.
Constraints:
  • if jobz='V', ldz max1,n ;
  • otherwise ldz1.
19:   workmax1,lwork – Complex (Kind=nag_wp) arrayWorkspace
On exit: if info=0, the real part of work1 contains the minimum value of lwork required for optimal performance.
20:   lwork – IntegerInput
On entry: the dimension of the array work as declared in the (sub)program from which f08spf (zhegvx) is called.
If lwork=-1, a workspace query is assumed; the routine only calculates the optimal size of the work array, returns this value as the first entry of the work array, and no error message related to lwork is issued.
Suggested value: for optimal performance, lworknb+1×n, where nb is the optimal block size for f08fsf (zhetrd).
Constraint: lworkmax1,2×n.
21:   rwork7×n – Real (Kind=nag_wp) arrayWorkspace
22:   iwork5×n – Integer arrayWorkspace
23:   jfail* – Integer arrayOutput
Note: the dimension of the array jfail must be at least max1,n.
On exit: if jobz='V', then
  • if info=0, the first m elements of jfail are zero;
  • if info=1ton, jfail contains the indices of the eigenvectors that failed to converge.
If jobz='N', jfail is not referenced.
24:   info – IntegerOutput
On exit: info=0 unless the routine detects an error (see Section 6).

6
Error Indicators and Warnings

info<0
If info=-i, argument i had an illegal value. An explanatory message is output, and execution of the program is terminated.
info=1ton
If info=i, f08fpf (zheevx) failed to converge; i eigenvectors failed to converge. Their indices are stored in array jfail.
info>n
f07frf (zpotrf) returned an error code; i.e., if info=n+i, for 1in, 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.

7
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.

8
Parallelism and Performance

f08spf (zhegvx) is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.
f08spf (zhegvx) 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.

9
Further Comments

The total number of floating-point operations is proportional to n3.
The real analogue of this routine is f08sbf (dsygvx).

10
Example

This example finds the eigenvalues in the half-open interval -3,3, and corresponding eigenvectors, of the generalized Hermitian eigenproblem Az=λ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 f08sqf (zhegvd) illustrates solving a generalized Hermitian eigenproblem of the form ABz=λz.

10.1
Program Text

Program Text (f08spfe.f90)

10.2
Program Data

Program Data (f08spfe.d)

10.3
Program Results

Program Results (f08spfe.r)

© The Numerical Algorithms Group Ltd, Oxford, UK. 2017