Developer Reference for Intel® oneAPI Math Kernel Library for C

ID 766684
Date 7/13/2023
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents

?hpevd

Uses divide and conquer algorithm to compute all eigenvalues and, optionally, all eigenvectors of a complex Hermitian matrix held in packed storage.

Syntax

lapack_int LAPACKE_chpevd( int matrix_layout, char jobz, char uplo, lapack_int n, lapack_complex_float* ap, float* w, lapack_complex_float* z, lapack_int ldz );

lapack_int LAPACKE_zhpevd( int matrix_layout, char jobz, char uplo, lapack_int n, lapack_complex_double* ap, double* w, lapack_complex_double* z, lapack_int ldz );

Include Files

  • mkl.h

Description

The routine computes all the eigenvalues, and optionally all the eigenvectors, of a complex Hermitian matrix A (held in packed storage). In other words, it can compute the spectral factorization of A as: A = Z*Λ*ZH.

Here Λ is a real diagonal matrix whose diagonal elements are the eigenvalues λi, and Z is the (complex) unitary matrix whose columns are the eigenvectors zi. Thus,

A*zi = λi*zi for i = 1, 2, ..., n.

If the eigenvectors are requested, then this routine 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.

Input Parameters

matrix_layout

Specifies whether matrix storage layout is row major (LAPACK_ROW_MAJOR) or column major (LAPACK_COL_MAJOR).

jobz

Must be 'N' or 'V'.

If jobz = 'N', then only eigenvalues are computed.

If jobz = 'V', then eigenvalues and eigenvectors are computed.

uplo

Must be 'U' or 'L'.

If uplo = 'U', ap stores the packed upper triangular part of A.

If uplo = 'L', ap stores the packed lower triangular part of A.

n

The order of the matrix A (n 0).

ap

ap contains the packed upper or lower triangle of Hermitian matrix A, as specified by uplo.

The dimension of ap must be at least max(1, n*(n+1)/2).

ldz

The leading dimension of the output array z.

Constraints:

if jobz = 'N', then ldz 1;

if jobz = 'V', then ldz max(1, n).

Output Parameters

w

Array, size at least max(1, n).

If info = 0, contains the eigenvalues of the matrix A in ascending order. See also info.

z

Array, size 1 if jobz = 'N' and max(1, ldz*n) if jobz = 'V'.

If jobz = 'V', then this array is overwritten by the unitary matrix Z which contains the eigenvectors of A.

If jobz = 'N', then z is not referenced.

ap

On exit, this array 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.

Return Values

This function returns a value info.

If info=0, the execution is successful.

If info = -i, the i-th parameter had an illegal value.

If info = i, then the algorithm failed to converge; i indicates the number of elements of an intermediate tridiagonal form which did not converge to zero.

Application Notes

The computed eigenvalues and eigenvectors are exact for a matrix A + E such that ||E||2 = O(ε)*||A||2, where ε is the machine precision.

The real analogue of this routine is spevd.

See also heevd for matrices held in full storage, and hbevd for banded matrices.