NAG Library Function Document

nag_zhpev (f08gnc)

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.3.1.3 in How to Use the NAG Library and its Documentation for a more detailed explanation of the use of this argument.

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

2:    $\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}$.

3:    $\mathbf{uplo}$ – Nag_UploTypeInput

On entry: if $\mathbf{uplo}=\mathrm{Nag\_Upper}$, the upper triangular part of $A$ is stored.

If $\mathbf{uplo}=\mathrm{Nag\_Lower}$, the lower triangular part of $A$ is stored.

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

4:    $\mathbf{n}$ – IntegerInput

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

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

5:    $\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: ap is overwritten by the values generated during the reduction to tridiagonal form. The elements of the diagonal and the off-diagonal of the tridiagonal matrix overwrite the corresponding elements of $A$.

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

On exit: the eigenvalues in ascending order.

7:    $\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}$, z contains the orthonormal eigenvectors of the matrix $A$, with the $i$th column of $Z$ holding the eigenvector associated with $\mathbf{w}\left[i-1\right]$.

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

8:    $\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$.

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

The NAG error argument (see Section 3.7 in How to Use the NAG Library and its Documentation).

6

Error Indicators and Warnings

NE_ALLOC_FAIL

Dynamic memory allocation failed.
See Section 2.3.1.2 in How to Use the NAG Library and its Documentation 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}}〉$ off-diagonal elements of an intermediate tridiagonal form did not converge to zero.

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_INT

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.
See Section 2.7.6 in How to Use the NAG Library and its Documentation for further information.

NE_NO_LICENCE

Your licence key may have expired or may not have been installed correctly.
See Section 2.7.5 in How to Use the NAG Library and its Documentation for further information.

7

Accuracy

8

Parallelism and Performance

9

Further Comments

10

Example

10.1

Program Text

Program Text (f08gnce.c)

10.2

Program Data

Program Data (f08gnce.d)

10.3

Program Results

Program Results (f08gnce.r)