NAG Library Routine Document

F08XBF (DGGESX)

1  Purpose

2  Specification

3  Description

4  References

5  Parameters

1:     $\mathrm{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:     $\mathrm{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:     $\mathrm{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:     $\mathrm{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 F08XBF (DGGESX), and may be called with the dummy function F08XAZ.

The specification of SELCTG is:

FUNCTION SELCTG ( AR, AI, B) LOGICAL SELCTG REAL (KIND=nag_wp)  AR, AI, B

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

2:     $\mathrm{AI}$ – REAL (KIND=nag_wp)Input

3:     $\mathrm{B}$ – REAL (KIND=nag_wp)Input

On entry: an eigenvalue $\left(\mathbf{AR}\left(j\right)+\sqrt{-1}\times \mathbf{AI}\left(j\right)\right)/\mathbf{B}\left(j\right)$ is selected if $\mathbf{SELCTG}\left(\mathbf{AR}\left(j\right),\mathbf{AI}\left(j\right),\mathbf{B}\left(j\right)\right)$ is .TRUE.. If either one of a complex conjugate pair is selected, then both complex generalized eigenvalues are selected.

Note that in the ill-conditioned case, a selected complex generalized eigenvalue may no longer satisfy $\mathbf{SELCTG}\left(\mathbf{AR}\left(j\right),\mathbf{AI}\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 F08XBF (DGGESX) is called. Parameters denoted as Input must not be changed by this procedure.

5:     $\mathrm{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 deflating subspaces 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'}$.

6:     $\mathrm{N}$ – INTEGERInput

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

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

7:     $\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 first of the pair of matrices, $A$.

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

8:     $\mathrm{LDA}$ – INTEGERInput

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

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

9:     $\mathrm{B}\left(\mathbf{LDB},*\right)$ – REAL (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$.

10:   $\mathrm{LDB}$ – INTEGERInput

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

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

11:   $\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 SELCTG is .TRUE.. (Complex conjugate pairs for which SELCTG is .TRUE. for either eigenvalue count as $2$.)

12:   $\mathrm{ALPHAR}\left(\mathbf{N}\right)$ – REAL (KIND=nag_wp) arrayOutput

On exit: see the description of BETA.

13:   $\mathrm{ALPHAI}\left(\mathbf{N}\right)$ – REAL (KIND=nag_wp) arrayOutput

On exit: see the description of BETA.

14:   $\mathrm{BETA}\left(\mathbf{N}\right)$ – REAL (KIND=nag_wp) arrayOutput

On exit: $\left(\mathbf{ALPHAR}\left(\mathit{j}\right)+\mathbf{ALPHAI}\left(\mathit{j}\right)\times i\right)/\mathbf{BETA}\left(\mathit{j}\right)$, for $\mathit{j}=1,2,\dots ,\mathbf{N}$, will be the generalized eigenvalues. $\mathbf{ALPHAR}\left(\mathit{j}\right)+\mathbf{ALPHAI}\left(\mathit{j}\right)\times i$, and $\mathbf{BETA}\left(\mathit{j}\right)$, for $\mathit{j}=1,2,\dots ,\mathbf{N}$, are the diagonals of the complex Schur form $\left(S,T\right)$ that would result if the $2$ by $2$ diagonal blocks of the real Schur form of $\left(A,B\right)$ were further reduced to triangular form using $2$ by $2$ complex unitary transformations.

If $\mathbf{ALPHAI}\left(j\right)$ is zero, then the $j$th eigenvalue is real; if positive, then the $j$th and $\left(j+1\right)$st eigenvalues are a complex conjugate pair, with $\mathbf{ALPHAI}\left(j+1\right)$ negative.

Note:  the quotients $\mathbf{ALPHAR}\left(j\right)/\mathbf{BETA}\left(j\right)$ and $\mathbf{ALPHAI}\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, ALPHAR and ALPHAI will always be less than and usually comparable with ${‖\mathbf{A}‖}_2$ in magnitude, and BETA will always be less than and usually comparable with ${‖\mathbf{B}‖}_2$.

15:   $\mathrm{VSL}\left(\mathbf{LDVSL},*\right)$ – REAL (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.

16:   $\mathrm{LDVSL}$ – INTEGERInput

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

Constraints:

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

17:   $\mathrm{VSR}\left(\mathbf{LDVSR},*\right)$ – REAL (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.

18:   $\mathrm{LDVSR}$ – INTEGERInput

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

Constraints:

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

19:   $\mathrm{RCONDE}\left(2\right)$ – REAL (KIND=nag_wp) arrayOutput

On exit: if $\mathbf{SENSE}=\text{'E'}$ or $\text{'B'}$, $\mathbf{RCONDE}\left(1\right)$ and $\mathbf{RCONDE}\left(2\right)$ contain the reciprocal condition numbers for the average of the selected eigenvalues.

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

20:   $\mathrm{RCONDV}\left(2\right)$ – REAL (KIND=nag_wp) arrayOutput

On exit: if $\mathbf{SENSE}=\text{'V'}$ or $\text{'B'}$, $\mathbf{RCONDV}\left(1\right)$ and $\mathbf{RCONDV}\left(2\right)$ contain the reciprocal condition numbers for the selected deflating subspaces.

if $\mathbf{SENSE}=\text{'N'}$ or $\text{'E'}$, RCONDV is not referenced.

21:   $\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)$ returns the optimal LWORK.

22:   $\mathrm{LWORK}$ – INTEGERInput

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

If $\mathbf{LWORK}=-1$, a workspace query is assumed; the routine only calculates the bound on the optimal size of the WORK array and the minimum size of the IWORK array, returns these values as the first entries of the WORK and IWORK arrays, and no error message related to LWORK or LIWORK is issued.

Constraints:

• if $\mathbf{SENSE}=\text{'E'}$, $\text{'V'}$ or $\text{'B'}$, $\mathbf{LWORK}\ge \max \left(8\times \left(\mathbf{N}+1\right)+16,2\times \mathbf{SDIM}\times \left(\mathbf{N}-\mathbf{SDIM}\right)\right)$;
• otherwise $\mathbf{LWORK}\ge \max \left(1,8\times \mathbf{N},6\times \mathbf{N}+16\right)$.

Note: that $2\times \mathbf{SDIM}\times \left(\mathbf{N}-\mathbf{SDIM}\right)\le \mathbf{N}\times \mathbf{N}/2$. Note also that an error is only returned if $\mathbf{LWORK}<8\times \left(\mathbf{N}+1\right)+16$, but if $\mathbf{SENSE}=\text{'E'}$, $\text{'V'}$ or $\text{'B'}$ this may not be large enough. Consider increasing LWORK by $\mathit{nb}$, where $\mathit{nb}$ is the optimal block size.

23:   $\mathrm{IWORK}\left(\max \left(1,\mathbf{LIWORK}\right)\right)$ – INTEGER arrayWorkspace

On exit: if $\mathbf{INFO}=\mathbf{0}$, $\mathbf{IWORK}\left(1\right)$ returns the minimum LIWORK.

24:   $\mathrm{LIWORK}$ – INTEGERInput

On entry: the dimension of the array IWORK as declared in the (sub)program from which F08XBF (DGGESX) is called.

If $\mathbf{LIWORK}=-1$, a workspace query is assumed; the routine only calculates the bound on the optimal size of the WORK array and the minimum size of the IWORK array, returns these values as the first entries of the WORK and IWORK arrays, and no error message related to LWORK or LIWORK is issued.

Constraints:

• if $\mathbf{SENSE}=\text{'N'}$ or $\mathbf{N}=0$, $\mathbf{LIWORK}\ge 1$;
• otherwise $\mathbf{LIWORK}\ge \mathbf{N}+6$.

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

26:   $\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}$

The $QZ$ iteration failed. $\left(A,B\right)$ are not in Schur form, but $\mathbf{ALPHAR}\left(j\right)$, $\mathbf{ALPHAI}\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 F08XEF (DHGEQZ).

$\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  Parallelism and Performance

9  Further Comments

10  Example

10.1  Program Text

Program Text (f08xbfe.f90)

10.2  Program Data

Program Data (f08xbfe.d)

10.3  Program Results

Program Results (f08xbfe.r)