NAG Library Routine Document

f08pxf  (zhsein)

1

Purpose

2

Specification

3

Description

4

References

5

Arguments

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

On entry: indicates whether left and/or right eigenvectors are to be computed.

$\mathbf{job}=\text{'R'}$

Only right eigenvectors are computed.

$\mathbf{job}=\text{'L'}$

Only left eigenvectors are computed.

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

Both left and right eigenvectors are computed.

Constraint: $\mathbf{job}=\text{'R'}$, $\text{'L'}$ or $\text{'B'}$.

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

On entry: indicates whether the eigenvalues of $H$ (stored in w) were found using f08psf (zhseqr).

$\mathbf{eigsrc}=\text{'Q'}$

The eigenvalues of $H$ were found using f08psf (zhseqr); thus if $H$ has any zero subdiagonal elements (and so is block triangular), then the $j$th eigenvalue can be assumed to be an eigenvalue of the block containing the $j$th row/column. This property allows the routine to perform inverse iteration on just one diagonal block.

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

No such assumption is made and the routine performs inverse iteration using the whole matrix.

Constraint: $\mathbf{eigsrc}=\text{'Q'}$ or $\text{'N'}$.

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

On entry: indicates whether you are supplying initial estimates for the selected eigenvectors.

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

No initial estimates are supplied.

$\mathbf{initv}=\text{'U'}$

Initial estimates are supplied in vl and/or vr.

Constraint: $\mathbf{initv}=\text{'N'}$ or $\text{'U'}$.

4:     $\mathbf{select}\left(*\right)$ – Logical arrayInput

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

On entry: specifies which eigenvectors are to be computed. To select the eigenvector corresponding to the eigenvalue $\mathbf{w}\left(j\right)$, $\mathbf{select}\left(j\right)$ must be set to .TRUE..

5:     $\mathbf{n}$ – IntegerInput

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

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

6:     $\mathbf{h}\left(\mathbf{ldh},*\right)$ – Complex (Kind=nag_wp) arrayInput

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

On entry: the $n$ by $n$ upper Hessenberg matrix $H$. If a NaN is detected in h, the routine will return with $\mathbf{info}=-\mathbf{6}$.

Constraint: No element of h is equal to NaN.

7:     $\mathbf{ldh}$ – IntegerInput

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

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

8:     $\mathbf{w}\left(*\right)$ – Complex (Kind=nag_wp) arrayInput/Output

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

On entry: the eigenvalues of the matrix $H$. If $\mathbf{eigsrc}=\text{'Q'}$, the array must be exactly as returned by f08psf (zhseqr).

On exit: the real parts of some elements of w may be modified, as close eigenvalues are perturbed slightly in searching for independent eigenvectors.

9:     $\mathbf{vl}\left(\mathbf{ldvl},*\right)$ – Complex (Kind=nag_wp) arrayInput/Output

Note: the second dimension of the array vl must be at least $\max \left(1,\mathbf{mm}\right)$ if $\mathbf{job}=\text{'L'}$ or $\text{'B'}$ and at least $1$ if $\mathbf{job}=\text{'R'}$.

On entry: if $\mathbf{initv}=\text{'U'}$ and $\mathbf{job}=\text{'L'}$ or $\text{'B'}$, vl must contain starting vectors for inverse iteration for the left eigenvectors. Each starting vector must be stored in the same column as will be used to store the corresponding eigenvector (see below).

If $\mathbf{initv}=\text{'N'}$, vl need not be set.

On exit: if $\mathbf{job}=\text{'L'}$ or $\text{'B'}$, vl contains the computed left eigenvectors (as specified by select). The eigenvectors are stored consecutively in the columns of the array, in the same order as their eigenvalues.

If $\mathbf{job}=\text{'R'}$, vl is not referenced.

10:   $\mathbf{ldvl}$ – IntegerInput

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

Constraints:

• if $\mathbf{job}=\text{'L'}$ or $\text{'B'}$, $\mathbf{ldvl}\ge \mathbf{n}$;
• if $\mathbf{job}=\text{'R'}$, $\mathbf{ldvl}\ge 1$.

11:   $\mathbf{vr}\left(\mathbf{ldvr},*\right)$ – Complex (Kind=nag_wp) arrayInput/Output

Note: the second dimension of the array vr must be at least $\max \left(1,\mathbf{mm}\right)$ if $\mathbf{job}=\text{'R'}$ or $\text{'B'}$ and at least $1$ if $\mathbf{job}=\text{'L'}$.

On entry: if $\mathbf{initv}=\text{'U'}$ and $\mathbf{job}=\text{'R'}$ or $\text{'B'}$, vr must contain starting vectors for inverse iteration for the right eigenvectors. Each starting vector must be stored in the same column as will be used to store the corresponding eigenvector (see below).

If $\mathbf{initv}=\text{'N'}$, vr need not be set.

On exit: if $\mathbf{job}=\text{'R'}$ or $\text{'B'}$, vr contains the computed right eigenvectors (as specified by select). The eigenvectors are stored consecutively in the columns of the array, in the same order as their eigenvalues.

If $\mathbf{job}=\text{'L'}$, vr is not referenced.

12:   $\mathbf{ldvr}$ – IntegerInput

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

Constraints:

• if $\mathbf{job}=\text{'R'}$ or $\text{'B'}$, $\mathbf{ldvr}\ge \mathbf{n}$;
• if $\mathbf{job}=\text{'L'}$, $\mathbf{ldvr}\ge 1$.

13:   $\mathbf{mm}$ – IntegerInput

On entry: the number of columns in the arrays vl and/or vr . This must be an upper bound on the actual number of columns required, that is, the number of elements of select, in the first n, that are set to .TRUE..

Constraint: $\mathbf{mm}\ge \mathit{m}$.

14:   $\mathbf{m}$ – IntegerOutput

On exit: $\mathit{m}$, the number of selected eigenvectors.

15:   $\mathbf{work}\left(\mathbf{n}\times \mathbf{n}\right)$ – Complex (Kind=nag_wp) arrayWorkspace

16:   $\mathbf{rwork}\left(\mathbf{n}\right)$ – Real (Kind=nag_wp) arrayWorkspace

17:   $\mathbf{ifaill}\left(*\right)$ – Integer arrayOutput

Note: the dimension of the array ifaill must be at least $\max \left(1,\mathbf{mm}\right)$ if $\mathbf{job}=\text{'L'}$ or $\text{'B'}$ and at least $1$ if $\mathbf{job}=\text{'R'}$.

On exit: if $\mathbf{job}=\text{'L'}$ or $\text{'B'}$, then $\mathbf{ifaill}\left(i\right)=0$ if the selected left eigenvector converged and $\mathbf{ifaill}\left(i\right)=j>0$ if the eigenvector stored in the $i$th row or column of vl (corresponding to the $j$th eigenvalue) failed to converge.

If $\mathbf{job}=\text{'R'}$, ifaill is not referenced.

18:   $\mathbf{ifailr}\left(*\right)$ – Integer arrayOutput

Note: the dimension of the array ifailr must be at least $\max \left(1,\mathbf{mm}\right)$ if $\mathbf{job}=\text{'R'}$ or $\text{'B'}$ and at least $1$ if $\mathbf{job}=\text{'L'}$.

On exit: if $\mathbf{job}=\text{'R'}$ or $\text{'B'}$, then $\mathbf{ifailr}\left(i\right)=0$ if the selected right eigenvector converged and $\mathbf{ifailr}\left(i\right)=j>0$ if the eigenvector stored in the $i$th column of vr (corresponding to the $j$th eigenvalue) failed to converge.

If $\mathbf{job}=\text{'L'}$, ifailr is not referenced.

19:   $\mathbf{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}>0$

If $\mathbf{info}=i$, then $i$ eigenvectors (as indicated by the arguments ifaill and/or ifailr above) failed to converge. The corresponding columns of vl and/or vr contain no useful information.

7

Accuracy

8

Parallelism and Performance

9

Further Comments

10

Example