NAG Library Function Document

nag_zhpgvx (f08tpc)

1  Purpose

2  Specification

3  Description

4  References

5  Arguments

1:    $\mathbf{order}$ – Nag_OrderTypeInput

On entry: the order argument specifies the two-dimensional storage scheme being used, i.e., row-major ordering or column-major ordering. C language defined storage is specified by $\mathbf{order}=\mathrm{Nag\_RowMajor}$. See Section 3.2.1.3 in the Essential Introduction for a more detailed explanation of the use of this argument.

Constraint: $\mathbf{order}=\mathrm{Nag\_RowMajor}$ or $\mathrm{Nag\_ColMajor}$.

2:    $\mathbf{itype}$ – IntegerInput

On entry: specifies the problem type to be solved.

$\mathbf{itype}=1$

$Az=\lambda Bz$.

$\mathbf{itype}=2$

$ABz=\lambda z$.

$\mathbf{itype}=3$

$BAz=\lambda z$.

Constraint: $\mathbf{itype}=1$, $2$ or $3$.

3:    $\mathbf{job}$ – Nag_JobTypeInput

On entry: indicates whether eigenvectors are computed.

$\mathbf{job}=\mathrm{Nag\_EigVals}$

Only eigenvalues are computed.

$\mathbf{job}=\mathrm{Nag\_DoBoth}$

Eigenvalues and eigenvectors are computed.

Constraint: $\mathbf{job}=\mathrm{Nag\_EigVals}$ or $\mathrm{Nag\_DoBoth}$.

4:    $\mathbf{range}$ – Nag_RangeTypeInput

On entry: if $\mathbf{range}=\mathrm{Nag\_AllValues}$, all eigenvalues will be found.

If $\mathbf{range}=\mathrm{Nag\_Interval}$, all eigenvalues in the half-open interval $\left(\mathbf{vl},\mathbf{vu}\right]$ will be found.

If $\mathbf{range}=\mathrm{Nag\_Indices}$, the ilth to iuth eigenvalues will be found.

Constraint: $\mathbf{range}=\mathrm{Nag\_AllValues}$, $\mathrm{Nag\_Interval}$ or $\mathrm{Nag\_Indices}$.

5:    $\mathbf{uplo}$ – Nag_UploTypeInput

On entry: if $\mathbf{uplo}=\mathrm{Nag\_Upper}$, the upper triangles of $A$ and $B$ are stored.

If $\mathbf{uplo}=\mathrm{Nag\_Lower}$, the lower triangles of $A$ and $B$ are stored.

Constraint: $\mathbf{uplo}=\mathrm{Nag\_Upper}$ or $\mathrm{Nag\_Lower}$.

6:    $\mathbf{n}$ – IntegerInput

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

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

7:    $\mathbf{ap}\left[\mathit{dim}\right]$ – ComplexInput/Output

Note: the dimension, dim, of the array ap must be at least $\max \left(1,\mathbf{n}\times \left(\mathbf{n}+1\right)/2\right)$.

On entry: the upper or lower triangle of the $n$ by $n$ Hermitian matrix $A$, packed by rows or columns.

The storage of elements $A_{ij}$ depends on the order and uplo arguments as follows:

• if $\mathbf{order}=\mathrm{Nag\_ColMajor}$ and $\mathbf{uplo}=\mathrm{Nag\_Upper}$,
            $A_{ij}$ is stored in $\mathbf{ap}\left[\left(j-1\right)\times j/2+i-1\right]$, for $i\le j$;
• if $\mathbf{order}=\mathrm{Nag\_ColMajor}$ and $\mathbf{uplo}=\mathrm{Nag\_Lower}$,
            $A_{ij}$ is stored in $\mathbf{ap}\left[\left(2n-j\right)\times \left(j-1\right)/2+i-1\right]$, for $i\ge j$;
• if $\mathbf{order}=\mathrm{Nag\_RowMajor}$ and $\mathbf{uplo}=\mathrm{Nag\_Upper}$,
            $A_{ij}$ is stored in $\mathbf{ap}\left[\left(2n-i\right)\times \left(i-1\right)/2+j-1\right]$, for $i\le j$;
• if $\mathbf{order}=\mathrm{Nag\_RowMajor}$ and $\mathbf{uplo}=\mathrm{Nag\_Lower}$,
            $A_{ij}$ is stored in $\mathbf{ap}\left[\left(i-1\right)\times i/2+j-1\right]$, for $i\ge j$.

On exit: the contents of ap are destroyed.

8:    $\mathbf{bp}\left[\mathit{dim}\right]$ – ComplexInput/Output

Note: the dimension, dim, of the array bp must be at least $\max \left(1,\mathbf{n}\times \left(\mathbf{n}+1\right)/2\right)$.

On entry: the upper or lower triangle of the $n$ by $n$ Hermitian matrix $B$, packed by rows or columns.

The storage of elements $B_{ij}$ depends on the order and uplo arguments as follows:

• if $\mathbf{order}=\mathrm{Nag\_ColMajor}$ and $\mathbf{uplo}=\mathrm{Nag\_Upper}$,
            $B_{ij}$ is stored in $\mathbf{bp}\left[\left(j-1\right)\times j/2+i-1\right]$, for $i\le j$;
• if $\mathbf{order}=\mathrm{Nag\_ColMajor}$ and $\mathbf{uplo}=\mathrm{Nag\_Lower}$,
            $B_{ij}$ is stored in $\mathbf{bp}\left[\left(2n-j\right)\times \left(j-1\right)/2+i-1\right]$, for $i\ge j$;
• if $\mathbf{order}=\mathrm{Nag\_RowMajor}$ and $\mathbf{uplo}=\mathrm{Nag\_Upper}$,
            $B_{ij}$ is stored in $\mathbf{bp}\left[\left(2n-i\right)\times \left(i-1\right)/2+j-1\right]$, for $i\le j$;
• if $\mathbf{order}=\mathrm{Nag\_RowMajor}$ and $\mathbf{uplo}=\mathrm{Nag\_Lower}$,
            $B_{ij}$ is stored in $\mathbf{bp}\left[\left(i-1\right)\times i/2+j-1\right]$, for $i\ge j$.

On exit: the triangular factor $U$ or $L$ from the Cholesky factorization $B=U^{\mathrm{H}}U$ or $B=L{L}^{\mathrm{H}}$, in the same storage format as $B$.

9:    $\mathbf{vl}$ – doubleInput

10:  $\mathbf{vu}$ – doubleInput

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

If $\mathbf{range}=\mathrm{Nag\_AllValues}$ or $\mathrm{Nag\_Indices}$, vl and vu are not referenced.

Constraint: if $\mathbf{range}=\mathrm{Nag\_Interval}$, $\mathbf{vl}<\mathbf{vu}$.

11:  $\mathbf{il}$ – IntegerInput

12:  $\mathbf{iu}$ – IntegerInput

On entry: if $\mathbf{range}=\mathrm{Nag\_Indices}$, the indices (in ascending order) of the smallest and largest eigenvalues to be returned.

If $\mathbf{range}=\mathrm{Nag\_AllValues}$ or $\mathrm{Nag\_Interval}$, il and iu are not referenced.

Constraints:

• if $\mathbf{range}=\mathrm{Nag\_Indices}$ and $\mathbf{n}=0$, $\mathbf{il}=1$ and $\mathbf{iu}=0$;
• if $\mathbf{range}=\mathrm{Nag\_Indices}$ and $\mathbf{n}>0$, $1\le \mathbf{il}\le \mathbf{iu}\le \mathbf{n}$.

13:  $\mathbf{abstol}$ – doubleInput

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 $\left[a,b\right]$ of width less than or equal to

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

where $\epsilon$ is the machine precision. If abstol is less than or equal to zero, then $\epsilon {‖T‖}_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{nag\_real\_safe\_small\_number}\left( \right)$, not zero. If this function returns with $\mathbf{fail}\mathbf{.}\mathbf{code}=$ NE_CONVERGENCE, indicating that some eigenvectors did not converge, try setting abstol to $2\times \mathbf{nag\_real\_safe\_small\_number}\left( \right)$. See Demmel and Kahan (1990).

14:  $\mathbf{m}$ – Integer *Output

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

If $\mathbf{range}=\mathrm{Nag\_AllValues}$, $\mathbf{m}=\mathbf{n}$.

If $\mathbf{range}=\mathrm{Nag\_Indices}$, $\mathbf{m}=\mathbf{iu}-\mathbf{il}+1$.

15:  $\mathbf{w}\left[\mathbf{n}\right]$ – doubleOutput

On exit: the first m elements contain the selected eigenvalues in ascending order.

16:  $\mathbf{z}\left[\mathit{dim}\right]$ – ComplexOutput

Note: the dimension, dim, of the array z must be at least

• $\max \left(1,\mathbf{pdz}\times \mathbf{n}\right)$ when $\mathbf{job}=\mathrm{Nag\_DoBoth}$;
• $1$ otherwise.

The $\left(i,j\right)$th element of the matrix $Z$ is stored in

• $\mathbf{z}\left[\left(j-1\right)\times \mathbf{pdz}+i-1\right]$ when $\mathbf{order}=\mathrm{Nag\_ColMajor}$;
• $\mathbf{z}\left[\left(i-1\right)\times \mathbf{pdz}+j-1\right]$ when $\mathbf{order}=\mathrm{Nag\_RowMajor}$.

On exit: if $\mathbf{job}=\mathrm{Nag\_DoBoth}$, then

• if $\mathbf{fail}\mathbf{.}\mathbf{code}=$ NE_NOERROR, the first m columns of $Z$ contain the orthonormal eigenvectors of the matrix $A$ corresponding to the selected eigenvalues, with the $i$th column of $Z$ holding the eigenvector associated with $\mathbf{w}\left[i-1\right]$. The eigenvectors are normalized as follows:
  • if $\mathbf{itype}=1$ or $2$, $Z^{\mathrm{H}}BZ=I$;
  • if $\mathbf{itype}=3$, $Z^{\mathrm{H}}{B}^{-1}Z=I$;
• if an eigenvector fails to converge ($\mathbf{fail}\mathbf{.}\mathbf{code}=$ NE_CONVERGENCE), then that column of $Z$ contains the latest approximation to the eigenvector, and the index of the eigenvector is returned in jfail.

If $\mathbf{job}=\mathrm{Nag\_EigVals}$, z is not referenced.

17:  $\mathbf{pdz}$ – IntegerInput

On entry: the stride separating row or column elements (depending on the value of order) in the array z.

Constraints:

• if $\mathbf{job}=\mathrm{Nag\_DoBoth}$, $\mathbf{pdz}\ge \max \left(1,\mathbf{n}\right)$;
• otherwise $\mathbf{pdz}\ge 1$.

18:  $\mathbf{jfail}\left[\mathit{dim}\right]$ – IntegerOutput

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

On exit: if $\mathbf{job}=\mathrm{Nag\_DoBoth}$, then

• if $\mathbf{fail}\mathbf{.}\mathbf{code}=$ NE_NOERROR, the first m elements of jfail are zero;
• if $\mathbf{fail}\mathbf{.}\mathbf{code}=$ NE_CONVERGENCE, jfail contains the indices of the eigenvectors that failed to converge.

If $\mathbf{job}=\mathrm{Nag\_EigVals}$, jfail is not referenced.

19:  $\mathbf{fail}$ – NagError *Input/Output

The NAG error argument (see Section 3.6 in the Essential Introduction).

6  Error Indicators and Warnings

NE_ALLOC_FAIL

Dynamic memory allocation failed.
See Section 3.2.1.2 in the Essential Introduction for further information.

NE_BAD_PARAM

On entry, argument $〈\mathit{\text{value}}〉$ had an illegal value.

NE_CONVERGENCE

The algorithm failed to converge; $〈\mathit{\text{value}}〉$ eigenvectors failed to converge.

NE_ENUM_INT_2

On entry, $\mathbf{job}=〈\mathit{\text{value}}〉$, $\mathbf{pdz}=〈\mathit{\text{value}}〉$ and $\mathbf{n}=〈\mathit{\text{value}}〉$.
Constraint: if $\mathbf{job}=\mathrm{Nag\_DoBoth}$, $\mathbf{pdz}\ge \max \left(1,\mathbf{n}\right)$;
otherwise $\mathbf{pdz}\ge 1$.

NE_ENUM_INT_3

On entry, $\mathbf{range}=〈\mathit{\text{value}}〉$, $\mathbf{il}=〈\mathit{\text{value}}〉$, $\mathbf{iu}=〈\mathit{\text{value}}〉$ and $\mathbf{n}=〈\mathit{\text{value}}〉$.
Constraint: if $\mathbf{range}=\mathrm{Nag\_Indices}$ and $\mathbf{n}=0$, $\mathbf{il}=1$ and $\mathbf{iu}=0$;
if $\mathbf{range}=\mathrm{Nag\_Indices}$ and $\mathbf{n}>0$, $1\le \mathbf{il}\le \mathbf{iu}\le \mathbf{n}$.

NE_ENUM_REAL_2

On entry, $\mathbf{range}=〈\mathit{\text{value}}〉$, $\mathbf{vl}=〈\mathit{\text{value}}〉$ and $\mathbf{vu}=〈\mathit{\text{value}}〉$.
Constraint: if $\mathbf{range}=\mathrm{Nag\_Interval}$, $\mathbf{vl}<\mathbf{vu}$.

NE_INT

On entry, $\mathbf{itype}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{itype}=1$, $2$ or $3$.

On entry, $\mathbf{n}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{n}\ge 0$.

On entry, $\mathbf{pdz}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{pdz}>0$.

NE_INTERNAL_ERROR

An internal error has occurred in this function. Check the function call and any array sizes. If the call is correct then please contact NAG for assistance.

An unexpected error has been triggered by this function. Please contact NAG.
See Section 3.6.6 in the Essential Introduction for further information.

NE_MAT_NOT_POS_DEF

If $\mathbf{fail}\mathbf{.}\mathbf{errnum}=\mathbf{n}+〈\mathit{\text{value}}〉$, for $1\le 〈\mathit{\text{value}}〉\le \mathbf{n}$, then the leading minor of order $〈\mathit{\text{value}}〉$ of $B$ is not positive definite. The factorization of $B$ could not be completed and no eigenvalues or eigenvectors were computed.

NE_NO_LICENCE

Your licence key may have expired or may not have been installed correctly.
See Section 3.6.5 in the Essential Introduction for further information.

7  Accuracy

8  Parallelism and Performance

9  Further Comments

10  Example

10.1  Program Text

Program Text (f08tpce.c)

10.2  Program Data

Program Data (f08tpce.d)

10.3  Program Results

Program Results (f08tpce.r)