NAG FL Interface
f08pbf (dgeesx)

1 Purpose

2 Specification

3 Description

4 References

5 Arguments

1: $\mathbf{jobvs}$ – Character(1) Input

On entry: if $\mathbf{jobvs}=\text{'N'}$, Schur vectors are not computed.

If $\mathbf{jobvs}=\text{'V'}$, Schur vectors are computed.

Constraint: $\mathbf{jobvs}=\text{'N'}$ or $\text{'V'}$.

2: $\mathbf{sort}$ – Character(1) Input

On entry: specifies whether or not to order the eigenvalues on the diagonal of the Schur form.

$\mathbf{sort}=\text{'N'}$

Eigenvalues are not ordered.

$\mathbf{sort}=\text{'S'}$

Eigenvalues are ordered (see select).

Constraint: $\mathbf{sort}=\text{'N'}$ or $\text{'S'}$.

3: $\mathbf{select}$ – Logical Function, supplied by the user. External Procedure

If $\mathbf{sort}=\text{'S'}$, select is used to select eigenvalues to sort to the top left of the Schur form.

If $\mathbf{sort}=\text{'N'}$, select is not referenced and f08pbf may be called with the dummy function f08paz.

An eigenvalue $\mathbf{wr}\left(j\right)+\sqrt{-1}\times \mathbf{wi}\left(j\right)$ is selected if $\mathbf{select}\left(\mathbf{wr}\left(j\right),\mathbf{wi}\left(j\right)\right)$ is .TRUE.. If either one of a complex conjugate pair of eigenvalues is selected, then both are. Note that a selected complex eigenvalue may no longer satisfy $\mathbf{select}\left(\mathbf{wr}\left(j\right),\mathbf{wi}\left(j\right)\right)=\mathrm{.TRUE.}$ after ordering, since ordering may change the value of complex eigenvalues (especially if the eigenvalue is ill-conditioned); in this case info is set to $\mathbf{n}+2$ (see info below).

The specification of select is:

Fortran Interface

Function select ( wr, wi) Logical :: select Real (Kind=nag_wp), Intent (In) :: wr, wi

C Header Interface

Nag_Boolean  select_ (const double *wr, const double *wi)

C++ Header Interface

#include <nag.h> extern "C" { Nag_Boolean  select_ (const double &wr, const double &wi) }

1: $\mathbf{wr}$ – Real (Kind=nag_wp) Input

2: $\mathbf{wi}$ – Real (Kind=nag_wp) Input

On entry: the real and imaginary parts of the eigenvalue.

select must either be a module subprogram USEd by, or declared as EXTERNAL in, the (sub)program from which f08pbf is called. Arguments denoted as Input must not be changed by this procedure.

4: $\mathbf{sense}$ – Character(1) Input

On entry: determines which reciprocal condition numbers are computed.

$\mathbf{sense}=\text{'N'}$

None are computed.

$\mathbf{sense}=\text{'E'}$

Computed for average of selected eigenvalues only.

$\mathbf{sense}=\text{'V'}$

Computed for selected right invariant subspace only.

$\mathbf{sense}=\text{'B'}$

Computed for both.

If $\mathbf{sense}=\text{'E'}$, $\text{'V'}$ or $\text{'B'}$, $\mathbf{sort}=\text{'S'}$.

Constraint: $\mathbf{sense}=\text{'N'}$, $\text{'E'}$, $\text{'V'}$ or $\text{'B'}$.

5: $\mathbf{n}$ – Integer Input

On entry: $n$, the order of the matrix $A$.

Constraint: $\mathbf{n}\ge 0$.

6: $\mathbf{a}\left(\mathbf{lda},*\right)$ – Real (Kind=nag_wp) array Input/Output

Note: the second dimension of the array a must be at least $\max \left(1,\mathbf{n}\right)$.

On entry: the $n$ by $n$ matrix $A$.

On exit: a is overwritten by its real Schur form $T$.

7: $\mathbf{lda}$ – Integer Input

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

Constraint: $\mathbf{lda}\ge \max \left(1,\mathbf{n}\right)$.

8: $\mathbf{sdim}$ – Integer Output

On exit: if $\mathbf{sort}=\text{'N'}$, $\mathbf{sdim}=0$.

If $\mathbf{sort}=\text{'S'}$, $\mathbf{sdim}=$ number of eigenvalues (after sorting) for which select is .TRUE.. (Complex conjugate pairs for which select is .TRUE. for either eigenvalue count as $2$.)

9: $\mathbf{wr}\left(*\right)$ – Real (Kind=nag_wp) array Output

Note: the dimension of the array wr must be at least $\max \left(1,\mathbf{n}\right)$.

On exit: see the description of wi.

10: $\mathbf{wi}\left(*\right)$ – Real (Kind=nag_wp) array Output

Note: the dimension of the array wi must be at least $\max \left(1,\mathbf{n}\right)$.

On exit: wr and wi contain the real and imaginary parts, respectively, of the computed eigenvalues in the same order that they appear on the diagonal of the output Schur form $T$. Complex conjugate pairs of eigenvalues will appear consecutively with the eigenvalue having the positive imaginary part first.

11: $\mathbf{vs}\left(\mathbf{ldvs},*\right)$ – Real (Kind=nag_wp) array Output

Note: the second dimension of the array vs must be at least $\max \left(1,\mathbf{n}\right)$ if $\mathbf{jobvs}=\text{'V'}$, and at least $1$ otherwise.

On exit: if $\mathbf{jobvs}=\text{'V'}$, vs contains the orthogonal matrix $Z$ of Schur vectors.

If $\mathbf{jobvs}=\text{'N'}$, vs is not referenced.

12: $\mathbf{ldvs}$ – Integer Input

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

Constraints:

• if $\mathbf{jobvs}=\text{'V'}$, $\mathbf{ldvs}\ge \max \left(1,\mathbf{n}\right)$;
• otherwise $\mathbf{ldvs}\ge 1$.

13: $\mathbf{rconde}$ – Real (Kind=nag_wp) Output

On exit: if $\mathbf{sense}=\text{'E'}$ or $\text{'B'}$, contains the reciprocal condition number for the average of the selected eigenvalues.

If $\mathbf{sense}=\text{'N'}$ or $\text{'V'}$, rconde is not referenced.

14: $\mathbf{rcondv}$ – Real (Kind=nag_wp) Output

On exit: if $\mathbf{sense}=\text{'V'}$ or $\text{'B'}$, rcondv contains the reciprocal condition number for the selected right invariant subspace.

If $\mathbf{sense}=\text{'N'}$ or $\text{'E'}$, rcondv is not referenced.

15: $\mathbf{work}\left(\max \left(1,\mathbf{lwork}\right)\right)$ – Real (Kind=nag_wp) array Workspace

On exit: if $\mathbf{info}=\mathbf{0}$, $\mathbf{work}\left(1\right)$ contains the minimum value of lwork required for optimal performance.

16: $\mathbf{lwork}$ – Integer Input

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

If $\mathbf{lwork}=-1$, a workspace query is assumed; the routine only calculates upper bounds on the optimal sizes of the work and iwork arrays, returns these values as the first entries of the work and iwork arrays, and no error messages related to lwork or liwork is issued.

If $\mathbf{sense}=\text{'E'}$, $\text{'V'}$ or $\text{'B'}$, $\mathbf{lwork}\ge \mathbf{n}+2\times \mathbf{sdim}\times \left(\mathbf{n}-\mathbf{sdim}\right)$, where sdim is the number of selected eigenvalues computed by this routine. Note that $\mathbf{n}+2\times \mathbf{sdim}\times \left(\mathbf{n}-\mathbf{sdim}\right)\le \mathbf{n}+\mathbf{n}\times \mathbf{n}/2$.

Note also that an error is only returned if $\mathbf{lwork}<\max \left(1,3\times \mathbf{n}\right)$, but if $\mathbf{sense}=\text{'E'}$, $\text{'V'}$ or $\text{'B'}$ this may not be large enough.

Suggested value: for optimal performance, lwork must generally be larger than the minimum; increase the workspace by, say, $\mathit{nb}\times \mathbf{n}$, where $\mathit{nb}$ is the optimal block size for f08nef.

Constraint: $\mathbf{lwork}\ge \max \left(1,3\times \mathbf{n}\right)$.

17: $\mathbf{iwork}\left(\max \left(1,\mathbf{liwork}\right)\right)$ – Integer array Workspace

On exit: if $\mathbf{info}=\mathbf{0}$, $\mathbf{iwork}\left(1\right)$ returns the optimal liwork.

18: $\mathbf{liwork}$ – Integer Input

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

If $\mathbf{liwork}=-1$, a workspace query is assumed; the routine only calculates upper bounds on the optimal sizes of the work and iwork arrays, returns these values as the first entries of the work and iwork arrays, and no error messages related to lwork or liwork is issued.

Constraints:

• if $\mathbf{sense}=\text{'V'}$ or $\text{'B'}$, $\mathbf{liwork}\ge \mathbf{sdim}\times \left(\mathbf{n}-\mathbf{sdim}\right)$;
• otherwise $\mathbf{liwork}\ge 1$.

Note: $\mathbf{sdim}\times \left(\mathbf{n}-\mathbf{sdim}\right)\le \mathbf{n}\times \mathbf{n}/4$. Note also that an error is only returned if $\mathbf{liwork}<1$, but if $\mathbf{sense}=\text{'V'}$ or $\text{'B'}$ this may not be large enough.

19: $\mathbf{bwork}\left(*\right)$ – Logical array Workspace

Note: the dimension of the array bwork must be at least $\max \left(1,\mathbf{n}\right)$ if $\mathbf{sort}\ne \text{'N'}$, and at least $1$ otherwise.

If $\mathbf{sort}=\text{'N'}$, bwork is not referenced.

20: $\mathbf{info}$ – Integer Output

On exit: $\mathbf{info}=0$ unless the routine detects an error (see Section 6).

6 Error Indicators and Warnings

$\mathbf{info}<0$

If $\mathbf{info}=-i$, argument $i$ had an illegal value. An explanatory message is output, and execution of the program is terminated.

$\mathbf{info}=1,\dots ,\mathbf{n}$

The $QR$ algorithm failed to compute all the eigenvalues.

$\mathbf{info}=\mathbf{n}+1$

The eigenvalues could not be reordered because some eigenvalues were too close to separate (the problem is very ill-conditioned).

$\mathbf{info}=\mathbf{n}+2$

After reordering, roundoff changed values of some complex eigenvalues so that leading eigenvalues in the Schur form no longer satisfy $\mathbf{select}=\mathrm{.TRUE.}$. This could also be caused by underflow due to scaling.

7 Accuracy

8 Parallelism and Performance

9 Further Comments

10 Example

10.1 Program Text

10.2 Program Data

10.3 Program Results