NAG Library Routine Document

F08XNF (ZGGES)

1  Purpose

2  Specification

3  Description

4  References

5  Parameters

1:     JOBVSL – CHARACTER(1)Input

On entry: if $\mathbf{JOBVSL}=\text{'N'}$, do not compute the left Schur vectors.

If $\mathbf{JOBVSL}=\text{'V'}$, compute the left Schur vectors.

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

2:     JOBVSR – CHARACTER(1)Input

On entry: if $\mathbf{JOBVSR}=\text{'N'}$, do not compute the right Schur vectors.

If $\mathbf{JOBVSR}=\text{'V'}$, compute the right Schur vectors.

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

3:     SORT – CHARACTER(1)Input

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

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

Eigenvalues are not ordered.

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

Eigenvalues are ordered (see SELCTG).

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

4:     SELCTG – LOGICAL FUNCTION, supplied by the user.External Procedure

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

If $\mathbf{SORT}=\text{'N'}$, SELCTG is not referenced by F08XNF (ZGGES), and may be called with the dummy function F08XNZ.

The specification of SELCTG is:

FUNCTION SELCTG ( A, B) LOGICAL SELCTG COMPLEX (KIND=nag_wp)  A, B

1:     A – COMPLEX (KIND=nag_wp)Input

2:     B – COMPLEX (KIND=nag_wp)Input

On entry: an eigenvalue $\mathbf{A}\left(j\right)/\mathbf{B}\left(j\right)$ is selected if $\mathbf{SELCTG}\left(\mathbf{A}\left(j\right),\mathbf{B}\left(j\right)\right)$ is .TRUE..

Note that in the ill-conditioned case, a selected generalized eigenvalue may no longer satisfy $\mathbf{SELCTG}\left(\mathbf{A}\left(j\right),\mathbf{B}\left(j\right)\right)=\mathrm{.TRUE.}$ after ordering. $\mathbf{INFO}=\mathbf{N}+\mathbf{2}$ in this case.

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

5:     N – INTEGERInput

On entry: $n$, the order of the matrices $A$ and $B$.

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

6:     A(LDA,$*$) – COMPLEX (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 first of the pair of matrices, $A$.

On exit: A has been overwritten by its generalized Schur form $S$.

7:     LDA – INTEGERInput

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

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

8:     B(LDB,$*$) – COMPLEX (KIND=nag_wp) arrayInput/Output

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

On entry: the second of the pair of matrices, $B$.

On exit: B has been overwritten by its generalized Schur form $T$.

9:     LDB – INTEGERInput

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

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

10:   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 SELCTG is .TRUE..

11:   ALPHA(N) – COMPLEX (KIND=nag_wp) arrayOutput

On exit: see the description of BETA.

12:   BETA(N) – COMPLEX (KIND=nag_wp) arrayOutput

On exit: $\mathbf{ALPHA}\left(\mathit{j}\right)/\mathbf{BETA}\left(\mathit{j}\right)$, for $\mathit{j}=1,2,\dots ,\mathbf{N}$, will be the generalized eigenvalues. $\mathbf{ALPHA}\left(\mathit{j}\right)$, for $\mathit{j}=1,2,\dots ,\mathbf{N}$ and $\mathbf{BETA}\left(\mathit{j}\right)$, for $\mathit{j}=1,2,\dots ,\mathbf{N}$, are the diagonals of the complex Schur form $\left(A,B\right)$ output by F08XNF (ZGGES). The $\mathbf{BETA}\left(j\right)$ will be non-negative real.

Note:  the quotients $\mathbf{ALPHA}\left(j\right)/\mathbf{BETA}\left(j\right)$ may easily overflow or underflow, and $\mathbf{BETA}\left(j\right)$ may even be zero. Thus, you should avoid naively computing the ratio $\alpha /\beta$. However, ALPHA will always be less than and usually comparable with $‖\mathbf{A}‖$ in magnitude, and BETA will always be less than and usually comparable with $‖\mathbf{B}‖$.

13:   VSL(LDVSL,$*$) – COMPLEX (KIND=nag_wp) arrayOutput

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

On exit: if $\mathbf{JOBVSL}=\text{'V'}$, VSL will contain the left Schur vectors, $Q$.

If $\mathbf{JOBVSL}=\text{'N'}$, VSL is not referenced.

14:   LDVSL – INTEGERInput

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

Constraints:

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

15:   VSR(LDVSR,$*$) – COMPLEX (KIND=nag_wp) arrayOutput

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

On exit: if $\mathbf{JOBVSR}=\text{'V'}$, VSR will contain the right Schur vectors, $Z$.

If $\mathbf{JOBVSR}=\text{'N'}$, VSR is not referenced.

16:   LDVSR – INTEGERInput

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

Constraints:

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

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

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

18:   LWORK – INTEGERInput

On entry: the dimension of the array WORK as declared in the (sub)program from which F08XNF (ZGGES) 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 $2\times \mathbf{N}+\mathit{nb}\times \mathbf{N}$, where $\mathit{nb}$ is the optimal block size for F08NSF (ZGEHRD).

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

19:   RWORK($\max \left(1,8\times \mathbf{N}\right)$) – REAL (KIND=nag_wp) arrayWorkspace

20:   BWORK($*$) – 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.

21:   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\text{ to }\mathbf{N}$

The $QZ$ iteration failed. $\left(A,B\right)$ are not in Schur form, but $\mathbf{ALPHA}\left(j\right)$ and $\mathbf{BETA}\left(j\right)$ should be correct for $j=\mathbf{INFO}+1,\dots ,\mathbf{N}$.

$\mathbf{INFO}=\mathbf{N}+1$

Unexpected error returned from F08XSF (ZHGEQZ).

$\mathbf{INFO}=\mathbf{N}+2$

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

$\mathbf{INFO}=\mathbf{N}+3$

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

7  Accuracy

8  Further Comments

9  Example

9.1  Program Text

Program Text (f08xnfe.f90)

9.2  Program Data

Program Data (f08xnfe.d)

9.3  Program Results

Program Results (f08xnfe.r)