NAG Library Routine Document
f08npf
(zgeevx)
1
Purpose
f08npf (zgeevx) computes the eigenvalues and, optionally, the left and/or right eigenvectors for an by complex nonsymmetric matrix .
Optionally, it also computes a balancing transformation to improve the conditioning of the eigenvalues and eigenvectors, reciprocal condition numbers for the eigenvalues, and reciprocal condition numbers for the right eigenvectors.
2
Specification
Fortran Interface
Subroutine f08npf ( |
balanc,
jobvl,
jobvr,
sense,
n,
a,
lda,
w,
vl,
ldvl,
vr,
ldvr,
ilo,
ihi,
scale,
abnrm,
rconde,
rcondv,
work,
lwork,
rwork,
info) |
Integer, Intent (In) | :: |
n,
lda,
ldvl,
ldvr,
lwork | Integer, Intent (Out) | :: |
ilo,
ihi,
info | Real (Kind=nag_wp), Intent (Inout) | :: |
scale(*),
rconde(*),
rcondv(*),
rwork(*) | Real (Kind=nag_wp), Intent (Out) | :: |
abnrm | 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) | :: |
balanc,
jobvl,
jobvr,
sense |
|
C Header Interface
#include nagmk26.h
void |
f08npf_ (
const char *balanc,
const char *jobvl,
const char *jobvr,
const char *sense,
const Integer *n,
Complex a[],
const Integer *lda,
Complex w[],
Complex vl[],
const Integer *ldvl,
Complex vr[],
const Integer *ldvr,
Integer *ilo,
Integer *ihi,
double scal[],
double *abnrm,
double rconde[],
double rcondv[],
Complex work[],
const Integer *lwork,
double rwork[],
Integer *info,
const Charlen length_balanc,
const Charlen length_jobvl,
const Charlen length_jobvr,
const Charlen length_sense) |
|
The routine may be called by its
LAPACK
name zgeevx.
3
Description
The right eigenvector
of
satisfies
where
is the
th eigenvalue of
. The left eigenvector
of
satisfies
where
denotes the conjugate transpose of
.
Balancing a matrix means permuting the rows and columns to make it more nearly upper triangular, and applying a diagonal similarity transformation
, where
is a diagonal matrix, with the aim of making its rows and columns closer in norm and the condition numbers of its eigenvalues and eigenvectors smaller. The computed reciprocal condition numbers correspond to the balanced matrix. Permuting rows and columns will not change the condition numbers (in exact arithmetic) but diagonal scaling will. For further explanation of balancing, see Section 4.8.1.2 of
Anderson et al. (1999).
Following the optional balancing, 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: indicates how the input matrix should be diagonally scaled and/or permuted to improve the conditioning of its eigenvalues.
- Do not diagonally scale or permute.
- Perform permutations to make the matrix more nearly upper triangular. Do not diagonally scale.
- Diagonally scale the matrix, i.e., replace by , where is a diagonal matrix chosen to make the rows and columns of more equal in norm. Do not permute.
- Both diagonally scale and permute .
Computed reciprocal condition numbers will be for the matrix after balancing and/or permuting. Permuting does not change condition numbers (in exact arithmetic), but balancing does.
Constraint:
, , or .
- 2: – Character(1)Input
-
On entry: if
, the left eigenvectors of
are not computed.
If , the left eigenvectors of are computed.
If
or
,
jobvl must be set to
.
Constraint:
or .
- 3: – Character(1)Input
-
On entry: if
, the right eigenvectors of
are not computed.
If , the right eigenvectors of are computed.
If
or
,
jobvr must be set to
.
Constraint:
or .
- 4: – Character(1)Input
-
On entry: determines which reciprocal condition numbers are computed.
- None are computed.
- Computed for eigenvalues only.
- Computed for right eigenvectors only.
- Computed for eigenvalues and right eigenvectors.
If or , both left and right eigenvectors must also be computed ( and ).
Constraint:
, , or .
- 5: – IntegerInput
-
On entry: , the order of the matrix .
Constraint:
.
- 6: – 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. If
or
,
contains the Schur form of the balanced version of the matrix
.
- 7: – IntegerInput
-
On entry: the first dimension of the array
a as declared in the (sub)program from which
f08npf (zgeevx) is called.
Constraint:
.
- 8: – Complex (Kind=nag_wp) arrayOutput
-
Note: the dimension of the array
w
must be at least
.
On exit: contains the computed eigenvalues.
- 9: – 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.
- 10: – IntegerInput
-
On entry: the first dimension of the array
vl as declared in the (sub)program from which
f08npf (zgeevx) is called.
Constraints:
- if , ;
- otherwise .
- 11: – 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.
- 12: – IntegerInput
-
On entry: the first dimension of the array
vr as declared in the (sub)program from which
f08npf (zgeevx) is called.
Constraints:
- if , ;
- otherwise .
- 13: – IntegerOutput
- 14: – IntegerOutput
-
On exit:
ilo and
ihi are integer values determined when
was balanced. The balanced
has
if
and
or
.
- 15: – Real (Kind=nag_wp) arrayOutput
-
Note: the dimension of the array
scale
must be at least
.
On exit: details of the permutations and scaling factors applied when balancing
.
If
is the index of the row and column interchanged with row and column
, and
is the scaling factor applied to row and column
, then
- , for ;
- , for ;
- , for .
The order in which the interchanges are made is
n to
, then
to
.
- 16: – Real (Kind=nag_wp)Output
-
On exit: the -norm of the balanced matrix (the maximum of the sum of absolute values of elements of any column).
- 17: – Real (Kind=nag_wp) arrayOutput
-
Note: the dimension of the array
rconde
must be at least
.
On exit: is the reciprocal condition number of the th eigenvalue.
- 18: – Real (Kind=nag_wp) arrayOutput
-
Note: the dimension of the array
rcondv
must be at least
.
On exit: is the reciprocal condition number of the th right eigenvector.
- 19: – Complex (Kind=nag_wp) arrayWorkspace
-
On exit: if
, the real part of
contains the minimum value of
lwork required for optimal performance.
- 20: – IntegerInput
-
On entry: the dimension of the array
work as declared in the (sub)program from which
f08npf (zgeevx) 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 must generally be larger than the minimum, increase
lwork by, say,
, where
is the optimal
block size for
f08nef (dgehrd).
Constraints:
- if or , ;
- if or , .
- 21: – Real (Kind=nag_wp) arrayWorkspace
-
Note: the dimension of the array
rwork
must be at least
.
- 22: – 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 or condition numbers have been computed; elements
and
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
f08npf (zgeevx) is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.
f08npf (zgeevx) 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
f08nbf (dgeevx).
10
Example
This example finds all the eigenvalues and right eigenvectors of the matrix
together with estimates of the condition number and forward error bounds for each eigenvalue and eigenvector. The option to balance the matrix is used. In order to compute the condition numbers of the eigenvalues, the left eigenvectors also have to be computed, but they are not printed out in this example.
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 (f08npfe.f90)
10.2
Program Data
Program Data (f08npfe.d)
10.3
Program Results
Program Results (f08npfe.r)