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 f08nbf (

balanc, jobvl, jobvr, sense, n, a, lda, wr, wi, vl, ldvl, vr, ldvr, ilo, ihi, scale, abnrm, rconde, rcondv, work, lwork, iwork, info)

Integer, Intent (In)	::	n, lda, ldvl, ldvr, lwork
Integer, Intent (Inout)	::	iwork(*)
Integer, Intent (Out)	::	ilo, ihi, info
Real (Kind=nag_wp), Intent (Inout)	::	a(lda,), wr(), wi(), vl(ldvl,), vr(ldvr,), scale(), rconde(), rcondv()
Real (Kind=nag_wp), Intent (Out)	::	abnrm, work(max(1,lwork))
Character (1), Intent (In)	::	balanc, jobvl, jobvr, sense

C Header Interface

#include <nag.h>

void

f08nbf_ (const char *balanc, const char *jobvl, const char *jobvr, const char *sense, const Integer *n, double a[], const Integer *lda, double wr[], double wi[], double vl[], const Integer *ldvl, double vr[], const Integer *ldvr, Integer *ilo, Integer *ihi, double scal[], double *abnrm, double rconde[], double rcondv[], double work[], const Integer *lwork, Integer iwork[], Integer *info, const Charlen length_balanc, const Charlen length_jobvl, const Charlen length_jobvr, const Charlen length_sense)

The routine may be called by the names f08nbf, nagf_lapackeig_dgeevx or its LAPACK name dgeevx.

3 Description

The right eigenvector

v_{j}

A

satisfies

A v_{j} = λ_{j} v_{j}

where

λ_{j}

is the

j

th eigenvalue of

A

. The left eigenvector

u_{j}

A

satisfies

u_{j}^{H} A = λ_{j} u_{j}^{H}

where

u_{j}^{H}

denotes the conjugate transpose of

u_{j}

Balancing a matrix means permuting the rows and columns to make it more nearly upper triangular, and applying a diagonal similarity transformation

D A D^{- 1}

, where

D

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

A

is first reduced to upper Hessenberg form by means of unitary similarity transformations, and the

Q R

algorithm is then used to further reduce the matrix to upper triangular Schur form,

T

, from which the eigenvalues are computed. Optionally, the eigenvectors of

T

are also computed and backtransformed to those of

A

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: $balanc$ – Character(1) Input

On entry: indicates how the input matrix should be diagonally scaled and/or permuted to improve the conditioning of its eigenvalues.

$balanc ='N'$: Do not diagonally scale or permute.
$balanc ='P'$: Perform permutations to make the matrix more nearly upper triangular. Do not diagonally scale.
$balanc ='S'$: Diagonally scale the matrix, i.e., replace $A \times D A D^{- 1}$ , where $D$ is a diagonal matrix chosen to make the rows and columns of $A$ more equal in norm. Do not permute.
$balanc ='B'$: Both diagonally scale and permute $A$ .

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:

balanc ='N'

'P'

'S'

'B'

2: $jobvl$ – Character(1) Input

On entry: if

jobvl ='N'

, the left eigenvectors of

A

are not computed.

jobvl ='V'

, the left eigenvectors of

A

are computed.

sense ='E'

'B'

, jobvl must be set to

jobvl ='V'

Constraint:

jobvl ='N'

'V'

3: $jobvr$ – Character(1) Input

On entry: if

jobvr ='N'

, the right eigenvectors of

A

are not computed.

jobvr ='V'

, the right eigenvectors of

A

are computed.

sense ='E'

'B'

, jobvr must be set to

jobvr ='V'

Constraint:

jobvr ='N'

'V'

4: $sense$ – Character(1) Input

On entry: determines which reciprocal condition numbers are computed.

$sense ='N'$: None are computed.
$sense ='E'$: Computed for eigenvalues only.
$sense ='V'$: Computed for right eigenvectors only.
$sense ='B'$: Computed for eigenvalues and right eigenvectors.

sense ='E'

'B'

, both left and right eigenvectors must also be computed (

jobvl ='V'

and

jobvr ='V'

Constraint:

sense ='N'

'E'

'V'

'B'

5: $n$ – Integer Input

On entry:

n

, the order of the matrix

A

Constraint:

n \geq 0

6: $a (lda, *)$ – Real (Kind=nag_wp) array Input/Output

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

\max (1, n)

On entry: the

n \times n

matrix

A

On exit: a has been overwritten. If

jobvl ='V'

jobvr ='V'

A

contains the real Schur form of the balanced version of the input matrix

A

7: $lda$ – Integer Input

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

Constraint:

lda \geq \max (1, n)

8: $wr (*)$ – Real (Kind=nag_wp) array Output

9: $wi (*)$ – Real (Kind=nag_wp) array Output

Note: the dimension of the arrays wr and wi must be at least

\max (1, n)

On exit: wr and wi contain the real and imaginary parts, respectively, of the computed eigenvalues. Complex conjugate pairs of eigenvalues appear consecutively with the eigenvalue having the positive imaginary part first.

10: $vl (ldvl, *)$ – Real (Kind=nag_wp) array Output

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

\max (1, n)

jobvl ='V'

, and at least

1

otherwise.

On exit: if

jobvl ='V'

, the left eigenvectors

u_{j}

are stored one after another in the columns of vl, in the same order as their corresponding eigenvalues. If the

j

th eigenvalue is real, then

u_{j} = vl (:, j)

, the

j

th column of vl. If the

j

th and

(j + 1)

st eigenvalues form a complex conjugate pair, then

u_{j} = vl (:, j) + i \times vl (:, j + 1)

and

u_{j + 1} = vl (:, j) - i \times vl (:, j + 1)

jobvl ='N'

, vl is not referenced.

11: $ldvl$ – Integer Input

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

Constraints:

if $jobvl ='V'$ , $ldvl \geq \max (1, n)$ ;
otherwise $ldvl \geq 1$ .

12: $vr (ldvr, *)$ – Real (Kind=nag_wp) array Output

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

\max (1, n)

jobvr ='V'

, and at least

1

otherwise.

On exit: if

jobvr ='V'

, the right eigenvectors

v_{j}

are stored one after another in the columns of vr, in the same order as their corresponding eigenvalues. If the

j

th eigenvalue is real, then

v_{j} = vr (:, j)

, the

j

th column of vr. If the

j

th and

(j + 1)

st eigenvalues form a complex conjugate pair, then

v_{j} = vr (:, j) + i \times vr (:, j + 1)

and

v_{j + 1} = vr (:, j) - i \times vr (:, j + 1)

jobvr ='N'

, vr is not referenced.

13: $ldvr$ – Integer Input

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

Constraints:

if $jobvr ='V'$ , $ldvr \geq \max (1, n)$ ;
otherwise $ldvr \geq 1$ .

14: $ilo$ – Integer Output

15: $ihi$ – Integer Output

On exit: ilo and ihi are integer values determined when

A

was balanced. The balanced

A

has

a_{i j} = 0

i > j

and

j = 1, 2, \dots, ilo - 1

i = ihi + 1, \dots, n

16: $scale (*)$ – Real (Kind=nag_wp) array Output

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

\max (1, n)

On exit: details of the permutations and scaling factors applied when balancing

A

p_{j}

is the index of the row and column interchanged with row and column

j

, and

d_{j}

is the scaling factor applied to row and column

j

, then

$scale (j) = p_{j}$ , for $j = 1, 2, \dots, ilo - 1$ ;
$scale (j) = d_{j}$ , for $j = ilo, \dots, ihi$ ;
$scale (j) = p_{j}$ , for $j = ihi + 1, \dots, n$ .

The order in which the interchanges are made is n to

ihi + 1

, then

1

ilo - 1

17: $abnrm$ – Real (Kind=nag_wp) Output

On exit: the

1

-norm of the balanced matrix (the maximum of the sum of absolute values of elements of any column).

18: $rconde (*)$ – Real (Kind=nag_wp) array Output

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

\max (1, n)

On exit:

rconde (j)

is the reciprocal condition number of the

j

th eigenvalue.

19: $rcondv (*)$ – Real (Kind=nag_wp) array Output

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

\max (1, n)

On exit:

rcondv (j)

is the reciprocal condition number of the

j

th right eigenvector.

20: $work (\max (1, lwork))$ – Real (Kind=nag_wp) array Workspace

On exit: if

info = 0

work (1)

contains the minimum value of lwork required for optimal performance.

21: $lwork$ – Integer Input

On entry: the dimension of the array work as declared in the (sub)program from which f08nbf is called.

lwork = −1

, 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,

n \times nb

, where

nb

is the optimal block size for f08nef.

Constraints:

lwork \neq −1

if $jobvl ='N'$ and $jobvr ='N'$ ,
- if $sense ='N'$ , $lwork \geq \max (1, 2 \times n)$ ;
- otherwise $lwork \geq \max (1, n^{2} + 6 \times n)$ ;
if $jobvl ='V'$ or $jobvr ='V'$ ,
- if $sense ='N'$ or $'E'$ , $lwork \geq \max (1, 3 \times n)$ ;
- otherwise $lwork \geq \max (1, n^{2} + 6 \times n)$ .

22: $iwork (*)$ – Integer array Workspace

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

\max (1, 2 \times n - 1)

sense ='N'

'E'

, iwork is not referenced.

23: $info$ – Integer Output

On exit:

info = 0

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

6 Error Indicators and Warnings

$info < 0$: If $info = - i$ , argument $i$ had an illegal value. An explanatory message is output, and execution of the program is terminated.

$info > 0$: The $Q R$ algorithm failed to compute all the eigenvalues, and no eigenvectors or condition numbers have been computed; elements $1$ to $ilo - 1$ and $⟨ value ⟩$ to n of wr and wi contain eigenvalues which have converged.

7 Accuracy

The computed eigenvalues and eigenvectors are exact for a nearby matrix

(A + E)

, where

{‖ E ‖}_{2} = O (ε) {‖ A ‖}_{2},

and

ε

is the machine precision. See Section 4.8 of Anderson et al. (1999) for further details.

8 Parallelism and Performance

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

f08nbf is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.

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

9 Further Comments

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

n^{3}

The complex analogue of this routine is f08npf.

10 Example

This example finds all the eigenvalues and right eigenvectors of the matrix

A = (\begin{array}{r} 0.35 & 0.45 & - 0.14 & - 0.17 \\ 0.09 & 0.07 & - 0.54 & 0.35 \\ - 0.44 & - 0.33 & - 0.03 & 0.17 \\ 0.25 & - 0.32 & - 0.13 & 0.11 \end{array}),

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

64

assumed in this example is not realistic for such a small problem, but should be suitable for large problems.

f08nb: FL CL CPP AD PY MB

NAG FL Interfacef08nbf (dgeevx)

▸▿ 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

10.1 Program Text

10.2 Program Data

10.3 Program Results

NAG FL Interface
f08nbf (dgeevx)