NAG Library Routine Document

F08UQF (ZHBGVD)

1  Purpose

2  Specification

3  Description

4  References

5  Parameters

1:     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:     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'}$.

3:     N – INTEGERInput

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

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

4:     KA – INTEGERInput

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$.

5:     KB – INTEGERInput

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$.

6:     AB(LDAB,$*$) – COMPLEX (KIND=nag_wp) arrayInput/Output

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

On entry: the upper or lower triangle of the $n$ by $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}\left(k_a+1+i-j,j\right)\text{ for }\max \left(1,j-k_a\right)\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}\left(1+i-j,j\right)\text{ for }j\le i\le \min \left(n,j+k_a\right)\text{.}$

On exit: the contents of AB are overwritten.

7:     LDAB – INTEGERInput

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

Constraint: $\mathbf{LDAB}\ge \mathbf{KA}+1$.

8:     BB(LDBB,$*$) – COMPLEX (KIND=nag_wp) arrayInput/Output

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

On entry: the upper or lower triangle of the $n$ by $n$ Hermitian 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}\left(k_b+1+i-j,j\right)\text{ for }\max \left(1,j-k_b\right)\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}\left(1+i-j,j\right)\text{ for }j\le i\le \min \left(n,j+k_b\right)\text{.}$

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

9:     LDBB – INTEGERInput

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

Constraint: $\mathbf{LDBB}\ge \mathbf{KB}+1$.

10:   W(N) – REAL (KIND=nag_wp) arrayOutput

On exit: the eigenvalues in ascending order.

11:   Z(LDZ,$*$) – COMPLEX (KIND=nag_wp) arrayOutput

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

On exit: if $\mathbf{JOBZ}=\text{'V'}$, Z contains the matrix $Z$ of eigenvectors, 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 $\mathbf{JOBZ}=\text{'N'}$, Z is not referenced.

12:   LDZ – INTEGERInput

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

Constraints:

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

13:   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.

14:   LWORK – INTEGERInput

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

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

Constraints:

• if $\mathbf{N}\le 1$, $\mathbf{LWORK}\ge 1$;
• if $\mathbf{JOBZ}=\text{'N'}$ and $\mathbf{N}>1$, $\mathbf{LWORK}\ge \max \left(1,\mathbf{N}\right)$;
• if $\mathbf{JOBZ}=\text{'V'}$ and $\mathbf{N}>1$, $\mathbf{LWORK}\ge \max \left(1,{\mathbf{N}}^2\right)$.

15:   RWORK($\max \left(1,\mathbf{LRWORK}\right)$) – REAL (KIND=nag_wp) arrayWorkspace

On exit: if $\mathbf{INFO}=\mathbf{0}$, $\mathbf{RWORK}\left(1\right)$ returns the optimal LRWORK.

16:   LRWORK – INTEGERInput

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

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

Constraints:

• if $\mathbf{N}\le 1$, $\mathbf{LRWORK}\ge 1$;
• if $\mathbf{JOBZ}=\text{'N'}$ and $\mathbf{N}>1$, $\mathbf{LRWORK}\ge \max \left(1,\mathbf{N}\right)$;
• if $\mathbf{JOBZ}=\text{'V'}$ and $\mathbf{N}>1$, $\mathbf{LRWORK}\ge 1+5\times \mathbf{N}+2\times {\mathbf{N}}^2$.

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

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

18:   LIWORK – INTEGERInput

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

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

Constraints:

• if $\mathbf{JOBZ}=\text{'N'}$ or $\mathbf{N}\le 1$, $\mathbf{LIWORK}\ge 1$;
• if $\mathbf{JOBZ}=\text{'V'}$ and $\mathbf{N}>1$, $\mathbf{LIWORK}\ge 3+5\times \mathbf{N}$.

19:   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$ and $i\le \mathbf{N}$, the algorithm failed to converge; $i$ off-diagonal elements of an intermediate tridiagonal form did not converge to zero.

If $\mathbf{INFO}=i$ and $i>\mathbf{N}$, if $\mathbf{INFO}=\mathbf{N}+i$, for $1\le i\le \mathbf{N}$, then F08UTF (ZPBSTF) returned $\mathbf{INFO}=i$: $B$ is not positive definite. The factorization of $B$ could not be completed and no eigenvalues or eigenvectors were computed.

7  Accuracy

8  Further Comments

9  Example

9.1  Program Text

Program Text (f08uqfe.f90)

9.2  Program Data

Program Data (f08uqfe.d)

9.3  Program Results

Program Results (f08uqfe.r)