NAG FL Interface
f08upf (zhbgvx)

1 Purpose

2 Specification

3 Description

4 References

5 Arguments

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

On entry: indicates whether eigenvectors are computed.

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

Only eigenvalues are computed.

$\mathbf{jobz}=\text{'V'}$

Eigenvalues and eigenvectors are computed.

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

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

On entry: if $\mathbf{range}=\text{'A'}$, all eigenvalues will be found.

If $\mathbf{range}=\text{'V'}$, all eigenvalues in the half-open interval $(\mathbf{vl},\mathbf{vu}]$ will be found.

If $\mathbf{range}=\text{'I'}$, the ilth to iuth eigenvalues will be found.

Constraint: $\mathbf{range}=\text{'A'}$, $\text{'V'}$ or $\text{'I'}$.

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

On entry: if $\mathbf{uplo}=\text{'U'}$, the upper triangles of $A$ and $B$ are stored.

If $\mathbf{uplo}=\text{'L'}$, the lower triangles of $A$ and $B$ are stored.

Constraint: $\mathbf{uplo}=\text{'U'}$ or $\text{'L'}$.

4: $\mathbf{n}$ – Integer Input

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

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

5: $\mathbf{ka}$ – Integer Input

On entry: if $\mathbf{uplo}=\text{'U'}$, the number of superdiagonals, $k_a$, of the matrix $A$.

If $\mathbf{uplo}=\text{'L'}$, the number of subdiagonals, $k_a$, of the matrix $A$.

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

6: $\mathbf{kb}$ – Integer Input

On entry: if $\mathbf{uplo}=\text{'U'}$, the number of superdiagonals, $k_b$, of the matrix $B$.

If $\mathbf{uplo}=\text{'L'}$, the number of subdiagonals, $k_b$, of the matrix $B$.

Constraint: $\mathbf{ka}\ge \mathbf{kb}\ge 0$.

7: $\mathbf{ab}(\mathbf{ldab},*)$ – Complex (Kind=nag_wp) array Input/Output

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

On entry: the upper or lower triangle of the $n\times n$ Hermitian band matrix $A$.

The matrix is stored in rows $1$ to $k_a+1$, more precisely,

• if $\mathbf{uplo}=\text{'U'}$, the elements of the upper triangle of $A$ within the band must be stored with element $A_{ij}$ in $\mathbf{ab}(k_a+1+i-j,j)\text{ for }\max (1,j-k_a)\le i\le j$;
• if $\mathbf{uplo}=\text{'L'}$, the elements of the lower triangle of $A$ within the band must be stored with element $A_{ij}$ in $\mathbf{ab}(1+i-j,j)\text{ for }j\le i\le \min (n,j+k_a)\text{.}$

On exit: the contents of ab are overwritten.

8: $\mathbf{ldab}$ – Integer Input

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

Constraint: $\mathbf{ldab}\ge \mathbf{ka}+1$.

9: $\mathbf{bb}(\mathbf{ldbb},*)$ – Complex (Kind=nag_wp) array Input/Output

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

On entry: the upper or lower triangle of the $n\times n$ Hermitian positive definite band matrix $B$.

The matrix is stored in rows $1$ to $k_b+1$, more precisely,

• if $\mathbf{uplo}=\text{'U'}$, the elements of the upper triangle of $B$ within the band must be stored with element $B_{ij}$ in $\mathbf{bb}(k_b+1+i-j,j)\text{ for }\max (1,j-k_b)\le i\le j$;
• if $\mathbf{uplo}=\text{'L'}$, the elements of the lower triangle of $B$ within the band must be stored with element $B_{ij}$ in $\mathbf{bb}(1+i-j,j)\text{ for }j\le i\le \min (n,j+k_b)\text{.}$

On exit: the factor $S$ from the split Cholesky factorization $B=S^{\mathrm{H}}S$, as returned by f08utf.

10: $\mathbf{ldbb}$ – Integer Input

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

Constraint: $\mathbf{ldbb}\ge \mathbf{kb}+1$.

11: $\mathbf{q}(\mathbf{ldq},*)$ – Complex (Kind=nag_wp) array Output

Note: the second dimension of the array q must be at least $\max (1,\mathbf{n})$ if $\mathbf{jobz}=\text{'V'}$, and at least $1$ otherwise.

On exit: if $\mathbf{jobz}=\text{'V'}$, the $n\times n$ matrix, $Q$ used in the reduction of the standard form, i.e., $Cx=\lambda x$, from symmetric banded to tridiagonal form.

If $\mathbf{jobz}=\text{'N'}$, q is not referenced.

12: $\mathbf{ldq}$ – Integer Input

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

Constraints:

• if $\mathbf{jobz}=\text{'V'}$, $\mathbf{ldq}\ge \max (1,\mathbf{n})$;
• otherwise $\mathbf{ldq}\ge 1$.

13: $\mathbf{vl}$ – Real (Kind=nag_wp) Input

14: $\mathbf{vu}$ – Real (Kind=nag_wp) Input

On entry: if $\mathbf{range}=\text{'V'}$, the lower and upper bounds of the interval to be searched for eigenvalues.

If $\mathbf{range}=\text{'A'}$ or $\text{'I'}$, vl and vu are not referenced.

Constraint: if $\mathbf{range}=\text{'V'}$, $\mathbf{vl}<\mathbf{vu}$.

15: $\mathbf{il}$ – Integer Input

16: $\mathbf{iu}$ – Integer Input

On entry: if $\mathbf{range}=\text{'I'}$, il and iu specify the indices (in ascending order) of the smallest and largest eigenvalues to be returned, respectively.

If $\mathbf{range}=\text{'A'}$ or $\text{'V'}$, il and iu are not referenced.

Constraints:

• if $\mathbf{range}=\text{'I'}$ and $\mathbf{n}=0$, $\mathbf{il}=1$ and $\mathbf{iu}=0$;
• if $\mathbf{range}=\text{'I'}$ and $\mathbf{n}>0$, $1\le \mathbf{il}\le \mathbf{iu}\le \mathbf{n}$.

17: $\mathbf{abstol}$ – Real (Kind=nag_wp) Input

On entry: the absolute error tolerance for the eigenvalues. An approximate eigenvalue is accepted as converged when it is determined to lie in an interval $[a,b]$ of width less than or equal to

$$\mathbf{abstol}+\epsilon \max (\left|a\right|,\left|b\right|)\text{,}$$

where $\epsilon$ is the machine precision. If abstol is less than or equal to zero, then $\epsilon {\Vert T\Vert }_1$ will be used in its place, where $T$ is the tridiagonal matrix obtained by reducing $C$ to tridiagonal form. Eigenvalues will be computed most accurately when abstol is set to twice the underflow threshold $2\times \mathbf{x02amf}( )$, not zero. If this routine returns with $\mathbf{info}=\mathbf{1},\dots ,\mathbf{n}$, indicating that some eigenvectors did not converge, try setting abstol to $2\times \mathbf{x02amf}( )$. See Demmel and Kahan (1990).

18: $\mathbf{m}$ – Integer Output

On exit: the total number of eigenvalues found. $0\le \mathbf{m}\le \mathbf{n}$.

If $\mathbf{range}=\text{'A'}$, $\mathbf{m}=\mathbf{n}$.

If $\mathbf{range}=\text{'I'}$, $\mathbf{m}=\mathbf{iu}-\mathbf{il}+1$.

19: $\mathbf{w}\left(\mathbf{n}\right)$ – Real (Kind=nag_wp) array Output

On exit: the eigenvalues in ascending order.

20: $\mathbf{z}(\mathbf{ldz},*)$ – Complex (Kind=nag_wp) array Output

Note: the second dimension of the array z must be at least $\max (1,\mathbf{m})$ if $\mathbf{jobz}=\text{'V'}$, and at least $1$ otherwise.

On exit: if $\mathbf{jobz}=\text{'V'}$, then

• if $\mathbf{info}=\mathbf{0}$, the first m columns of $Z$ contain the eigenvectors corresponding to the selected eigenvalues, with the $i$th column of $Z$ holding the eigenvector associated with $\mathbf{w}\left(i\right)$. The eigenvectors are normalized so that $Z^{\mathrm{H}}BZ=I$;
• if an eigenvector fails to converge ($\mathbf{info}=\mathbf{1},\dots ,\mathbf{n}$), then that column of $Z$ contains the latest approximation to the eigenvector, and the index of the eigenvector is returned in jfail.

If $\mathbf{jobz}=\text{'N'}$, z is not referenced.

Note:  you must ensure that at least $\max (1,\mathbf{m})$ columns are supplied in the array z; if $\mathbf{range}=\text{'V'}$, the exact value of m is not known in advance and an upper bound of at least n must be used.

21: $\mathbf{ldz}$ – Integer Input

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

Constraints:

• if $\mathbf{jobz}=\text{'V'}$, $\mathbf{ldz}\ge \max (1,\mathbf{n})$;
• otherwise $\mathbf{ldz}\ge 1$.

22: $\mathbf{work}\left(\mathbf{n}\right)$ – Complex (Kind=nag_wp) array Workspace

23: $\mathbf{rwork}\left(7\times \mathbf{n}\right)$ – Real (Kind=nag_wp) array Workspace

24: $\mathbf{iwork}\left(5\times \mathbf{n}\right)$ – Integer array Workspace

25: $\mathbf{jfail}\left(*\right)$ – Integer array Output

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

On exit: if $\mathbf{jobz}=\text{'V'}$, then

• if $\mathbf{info}=\mathbf{0}$, the first m elements of jfail are zero;
• if $\mathbf{info}=\mathbf{1},\dots ,\mathbf{n}$, the first info elements of jfail contains the indices of the eigenvectors that failed to converge.

If $\mathbf{jobz}=\text{'N'}$, jfail is not referenced.

26: $\mathbf{info}$ – Integer Output

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,\dots ,\mathbf{n}$

The algorithm failed to converge; $⟨\mathit{\text{value}}⟩$ eigenvectors did not converge. Their indices are stored in array jfail.

$\mathbf{info}>\mathbf{n}$

If $\mathbf{info}=\mathbf{n}+⟨\mathit{\text{value}}⟩$, for $1\le ⟨\mathit{\text{value}}⟩\le \mathbf{n}$, f08utf returned $\mathbf{info}=⟨\mathit{\text{value}}⟩$: $B$ is not positive definite. The factorization of $B$ could not be completed and no eigenvalues or eigenvectors were computed.

7 Accuracy

8 Parallelism and Performance

9 Further Comments

10 Example

10.1 Program Text

10.2 Program Data

10.3 Program Results