NAG C Library Function Document
nag_dtrsen (f08qgc)
1
Purpose
nag_dtrsen (f08qgc) reorders the Schur factorization of a real general matrix so that a selected cluster of eigenvalues appears in the leading elements or blocks on the diagonal of the Schur form. The function also optionally computes the reciprocal condition numbers of the cluster of eigenvalues and/or the invariant subspace.
2
Specification
#include <nag.h> |
#include <nagf08.h> |
void |
nag_dtrsen (Nag_OrderType order,
Nag_JobType job,
Nag_ComputeQType compq,
const Nag_Boolean select[],
Integer n,
double t[],
Integer pdt,
double q[],
Integer pdq,
double wr[],
double wi[],
Integer *m,
double *s,
double *sep,
NagError *fail) |
|
3
Description
nag_dtrsen (f08qgc) reorders the Schur factorization of a real general matrix , so that a selected cluster of eigenvalues appears in the leading diagonal elements or blocks of the Schur form.
The reordered Schur form is computed by an orthogonal similarity transformation: . Optionally the updated matrix of Schur vectors is computed as , giving .
Let , where the selected eigenvalues are precisely the eigenvalues of the leading by sub-matrix . Let be correspondingly partitioned as where consists of the first columns of . Then , and so the columns of form an orthonormal basis for the invariant subspace corresponding to the selected cluster of eigenvalues.
Optionally the function also computes estimates of the reciprocal condition numbers of the average of the cluster of eigenvalues and of the invariant subspace.
4
References
Golub G H and Van Loan C F (1996) Matrix Computations (3rd Edition) Johns Hopkins University Press, Baltimore
5
Arguments
- 1:
– Nag_OrderTypeInput
-
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.3.1.3 in How to Use the NAG Library and its Documentation for a more detailed explanation of the use of this argument.
Constraint:
or .
- 2:
– Nag_JobTypeInput
-
On entry: indicates whether condition numbers are required for the cluster of eigenvalues and/or the invariant subspace.
- No condition numbers are required.
- Only the condition number for the cluster of eigenvalues is computed.
- Only the condition number for the invariant subspace is computed.
- Condition numbers for both the cluster of eigenvalues and the invariant subspace are computed.
Constraint:
, , or .
- 3:
– Nag_ComputeQTypeInput
-
On entry: indicates whether the matrix
of Schur vectors is to be updated.
- The matrix of Schur vectors is updated.
- No Schur vectors are updated.
Constraint:
or .
- 4:
– const Nag_BooleanInput
-
Note: the dimension,
dim, of the array
select
must be at least
.
On entry: the eigenvalues in the selected cluster. To select a real eigenvalue
,
must be set Nag_TRUE. To select a complex conjugate pair of eigenvalues
and
(corresponding to a
by
diagonal block),
and/or
must be set to Nag_TRUE. A complex conjugate pair of eigenvalues
must be either both included in the cluster or both excluded. See also
Section 9.
- 5:
– IntegerInput
-
On entry: , the order of the matrix .
Constraint:
.
- 6:
– doubleInput/Output
-
Note: the dimension,
dim, of the array
t
must be at least
.
The
th element of the matrix
is stored in
- when ;
- when .
On entry: the
by
upper quasi-triangular matrix
in canonical Schur form, as returned by
nag_dhseqr (f08pec). See also
Section 9.
On exit:
t is overwritten by the updated matrix
.
- 7:
– IntegerInput
-
On entry: the stride separating row or column elements (depending on the value of
order) in the array
t.
Constraint:
.
- 8:
– doubleInput/Output
-
Note: the dimension,
dim, of the array
q
must be at least
- when
;
- when
.
The
th element of the matrix
is stored in
- when ;
- when .
On entry: if
,
q must contain the
by
orthogonal matrix
of Schur vectors, as returned by
nag_dhseqr (f08pec).
On exit: if
,
q contains the updated matrix of Schur vectors; the first
columns of
form an orthonormal basis for the specified invariant subspace.
If
,
q is not referenced.
- 9:
– IntegerInput
-
On entry: the stride separating row or column elements (depending on the value of
order) in the array
q.
Constraints:
- if , ;
- if , .
- 10:
– doubleOutput
- 11:
– doubleOutput
-
Note: the dimension,
dim, of the arrays
wr and
wi
must be at least
.
On exit: the real and imaginary parts, respectively, of the reordered eigenvalues of
. The eigenvalues are stored in the same order as on the diagonal of
; see
Section 9 for details. Note that if a complex eigenvalue is sufficiently ill-conditioned, then its value may differ significantly from its value before reordering.
- 12:
– Integer *Output
-
On exit:
, the dimension of the specified invariant subspace. The value of
is obtained by counting
for each selected real eigenvalue and
for each selected complex conjugate pair of eigenvalues (see
select);
.
- 13:
– double *Output
-
On exit: if
or
,
s is a lower bound on the reciprocal condition number of the average of the selected cluster of eigenvalues. If
,
; if
NE_REORDER (see
Section 6),
s is set to zero.
If
or
,
s is not referenced.
- 14:
– double *Output
-
On exit: if
or
,
sep is the estimated reciprocal condition number of the specified invariant subspace. If
,
; if
NE_REORDER (see
Section 6),
sep is set to zero.
If
or
,
sep is not referenced.
- 15:
– NagError *Input/Output
-
The NAG error argument (see
Section 3.7 in How to Use the NAG Library and its Documentation).
6
Error Indicators and Warnings
- NE_ALLOC_FAIL
-
Dynamic memory allocation failed.
See
Section 2.3.1.2 in How to Use the NAG Library and its Documentation for further information.
- NE_BAD_PARAM
-
On entry, argument had an illegal value.
- NE_ENUM_INT_2
-
On entry, , and .
Constraint: if , ;
if , .
- NE_INT
-
On entry, .
Constraint: .
On entry, .
Constraint: .
On entry, .
Constraint: .
- NE_INT_2
-
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 2.7.6 in How to Use the NAG Library and its Documentation for further information.
- NE_NO_LICENCE
-
Your licence key may have expired or may not have been installed correctly.
See
Section 2.7.5 in How to Use the NAG Library and its Documentation for further information.
- NE_REORDER
-
The reordering of failed because a selected eigenvalue was too close to an unselected eigenvalue.
The reordering of
failed because a selected eigenvalue was too close to an eigenvalue which was not selected; this error exit can only occur if at least one of the eigenvalues involved was complex. The problem is too ill-conditioned: consider modifying the selection of eigenvalues so that eigenvalues which are very close together are either all included in the cluster or all excluded. On exit,
may have been partially reordered, but
wr,
wi and
(if requested) are updated consistently with
;
s and
sep (if requested) are both set to zero.
7
Accuracy
The computed matrix
is similar to a matrix
, where
and
is the
machine precision.
s cannot underestimate the true reciprocal condition number by more than a factor of
.
sep may differ from the true value by
. The angle between the computed invariant subspace and the true subspace is
.
Note that if a by diagonal block is involved in the reordering, its off-diagonal elements are in general changed; the diagonal elements and the eigenvalues of the block are unchanged unless the block is sufficiently ill-conditioned, in which case they may be noticeably altered. It is possible for a by block to break into two by blocks, i.e., for a pair of complex eigenvalues to become purely real. The values of real eigenvalues however are never changed by the reordering.
8
Parallelism and Performance
nag_dtrsen (f08qgc) 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 input matrix must be in canonical Schur form, as is the output matrix . This has the following structure.
If all the computed eigenvalues are real, is upper triangular, and the diagonal elements of are the eigenvalues; , for and .
If some of the computed eigenvalues form complex conjugate pairs, then
has
by
diagonal blocks. Each diagonal block has the form
where
. The corresponding eigenvalues are
;
;
;
.
The complex analogue of this function is
nag_ztrsen (f08quc).
10
Example
This example reorders the Schur factorization of the matrix
such that the two real eigenvalues appear as the leading elements on the diagonal of the reordered matrix
, where
and
The example program for nag_dtrsen (f08qgc) illustrates the computation of error bounds for the eigenvalues.
The original matrix
is given in
Section 10 in
nag_dorghr (f08nfc).
10.1
Program Text
Program Text (f08qgce.c)
10.2
Program Data
Program Data (f08qgce.d)
10.3
Program Results
Program Results (f08qgce.r)