NAG CL Interface
f08yuc (ztgsen)
1
Purpose
f08yuc reorders the generalized Schur factorization of a complex matrix pair in generalized Schur form, so that a selected cluster of eigenvalues appears in the leading elements on the diagonal of the generalized Schur form. The function also, optionally, computes the reciprocal condition numbers of the cluster of eigenvalues and/or corresponding deflating subspaces.
2
Specification
void |
f08yuc (Nag_OrderType order,
Integer ijob,
Nag_Boolean wantq,
Nag_Boolean wantz,
const Nag_Boolean select[],
Integer n,
Complex a[],
Integer pda,
Complex b[],
Integer pdb,
Complex alpha[],
Complex beta[],
Complex q[],
Integer pdq,
Complex z[],
Integer pdz,
Integer *m,
double *pl,
double *pr,
double dif[],
NagError *fail) |
|
The function may be called by the names: f08yuc, nag_lapackeig_ztgsen or nag_ztgsen.
3
Description
f08yuc factorizes the generalized complex
by
matrix pair
in generalized Schur form, using a unitary equivalence transformation as
where
are also in generalized Schur form and have the selected eigenvalues as the leading diagonal elements. The leading columns of
and
are the generalized Schur vectors corresponding to the selected eigenvalues and form orthonormal subspaces for the left and right eigenspaces (deflating subspaces) of the pair
.
The pair
are in generalized Schur form if
and
are upper triangular as returned, for example, by
f08xnc, or
f08xsc with
. The diagonal elements define the generalized eigenvalues
, for
, of the pair
. The eigenvalues are given by
but are returned as the pair
in order to avoid possible overflow in computing
. Optionally, the function returns reciprocals of condition number estimates for the selected eigenvalue cluster,
and
, the right and left projection norms, and of deflating subspaces,
and
. For more information see Sections 2.4.8 and 4.11 of
Anderson et al. (1999).
If
and
are the result of a generalized Schur factorization of a matrix pair
then, optionally, the matrices
and
can be updated as
and
. Note that the condition numbers of the pair
are the same as those of the pair
.
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
5
Arguments
-
1:
– Nag_OrderType
Input
-
On entry: the
order argument specifies the two-dimensional storage scheme being used, i.e., row-major ordering or column-major ordering. C language defined storage is specified by
. See
Section 3.1.3 in the Introduction to the NAG Library CL Interface for a more detailed explanation of the use of this argument.
Constraint:
or .
-
2:
– Integer
Input
-
On entry: specifies whether condition numbers are required for the cluster of eigenvalues (
and
) or the deflating subspaces (
and
).
- Only reorder with respect to select. No extras.
- Reciprocal of norms of ‘projections’ onto left and right eigenspaces with respect to the selected cluster ( and ).
- The upper bounds on and . -norm-based estimate (stored in and respectively).
- Estimate of and . -norm-based estimate (stored in and respectively). About five times as expensive as .
- Compute pl, pr and dif as in , and . Economic version to get it all.
- Compute pl, pr and dif as in , and .
Constraint:
.
-
3:
– Nag_Boolean
Input
-
On entry: if
, update the left transformation matrix
.
If , do not update .
-
4:
– Nag_Boolean
Input
-
On entry: if
, update the right transformation matrix
.
If , do not update .
-
5:
– const Nag_Boolean
Input
-
On entry: specifies the eigenvalues in the selected cluster. To select an eigenvalue , must be set to Nag_TRUE.
-
6:
– Integer
Input
-
On entry: , the order of the matrices and .
Constraint:
.
-
7:
– Complex
Input/Output
-
Note: the dimension,
dim, of the array
a
must be at least
.
The
th element of the matrix
is stored in
- when ;
- when .
On entry: the matrix in the pair .
On exit: the updated matrix .
-
8:
– Integer
Input
-
On entry: the stride separating row or column elements (depending on the value of
order) in the array
a.
Constraint:
.
-
9:
– Complex
Input/Output
-
Note: the dimension,
dim, of the array
b
must be at least
.
The
th element of the matrix
is stored in
- when ;
- when .
On entry: the matrix , in the pair .
On exit: the updated matrix
-
10:
– Integer
Input
-
On entry: the stride separating row or column elements (depending on the value of
order) in the array
b.
Constraint:
.
-
11:
– Complex
Output
-
12:
– Complex
Output
-
On exit:
alpha and
beta contain diagonal elements of
and
, respectively, when the pair
has been reduced to generalized Schur form.
, for
, are the eigenvalues.
-
13:
– Complex
Input/Output
-
Note: the dimension,
dim, of the array
q
must be at least
- when
;
- otherwise.
The
th element of the matrix
is stored in
- when ;
- when .
On entry: if , the by matrix .
On exit: if
, the updated matrix
.
If
,
q is not referenced.
-
14:
– Integer
Input
-
On entry: the stride separating row or column elements (depending on the value of
order) in the array
q.
Constraints:
- if , ;
- otherwise .
-
15:
– Complex
Input/Output
-
Note: the dimension,
dim, of the array
z
must be at least
- when
;
- otherwise.
The
th element of the matrix
is stored in
- when ;
- when .
On entry: if , the by matrix .
On exit: if
, the updated matrix
.
If
,
z is not referenced.
-
16:
– Integer
Input
-
On entry: the stride separating row or column elements (depending on the value of
order) in the array
z.
Constraints:
- if , ;
- otherwise .
-
17:
– Integer *
Output
-
On exit: the dimension of the specified pair of left and right eigenspaces (deflating subspaces),
where
m will be in the range
.
-
18:
– double *
Output
-
19:
– double *
Output
-
On exit: if
,
or
,
pl and
pr are lower bounds on the reciprocal of the norm of ‘projections’
and
onto left and right eigenspace with respect to the selected cluster.
,
.
If or , .
If
,
or
,
pl and
pr are not referenced.
-
20:
– double
Output
-
Note: the dimension,
dim, of the array
dif
must be at least
.
On exit: if
,
and
store the estimates of
and
.
If or , and are -norm-based upper bounds on and .
If or , and are -norm-based estimates of and .
If or , and .
If
or
,
dif is not referenced.
-
21:
– NagError *
Input/Output
-
The NAG error argument (see
Section 7 in the Introduction to the NAG Library CL Interface).
6
Error Indicators and Warnings
- NE_ALLOC_FAIL
-
Dynamic memory allocation failed.
See
Section 3.1.2 in the Introduction to the NAG Library CL Interface for further information.
- NE_BAD_PARAM
-
On entry, argument had an illegal value.
- NE_CONSTRAINT
-
Constraint: if , ;
otherwise .
Constraint: if , ;
otherwise .
- NE_INT
-
On entry, .
Constraint: .
On entry, .
Constraint: .
On entry, .
Constraint: .
On entry, .
Constraint: .
On entry, .
Constraint: .
On entry, .
Constraint: .
- NE_INT_2
-
On entry, and .
Constraint: .
On entry, and .
Constraint: .
- NE_INTERNAL_ERROR
-
An internal error has occurred in this function. Check the function call and any array sizes. If the call is correct then please contact
NAG for assistance.
See
Section 7.5 in the Introduction to the NAG Library CL Interface for further information.
- NE_NO_LICENCE
-
Your licence key may have expired or may not have been installed correctly.
See
Section 8 in the Introduction to the NAG Library CL Interface for further information.
- NE_SCHUR
-
Reordering of
failed because the transformed matrix pair would be too far from generalized Schur form; the problem is very ill-conditioned.
may have been partially reordered. If requested,
is returned in
and
,
pl and
pr.
7
Accuracy
The computed generalized Schur form is nearly the exact generalized Schur form for nearby matrices
and
, where
and
is the
machine precision. See Section 4.11 of
Anderson et al. (1999) for further details of error bounds for the generalized nonsymmetric eigenproblem, and for information on the condition numbers returned.
8
Parallelism and Performance
f08yuc 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 function. Please also consult the
Users' Note for your implementation for any additional implementation-specific information.
The real analogue of this function is
f08ygc.
10
Example
This example reorders the generalized Schur factors
and
and update the matrices
and
given by
selecting the second and third generalized eigenvalues to be moved to the leading positions. Bases for the left and right deflating subspaces, and estimates of the condition numbers for the eigenvalues and Frobenius norm based bounds on the condition numbers for the deflating subspaces are also output.
10.1
Program Text
10.2
Program Data
10.3
Program Results