NAG Library Routine Document

F08PAF (DGEES)

1  Purpose

2  Specification

3  Description

4  References

5  Parameters

1:     $\mathrm{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:     $\mathrm{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:     $\mathrm{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 F08PAF (DGEES) 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:

FUNCTION SELECT ( WR, WI) LOGICAL SELECT REAL (KIND=nag_wp)  WR, WI

1:     $\mathrm{WR}$ – REAL (KIND=nag_wp)Input

2:     $\mathrm{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 F08PAF (DGEES) is called. Parameters denoted as Input must not be changed by this procedure.

4:     $\mathrm{N}$ – INTEGERInput

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

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

5:     $\mathrm{A}\left(\mathbf{LDA},*\right)$ – REAL (KIND=nag_wp) arrayInput/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$.

6:     $\mathrm{LDA}$ – INTEGERInput

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

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

7:     $\mathrm{SDIM}$ – INTEGEROutput

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

8:     $\mathrm{WR}\left(*\right)$ – REAL (KIND=nag_wp) arrayOutput

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

On exit: see the description of WI.

9:     $\mathrm{WI}\left(*\right)$ – REAL (KIND=nag_wp) arrayOutput

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.

10:   $\mathrm{VS}\left(\mathbf{LDVS},*\right)$ – REAL (KIND=nag_wp) arrayOutput

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.

11:   $\mathrm{LDVS}$ – INTEGERInput

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

Constraints:

• if $\mathbf{JOBVS}=\text{'V'}$, $\mathbf{LDVS}\ge \max \left(1,\mathbf{N}\right)$;
• otherwise $\mathbf{LDVS}\ge 1$.

12:   $\mathrm{WORK}\left(\max \left(1,\mathbf{LWORK}\right)\right)$ – REAL (KIND=nag_wp) arrayWorkspace

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

13:   $\mathrm{LWORK}$ – INTEGERInput

On entry: the dimension of the array WORK as declared in the (sub)program from which F08PAF (DGEES) is called.

If $\mathbf{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, say $3\times \mathbf{N}+\mathit{nb}\times \mathbf{N}$, where $\mathit{nb}$ is the optimal block size for F08NEF (DGEHRD)

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

14:   $\mathrm{BWORK}\left(*\right)$ – LOGICAL arrayWorkspace

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

If $\mathbf{SORT}=\text{'N'}$, BWORK is not referenced.

15:   $\mathrm{INFO}$ – INTEGEROutput

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\hspace{0.17em}\text{to}\hspace{0.17em}\mathbf{N}$

If $\mathbf{INFO}=i$ and $i\le \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

Program Text (f08pafe.f90)

10.2  Program Data

Program Data (f08pafe.d)

10.3  Program Results

Program Results (f08pafe.r)