NAG FL Interface
f08pnf (zgees)
1
Purpose
f08pnf computes the eigenvalues, the Schur form , and, optionally, the matrix of Schur vectors for an by complex nonsymmetric matrix .
2
Specification
Fortran Interface
Subroutine f08pnf ( |
jobvs, sort, select, n, a, lda, sdim, w, vs, ldvs, work, lwork, rwork, bwork, info) |
Integer, Intent (In) |
:: |
n, lda, ldvs, lwork |
Integer, Intent (Out) |
:: |
sdim, info |
Real (Kind=nag_wp), Intent (Inout) |
:: |
rwork(*) |
Complex (Kind=nag_wp), Intent (Inout) |
:: |
a(lda,*), w(*), vs(ldvs,*) |
Complex (Kind=nag_wp), Intent (Out) |
:: |
work(max(1,lwork)) |
Logical, External |
:: |
select |
Logical, Intent (Inout) |
:: |
bwork(*) |
Character (1), Intent (In) |
:: |
jobvs, sort |
|
C Header Interface
#include <nag.h>
void |
f08pnf_ (const char *jobvs, const char *sort, logical (NAG_CALL *sel)(const Complex *w), const Integer *n, Complex a[], const Integer *lda, Integer *sdim, Complex w[], Complex vs[], const Integer *ldvs, Complex work[], const Integer *lwork, double rwork[], logical bwork[], Integer *info, const Charlen length_jobvs, const Charlen length_sort) |
|
C++ Header Interface
#include <nag.h> extern "C" {
void |
f08pnf_ (const char *jobvs, const char *sort, logical (NAG_CALL *sel)(const Complex &w), const Integer &n, Complex a[], const Integer &lda, Integer &sdim, Complex w[], Complex vs[], const Integer &ldvs, Complex work[], const Integer &lwork, double rwork[], logical bwork[], Integer &info, const Charlen length_jobvs, const Charlen length_sort) |
}
|
The routine may be called by the names f08pnf, nagf_lapackeig_zgees or its LAPACK name zgees.
3
Description
The Schur factorization of
is given by
where
, the matrix of Schur vectors, is unitary and
is the Schur form. A complex matrix is in Schur form if it is upper triangular.
Optionally, f08pnf also orders the eigenvalues on the diagonal of the Schur form so that selected eigenvalues are at the top left. The leading columns of form an orthonormal basis for the invariant subspace corresponding to the selected eigenvalues.
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
https://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
, Schur vectors are not computed.
If , Schur vectors are computed.
Constraint:
or .
-
2:
– Character(1)
Input
-
On entry: specifies whether or not to order the eigenvalues on the diagonal of the Schur form.
- Eigenvalues are not ordered.
- Eigenvalues are ordered (see select).
Constraint:
or .
-
3:
– Logical Function, supplied by the user.
External Procedure
-
If
,
select is used to select eigenvalues to sort to the top left of the Schur form.
If
,
select is not referenced and
f08pnf may be called with the dummy function
f08pnz.
An eigenvalue is selected if is .TRUE..
The specification of
select is:
Fortran Interface
Logical |
:: |
select |
Complex (Kind=nag_wp), Intent (In) |
:: |
w |
|
C Header Interface
Nag_Boolean |
select_ (const Complex *w) |
|
C++ Header Interface
#include <nag.h> extern "C" {
Nag_Boolean |
select_ (const Complex &w) |
}
|
-
1:
– Complex (Kind=nag_wp)
Input
-
On entry: the real and imaginary parts of the eigenvalue.
select must either be a module subprogram USEd by, or declared as EXTERNAL in, the (sub)program from which
f08pnf is called. Arguments denoted as
Input must
not be changed by this procedure.
-
4:
– Integer
Input
-
On entry: , the order of the matrix .
Constraint:
.
-
5:
– Complex (Kind=nag_wp) array
Input/Output
-
Note: the second dimension of the array
a
must be at least
.
On entry: the by matrix .
On exit:
a is overwritten by its Schur form
.
-
6:
– Integer
Input
-
On entry: the first dimension of the array
a as declared in the (sub)program from which
f08pnf is called.
Constraint:
.
-
7:
– Integer
Output
-
On exit: if
,
.
If
,
number of eigenvalues for which
select is .TRUE..
-
8:
– Complex (Kind=nag_wp) array
Output
-
Note: the dimension of the array
w
must be at least
.
On exit: contains the computed eigenvalues, in the same order that they appear on the diagonal of the output Schur form .
-
9:
– Complex (Kind=nag_wp) array
Output
-
Note: the second dimension of the array
vs
must be at least
if
, and at least
otherwise.
On exit: if
,
vs contains the unitary matrix
of Schur vectors.
If
,
vs is not referenced.
-
10:
– Integer
Input
-
On entry: the first dimension of the array
vs as declared in the (sub)program from which
f08pnf is called.
Constraints:
- if , ;
- otherwise .
-
11:
– Complex (Kind=nag_wp) array
Workspace
-
On exit: if
, the real part of
contains the minimum value of
lwork required for optimal performance.
-
12:
– Integer
Input
-
On entry: the dimension of the array
work as declared in the (sub)program from which
f08pnf 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, say
, where
is the optimal
block size for
f08nsf.
Constraint:
.
-
13:
– Real (Kind=nag_wp) array
Workspace
-
Note: the dimension of the array
rwork
must be at least
.
-
14:
– Logical array
Workspace
-
Note: the dimension of the array
bwork
must be at least
if
, and at least
otherwise.
If
,
bwork is not referenced.
-
15:
– Integer
Output
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.
-
The algorithm failed to compute all the eigenvalues.
-
The eigenvalues could not be reordered because some eigenvalues were too close to separate (the problem is very ill-conditioned).
-
After reordering, roundoff changed values of some complex eigenvalues so that leading eigenvalues in the Schur form no longer satisfy . This could also be caused by underflow due to scaling.
7
Accuracy
The computed Schur factorization satisfies
where
and
is the
machine precision. See Section 4.8 of
Anderson et al. (1999) for further details.
8
Parallelism and Performance
f08pnf is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.
f08pnf 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.
The total number of floating-point operations is proportional to .
The real analogue of this routine is
f08paf.
10
Example
This example finds the Schur factorization 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
10.2
Program Data
10.3
Program Results