next up previous contents index
Next: Example (from Program LA_SBGVX_EXAMPLE) Up: Generalized Symmetric Eigenvalue Problems Previous: Purpose   Contents   Index

Arguments

AB
(input/output) REAL or COMPLEX array, shape $(:,:)$ with $size$(AB,1) $= ka+1$ and $size$(AB,2) $= n$, where $ka$ is the number of subdiagonals or superdiagonals in the band of $A$ and $n$ is the order of $A$ and $B$.
On entry, the upper (if UPLO = 'U') or lower (if UPLO = 'L') triangle of $A$ in band storage. The $ka+1$ diagonals of $A$ are stored in the rows of AB so that the $j^{th}$ column of $A$ is stored in the $j^{th}$ column of ${\bf AB}$ as follows:

\begin{displaymath}
\begin{array}{c\vert c\vert c}
A_{i,j} & i,j & {\bf UPLO} ...
...1 \leq j \leq n \end{array} & \mbox{'L'} \\ \hline
\end{array}\end{displaymath}

On exit, the contents of AB are destroyed.

BB
(input/output) REAL or COMPLEX array, shape $(:,:)$ with $size$(BB,1) $= kb+1$ and $size$(BB,2) $= n$, where $kb$ is the number of subdiagonals or superdiagonals in the band of $B$.
On entry, the upper (if UPLO = 'U') or lower (if UPLO = 'L') triangle of matrix $B$ in band storage. The $kb+1$ diagonals of $B$ are stored in the rows of BB so that the $j^{th}$ column of $B$ is stored in the $j^{th}$ column of ${\bf BB}$ as follows:

\begin{displaymath}
\begin{array}{c\vert c\vert c}
B_{i,j} & i,j & {\bf UPLO} ...
...1 \leq j \leq n \end{array} & \mbox{'L'} \\ \hline
\end{array}\end{displaymath}

On exit, the factor $S$ from the split Cholesky factorization $B = S^H\,S$.

W
(output) REAL array, shape $(:)$ with $size({\bf W}) = n$.
The first M elements contain the selected eigenvalues in ascending order.

UPLO
Optional (input) CHARACTER(LEN=1).

\begin{optionarg}
\item[{$ =$\ 'U':}] Upper triangles of $A$\ and $B$\ are stor...
...item[{$ =$\ 'L':}] Lower triangles of $A$\ and $B$\ are stored.
\end{optionarg}
Default value: 'U'.

Z
Optional (output) REAL or COMPLEX square array, shape $(:,:)$ with $size$(Z,1) $= n$.
The first M columns of Z contain the orthonormal eigenvectors corresponding to the selected eigenvalues, with the i$^{th}$ column of Z containing the eigenvector associated with the eigenvalue in W$_i$. The eigenvectors are normalized so that $Z^HBZ = I$. If an eigenvector fails to converge, then that column of Z contains the latest approximation to the eigenvector and the index of the eigenvector is returned in IFAIL.

VL,VU
Optional (input) REAL.
The lower and upper bounds of the interval to be searched for eigenvalues. VL $<$ VU.
Default values: VL $=$ -HUGE(wp) and VU $=$ HUGE(wp), where wp ::= KIND(1.0) $\mid$ KIND(1.0D0).
Note: Neither VL nor VU may be present if IL and/or IU is present.

IL,IU
Optional (input) INTEGER.
The indices of the smallest and largest eigenvalues to be returned. The ${\bf IL}^{th}$ through ${\bf IU}^{th}$ eigenvalues will be found. $1 \leq {\bf IL} \leq {\bf IU} \leq size({\bf A},1)$.
Default values: IL $= 1$ and IU $=$ $size$(A,1).
Note: Neither IL nor IU may be present if VL and/or VU is present.
Note: All eigenvalues are calculated if none of the arguments VL, VU, IL and IU are present.

M
Optional (output) INTEGER.
The total number of eigenvalues found. $0 \leq {\bf M} \leq size({\bf A},1)$.
Note: If ${\bf IL}$ and ${\bf IU}$ are present then ${\bf M} = {\bf IU}-{\bf IL}+1$.

IFAIL
Optional (output) INTEGER array, shape $(:)$ with $size$(IFAIL) $= n$.
If INFO $= 0$, the first M elements of IFAIL are zero.
If INFO $ > 0$, then IFAIL contains the indices of the eigenvectors that failed to converge. Note: If Z is present then IFAIL should also be present.

Q
Optional (output) REAL or COMPLEX square array, shape(:,:) with $size({\bf Q},1) = n$.
If Z is present, the matrix used in the reduction of $A\, z=\lambda \, B\, z$ to tridiagonal form.

ABSTOL
Optional (input) REAL.
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

\begin{displaymath}{\bf ABSTOL} + {\bf EPSILON}(1.0\_{\it wp})\times
\max(\mid a\mid,\mid b\mid),\end{displaymath}

where wp is the working precision. If ABSTOL $\leq 0$, then ${\bf EPSILON}(1.0\_{\it wp})\times \Vert T \Vert _1 $ will be used in its place, where $\Vert T \Vert _1$ is the $l_1$ norm of the tridiagonal matrix obtained by reducing the generalized eigenvalue problem to tridiagonal form. Eigenvalues will be computed most accurately when ABSTOL is set to twice the underflow threshold $2\times {\bf LA\_LAMCH}(1.0\_{\it wp},\mbox{'S'})$, not zero.
Default value: $0.0\_{\it wp}$.
Note: If this routine returns with $ 0 < {\bf INFO} \leq n$, then some eigenvectors did not converge. Try setting ABSTOL to $2\times {\bf LA\_LAMCH}(1.0\_{\it wp},\mbox{'S'})$.

INFO
Optional (output) INTEGER.

\begin{infoarg}
\item[{$= 0$:}] successful exit.
\item[{$< 0$:}] if {\bf INFO}...
...d and
no eigenvalues or eigenvectors were computed.
\end{infoarg}\end{infoarg}
If INFO is not present and an error occurs, then the program is terminated with an error message.

References: [1] and [17,9,20,21].
next up previous contents index
Next: Example (from Program LA_SBGVX_EXAMPLE) Up: Generalized Symmetric Eigenvalue Problems Previous: Purpose   Contents   Index
Susan Blackford 2001-08-19