Developer Reference for Intel® oneAPI Math Kernel Library for Fortran

ID 766686
Date 3/22/2024
Public

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

Document Table of Contents

?geev

Computes the eigenvalues and left and right eigenvectors of a general matrix.

Syntax

call sgeev(jobvl, jobvr, n, a, lda, wr, wi, vl, ldvl, vr, ldvr, work, lwork, info)

call dgeev(jobvl, jobvr, n, a, lda, wr, wi, vl, ldvl, vr, ldvr, work, lwork, info)

call cgeev(jobvl, jobvr, n, a, lda, w, vl, ldvl, vr, ldvr, work, lwork, rwork, info)

call zgeev(jobvl, jobvr, n, a, lda, w, vl, ldvl, vr, ldvr, work, lwork, rwork, info)

call geev(a, wr, wi [,vl] [,vr] [,info])

call geev(a, w [,vl] [,vr] [,info])

Include Files

  • mkl.fi, lapack.f90

Description

The routine computes for an n-by-n real/complex nonsymmetric matrix A, the eigenvalues and, optionally, the left and/or right eigenvectors. The right eigenvector v of A satisfies

A*v = λ*v

where λ is its eigenvalue.

The left eigenvector u of A satisfies

uH*A = λ*uH

where uH denotes the conjugate transpose of u. The computed eigenvectors are normalized to have Euclidean norm equal to 1 and largest component real.

Input Parameters

jobvl

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

If jobvl = 'N', then left eigenvectors of A are not computed.

If jobvl = 'V', then left eigenvectors of A are computed.

jobvr

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

If jobvr = 'N', then right eigenvectors of A are not computed.

If jobvr = 'V', then right eigenvectors of A are computed.

n

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

a, work

REAL for sgeev

DOUBLE PRECISION for dgeev

COMPLEX for cgeev

DOUBLE COMPLEX for zgeev.

Arrays:

a(lda,*) is an array containing the n-by-n matrix A.

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

ldvl, ldvr

INTEGER. The leading dimensions of the output arrays vl and vr, respectively.

Constraints:

ldvl 1; ldvr 1.

If jobvl = 'V', ldvl max(1, n);

If jobvr = 'V', ldvr max(1, n).

lwork

INTEGER.

The dimension of the array work.

Constraint for real flavors:

lwork max(1, 3n). If computing eigenvectors (jobvl = 'V' or jobvr = 'V'), lwork max(1, 4n).

Constraint for complex flavors:

lwork max(1, 2n).

For good performance, lwork must generally be larger.

If lwork = -1, then 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 by xerbla.

rwork

REAL for cgeev

DOUBLE PRECISION for zgeev

Workspace array, size at least max(1, 2n). Used in complex flavors only.

Output Parameters

a

On exit, this array is overwritten.

wr, wi

REAL for sgeev

DOUBLE PRECISION for dgeev

Arrays, size at least max (1, n) each.

Contain the real and imaginary parts, respectively, of the computed eigenvalues. Complex conjugate pairs of eigenvalues appear consecutively with the eigenvalue having positive imaginary part first.

w

COMPLEX for cgeev

DOUBLE COMPLEX for zgeev.

Array, size at least max(1, n).

Contains the computed eigenvalues.

vl, vr

REAL for sgeev

DOUBLE PRECISION for dgeev

COMPLEX for cgeev

DOUBLE COMPLEX for zgeev.

Arrays:

vl(ldvl,*); the second dimension of vl must be at least max(1, n).

If jobvl = 'N', vl is not referenced.

For real flavors:

If the j-th eigenvalue is real, then uj = vl(:,j), the j-th column of vl.

If the j-th and (j+1)-st eigenvalues form a complex conjugate pair, then for i = sqrt(-1), uj = vl(:,j) + i*vl(:,j+1) and uj + 1 = vl(:,j)- i*vl(:,j+1).

For complex flavors:

uj = vl(:,j), the j-th column of vl.

vr(ldvr,*); the second dimension of vr must be at least max(1, n).

If jobvr = 'N', vr is not referenced.

For real flavors:

If the j-th eigenvalue is real, then vj = vr(:,j), the j-th column of vr.

If the j-th and (j+1)-st eigenvalues form a complex conjugate pair, then for i = sqrt(-1), vj = vr(:,j) + i*vr(:,j+1) and vj + 1 = vr(:,j) - i*vr(:,j+1).

For complex flavors:

vj = vr(:,j), the j-th column of vr.

work(1)

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

info

INTEGER.

If info = 0, the execution is successful.

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

If info = i, the QR algorithm failed to compute all the eigenvalues, and no eigenvectors have been computed; elements i+1:n of wr and wi (for real flavors) or w (for complex flavors) contain those eigenvalues which have converged.

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 geev interface are the following:

a

Holds the matrix A of size (n, n).

wr

Holds the vector of length n. Used in real flavors only.

wi

Holds the vector of length n. Used in real flavors only.

w

Holds the vector of length n. Used in complex flavors only.

vl

Holds the matrix VL of size (n, n).

vr

Holds the matrix VR of size (n, n).

jobvl

Restored based on the presence of the argument vl as follows:

jobvl = 'V', if vl is present,

jobvl = 'N', if vl is omitted.

jobvr

Restored based on the presence of the argument vr as follows:

jobvr = 'V', if vr is present,

jobvr = 'N', if vr is omitted.

Application Notes

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

If you choose the first option and set any of admissible lwork 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 on exit. Use this value (work(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). This operation is called a workspace query.

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