NAG Library Routine Document
f08nnf
(zgeev)
1
Purpose
f08nnf (zgeev) computes the eigenvalues and, optionally, the left and/or right eigenvectors for an by complex nonsymmetric matrix .
2
Specification
Fortran Interface
Subroutine f08nnf ( |
jobvl,
jobvr,
n,
a,
lda,
w,
vl,
ldvl,
vr,
ldvr,
work,
lwork,
rwork,
info) |
Integer, Intent (In) | :: |
n,
lda,
ldvl,
ldvr,
lwork | Integer, Intent (Out) | :: |
info | Real (Kind=nag_wp), Intent (Inout) | :: |
rwork(*) | Complex (Kind=nag_wp), Intent (Inout) | :: |
a(lda,*),
w(*),
vl(ldvl,*),
vr(ldvr,*) | Complex (Kind=nag_wp), Intent (Out) | :: |
work(max(1,lwork)) | Character (1), Intent (In) | :: |
jobvl,
jobvr |
|
C Header Interface
#include nagmk26.h
void |
f08nnf_ (
const char *jobvl,
const char *jobvr,
const Integer *n,
Complex a[],
const Integer *lda,
Complex w[],
Complex vl[],
const Integer *ldvl,
Complex vr[],
const Integer *ldvr,
Complex work[],
const Integer *lwork,
double rwork[],
Integer *info,
const Charlen length_jobvl,
const Charlen length_jobvr) |
|
The routine may be called by its
LAPACK
name zgeev.
3
Description
The right eigenvector
of
satisfies
where
is the
th eigenvalue of
. The left eigenvector
of
satisfies
where
denotes the conjugate transpose of
.
The matrix is first reduced to upper Hessenberg form by means of unitary similarity transformations, and the algorithm is then used to further reduce the matrix to upper triangular Schur form, , from which the eigenvalues are computed. Optionally, the eigenvectors of are also computed and backtransformed to those of .
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: if
, the left eigenvectors of
are not computed.
If , the left eigenvectors of are computed.
Constraint:
or .
- 2: – Character(1)Input
-
On entry: if
, the right eigenvectors of
are not computed.
If , the right eigenvectors of are computed.
Constraint:
or .
- 3: – IntegerInput
-
On entry: , the order of the matrix .
Constraint:
.
- 4: – Complex (Kind=nag_wp) arrayInput/Output
-
Note: the second dimension of the array
a
must be at least
.
On entry: the by matrix .
On exit:
a has been overwritten.
- 5: – IntegerInput
-
On entry: the first dimension of the array
a as declared in the (sub)program from which
f08nnf (zgeev) is called.
Constraint:
.
- 6: – Complex (Kind=nag_wp) arrayOutput
-
Note: the dimension of the array
w
must be at least
.
On exit: contains the computed eigenvalues.
- 7: – Complex (Kind=nag_wp) arrayOutput
-
Note: the second dimension of the array
vl
must be at least
if
, and at least
otherwise.
On exit: if
, the left eigenvectors
are stored one after another in the columns of
vl, in the same order as their corresponding eigenvalues; that is
, the
th column of
vl.
If
,
vl is not referenced.
- 8: – IntegerInput
-
On entry: the first dimension of the array
vl as declared in the (sub)program from which
f08nnf (zgeev) is called.
Constraints:
- if , ;
- otherwise .
- 9: – Complex (Kind=nag_wp) arrayOutput
-
Note: the second dimension of the array
vr
must be at least
if
, and at least
otherwise.
On exit: if
, the right eigenvectors
are stored one after another in the columns of
vr, in the same order as their corresponding eigenvalues; that is
, the
th column of
vr.
If
,
vr is not referenced.
- 10: – IntegerInput
-
On entry: the first dimension of the array
vr as declared in the (sub)program from which
f08nnf (zgeev) is called.
Constraints:
- if , ;
- otherwise .
- 11: – Complex (Kind=nag_wp) arrayWorkspace
-
On exit: if
, the real part of
contains the minimum value of
lwork required for optimal performance.
- 12: – IntegerInput
-
On entry: the dimension of the array
work as declared in the (sub)program from which
f08nnf (zgeev) is called.
If
, 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 should be generally larger than the minimum, say
, where
is the optimal
block size for
f08nsf (zgehrd).
Constraint:
.
- 13: – Real (Kind=nag_wp) arrayWorkspace
-
Note: the dimension of the array
rwork
must be at least
.
- 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
, the
algorithm failed to compute all the eigenvalues, and no eigenvectors have been computed; elements
of
w contain eigenvalues which have converged.
7
Accuracy
The computed eigenvalues and eigenvectors are exact for a nearby matrix
, where
and
is the
machine precision. See Section 4.8 of
Anderson et al. (1999) for further details.
8
Parallelism and Performance
f08nnf (zgeev) is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.
f08nnf (zgeev) 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.
Each eigenvector is normalized to have Euclidean norm equal to unity and the element of largest absolute value real.
The total number of floating-point operations is proportional to .
The real analogue of this routine is
f08naf (dgeev).
10
Example
This example finds all the eigenvalues and right eigenvectors of the matrix
Note that the block size (NB) of assumed in this example is not realistic for such a small problem, but should be suitable for large problems.
10.1
Program Text
Program Text (f08nnfe.f90)
10.2
Program Data
Program Data (f08nnfe.d)
10.3
Program Results
Program Results (f08nnfe.r)