f08qkf (dtrevc) : NAG Library, Mark 30

2 Specification

Fortran Interface

Subroutine f08qkf (

job, howmny, select, n, t, ldt, vl, ldvl, vr, ldvr, mm, m, work, info)

Integer, Intent (In)	::	n, ldt, ldvl, ldvr, mm
Integer, Intent (Out)	::	m, info
Real (Kind=nag_wp), Intent (In)	::	t(ldt,*)
Real (Kind=nag_wp), Intent (Inout)	::	vl(ldvl,), vr(ldvr,)
Real (Kind=nag_wp), Intent (Out)	::	work(3*n)
Logical, Intent (Inout)	::	select(*)
Character (1), Intent (In)	::	job, howmny

C Header Interface

#include <nag.h>

void

f08qkf_ (const char *job, const char *howmny, logical sel[], const Integer *n, const double t[], const Integer *ldt, double vl[], const Integer *ldvl, double vr[], const Integer *ldvr, const Integer *mm, Integer *m, double work[], Integer *info, const Charlen length_job, const Charlen length_howmny)

The routine may be called by the names f08qkf, nagf_lapackeig_dtrevc or its LAPACK name dtrevc.

3 Description

f08qkf computes left and/or right eigenvectors of a real upper quasi-triangular matrix

T

in canonical Schur form. Such a matrix arises from the Schur factorization of a real general matrix, as computed by f08pef, for example.

The right eigenvector

x

, and the left eigenvector

y

, corresponding to an eigenvalue

λ

, are defined by:

T x = λ x and y^{H} T = λ y^{H} (or ​ T^{T} y = \bar{λ} y) .

Note that even though

T

is real,

λ

x

and

y

may be complex. If

x

is an eigenvector corresponding to a complex eigenvalue

λ

, then the complex conjugate vector

\bar{x}

is the eigenvector corresponding to the complex conjugate eigenvalue

\bar{λ}

The routine can compute the eigenvectors corresponding to selected eigenvalues, or it can compute all the eigenvectors. In the latter case the eigenvectors may optionally be pre-multiplied by an input matrix

Q

. Normally

Q

is an orthogonal matrix from the Schur factorization of a matrix

A

A = Q T Q^{T}

; if

x

is a (left or right) eigenvector of

T

, then

Q x

is an eigenvector of

A

The eigenvectors are computed by forward or backward substitution. They are scaled so that, for a real eigenvector

x

\max (| x_{i} |) = 1

, and for a complex eigenvector,

\max (| Re (x_{i}) | + | Im (x_{i}) |) = 1

5 Arguments

job

– Character(1) Input

On entry: indicates whether left and/or right eigenvectors are to be computed.

$job ='R'$: Only right eigenvectors are computed.
$job ='L'$: Only left eigenvectors are computed.
$job ='B'$: Both left and right eigenvectors are computed.

Constraint:

job ='R'

'L'

'B'

howmny

– Character(1) Input

On entry: indicates how many eigenvectors are to be computed.

$howmny ='A'$: All eigenvectors (as specified by job) are computed.
$howmny ='B'$: All eigenvectors (as specified by job) are computed and then pre-multiplied by the matrix $Q$ (which is overwritten).
$howmny ='S'$: Selected eigenvectors (as specified by job and select) are computed.

Constraint:

howmny ='A'

'B'

'S'

select (*)

– Logical array Input/Output

Note: the dimension of the array select must be at least

\max (1, n)

howmny ='S'

, and at least

1

otherwise.

On entry: specifies which eigenvectors are to be computed if

howmny ='S'

. To obtain the real eigenvector corresponding to the real eigenvalue

λ_{j}

select (j)

must be set .TRUE.. To select the complex eigenvector corresponding to a complex conjugate pair of eigenvalues

λ_{j}

and

λ_{j + 1}

select (j)

and/or

select (j + 1)

must be set .TRUE.; the eigenvector corresponding to the first eigenvalue in the pair is computed.

On exit: if a complex eigenvector was selected as specified above,

select (j)

is set to .TRUE. and

select (j + 1)

to .FALSE..

howmny ='A'

'B'

, select is not referenced.

n

– Integer Input

On entry:

n

, the order of the matrix

T

Constraint:

n \geq 0

t (ldt, *)

– Real (Kind=nag_wp) array Input

Note: the second dimension of the array t must be at least

\max (1, n)

On entry: the

n \times n

upper quasi-triangular matrix

T

in canonical Schur form, as returned by f08pef.

ldt

– Integer Input

On entry: the first dimension of the array t as declared in the (sub)program from which f08qkf is called.

Constraint:

ldt \geq \max (1, n)

vl (ldvl, *)

– Real (Kind=nag_wp) array Input/Output

Note: the second dimension of the array vl must be at least

\max (1, mm)

job ='L'

'B'

On entry: if

howmny ='B'

and

job ='L'

'B'

, vl must contain an

n \times n

matrix

Q

(usually the matrix of Schur vectors returned by f08pef).

howmny ='A'

'S'

, vl need not be set.

On exit: if

job ='L'

'B'

, vl contains the computed left eigenvectors (as specified by howmny and select). The eigenvectors are stored consecutively in the columns of the array, in the same order as their eigenvalues. Corresponding to each real eigenvalue is a real eigenvector, occupying one column. Corresponding to each complex conjugate pair of eigenvalues, is a complex eigenvector occupying two columns; the first column holds the real part and the second column holds the imaginary part.

job ='R'

, vl is not referenced.

ldvl

– Integer Input

On entry: the first dimension of the array vl as declared in the (sub)program from which f08qkf is called.

Constraints:

if $job ='L'$ or $'B'$ , $ldvl \geq n$ ;
if $job ='R'$ , $ldvl \geq 1$ .

vr (ldvr, *)

– Real (Kind=nag_wp) array Input/Output

Note: the second dimension of the array vr must be at least

\max (1, mm)

job ='R'

'B'

On entry: if

howmny ='B'

and

job ='R'

'B'

, vr must contain an

n \times n

matrix

Q

(usually the matrix of Schur vectors returned by f08pef).

howmny ='A'

'S'

, vr need not be set.

On exit: if

job ='R'

'B'

, vr contains the computed right eigenvectors (as specified by howmny and select). The eigenvectors are stored consecutively in the columns of the array, in the same order as their eigenvalues. Corresponding to each real eigenvalue is a real eigenvector, occupying one column. Corresponding to each complex conjugate pair of eigenvalues, is a complex eigenvector occupying two columns; the first column holds the real part and the second column holds the imaginary part.

job ='L'

, vr is not referenced.

10:

ldvr

– Integer Input

On entry: the first dimension of the array vr as declared in the (sub)program from which f08qkf is called.

Constraints:

if $job ='R'$ or $'B'$ , $ldvr \geq n$ ;
if $job ='L'$ , $ldvr \geq 1$ .

11:

mm

– Integer Input

On entry: the number of columns in the arrays vl and/or vr. The precise number of columns required,

m

, is

n

howmny ='A'

'B'

; if

howmny ='S'

m

is obtained by counting

1

for each selected real eigenvector and

2

for each selected complex eigenvector (see select), in which case

0 \leq m \leq n

Constraints:

if $howmny ='A'$ or $'B'$ , $mm \geq n$ ;
otherwise $mm \geq m$ .

12:

m

– Integer Output

On exit:

m

, the number of columns of vl and/or vr actually used to store the computed eigenvectors. If

howmny ='A'

'B'

, m is set to

n

13:

work (3 \times n)

– Real (Kind=nag_wp) array Workspace

14:

info

– Integer Output

On exit:

info = 0

unless the routine detects an error (see Section 6).

7 Accuracy

x_{i}

is an exact right eigenvector, and

{\tilde{x}}_{i}

is the corresponding computed eigenvector, then the angle

θ ({\tilde{x}}_{i}, x_{i})

between them is bounded as follows:

θ ({\tilde{x}}_{i}, x_{i}) \leq \frac{c (n) ε {‖ T ‖}_{2}}{{sep}_{i}}

where

{sep}_{i}

is the reciprocal condition number of

x_{i}

The condition number

{sep}_{i}

may be computed by calling f08qlf.

8 Parallelism and Performance

Background information to multithreading can be found in the Multithreading documentation.

f08qkf 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.

NAG FL Interface
f08qkf (dtrevc)

▸▿ Contents

1 Purpose

2 Specification

3 Description

4 References

5 Arguments

6 Error Indicators and Warnings

7 Accuracy

8 Parallelism and Performance

9 Further Comments

10 Example

NAG FL Interfacef08qkf (dtrevc)

▸▿ Contents

1 Purpose

2 Specification

3 Description

4 References

5 Arguments

6 Error Indicators and Warnings

7 Accuracy

8 Parallelism and Performance

9 Further Comments

10 Example

NAG FL Interface
f08qkf (dtrevc)