naginterfaces.library.lapackeig.zhbtrd

naginterfaces.library.lapackeig.zhbtrd(vect, uplo, kd, ab, q=None)[source]

zhbtrd reduces a complex Hermitian band matrix to tridiagonal form.

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

https://www.nag.com/numeric/nl/nagdoc_28.6/flhtml/f08/f08hsf.html

Parameters
vectstr, length 1

Indicates whether is to be returned.

is returned.

is updated (and the array must contain a matrix on entry).

is not required.

uplostr, length 1

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

The upper triangular part of is stored.

The lower triangular part of is stored.

kdint

If , the number of superdiagonals, , of the matrix .

If , the number of subdiagonals, , of the matrix .

abcomplex, array-like, shape

The upper or lower triangle of the Hermitian band matrix .

qNone or complex, array-like, shape , optional

Note: the required extent for this argument in dimension 1 is determined as follows: if : ; if : ; otherwise: .

Note: the required extent for this argument in dimension 2 is determined as follows: if : ; if : ; otherwise: .

If , must contain the matrix formed in a previous stage of the reduction (for example, the reduction of a banded Hermitian-definite generalized eigenproblem); otherwise need not be set.

Returns
abcomplex, ndarray, shape

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

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

dfloat, ndarray, shape

The diagonal elements of the tridiagonal matrix .

efloat, ndarray, shape

The off-diagonal elements of the tridiagonal matrix .

qNone or complex, ndarray, shape

If or , the matrix .

If , is not referenced.

Raises
NagValueError
(errno )

On entry, error in parameter .

Constraint: , or .

(errno )

On entry, error in parameter .

Constraint: or .

(errno )

On entry, error in parameter .

Constraint: .

(errno )

On entry, error in parameter .

Constraint: .

Notes

zhbtrd reduces a Hermitian band matrix to real symmetric tridiagonal form by a unitary similarity transformation:

The unitary matrix is determined as a product of Givens rotation matrices, and may be formed explicitly by the function if required.

The function uses a vectorizable form of the reduction, due to Kaufman (1984).

References

Kaufman, L, 1984, Banded eigenvalue solvers on vector machines, ACM Trans. Math. Software (10), 73–86

Parlett, B N, 1998, The Symmetric Eigenvalue Problem, SIAM, Philadelphia