SRC/zheevx_2stage.f(3)

📦
version 3.12.1 · 7 versions
, in arch rolling

okay bestie, welcome to the glow-up of SRC/zheevx_2stage.f, straight from the LAPACK Library Functions Manual. this page is all about ZHEEVX_2STAGE and it's lowkey iconic ✨

✨ NAME ✨

SRC/zheevx_2stage.f 💖

🌸 SYNOPSIS 🌸

Functions/Subroutines:

subroutine zheevx_2stage (jobz, range, uplo, n, a, lda, vl, vu, il, iu,
    abstol, m, w, z, ldz, work, lwork, rwork, iwork, ifail, info)

ZHEEVX_2STAGE computes the eigenvalues and, optionally, the left and/or right eigenvectors for HE matrices. no cap, that's the whole vibe 🦋

💅 Function/Subroutine Documentation 💅

🎀 subroutine zheevx_2stage 🎀

subroutine zheevx_2stage (character jobz, character range, character uplo,
    integer n, complex*16, dimension( lda, * ) a, integer lda, double
    precision vl, double precision vu, integer il, integer iu, double
    precision abstol, integer m, double precision, dimension( * ) w,
    complex*16, dimension( ldz, * ) z, integer ldz, complex*16, dimension( *
    ) work, integer lwork, double precision, dimension( * ) rwork, integer,
    dimension( * ) iwork, integer, dimension( * ) ifail, integer info)

ZHEEVX_2STAGE computes the eigenvalues and, optionally, the left and/or right eigenvectors for HE matrices. it's giving main character energy for sure 👑

🎯 Purpose 🎯

okay so the actual purpose is: ZHEEVX_2STAGE computes selected eigenvalues and, optionally, eigenvectors of a complex Hermitian matrix A using the 2stage technique for the reduction to tridiagonal. eigenvalues and eigenvectors can be selected by specifying either a range of values or a range of indices for the desired eigenvalues. periodt. 💫

🧾 Parameters 🧾

🔤 JOBZ 🔤

JOBZ is CHARACTER*1.

  • 'N': compute eigenvalues only.
  • 'V': compute eigenvalues and eigenvectors.
heads up bestie: 'V' is not available in this release. 😭

🌈 RANGE 🌈

RANGE is CHARACTER*1.

  • 'A': all eigenvalues will be found.
  • 'V': all eigenvalues in the half-open interval (VL,VU] will be found.
  • 'I': the IL-th through IU-th eigenvalues will be found.

🦋 UPLO 🦋

UPLO is CHARACTER*1.

  • 'U': upper triangle of A is stored.
  • 'L': lower triangle of A is stored.

🔢 N 🔢

N is INTEGER.

the order of the matrix A. N >= 0. slay, a whole dimension 💅

💖 A 💖

A is COMPLEX*16 array, dimension (LDA, N).

on entry, the Hermitian matrix A. if UPLO = 'U', the leading N-by-N upper triangular part of A contains the upper triangular part of the matrix A. if UPLO = 'L', the leading N-by-N lower triangular part of A contains the lower triangular part of the matrix A.

warning, bestie: on exit, the lower triangle (if UPLO='L') or the upper triangle (if UPLO='U') of A, including the diagonal, is destroyed. not me losing data 💀

🧚 LDA 🧚

LDA is INTEGER.

the leading dimension of the array A. LDA >= max(1,N). 🫶

🍓 VL 🍓

VL is DOUBLE PRECISION.

if RANGE='V', the lower bound of the interval to be searched for eigenvalues. VL < VU.

not referenced if RANGE = 'A' or 'I'.

🍓 VU 🍓

VU is DOUBLE PRECISION.

if RANGE='V', the upper bound of the interval to be searched for eigenvalues. VL < VU.

not referenced if RANGE = 'A' or 'I'.

🌟 IL 🌟

IL is INTEGER.

if RANGE='I', the index of the smallest eigenvalue to be returned.

1 <= IL <= IU <= N, if N > 0; IL = 1 and IU = 0 if N = 0.

not referenced if RANGE = 'A' or 'V'.

🌟 IU 🌟

IU is INTEGER.

if RANGE='I', the index of the largest eigenvalue to be returned.

1 <= IL <= IU <= N, if N > 0; IL = 1 and IU = 0 if N = 0.

not referenced if RANGE = 'A' or 'V'.

🎀 ABSTOL 🎀

ABSTOL is DOUBLE PRECISION.

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:

ABSTOL + EPS *   max( |a|,|b| ) ,

where EPS is the machine precision. if ABSTOL is less than or equal to zero, then EPS*|T| will be used in its place, where |T| is the 1-norm of the tridiagonal matrix obtained by reducing A to tridiagonal form.

eigenvalues will be computed most accurately when ABSTOL is set to twice the underflow threshold 2*DLAMCH('S'), not zero. if this routine returns with INFO>0, indicating that some eigenvectors did not converge, try setting ABSTOL to 2*DLAMCH('S').

it also says: “See by Demmel and Kahan, LAPACK Working Note #3.” yes, the source has that little gap; I'm not inventing a title, bestie 🙈

🔢 M 🔢

M is INTEGER.

the total number of eigenvalues found. 0 <= M <= N.

if RANGE = 'A', M = N, and if RANGE = 'I', M = IU-IL+1.

💜 W 💜

W is DOUBLE PRECISION array, dimension (N).

on normal exit, the first M elements contain the selected eigenvalues in ascending order. ate. 💅

🦋 Z 🦋

Z is COMPLEX*16 array, dimension (LDZ, max(1,M)).

if JOBZ = 'V', then if INFO = 0, the first M columns of Z contain the orthonormal eigenvectors of the matrix A corresponding to the selected eigenvalues, with the i-th column of Z holding the eigenvector associated with W(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.

if JOBZ = 'N', then Z is not referenced.

note: the user must ensure that at least max(1,M) columns are supplied in the array Z; if RANGE = 'V', the exact value of M is not known in advance and an upper bound must be used. plan ahead, bestie 🫶

🧚 LDZ 🧚

LDZ is INTEGER.

the leading dimension of the array Z. LDZ >= 1, and if JOBZ = 'V', LDZ >= max(1,N). ✨

🔥 WORK 🔥

WORK is COMPLEX*16 array, dimension (MAX(1,LWORK)).

on exit, if INFO = 0, WORK(1) returns the optimal LWORK. iconic. 👑

🔥 LWORK 🔥

LWORK is INTEGER.

the length of the array WORK. LWORK >= 1, when N <= 1; otherwise...

if JOBZ = 'N' and N > 1, LWORK must be queried.

LWORK = MAX(1, 8*N, dimension) where
        dimension = max(stage1,stage2) + (KD+1)*N + N
                  = N*KD + N*max(KD+1,FACTOPTNB)
                    + max(2*KD*KD, KD*NTHREADS)
                    + (KD+1)*N + N

where KD is the blocking size of the reduction, FACTOPTNB is the blocking used by the QR or LQ algorithm, usually FACTOPTNB=128 is a good choice, and NTHREADS is the number of threads used when openMP compilation is enabled, otherwise =1.

if JOBZ = 'V' and N > 1, LWORK must be queried. not yet available.

if LWORK = -1, then a workspace query is assumed; the routine only calculates the optimal size of the WORK array, returns this value as the first entry of the WORK array, and no error message related to LWORK is issued by XERBLA. very demure, very workspace-query 💅

🍓 RWORK 🍓

RWORK is DOUBLE PRECISION array, dimension (7*N).

🍓 IWORK 🍓

IWORK is INTEGER array, dimension (5*N).

🎀 IFAIL 🎀

IFAIL is INTEGER array, dimension (N).

if JOBZ = 'V', then 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.

if JOBZ = 'N', then IFAIL is not referenced. 🫶

🚨 INFO 🚨

INFO is INTEGER.

  • = 0: successful exit.
  • < 0: if INFO = -i, the i-th argument had an illegal value.
  • > 0: if INFO = i, then i eigenvectors failed to converge. their indices are stored in array IFAIL.

🌟 Author 🌟

  • Univ. of Tennessee
  • Univ. of California Berkeley
  • Univ. of Colorado Denver
  • NAG Ltd.

🔥 Further Details 🔥

all details about the 2stage techniques are available in:

  • Azzam Haidar, Hatem Ltaief, and Jack Dongarra. Parallel reduction to condensed forms for symmetric eigenvalue problems using aggregated fine-grained and memory-aware kernels. In Proceedings of 2011 International Conference for High Performance Computing, Networking, Storage and Analysis (SC '11), New York, NY, USA, Article 8 , 11 pages. http://doi.acm.org/10.1145/2063384.2063394
  • A. Haidar, J. Kurzak, P. Luszczek, 2013. An improved parallel singular value algorithm and its implementation for multicore hardware, In Proceedings of 2013 International Conference for High Performance Computing, Networking, Storage and Analysis (SC '13). Denver, Colorado, USA, 2013. Article 90, 12 pages. http://doi.acm.org/10.1145/2503210.2503292
  • A. Haidar, R. Solca, S. Tomov, T. Schulthess and J. Dongarra. A novel hybrid CPU-GPU generalized eigensolver for electronic structure calculations based on fine-grained memory aware tasks. International Journal of High Performance Computing Applications. Volume 28 Issue 2, Pages 196-209, May 2014. http://hpc.sagepub.com/content/28/2/196

Definition at line 303 of file zheevx_2stage.f. 💖

🤖 Author 🤖

Generated automatically by Doxygen for LAPACK from the source code.

cute little sign-off: this came from LAPACK Version 3.12.0, source SRC/zheevx_2stage.f(3) — no date in the footer, so I'm not inventing one, mwah 💋

📦 where this page comes from