NAG Library Routine Document

f08wwf (zggbak)

1
Purpose

f08wwf (zggbak) forms the right or left eigenvectors of the real generalized eigenvalue problem Ax=λBx, by backward transformation on the computed eigenvectors given by f08yxf (ztgevc). It is necessary to call this routine only if the optional balancing routine f08wvf (zggbal) was previously called to balance the matrix pair A,B.

2
Specification

Fortran Interface
Subroutine f08wwf ( job, side, n, ilo, ihi, lscale, rscale, m, v, ldv, info)
Integer, Intent (In):: n, ilo, ihi, m, ldv
Integer, Intent (Out):: info
Real (Kind=nag_wp), Intent (In):: lscale(*), rscale(*)
Complex (Kind=nag_wp), Intent (Inout):: v(ldv,*)
Character (1), Intent (In):: job, side
C Header Interface
#include <nagmk26.h>
void  f08wwf_ (const char *job, const char *side, const Integer *n, const Integer *ilo, const Integer *ihi, const double lscale[], const double rscale[], const Integer *m, Complex v[], const Integer *ldv, Integer *info, const Charlen length_job, const Charlen length_side)
The routine may be called by its LAPACK name zggbak.

3
Description

If the matrix pair has been previously balanced using the routine f08wvf (zggbal) then f08wwf (zggbak) backtransforms the eigenvector solution given by f08yxf (ztgevc). This is usually the sixth and last step in the solution of the generalized eigenvalue problem.
For a description of balancing, see the document for f08wvf (zggbal).

4
References

Ward R C (1981) Balancing the generalized eigenvalue problem SIAM J. Sci. Stat. Comp. 2 141–152

5
Arguments

1:     job – Character(1)Input
On entry: specifies the backtransformation step required.
job='N'
No transformations are done.
job='P'
Only do backward transformations based on permutations.
job='S'
Only do backward transformations based on scaling.
job='B'
Do backward transformations for both permutations and scaling.
Note:  this must be identical to the argument job as supplied to f08wvf (zggbal).
Constraint: job='N', 'P', 'S' or 'B'.
2:     side – Character(1)Input
On entry: indicates whether left or right eigenvectors are to be transformed.
side='L'
The left eigenvectors are transformed.
side='R'
The right eigenvectors are transformed.
Constraint: side='L' or 'R'.
3:     n – IntegerInput
On entry: n, the order of the matrices A and B of the generalized eigenvalue problem.
Constraint: n0.
4:     ilo – IntegerInput
5:     ihi – IntegerInput
On entry: ilo and ihi as determined by a previous call to f08wvf (zggbal).
Constraints:
  • if n>0, 1 ilo ihi n ;
  • if n=0, ilo=1 and ihi=0.
6:     lscale* – Real (Kind=nag_wp) arrayInput
Note: the dimension of the array lscale must be at least max1,n.
On entry: details of the permutations and scaling factors applied to the left side of the matrices A and B, as returned by a previous call to f08wvf (zggbal).
7:     rscale* – Real (Kind=nag_wp) arrayInput
Note: the dimension of the array rscale must be at least max1,n.
On entry: details of the permutations and scaling factors applied to the right side of the matrices A and B, as returned by a previous call to f08wvf (zggbal).
8:     m – IntegerInput
On entry: m, the required number of left or right eigenvectors.
Constraint: 0mn.
9:     vldv* – Complex (Kind=nag_wp) arrayInput/Output
Note: the second dimension of the array v must be at least max1,m.
On entry: the matrix of right or left eigenvectors, as returned by f08wvf (zggbal).
On exit: the transformed right or left eigenvectors.
10:   ldv – IntegerInput
On entry: the first dimension of the array v as declared in the (sub)program from which f08wwf (zggbak) is called.
Constraint: ldv max1,n .
11:   info – IntegerOutput
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.

7
Accuracy

The errors are negligible.

8
Parallelism and Performance

f08wwf (zggbak) 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

The number of operations is proportional to n2.
The real analogue of this routine is f08wjf (dggbak).

10
Example

See Section 10 in f08xsf (zhgeqz) and f08yxf (ztgevc).