?heevr

Developer Reference for Intel® oneAPI Math Kernel Library for Fortran

Download PDF

ID 766686

Date 6/24/2024

Version

Public

A newer version of this document is available. Customers should click here to go to the newest version.

Visible to Intel only — GUID: GUID-917A3B87-1503-4458-97AC-EE84F972CECC

View Details

?heevr

Computes selected eigenvalues and, optionally, eigenvectors of a Hermitian matrix using the Relatively Robust Representations.

Syntax

call cheevr(jobz, range, uplo, n, a, lda, vl, vu, il, iu, abstol, m, w, z, ldz, isuppz, work, lwork, rwork, lrwork, iwork, liwork, info)

call zheevr(jobz, range, uplo, n, a, lda, vl, vu, il, iu, abstol, m, w, z, ldz, isuppz, work, lwork, rwork, lrwork, iwork, liwork, info)

call heevr(a, w [,uplo] [,z] [,vl] [,vu] [,il] [,iu] [,m] [,isuppz] [,abstol] [,info])

Include Files

mkl.fi, lapack.f90

Description

The routine computes selected eigenvalues and, optionally, eigenvectors of a complex Hermitian matrix A. Eigenvalues and eigenvectors can be selected by specifying either a range of values or a range of indices for the desired eigenvalues.

The routine first reduces the matrix A to tridiagonal form T with a call to hetrd. Then, whenever possible, ?heevr calls stegr to compute the eigenspectrum using Relatively Robust Representations. ?stegr computes eigenvalues by the dqds algorithm, while orthogonal eigenvectors are computed from various "good" L*D*L^T representations (also known as Relatively Robust Representations). Gram-Schmidt orthogonalization is avoided as far as possible. More specifically, the various steps of the algorithm are as follows. For each unreduced block (submatrix) of T:

Compute T - σ*I = L*D*L^T, so that L and D define all the wanted eigenvalues to high relative accuracy. This means that small relative changes in the entries of D and L cause only small relative changes in the eigenvalues and eigenvectors. The standard (unfactored) representation of the tridiagonal matrix T does not have this property in general.
Compute the eigenvalues to suitable accuracy. If the eigenvectors are desired, the algorithm attains full accuracy of the computed eigenvalues only right before the corresponding vectors have to be computed, see Steps c) and d).
For each cluster of close eigenvalues, select a new shift close to the cluster, find a new factorization, and refine the shifted eigenvalues to suitable accuracy.
For each eigenvalue with a large enough relative separation, compute the corresponding eigenvector by forming a rank revealing twisted factorization. Go back to Step c) for any clusters that remain.

The desired accuracy of the output can be specified by the input parameter abstol.

The routine ?heevr calls stemr when the full spectrum is requested on machines which conform to the IEEE-754 floating point standard, or stebz and stein on non-IEEE machines and when partial spectrum requests are made.

Note that the routine ?heevr is preferable for most cases of complex Hermitian eigenvalue problems as its underlying algorithm is fast and uses less workspace.

Input Parameters

jobz

CHARACTER*1. Must be 'N' or 'V'.

If job = 'N', then only eigenvalues are computed.

If job = 'V', then eigenvalues and eigenvectors are computed.

range

CHARACTER*1. Must be 'A' or 'V' or 'I'.

If range = 'A', the routine computes all eigenvalues.

If range = 'V', the routine computes eigenvalues lambda(i) in the half-open interval: vl< lambda(i)≤vu.

If range = 'I', the routine computes eigenvalues with indices il to iu.

For range = 'V'or 'I', sstebz/dstebz and cstein/zstein are called.

uplo

CHARACTER*1. Must be 'U' or 'L'.

If uplo = 'U', a stores the upper triangular part of A.

If uplo = 'L', a stores the lower triangular part of A.

n

INTEGER. The order of the matrix A (n≥ 0).

a, work

COMPLEX for cheevr

DOUBLE COMPLEX for zheevr.

Arrays:

a(lda,*) is an array containing either upper or lower triangular part of the Hermitian matrix A, as specified by uplo.

The second dimension of a must be at least max(1, n).

work is a workspace array, its dimension max(1, lwork).

lda

INTEGER. The leading dimension of the array a.

Must be at least max(1, n).

vl, vu

REAL for cheevr

DOUBLE PRECISION for zheevr.

If range = 'V', the lower and upper bounds of the interval to be searched for eigenvalues.

Constraint: vl< vu.

If range = 'A' or 'I', vl and vu are not referenced.

il, iu

INTEGER.

If range = 'I', the indices in ascending order of the smallest and largest eigenvalues to be returned.

Constraint: 1 ≤il≤iu≤n, if n > 0; il=1 and iu=0 if n = 0.

If range = 'A' or 'V', il and iu are not referenced.

abstol

REAL for cheevr

DOUBLE PRECISION for zheevr.

The absolute error tolerance to which each eigenvalue/eigenvector is required.

If jobz = 'V', the eigenvalues and eigenvectors output have residual norms bounded by abstol, and the dot products between different eigenvectors are bounded by abstol.

If abstol < n *eps*||T||, then n *eps*||T|| is used instead, where eps is the machine precision, and ||T|| is the 1-norm of the matrix T. The eigenvalues are computed to an accuracy of eps*||T|| irrespective of abstol.

If high relative accuracy is important, set abstol to ?lamch('S').

ldz

INTEGER. The leading dimension of the output array z. Constraints:

ldz≥ 1 if jobz = 'N';

ldz≥ max(1, n) if jobz = 'V'.

lwork

INTEGER.

The dimension of the array work.

Constraint: lwork≥ max(1, 2n).

If lwork = -1, then a workspace query is assumed; the routine only calculates the optimal size of the work, rwork and iwork arrays, returns these values as the first entries of the work, rwork and iwork arrays, and no error message related to lwork or lrwork or liwork is issued by xerbla.

See Application Notes for the suggested value of lwork.

rwork

REAL for cheevr

DOUBLE PRECISION for zheevr.

Workspace array, size max(1, lwork).

lrwork

INTEGER.

The dimension of the array rwork;

lwork≥ max(1, 24n).

If lrwork = -1, then a workspace query is assumed; the routine only calculates the optimal size of the work, rwork and iwork arrays, returns these values as the first entries of the work, rwork and iwork arrays, and no error message related to lwork or lrwork or liwork is issued by xerbla.

iwork

INTEGER. Workspace array, its dimension max(1, liwork).

liwork

INTEGER.

The dimension of the array iwork,

lwork≥ max(1, 10n).

If liwork = -1, then a workspace query is assumed; the routine only calculates the optimal size of the work, rwork and iwork arrays, returns these values as the first entries of the work, rwork and iwork arrays, and no error message related to lwork or lrwork or liwork is issued by xerbla.

Output Parameters

a

On exit, the lower triangle (if uplo = 'L') or the upper triangle (if uplo = 'U') of A, including the diagonal, is overwritten.

m

INTEGER. The total number of eigenvalues found,

0 ≤m≤n.

If range = 'A', m = n, if range = 'I', m = iu-il+1, and if range = 'V' the exact value of m is not known in advance.

w

REAL for cheevr

DOUBLE PRECISION for zheevr.

Array, size at least max(1, n), contains the selected eigenvalues in ascending order, stored in w(1) to w(m).

z

COMPLEX for cheevr

DOUBLE COMPLEX for zheevr.

Array z(ldz,*), the second dimension of z must be at least max(1, m).

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 i-th column of z holding the eigenvector associated with w(i).

If jobz = 'N', then 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 must be used.

isuppz

INTEGER.

Array, size at least 2 *max(1, m).

The support of the eigenvectors in z, i.e., the indices indicating the nonzero elements in z. The i-th eigenvector is nonzero only in elements isuppz( 2i-1) through isuppz( 2i ). Referenced only if eigenvectors are needed (jobz = 'V') and all eigenvalues are needed, that is, range = 'A' or range = 'I' and il = 1 and iu = n.

work(1)

On exit, if info = 0, then work(1) returns the required minimal size of lwork.

rwork(1)

On exit, if info = 0, then rwork(1) returns the required minimal size of lrwork.

iwork(1)

On exit, if info = 0, then iwork(1) returns the required minimal size of liwork.

info

INTEGER.

If info = 0, the execution is successful.

If info = -i, the i-th parameter had an illegal value.

If info = i, an internal error has occurred.

LAPACK 95 Interface Notes

Routines in Fortran 95 interface have fewer arguments in the calling sequence than their FORTRAN 77 counterparts. For general conventions applied to skip redundant or restorable arguments, see LAPACK 95 Interface Conventions.

Specific details for the routine heevr interface are the following:

a: Holds the matrix A of size (n, n).
w: Holds the vector of length n.
z: Holds the matrix Z of size (n, n), where the values n and m are significant.
isuppz: Holds the vector of length (2*n), where the values (2*m) are significant.
uplo: Must be 'U' or 'L'. The default value is 'U'.
vl: Default value for this element is vl = -HUGE(vl).
vu: Default value for this element is vu = HUGE(vl).
il: Default value for this argument is il = 1.
iu: Default value for this argument is iu = n.
abstol: Default value for this element is abstol = 0.0_WP.
jobz: Restored based on the presence of the argument z as follows: jobz = 'V', if z is present, jobz = 'N', if z is omitted Note that there will be an error condition if isuppz is present and z is omitted.
range: Restored based on the presence of arguments vl, vu, il, iu as follows: range = 'V', if one of or both vl and vu are present, range = 'I', if one of or both il and iu are present, range = 'A', if none of vl, vu, il, iu is present, Note that there will be an error condition if one of or both vl and vu are present and at the same time one of or both il and iu are present.

Application Notes

For optimum performance use lwork≥ (nb+1)*n, where nb is the maximum of the blocksize for ?hetrd and ?unmtr returned by ilaenv.

If you are in doubt how much workspace to supply, use a generous value of lwork (or lrwork, or liwork) for the first run or set lwork = -1 (lrwork = -1, liwork = -1).

If you choose the first option and set any of admissible lwork (or lrwork, liwork) sizes, which is no less than the minimal value described, the routine completes the task, though probably not so fast as with a recommended workspace, and provides the recommended workspace in the first element of the corresponding array (work, rwork, iwork) on exit. Use this value (work(1), rwork(1), iwork(1)) for subsequent runs.

If you set lwork = -1, the routine returns immediately and provides the recommended workspace in the first element of the corresponding array (work, rwork, iwork). This operation is called a workspace query.

Note that if you set lwork (lrwork, liwork) to less than the minimal required value and not -1, the routine returns immediately with an error exit and does not provide any information on the recommended workspace.

Normal execution of ?stemr may create NaNs and infinities and hence may abort due to a floating point exception in environments which do not handle NaNs and infinities in the IEEE standard default manner.

For more details, see ?stemr and these references:

Inderjit S. Dhillon and Beresford N. Parlett: "Multiple representations to compute orthogonal eigenvectors of symmetric tridiagonal matrices," Linear Algebra and its Applications, 387(1), pp. 1-28, August 2004.
Inderjit Dhillon and Beresford Parlett: "Orthogonal Eigenvectors and Relative Gaps," SIAM Journal on Matrix Analysis and Applications, Vol. 25, 2004. Also LAPACK Working Note 154.
Inderjit Dhillon: "A new O(n^2) algorithm for the symmetric tridiagonal eigenvalue/eigenvector problem", Computer Science Division Technical Report No. UCB/CSD-97-971, UC Berkeley, May 1997.

Parent topic: Symmetric Eigenvalue Problems: LAPACK Driver Routines

Select Your Language

Using Intel.com Search

Quick Links

Recent Searches

Advanced Search

Only search in

Developer Reference for Intel® oneAPI Math Kernel Library for Fortran

?heevr

Syntax

Include Files

Description

Input Parameters

Output Parameters

LAPACK 95 Interface Notes

Application Notes