Integer, Intent (In)	::	n, lda, ldvl, ldvr, lwork
Integer, Intent (Out)	::	info
Real (Kind=nag_wp), Intent (Inout)	::	rwork(*)
Complex (Kind=nag_wp), Intent (Inout)	::	a(lda,), w(), vl(ldvl,), vr(ldvr,)
Complex (Kind=nag_wp), Intent (Out)	::	work(max(1,lwork))
Character (1), Intent (In)	::	jobvl, jobvr

C Header Interface

#include <nag.h>

void

f08nnf_ (const char *jobvl, const char *jobvr, const Integer *n, Complex a[], const Integer *lda, Complex w[], Complex vl[], const Integer *ldvl, Complex vr[], const Integer *ldvr, Complex work[], const Integer *lwork, double rwork[], Integer *info, const Charlen length_jobvl, const Charlen length_jobvr)

The routine may be called by the names f08nnf, nagf_lapackeig_zgeev or its LAPACK name zgeev.

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}

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: $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.

Constraint:

jobvl ='N'

'V'

2: $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.

Constraint:

jobvr ='N'

'V'

3: $n$ – Integer Input

On entry:

n

, the order of the matrix

A

Constraint:

n \geq 0

4: $a (lda, *)$ – Complex (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.

5: $lda$ – Integer Input

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

Constraint:

lda \geq \max (1, n)

6: $w (*)$ – Complex (Kind=nag_wp) array Output

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

\max (1, n)

On exit: contains the computed eigenvalues.

7: $vl (ldvl, *)$ – Complex (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; that is

u_{j} = vl (:, j)

, the

j

th column of vl.

jobvl ='N'

, vl is not referenced.

8: $ldvl$ – Integer Input

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

Constraints:

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

9: $vr (ldvr, *)$ – Complex (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; that is

v_{j} = vr (:, j)

, the

j

th column of vr.

jobvr ='N'

, 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 f08nnf is called.

Constraints:

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

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

On exit: if

info = 0

, the real part of

work (1)

contains the minimum value of lwork required for optimal performance.

12: $lwork$ – Integer Input

On entry: the dimension of the array work as declared in the (sub)program from which f08nnf 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 should be generally larger than the minimum, say

n + nb \times n

, where

nb

is the optimal block size for f08nsf.

Constraint:

lwork \geq \max (1, 2 \times n)

lwork = −1

13: $rwork (*)$ – Real (Kind=nag_wp) array Workspace

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

\max (1, 2 \times n)

14: $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 have been computed; elements $⟨ value ⟩$ to n of w 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.

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

f08nnf 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 real analogue of this routine is f08naf.

10 Example

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

A = (\begin{array}{r} - 3.97 - 5.04 i & - 4.11 + 3.70 i & - 0.34 + 1.01 i & 1.29 - 0.86 i \\ 0.34 - 1.50 i & 1.52 - 0.43 i & 1.88 - 5.38 i & 3.36 + 0.65 i \\ 3.31 - 3.85 i & 2.50 + 3.45 i & 0.88 - 1.08 i & 0.64 - 1.48 i \\ - 1.10 + 0.82 i & 1.81 - 1.59 i & 3.25 + 1.33 i & 1.57 - 3.44 i \end{array}) .

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.

f08nn: FL CL CPP AD PY MB

NAG FL Interfacef08nnf (zgeev)

▸▿ 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
f08nnf (zgeev)