naginterfaces.library.lapackeig.zhbevd

naginterfaces.library.lapackeig.zhbevd(job, uplo, kd, ab)

zhbevd computes all the eigenvalues and, optionally, all the eigenvectors of a complex Hermitian band matrix. If the eigenvectors are requested, then it uses a divide-and-conquer algorithm to compute eigenvalues and eigenvectors. However, if only eigenvalues are required, then it uses the Pal–Walker–Kahan variant of the $QL$ or $QR$ algorithm.

For full information please refer to the NAG Library document for f08hq

https://www.nag.com/numeric/nl/nagdoc_29.3/flhtml/f08/f08hqf.html

Parameters

jobstr, length 1

Indicates whether eigenvectors are computed.

$job=\text{'N'}$

Only eigenvalues are computed.

$job=\text{'V'}$

Eigenvalues and eigenvectors are computed.

uplostr, length 1

Indicates whether the upper or lower triangular part of $A$ is stored.

$uplo=\text{'U'}$

The upper triangular part of $A$ is stored.

$uplo=\text{'L'}$

The lower triangular part of $A$ is stored.

kdint

If $uplo=\text{'U'}$, the number of superdiagonals, $k_d$, of the matrix $A$.

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

abcomplex, array-like, shape $(kd+1,n)$

The upper or lower triangle of the $n\times n$ Hermitian band matrix $A$.

Returns

abcomplex, ndarray, shape $(kd+1,n)$

$ab$ is overwritten by values generated during the reduction to tridiagonal form.

The first superdiagonal or subdiagonal and the diagonal of the tridiagonal matrix $T$ are returned in $ab$ using the same storage format as described above.

wfloat, ndarray, shape $\left(n\right)$

The eigenvalues of the matrix $A$ in ascending order.

zcomplex, ndarray, shape $(:,:)$

If $job=\text{'V'}$, $z$ is overwritten by the unitary matrix $Z$ which contains the eigenvectors of $A$. The $i$th column of $Z$ contains the eigenvector which corresponds to the eigenvalue $w[i-1]$.

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

Raises

NagValueError

(errno $-1$)

On entry, error in parameter $job$.

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

(errno $-2$)

On entry, error in parameter $uplo$.

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

(errno $-3$)

On entry, error in parameter $\text{n}$.

Constraint: $n\ge 0$.

(errno $-4$)

On entry, error in parameter $kd$.

Constraint: $kd\ge 0$.

(errno $i>0$)

If $\text{errno}=⟨value⟩$ and $job=\text{'N'}$, the algorithm failed to converge; $⟨value⟩$ elements of an intermediate tridiagonal form did not converge to zero; if $\text{errno}=⟨value⟩$ and $job=\text{'V'}$, then the algorithm failed to compute an eigenvalue while working on the submatrix lying in rows and column $⟨value⟩/(n+1)$ through $mod(⟨value⟩,n+1)$.

Notes

zhbevd computes all the eigenvalues and, optionally, all the eigenvectors of a complex Hermitian band matrix $A$. In other words, it can compute the spectral factorization of $A$ as

$$A=Z\Lambda Z^H\text{,}$$

where $\Lambda$ is a real diagonal matrix whose diagonal elements are the eigenvalues ${\lambda }_i$, and $Z$ is the (complex) unitary matrix whose columns are the eigenvectors $z_i$. Thus

$$A{z}_i={\lambda }_i{z}_i\text{,}i=1,2,\dots ,n\text{.}$$

References

Anderson, E, Bai, Z, Bischof, C, Blackford, S, Demmel, J, Dongarra, J J, Du Croz, J J, Greenbaum, A, Hammarling, S, McKenney, A and Sorensen, D, 1999, LAPACK Users’ Guide, (3rd Edition), SIAM, Philadelphia, https://www.netlib.org/lapack/lug

Golub, G H and Van Loan, C F, 1996, Matrix Computations, (3rd Edition), Johns Hopkins University Press, Baltimore