p?heevd

Developer Reference for Intel® oneAPI Math Kernel Library for Fortran

Download PDF

ID 766686

Date 7/13/2023

Version

Public

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

Visible to Intel only — GUID: GUID-40A88A9C-27AD-46D8-B791-3E989955E1A6

View Details

p?heevd

Computes all eigenvalues and eigenvectors of a complex Hermitian matrix by using a divide and conquer algorithm.

Syntax

call pcheevd(jobz, uplo, n, a, ia, ja, desca, w, z, iz, jz, descz, work, lwork, rwork, lrwork, iwork, liwork, info)

call pzheevd(jobz, uplo, n, a, ia, ja, desca, w, z, iz, jz, descz, work, lwork, rwork, lrwork, iwork, liwork, info)

Include Files

Description

The p?heevd routine computes all eigenvalues and eigenvectors of a complex Hermitian matrix A by using a divide and conquer algorithm.

Input Parameters

np = the number of rows local to a given process.

nq = the number of columns local to a given process.

jobz

(global) CHARACTER*1. Must be 'N' or 'V'.

Specifies if it is necessary to compute the eigenvectors:

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

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

uplo

(global) CHARACTER*1. Must be 'U' or 'L'.

Specifies whether the upper or lower triangular part of the Hermitian matrix A is stored:

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

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

n

(global) INTEGER. The number of rows and columns of the matrix A(n≥ 0).

a

(local).

COMPLEX for pcheevd

DOUBLE COMPLEX for pzheevd.

Block cyclic array of global size (n, n) and local size (lld_a, LOCc(ja+n-1)). On entry, the Hermitian matrix A.

If uplo = 'U', only the upper triangular part of A is used to define the elements of the Hermitian matrix.

If uplo = 'L', only the lower triangular part of A is used to define the elements of the Hermitian matrix.

ia, ja

(global) INTEGER. The row and column indices in the global matrix A indicating the first row and the first column of the submatrix A, respectively.

desca

(global and local) INTEGER array of size dlen_. The array descriptor for the distributed matrix A. If desca(ctxt_) is incorrect, p?heevd cannot guarantee correct error reporting.

iz, jz

(global) INTEGER. The row and column indices in the global matrix Z indicating the first row and the first column of the submatrix Z, respectively.

descz

(global and local) INTEGER array of size dlen_. The array descriptor for the distributed matrix Z. descz(ctxt_) must equal desca(ctxt_).

work

(local).

COMPLEX for pcheevd

DOUBLE COMPLEX for pzheevd.

Array of size lwork.

lwork

(local) INTEGER. The size of the array work.

If eigenvalues are requested:

lwork = n + (nb0 + mq0 + nb)*nb

with np0 = numroc( max( n, nb, 2 ), nb, 0, 0, NPROW)

mq0 = numroc( max( n, nb, 2 ), nb, 0, 0, NPCOL)

If lwork = -1, then lwork is global input and a workspace query is assumed; the routine only calculates the size required for optimal performance for all work arrays. The required workspace is returned as the first element of the corresponding work arrays, and no error message is issued by pxerbla.

rwork

(local).

REAL for pcheevd

DOUBLE PRECISION for pzheevd.

Workspace array of size lrwork.

lrwork

(local) INTEGER. The size of the array rwork.

lrwork≥ 1 + 9*n + 3*np*nq,

with np = numroc( n, nb, myrow, iarow, NPROW)

nq = numroc( n, nb, mycol, iacol, NPCOL)

iwork

(local) INTEGER. Workspace array of size liwork.

liwork

(local) INTEGER , size of iwork.

liwork = 7*n + 8*npcol + 2.

Output Parameters

a

On exit, the lower triangle (if uplo = 'L'), or the upper triangle (if uplo = 'U') of A, including the diagonal, is overwritten.

w

(global).

REAL for pcheevd

DOUBLE PRECISION for pzheevd.

Array of size n. If info = 0, w contains the eigenvalues in the ascending order.

z

(local).

COMPLEX for pcheevd

DOUBLE COMPLEX for pzheevd.

Array, global size (n, n), local size (lld_z, LOCc(jz+n-1)).

The z parameter contains the orthonormal eigenvectors of the matrix A.

work(1)

On exit, returns adequate workspace to allow optimal performance.

rwork(1)

(local)

COMPLEX for pcheevd

DOUBLE COMPLEX for pzheevd.

On output, rwork(1) returns workspace required to guarantee completion.

iwork(1)

(local).

On return, iwork(1) contains the amount of integer workspace required.

info

(global) INTEGER.

If info = 0, the execution is successful.

If info < 0:

If the i-th argument is an array and the j-entry had an illegal value, then info = -(i*100+j). If the i-th argument is a scalar and had an illegal value, then info = -i.

If info> 0:

If info = 1 through n, the i-th eigenvalue did not converge.

Parent topic: ScaLAPACK Driver Routines

Select Your Language

Using Intel.com Search

Quick Links

Recent Searches

Advanced Search

Only search in

Developer Reference for Intel® oneAPI Math Kernel Library for Fortran

p?heevd

Syntax

Include Files

Description

Input Parameters

Output Parameters

See Also