NAG Library Routine Document

F08SPF (ZHEGVX)

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

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	ITYPE, N, LDA, LDB, IL, IU, M, LDZ, LWORK, IWORK(5N), JFAIL(), INFO
REAL (KIND=nag_wp)	VL, VU, ABSTOL, W(N), RWORK(7*N)
COMPLEX (KIND=nag_wp)	A(LDA,), B(LDB,), Z(LDZ,*), WORK(max(1,LWORK))
CHARACTER(1)	JOBZ, RANGE, UPLO

The routine may be called by its LAPACK name zhegvx.

3 Description

F08SPF (ZHEGVX) first performs a Cholesky factorization of the matrix

B

B = U^{H} U

, when

UPLO ='U'

B = L L^{H}

, when

UPLO ='L'

. The generalized problem is then reduced to a standard symmetric eigenvalue problem

C x = λ 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

A z = λ B z

, the eigenvectors are normalized so that the matrix of eigenvectors,

Z

, satisfies

Z^{H} A Z = Λ and Z^{H} 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 Z^{H} B Z = I,

and for

B A z = λ z

we have

Z^{H} A Z = Λ and Z^{H} 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 Parameters

1: $ITYPE$ – INTEGERInput

On entry: specifies the problem type to be solved.

$ITYPE = 1$: $A z = λ B z$ .
$ITYPE = 2$: $A B z = λ z$ .
$ITYPE = 3$: $B A z = λ z$ .

Constraint:

ITYPE = 1

2

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'

'V'

3: $RANGE$ – CHARACTER(1)Input

On entry: if

RANGE ='A'

, all eigenvalues will be found.

RANGE ='V'

, all eigenvalues in the half-open interval

(VL, VU]

will be found.

RANGE ='I'

, the ILth to IUth eigenvalues will be found.

Constraint:

RANGE ='A'

'V'

'I'

4: $UPLO$ – CHARACTER(1)Input

On entry: if

UPLO ='U'

, the upper triangles of

A

and

B

are stored.

UPLO ='L'

, the lower triangles of

A

and

B

are stored.

Constraint:

UPLO ='U'

'L'

5: $N$ – INTEGERInput

On entry:

n

, the order of the matrices

A

and

B

Constraint:

N \geq 0

6: $A (LDA *)$ – COMPLEX (KIND=nag_wp) arrayInput/Output

Note: the second dimension of the array A must be at least

\max (1, N)

On entry: the

n

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:

LDA \geq \max (1, N)

8: $B (LDB *)$ – COMPLEX (KIND=nag_wp) arrayInput/Output

Note: the second dimension of the array B must be at least

\max (1, N)

On entry: the

n

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

L

from the Cholesky factorization

B = U^{H} U

B = L L^{H}

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:

LDB \geq \max (1, 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.

RANGE ='A'

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

RANGE ='A'

'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 \leq IL \leq IU \leq 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 + ε \max (|a|, |b|),

where

ε

is the machine precision. If ABSTOL is less than or equal to zero, then

ε {‖T‖}_{1}

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 \times X02AMF ()

, not zero. If this routine returns with

INFO = 1 to N

, indicating that some eigenvectors did not converge, try setting ABSTOL to

2 \times X02AMF ()

. See Demmel and Kahan (1990).

15: $M$ – INTEGEROutput

On exit: the total number of eigenvalues found.

0 \leq M \leq N

RANGE ='A'

M = N

RANGE ='I'

M = IU - IL + 1

16: $W (N)$ – REAL (KIND=nag_wp) arrayOutput

On exit: the first M elements contain the selected eigenvalues in ascending order.

17: $Z (LDZ *)$ – COMPLEX (KIND=nag_wp) arrayOutput

Note: the second dimension of the array Z must be at least

\max (1, M)

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$ , $Z^{H} B Z = I$ ;
- if $ITYPE = 3$ , $Z^{H} B^{- 1} Z = I$ ;
if an eigenvector fails to converge ( $INFO = 1 to N$ ), then that column of $Z$ contains the latest approximation to the eigenvector, and the index of the eigenvector is returned in JFAIL.

JOBZ ='N'

, Z is not referenced.

Note: you must ensure that at least

\max (1, 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 \geq \max (1, N)$ ;
otherwise $LDZ \geq 1$ .

19: $WORK (\max (1, LWORK))$ – COMPLEX (KIND=nag_wp) arrayWorkspace

On exit: if

INFO = 0

, the real part of

WORK (1)

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.

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,

LWORK \geq (nb + 1) \times N

, where

nb

is the optimal block size for F08FSF (ZHETRD).

Constraint:

LWORK \geq \max (1, 2 \times N)

21: $RWORK (7 \times N)$ – REAL (KIND=nag_wp) arrayWorkspace

22: $IWORK (5 \times N)$ – INTEGER arrayWorkspace

23: $JFAIL (*)$ – INTEGER arrayOutput

Note: the dimension of the array JFAIL must be at least

\max (1, N)

On exit: if

JOBZ ='V'

, then

if $INFO = 0$ , the first M elements of JFAIL are zero;
if $INFO = 1 to N$ , JFAIL contains the indices of the eigenvectors that failed to converge.

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 = 1 to N$: 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 $1 \leq i \leq N$ , 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

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

n^{3}

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

A z = λ B z

, where

A = (\begin{array}{r} - 7.36 & 0.77 - 0.43 i & - 0.64 - 0.92 i & 3.01 - 6.97 i \\ 0.77 + 0.43 i & 3.49 & 2.19 + 4.45 i & 1.90 + 3.73 i \\ - 0.64 + 0.92 i & 2.19 - 4.45 i & 0.12 & 2.88 - 3.17 i \\ 3.01 + 6.97 i & 1.90 - 3.73 i & 2.88 + 3.17 i & - 2.54 \end{array})

and

B = (\begin{array}{r} 3.23 & 1.51 - 1.92 i & 1.90 + 0.84 i & 0.42 + 2.50 i \\ 1.51 + 1.92 i & 3.58 & - 0.23 + 1.11 i & - 1.18 + 1.37 i \\ 1.90 - 0.84 i & - 0.23 - 1.11 i & 4.09 & 2.33 - 0.14 i \\ 0.42 - 2.50 i & - 1.18 - 1.37 i & 2.33 + 0.14 i & 4.29 \end{array}) .

The example program for F08SQF (ZHEGVD) illustrates solving a generalized Hermitian eigenproblem of the form

A B z = λ z

NAG Library Routine DocumentF08SPF (ZHEGVX)

▸▿ Contents

1 Purpose

2 Specification

3 Description

4 References

5 Parameters

6 Error Indicators and Warnings

7 Accuracy

8 Parallelism and Performance

9 Further Comments

10 Example

10.1 Program Text

10.2 Program Data

10.3 Program Results

NAG Library Routine Document

F08SPF (ZHEGVX)