heevd_2stage(3)

πŸ¦‹ heevd_2stage(3) β€” Library Functions Manual πŸ¦‹

okay so bestie, welcome to heevd_2stage β€” yes that's the manual name, it lives in Library Functions Manual, and honestly the whole thing is a vibe. we're doing eig, and it's giving divide and conquer energy. grab a snack, this one's a baddie with a LOT of options πŸ’…βœ¨


✨ NAME ✨

heevd_2stage β€” {he,sy}evd_2stage: eig, divide and conquer

like… the whole point. you hand it a matrix, it hands you back eigenvalues (and maybe eigenvectors, we'll get into it), and it does the reduction to tridiagonal with the 2stage technique. iconic behavior, no cap πŸŽ€


🌈 SYNOPSIS 🌈

🫢 Functions

πŸ’œ cheevd_2stage

subroutine cheevd_2stage (jobz, uplo, n, a, lda, w, work, lwork, rwork,
    lrwork, iwork, liwork, info)

CHEEVD_2STAGE computes the eigenvalues and, optionally, the left and/or right eigenvectors for HE matrices

🌸 dsyevd_2stage

subroutine dsyevd_2stage (jobz, uplo, n, a, lda, w, work, lwork, iwork,
    liwork, info)

DSYEVD_2STAGE computes the eigenvalues and, optionally, the left and/or right eigenvectors for SY matrices

πŸ¦‹ ssyevd_2stage

subroutine ssyevd_2stage (jobz, uplo, n, a, lda, w, work, lwork, iwork,
    liwork, info)

SSYEVD_2STAGE computes the eigenvalues and, optionally, the left and/or right eigenvectors for SY matrices

πŸŽ€ zheevd_2stage

subroutine zheevd_2stage (jobz, uplo, n, a, lda, w, work, lwork, rwork,
    lrwork, iwork, liwork, info)

ZHEEVD_2STAGE computes the eigenvalues and, optionally, the left and/or right eigenvectors for HE matrices


πŸ’– Detailed Description πŸ’–

so the Detailed Description is where the real tea is, and the Function Documentation has the receipts for every single subroutine, one by one. we're going in order, no skipping, because bestie you deserve every parameter πŸ’œ


πŸ”₯ Function Documentation πŸ”₯

⭐ subroutine cheevd_2stage

subroutine cheevd_2stage (character jobz, character uplo, integer n,
    complex, dimension( lda, * ) a, integer lda, real, dimension( * ) w,
    complex, dimension( * ) work, integer lwork, real, dimension( * ) rwork,
    integer lrwork, integer, dimension( * ) iwork, integer liwork, integer
    info)

CHEEVD_2STAGE computes the eigenvalues and, optionally, the left and/or right eigenvectors for HE matrices πŸ‘‘

🎯 Purpose

CHEEVD_2STAGE computes all eigenvalues and, optionally, eigenvectors of a complex Hermitian matrix A using the 2stage technique for the reduction to tridiagonal. If eigenvectors are desired, it uses a divide and conquer algorithm.

fr fr it's doing a lot for you and it's not even charging rent 🫢

🌟 Parameters

  • JOBZ JOBZ is CHARACTER*1
    • 'N': Compute eigenvalues only;
    • 'V': Compute eigenvalues and eigenvectors. Not available in this release.
okay important: 'V' is literally listed as not available in this release β€” so don't come crying to me when it doesn't do the thing πŸ™ˆ
  • UPLO UPLO is CHARACTER*1
    • 'U': Upper triangle of A is stored;
    • 'L': Lower triangle of A is stored.

pick your fighter, and remember β€” only one triangle gets read ✨

  • N N is INTEGER The order of the matrix A. N >= 0.

zero is a valid order, matrix of nothing, we love a minimalist πŸ’…

  • A A is COMPLEX 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.

On exit, if JOBZ = 'V', then if INFO = 0, A contains the orthonormal eigenvectors of the matrix A.

If JOBZ = 'N', then on exit the lower triangle (if UPLO='L') or the upper triangle (if UPLO='U') of A, including the diagonal, is destroyed.

🫣 yes bestie, destroyed. the diagonal too. she's not coming back. work on a copy if you're emotionally attached.
  • LDA LDA is INTEGER The leading dimension of the array A. LDA >= max(1,N).
  • W W is REAL array, dimension (N) If INFO = 0, the eigenvalues in ascending order.

sorted for you, no extra charge, we love an organized queen 🌸

  • WORK WORK is COMPLEX array, dimension (MAX(1,LWORK)) On exit, if INFO = 0, WORK(1) returns the optimal LWORK.
  • LWORK LWORK is INTEGER The dimension of the array WORK.

If N <= 1, LWORK must be at least 1.

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

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

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, NTHREADS is the number of threads used when openMP compilation is enabled, otherwise =1.

If JOBZ = 'V' and N > 1, LWORK must be at least 2*N + N**2

If LWORK = -1, then a workspace query is assumed; the routine only calculates the optimal sizes of the WORK, RWORK and IWORK arrays, returns these values as the first entries of the WORK, RWORK and IWORK arrays, and no error message related to LWORK or LRWORK or LIWORK is issued by XERBLA.

🧚 the -1 thing is the classic "ask before you commit" move β€” you query, it tells you how much space it wants, then you allocate and come back. very demure, very mindful.
  • RWORK RWORK is REAL array, dimension (LRWORK) On exit, if INFO = 0, RWORK(1) returns the optimal LRWORK.
  • LRWORK LRWORK is INTEGER The dimension of the array RWORK.

If N <= 1, LRWORK must be at least 1.

If JOBZ = 'N' and N > 1, LRWORK must be at least N.

If JOBZ = 'V' and N > 1, LRWORK must be at least 1 + 5*N + 2*N**2.

If LRWORK = -1, then a workspace query is assumed; the routine only calculates the optimal sizes of the WORK, RWORK and IWORK arrays, returns these values as the first entries of the WORK, RWORK and IWORK arrays, and no error message related to LWORK or LRWORK or LIWORK is issued by XERBLA.

  • IWORK IWORK is INTEGER array, dimension (MAX(1,LIWORK)) On exit, if INFO = 0, IWORK(1) returns the optimal LIWORK.
  • LIWORK LIWORK is INTEGER The dimension of the array IWORK.

If N <= 1, LIWORK must be at least 1.

If JOBZ = 'N' and N > 1, LIWORK must be at least 1.

If JOBZ = 'V' and N > 1, LIWORK must be at least 3 + 5*N.

If LIWORK = -1, then a workspace query is assumed; the routine only calculates the optimal sizes of the WORK, RWORK and IWORK arrays, returns these values as the first entries of the WORK, RWORK and IWORK arrays, and no error message related to LWORK or LRWORK or LIWORK is issued by XERBLA.

πŸ’€ three separate arrays to query, three separate -1 flags. yes it's a lot. yes you have to do all of them. stay strong bestie.
  • INFO INFO is INTEGER
    • = 0: successful exit πŸŽ‰
    • < 0: if INFO = -i, the i-th argument had an illegal value
    • > 0: if INFO = i and JOBZ = 'N', then the algorithm failed to converge; i off-diagonal elements of an intermediate tridiagonal form did not converge to zero; if INFO = i and JOBZ = 'V', then the algorithm failed to compute an eigenvalue while working on the submatrix lying in rows and columns INFO/(N+1) through mod(INFO,N+1).
😭 a positive INFO is the algorithm saying "bestie I tried, here's exactly where it went sideways". read the number, it's telling you where.

πŸ‘‘ Author

Univ. of Tennessee

Univ. of California Berkeley

Univ. of Colorado Denver

NAG Ltd.

πŸ“š Further Details:

Modified description of INFO. Sven, 16 Feb 05.

(shoutout Sven 🫢)

🧠 Contributors:

Jeff Rutter, Computer Science Division, University of California at Berkeley, USA

πŸ”¬ 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
πŸ“– yes, all three papers stay. cite your sources, it's called being a scholar πŸ’…

Definition at line 245 of file cheevd_2stage.f.


⭐ subroutine dsyevd_2stage

subroutine dsyevd_2stage (character jobz, character uplo, integer n, double
    precision, dimension( lda, * ) a, integer lda, double precision,
    dimension( * ) w, double precision, dimension( * ) work, integer lwork,
    integer, dimension( * ) iwork, integer liwork, integer info)

DSYEVD_2STAGE computes the eigenvalues and, optionally, the left and/or right eigenvectors for SY matrices 🌸

🎯 Purpose

DSYEVD_2STAGE computes all eigenvalues and, optionally, eigenvectors of a real symmetric matrix A using the 2stage technique for the reduction to tridiagonal. If eigenvectors are desired, it uses a divide and conquer algorithm.

same energy as its complex sibling, just real and symmetric β€” and notice there's no RWORK/LRWORK situation here, she travels light ✨

🌟 Parameters

  • JOBZ JOBZ is CHARACTER*1
    • 'N': Compute eigenvalues only;
    • 'V': Compute eigenvalues and eigenvectors. Not available in this release.
πŸ™ˆ same warning bestie, 'V' still says not available in this release. don't say I didn't tell you twice.
  • 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.
  • A

…and that's exactly where the page cuts off, so A and everything after it for dsyevd_2stage is coming at you in the next part 🫢 hold that thought, bestie πŸ’–

  • A β€” DOUBLE PRECISION array, dimension (LDA, N). On entry this is your symmetric matrix A, bestie. If UPLO = 'U', the leading N-by-N upper triangular part of A holds the upper triangular part of the matrix A. If UPLO = 'L', the leading N-by-N lower triangular part of A holds the lower triangular part of the matrix A. On exit, if JOBZ = 'V', then when INFO = 0, A contains the orthonormal eigenvectors of the matrix A ✨. But if JOBZ = 'N', then on exit the lower triangle (when UPLO='L') or the upper triangle (when UPLO='U') of A, including the diagonal, is straight-up destroyed πŸ’€. Like, gone. She ate but she also emptied the fridge.
  • LDA β€” INTEGER. The leading dimension of the array A. LDA >= max(1,N). No cap, no notes, it's giving very simple rules πŸ’….
  • W β€” DOUBLE PRECISION array, dimension (N). If INFO = 0, this is where the eigenvalues live, in ascending order πŸŽ€. Sorted, tidy, iconic.
  • WORK β€” DOUBLE PRECISION array, dimension (LWORK). On exit, if INFO = 0, WORK(1) returns the optimal LWORK πŸ‘‘. She's a workspace girlie and she's telling you how much room she actually wanted.
  • LWORK β€” INTEGER. The dimension of the array WORK. Here's the whole ruleset, no skipping 🫢:
    • If N <= 1, LWORK must be at least 1.
    • If JOBZ = 'N' and N > 1, LWORK must be queried (yes, queried, don't guess ngl):
LWORK = MAX(1, dimension) where
        dimension = max(stage1,stage2) + (KD+1)*N + 2*N+1
                  = N*KD + N*max(KD+1,FACTOPTNB)
                    + max(2*KD*KD, KD*NTHREADS)
                    + (KD+1)*N + 2*N+1

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 at least 1 + 6*N + 2*N**2.

And the plot twist: if LWORK = -1, then a workspace query is assumed πŸ•΅οΈβ€β™€οΈ. The routine only calculates the optimal sizes of the WORK and IWORK arrays, returns these values as the first entries of the WORK and IWORK arrays, and no error message related to LWORK or LIWORK is issued by XERBLA. It's giving "just asking, not committing" energy.

  • IWORK β€” INTEGER array, dimension (MAX(1,LIWORK)). On exit, if INFO = 0, IWORK(1) returns the optimal LIWORK πŸ’œ.
  • LIWORK β€” INTEGER. The dimension of the array IWORK.
    • If N <= 1, LIWORK must be at least 1.
    • If JOBZ = 'N' and N > 1, LIWORK must be at least 1.
    • If JOBZ = 'V' and N > 1, LIWORK must be at least 3 + 5*N.

And same deal as before: if LIWORK = -1, then a workspace query is assumed β€” the routine only calculates the optimal sizes of the WORK and IWORK arrays, returns these values as the first entries of the WORK and IWORK arrays, and no error message related to LWORK or LIWORK is issued by XERBLA 🌈.

  • INFO β€” INTEGER. The vibe check at the end 😭:
    • = 0: successful exit πŸŽ‰ iconic, no notes.
    • < 0: if INFO = -i, the i-th argument had an illegal value πŸ™ˆ.
    • > 0: if INFO = i and JOBZ = 'N', then the algorithm failed to converge β€” i off-diagonal elements of an intermediate tridiagonal form did not converge to zero πŸ’€. If INFO = i and JOBZ = 'V', then the algorithm failed to compute an eigenvalue while working on the submatrix lying in rows and columns INFO/(N+1) through mod(INFO,N+1) πŸ”₯. Like bestie, those exact coordinates, write them down.

πŸ‘‘ Author

Univ. of Tennessee

Univ. of California Berkeley

Univ. of Colorado Denver

NAG Ltd.


🫢 Contributors:

Jeff Rutter, Computer Science Division, University of California at Berkeley, USA Modified by Francoise Tisseur, University of Tennessee Modified description of INFO. Sven, 16 Feb 05.


🧚 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 219 of file dsyevd_2stage.f πŸ“–.


🌸 subroutine ssyevd_2stage

subroutine ssyevd_2stage (character jobz, character uplo, integer n, real,
    dimension( lda, * ) a, integer lda, real, dimension( * ) w, real,
    dimension( * ) work, integer lwork, integer, dimension( * ) iwork,
    integer liwork, integer info)

SSYEVD_2STAGE computes the eigenvalues and, optionally, the left and/or right eigenvectors for SY matrices πŸ’–

Purpose:

SSYEVD_2STAGE computes all eigenvalues and, optionally, eigenvectors of a real symmetric matrix A using the 2stage technique for the reduction to tridiagonal. If eigenvectors are desired, it uses a divide and conquer algorithm πŸ¦‹.

Parameters

  • JOBZ β€” CHARACTER*1.
    • = 'N': Compute eigenvalues only;
    • = 'V': Compute eigenvalues and eigenvectors. Not available in this release. 😭 (I know. heartbreaking. not in this release, bestie.)
  • UPLO β€” CHARACTER*1.
    • = 'U': Upper triangle of A is stored;
    • = 'L': Lower triangle of A is stored.
  • N β€” INTEGER. The order of the matrix A. N >= 0. πŸŽ€
  • A β€” REAL array, dimension (LDA, N). On entry, the symmetric 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. On exit, if JOBZ = 'V', then if INFO = 0, A contains the orthonormal eigenvectors of the matrix A ✨. If JOBZ = 'N', then on exit the lower triangle (if UPLO='L') or the upper triangle (if UPLO='U') of A, including the diagonal, is destroyed πŸ’€.
  • LDA β€” INTEGER. The leading dimension of the array A. LDA >= max(1,N). πŸ’…
  • W β€” REAL array, dimension (N). If INFO = 0, the eigenvalues in ascending order 🌸.
  • WORK β€” REAL array, dimension (LWORK). On exit, if INFO = 0, WORK(1) returns the optimal LWORK πŸ‘‘.
  • LWORK β€” INTEGER. The dimension of the array WORK. Same energy as before, here we go:
    • If N <= 1, LWORK must be at least 1.
    • If JOBZ = 'N' and N > 1, LWORK must be queried:
LWORK = MAX(1, dimension) where
        dimension = max(stage1,stage2) + (KD+1)*N + 2*N+1
                  = N*KD + N*max(KD+1,FACTOPTNB)
                    + max(2*KD*KD, KD*NTHREADS)
                    + (KD+1)*N + 2*N+1

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 at least 1 + 6*N + 2*N**2.

If LWORK = -1, then a workspace query is assumed; the routine only calculates the optimal sizes of the WORK and IWORK arrays, returns these values as the first entries of the WORK and IWORK arrays, and no error message related to LWORK or LIWORK is issued by XERBLA πŸ•΅οΈβ€β™€οΈ.

  • IWORK β€” INTEGER array, dimension (MAX(1,LIWORK)). On exit, if INFO = 0, IWORK(1) returns the optimal LIWORK πŸ’œ.
  • LIWORK β€” πŸ’«

okay so LIWORK is INTEGER, bestie, and it's literally the dimension of the IWORK array πŸ’–

  • If N <= 1, LIWORK must be at least 1.
  • If JOBZ = 'N' and N > 1, LIWORK must be at least 1.
  • If JOBZ = 'V' and N > 1, LIWORK must be at least 3 + 5*N.
If LIWORK = -1, then a workspace query is assumed; the routine only calculates the optimal sizes of the WORK and IWORK arrays, returns these values as the first entries of the WORK and IWORK arrays, and no error message related to LWORK or LIWORK is issued by XERBLA.

INFO β€” INFO is INTEGER

  • = 0: successful exit
  • < 0: if INFO = -i, the i-th argument had an illegal value
  • > 0: if INFO = i and JOBZ = 'N', then the algorithm failed to converge; i off-diagonal elements of an intermediate tridiagonal form did not converge to zero; if INFO = i and JOBZ = 'V', then the algorithm failed to compute an eigenvalue while working on the submatrix lying in rows and columns INFO/(N+1) through mod(INFO,N+1).

Author

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

Contributors

  • Jeff Rutter, Computer Science Division, University of California at Berkeley, USA
  • Modified by Francoise Tisseur, University of Tennessee
  • Modified description of INFO. Sven, 16 Feb 05.

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 219 of file ssyevd_2stage.f.


subroutine zheevd_2stage

subroutine zheevd_2stage (character jobz, character uplo, integer n,
    complex*16, dimension( lda, * ) a, integer lda, double precision,
    dimension( * ) w, complex*16, dimension( * ) work, integer lwork, double
    precision, dimension( * ) rwork, integer lrwork, integer, dimension( * )
    iwork, integer liwork, integer info)

ZHEEVD_2STAGE computes the eigenvalues and, optionally, the left and/or right eigenvectors for HE matrices πŸ‘‘

Purpose

ZHEEVD_2STAGE computes all eigenvalues and, optionally, eigenvectors of a complex Hermitian matrix A using the 2stage technique for the reduction to tridiagonal. If eigenvectors are desired, it uses a divide and conquer algorithm ✨

Parameters

JOBZ β€” JOBZ is CHARACTER*1

  • = 'N': Compute eigenvalues only;
  • = 'V': Compute eigenvalues and eigenvectors. Not available in this release.

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.

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. On exit, if JOBZ = 'V', then if INFO = 0, A contains the orthonormal eigenvectors of the matrix A. If JOBZ = 'N', then on exit the lower triangle (if UPLO='L') or the upper triangle (if UPLO='U') of A, including the diagonal, is destroyed.

LDA β€” LDA is INTEGER The leading dimension of the array A. LDA >= max(1,N).

W β€” W is DOUBLE PRECISION array, dimension (N) If INFO = 0, the eigenvalues in ascending order.

WORK β€” WORK is COMPLEX*16 array, dimension (MAX(1,LWORK)) On exit, if INFO = 0, WORK(1) returns the optimal LWORK.

LWORK β€” LWORK is INTEGER The dimension of the array WORK.

  • If N <= 1, LWORK must be at least 1.
  • If JOBZ = 'N' and N > 1, LWORK must be queried.
LWORK = MAX(1, dimension) where
dimension = max(stage1,stage2) + (KD+1)*N + N+1
          = N*KD + N*max(KD+1,FACTOPTNB)
            + max(2*KD*KD, KD*NTHREADS)
            + (KD+1)*N + N+1
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
NTHREADS is the number of threads used when
openMP compilation is enabled, otherwise =1.
  • If JOBZ = 'V' and N > 1, LWORK must be at least 2*N + N**2
If LWORK = -1, then a workspace query is assumed; the routine only calculates the optimal sizes of the WORK, RWORK and IWORK arrays, returns these values as the first entries of the WORK, RWORK and IWORK arrays, and no error message related to LWORK or LRWORK or LIWORK is issued by XERBLA.

RWORK β€” RWORK is DOUBLE PRECISION array, dimension (LRWORK) On exit, if INFO = 0, RWORK(1) returns the optimal LRWORK.

LRWORK β€” LRWORK is INTEGER The dimension of the array RWORK.

  • If N <= 1, LRWORK must be at least 1.
  • If JOBZ = 'N' and N > 1, LRWORK must be at least N.
  • If JOBZ = 'V' and N > 1, LRWORK must be at least 1 + 5*N + 2*N**2.
If LRWORK = -1, then a workspace query is assumed; the routine only calculates the optimal sizes of the WORK, RWORK and IWORK arrays, returns these values as the first entries of the WORK, RWORK and IWORK arrays, and no error message related to LWORK or LRWORK or LIWORK is issued by XERBLA.

IWORK β€” IWORK is INTEGER array, dimension (MAX(1,LIWORK)) On exit, if INFO = 0, IWORK(1) returns the optimal LIWORK.

LIWORK β€” LIWORK is INTEGER The dimension of the array IWORK.

  • If N <= 1, LIWORK must be at least 1.
  • If JOBZ = 'N' and N > 1, LIWORK must be at least 1.
  • If JOBZ = 'V' and N > 1, LIWORK must be at least 3 + 5*N.
If LIWORK = -1, then a workspace query is assumed; the routine only calculates the optimal sizes of the WORK, RWORK and IWORK arrays, returns these values as the first entries of the WORK, RWORK and IWORK arrays, and no error message related to LWORK or LRWORK or LIWORK is issued by XERBLA.

INFO β€” INFO is INTEGER

  • = 0: successful exit
  • < 0: if INFO = -i, the i-th argument had an illegal value
  • > 0: if INFO = i and JOBZ = 'N', then the algorithm failed to converge; i off-diagonal elements of an intermediate tridiagonal form did not converge to zero; if INFO = i and JOBZ = 'V', then the algorithm failed to compute an eigenvalue while working on the submatrix lying in rows and columns INFO/(N+1) through mod(INFO,N+1).

Author

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

Further Details

Modified description of INFO. Sven, 16 Feb 05.

Contributors

  • Jeff Rutter, Computer Science Division, University of California at Berkeley, USA

Further Details

okay so, if you want the full 2stage lore, bestie, it's literally all right here β€” no gatekeeping:

  • 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

πŸ‘‘ Author πŸ‘‘

Generated automatically by Doxygen for LAPACK from the source code. iconic, honestly. πŸ’…

Also, for the record: Definition at line 245 of file zheevd_2stage.f. keep that receipt, iykyk. 🧾✨

Cute little footer sign-off, bestie: the source/version/date tea is <pink>LAPACK Version 3.12.0</pink>, <purple>heevd_2stage(3)</purple> β€” periodt, that's the vibe. πŸŽ€πŸ¦‹πŸ’–

πŸ“¦ where this page comes from