hpevd(3)

๐Ÿ’– NAME ๐Ÿ’–

hpevd โ€” {hp,sp}evd: eig, divide and conquer. that's the whole vibe bestie, no cap โœจ


โœจ SYNOPSIS โœจ

๐Ÿฆ‹ Functions

  • subroutine chpevd (jobz, uplo, n, ap, w, z, ldz, work, lwork, rwork, lrwork, iwork, liwork, info) โ€” CHPEVD computes the eigenvalues and, optionally, the left and/or right eigenvectors for OTHER matrices ๐Ÿ’…
  • subroutine dspevd (jobz, uplo, n, ap, w, z, ldz, work, lwork, iwork, liwork, info) โ€” DSPEVD computes the eigenvalues and, optionally, the left and/or right eigenvectors for OTHER matrices ๐Ÿ’…
  • subroutine sspevd (jobz, uplo, n, ap, w, z, ldz, work, lwork, iwork, liwork, info) โ€” SSPEVD computes the eigenvalues and, optionally, the left and/or right eigenvectors for OTHER matrices ๐Ÿ’…
  • subroutine zhpevd (jobz, uplo, n, ap, w, z, ldz, work, lwork, rwork, lrwork, iwork, liwork, info) โ€” ZHPEVD computes the eigenvalues and, optionally, the left and/or right eigenvectors for OTHER matrices ๐Ÿ’…

๐Ÿ’ซ Detailed Description ๐Ÿ’ซ

okay so this section is literally empty in the original โ€” nothing under it, bestie, we move straight to the good part ๐Ÿซถ


๐Ÿ”ฅ Function Documentation ๐Ÿ”ฅ

๐ŸŽ€ subroutine chpevd

subroutine chpevd (character jobz, character uplo, integer n, complex,
    dimension( * ) ap, real, dimension( * ) w, complex, dimension( ldz, * )
    z, integer ldz, complex, dimension( * ) work, integer lwork, real,
    dimension( * ) rwork, integer lrwork, integer, dimension( * ) iwork,
    integer liwork, integer info)

CHPEVD computes the eigenvalues and, optionally, the left and/or right eigenvectors for OTHER matrices

๐ŸŒŸ Purpose:

CHPEVD computes all the eigenvalues and, optionally, eigenvectors of a complex Hermitian matrix A in packed storage. If eigenvectors are desired, it uses a divide and conquer algorithm. iconic behavior fr ๐Ÿ”ฅ

๐ŸŒธ Parameters

  • JOBZ โ€” JOBZ is CHARACTER*1, so like, what do you actually want out of this:
    • = 'N': Compute eigenvalues only;
    • = 'V': Compute eigenvalues and eigenvectors.
  • UPLO โ€” UPLO is CHARACTER*1, which triangle are we even talking about:
    • = '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. (yes, zero is allowed, she's tiny but valid ๐Ÿ’€)
  • AP โ€” AP is COMPLEX array, dimension (N*(N+1)/2). On entry, the upper or lower triangle of the Hermitian matrix A, packed columnwise in a linear array. The j-th column of A is stored in the array AP as follows:
if UPLO = 'U', AP(i + (j-1)*j/2) = A(i,j) for 1<=i<=j;
if UPLO = 'L', AP(i + (j-1)*(2*n-j)/2) = A(i,j) for j<=i<=n.

On exit, AP is overwritten by values generated during the reduction to tridiagonal form. If UPLO = 'U', the diagonal and first superdiagonal of the tridiagonal matrix T overwrite the corresponding elements of A, and if UPLO = 'L', the diagonal and first subdiagonal of T overwrite the corresponding elements of A. so yeah, your input? gone. she ate it ๐Ÿ˜ญ

  • W โ€” W is REAL array, dimension (N). If INFO = 0, the eigenvalues in ascending order. cute, sorted, organized, main character energy ๐Ÿ‘‘
  • Z โ€” Z is COMPLEX array, dimension (LDZ, N). If JOBZ = 'V', then if INFO = 0, Z contains the orthonormal eigenvectors of the matrix A, with the i-th column of Z holding the eigenvector associated with W(i). If JOBZ = 'N', then Z is not referenced. (she said "don't talk to me" ๐Ÿ™ˆ)
  • 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 array, dimension (MAX(1,LWORK)). On exit, if INFO = 0, WORK(1) returns the required LWORK. she's a little snitch and that's a compliment ๐Ÿ’…
  • LWORK โ€” LWORK is INTEGER. The dimension of array WORK.
    • If N <= 1, LWORK must be at least 1.
    • If JOBZ = 'N' and N > 1, LWORK must be at least N.
    • If JOBZ = 'V' and N > 1, LWORK must be at least 2*N.
    • If LWORK = -1, then a workspace query is assumed; the routine only calculates the required 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 trick is basically "hey queen, how much room do I need?" ๐Ÿงš)
  • RWORK โ€” RWORK is REAL array, dimension (MAX(1,LRWORK)). On exit, if INFO = 0, RWORK(1) returns the required LRWORK.
  • LRWORK โ€” LRWORK is INTEGER. The dimension of 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 required 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 required LIWORK.
  • LIWORK โ€” LIWORK is INTEGER. The dimension of array IWORK.
    • If JOBZ = 'N' or 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 required 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, the receipts ๐Ÿงพ
    • = 0: successful exit (slay ๐ŸŽ‰)
    • < 0: if INFO = -i, the i-th argument had an illegal value. (you passed her something cursed, bestie)
    • > 0: if INFO = i, the algorithm failed to converge; i off-diagonal elements of an intermediate tridiagonal form did not converge to zero. (this one's the bad ending โ€” she tried and she could NOT ๐Ÿ˜ญ)

๐Ÿซถ Author

Univ. of Tennessee

Univ. of California Berkeley

Univ. of Colorado Denver

NAG Ltd.

โญ Definition at line 192 of file chpevd.f.


๐ŸŽ€ subroutine dspevd

subroutine dspevd (character jobz, character uplo, integer n, double
    precision, dimension( * ) ap, double precision, dimension( * ) w, double
    precision, dimension( ldz, * ) z, integer ldz, double precision,
    dimension( * ) work, integer lwork, integer, dimension( * ) iwork,
    integer liwork, integer info)

DSPEVD computes the eigenvalues and, optionally, the left and/or right eigenvectors for OTHER matrices

๐ŸŒŸ Purpose:

DSPEVD computes all the eigenvalues and, optionally, eigenvectors of a real symmetric matrix A in packed storage. If eigenvectors are desired, it uses a divide and conquer algorithm. same energy, double precision this time ๐Ÿ’œ

๐ŸŒธ Parameters

  • JOBZ โ€” JOBZ is CHARACTER*1
    • = 'N': Compute eigenvalues only;
    • = 'V': Compute eigenvalues and eigenvectors.
  • 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.
  • AP โ€” AP is DOUBLE PRECISION array, dimension (N*(N+1)/2). On entry, the upper or lower triangle of the symmetric matrix A, packed columnwise in a linear array. The j-th column of A is stored in the array AP as follows:
if UPLO = 'U', AP(i + (j-1)*j/2) = A(i,j) for 1<=i<=j;
if UPLO = 'L', AP(i + (j-1)*(2*n-j)/2) = A(i,j) for j<=i<=n.

On exit, AP is overwritten by values generated during the reduction to tridiagonal form. If UPLO = 'U', the diagonal and first superdiagonal of the tridiagonal matrix T overwrite the corresponding elements of A, and if UPLO = 'L', the diagonal and first subdiagonal of T overwrite the corresponding elements of A. again: your precious input gets replaced, that's just the deal ๐Ÿซ 

  • W โ€” W is DOUBLE PRECISION array, dimension (N). If INFO = 0, the eigenvalues in ascending order.
  • Z โ€” Z is DOUBLE PRECISION array, dimension (LDZ, N). If JOBZ = 'V', then if INFO = 0, Z contains the orthonormal eigenvectors of the matrix A, with the i-th column of Z holding the eigenvector associated with W(i). If JOBZ = 'N', then Z is not referenced.
  • LDZ โ€” LDZ is INTEGER. The leading dimension of the array Z. LDZ >= 1, and if JOBZ = 'V', LDZ >= max(1,N).
  • WORK โ€” WORK is DOUBLE PRECISION array, dimension (MAX(1,LWORK)). On exit, if INFO = 0, WORK(1) returns the required 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 at least 2*N.
    • If JOBZ = 'V' and N > 1, LWORK must be at least 1 + 6*N + N**2.
    • If LWORK = -1, then a workspace query is assumed; the routine only calculates the required 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. (yup, no RWORK in this one โ€” different routine, different baggage โœจ)
  • IWORK โ€” IWORK is INTEGER array, dimension (MAX(1,LIWORK)). On exit, if INFO = 0, IWORK(1) returns the required LIWORK.
  • LIWORK โ€”
  • LIWORK โ€” okay so LIWORK is INTEGER, and it's literally the dimension of the IWORK array, bestie. If JOBZ = 'N' or N <= 1, then LIWORK has to be at least 1. If JOBZ = 'V' and N > 1, then LIWORK must be at least 3 + 5*N. And if LIWORK = -1, that's the workspace-query vibe: the routine only calculates the required sizes of the WORK and IWORK arrays, returns those values as the first entries of the WORK and IWORK arrays, and XERBLA does not issue any error message related to LWORK or LIWORK. Periodt. ๐Ÿ’…
  • INFO โ€” INFO is INTEGER, and here's the tea: = 0 means successful exit ๐ŸŽ‰; < 0 means if INFO = -i, the i-th argument had an illegal value ๐Ÿšจ; and > 0 means if INFO = i, the algorithm failed to converge โ€” specifically, i off-diagonal elements of an intermediate tridiagonal form did not converge to zero ๐Ÿ˜ญ. Not me being dramatic, that's just what it says.

๐Ÿ‘‘ Author

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

๐Ÿ“Œ Definition

Definition at line 170 of file dspevd.f.


๐Ÿฆ‹ subroutine sspevd

   subroutine sspevd (character jobz, character uplo, integer n, real,
       dimension( * ) ap, real, dimension( * ) w, real, dimension( ldz, * ) z,
       integer ldz, real, dimension( * ) work, integer lwork, integer,
       dimension( * ) iwork, integer liwork, integer info)
        SSPEVD computes the eigenvalues and, optionally, the left and/or right
       eigenvectors for OTHER matrices

SSPEVD computes the eigenvalues and, optionally, the left and/or right eigenvectors for OTHER matrices. Iconic. โœจ

โœจ Purpose

SSPEVD computes all the eigenvalues and, optionally, eigenvectors of a real symmetric matrix A in packed storage. If eigenvectors are desired, it uses a divide and conquer algorithm. Slay. ๐Ÿ’–

๐ŸŒธ Parameters

  • JOBZ โ€” JOBZ is CHARACTER*1. = 'N': compute eigenvalues only; = 'V': compute eigenvalues and eigenvectors. Choose your fighter. ๐Ÿ’…
  • UPLO โ€” UPLO is CHARACTER*1. = 'U': upper triangle of A is stored; = 'L': lower triangle of A is stored. Pick a side, bestie. ๐Ÿซถ
  • N โ€” N is INTEGER. The order of the matrix A. N >= 0. No negative nonsense. ๐Ÿšซ
  • AP โ€” AP is REAL array, dimension (N*(N+1)/2). On entry, the upper or lower triangle of the symmetric matrix A, packed columnwise in a linear array. The j-th column of A is stored in the array AP as follows: if UPLO = 'U', AP(i + (j-1)*j/2) = A(i,j) for 1<=i<=j; if UPLO = 'L', AP(i + (j-1)*(2*n-j)/2) = A(i,j) for j<=i<=n. On exit, AP is overwritten by values generated during the reduction to tridiagonal form. If UPLO = 'U', the diagonal and first superdiagonal of the tridiagonal matrix T overwrite the corresponding elements of A, and if UPLO = 'L', the diagonal and first subdiagonal of T overwrite the corresponding elements of A. That's the whole packed-storage moment. ๐Ÿ’€
  • W โ€” W is REAL array, dimension (N). If INFO = 0, the eigenvalues in ascending order. So organized. ๐ŸŒˆ
  • Z โ€” Z is REAL array, dimension (LDZ, N). If JOBZ = 'V', then if INFO = 0, Z contains the orthonormal eigenvectors of the matrix A, with the i-th column of Z holding the eigenvector associated with W(i). If JOBZ = 'N', then Z is not referenced. Ghosted. ๐Ÿ‘ป
  • LDZ โ€” LDZ is INTEGER. The leading dimension of the array Z. LDZ >= 1, and if JOBZ = 'V', LDZ >= max(1,N). Respect the dimension, fr fr. ๐Ÿ“
  • WORK โ€” WORK is REAL array, dimension (MAX(1,LWORK)). On exit, if INFO = 0, WORK(1) returns the required LWORK. Cute. โœจ
  • 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 at least 2*N. If JOBZ = 'V' and N > 1, LWORK must be at least 1 + 6*N + N**2. If LWORK = -1, then a workspace query is assumed; the routine only calculates the required 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. The math is mathing. ๐Ÿงฎ
  • IWORK โ€” IWORK is INTEGER array, dimension (MAX(1,LIWORK)). On exit, if INFO = 0, IWORK(1) returns the required LIWORK. ๐Ÿ’œ
  • LIWORK โ€” LIWORK is INTEGER. The dimension of the array IWORK. If JOBZ = 'N' or 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 required 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. Same energy, different array. ๐ŸŽ€
  • INFO โ€” INFO is INTEGER. = 0: successful exit โœ…; < 0: if INFO = -i, the i-th argument had an illegal value โŒ; > 0: if INFO = i, the algorithm failed to converge; i off-diagonal elements of an intermediate tridiagonal form did not converge to zero ๐Ÿ˜ตโ€๐Ÿ’ซ. No cap.

๐Ÿ‘‘ Author

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

๐Ÿ“Œ Definition

Definition at line 170 of file sspevd.f.


๐Ÿฆ‹ subroutine zhpevd

   subroutine zhpevd (character jobz, character uplo, integer n, complex*16,
       dimension( * ) ap, double precision, dimension( * ) w, complex*16,
       dimension( ldz, * ) z, integer ldz, complex*16, dimension( * ) work,
       integer lwork, double precision, dimension( * ) rwork, integer lrwork,
       integer, dimension( * ) iwork, integer liwork, integer info)
        ZHPEVD computes the eigenvalues and, optionally, the left and/or right
       eigenvectors for OTHER matrices

ZHPEVD computes the eigenvalues and, optionally, the left and/or right eigenvectors for OTHER matrices. Complex Hermitian? We love to see it. ๐Ÿ’–

โœจ Purpose

ZHPEVD computes all the eigenvalues and, optionally, eigenvectors of a complex Hermitian matrix A in packed storage. If eigenvectors are desired, it uses a divide and conquer algorithm. Main character algorithm energy. ๐Ÿ‘‘

๐ŸŒธ Parameters

  • JOBZ โ€” JOBZ is CHARACTER*1. = 'N': compute eigenvalues only; = 'V': compute eigenvalues and eigenvectors. Pick your plotline. ๐Ÿ’…
  • UPLO โ€” UPLO is CHARACTER*1. = 'U': upper triangle of A is stored; = 'L': lower triangle of A is stored. Choose wisely, bestie. ๐Ÿซถ
  • N โ€” N is INTEGER. The order of the matrix A. N >= 0. Keep it non-negative. โœจ
  • AP โ€” AP is COMPLEX*16 array, dimension (N*(N+1)/2). On entry, the upper or lower triangle of the Hermitian matrix A, packed columnwise in a linear array. The j-th column of A is stored in the array AP as follows: if UPLO = 'U', AP(i + (j-1)*j/2) = A(i,j) for 1<=i<=j; if UPLO = 'L', AP(i + (j-1)*(2*n-j)/2) = A(i,j) for j<=i<=n. On exit, AP is overwritten by values generated during the reduction to tridiagonal form. If UPLO = 'U', the diagonal and first superdiagonal of the tridiagonal matrix T overwrite the corresponding elements of A, and if UPLO = 'L', the diagonal and first subdiagonal of T overwrite the corresponding elements of A. Same packed-storage saga, now with complex flavor. ๐ŸŒธ
  • W โ€” W is DOUBLE PRECISION array, dimension (N). If INFO = 0, the eigenvalues in ascending order. Sorted, slay. ๐ŸŒˆ
  • Z โ€” Z is COMPLEX*16 array, dimension (LDZ, N). If JOBZ = 'V', then if INFO = 0, Z contains the orthonormal eigenvectors of the matrix A, with the i-th column of Z holding the eigenvector associated with W(i). If JOBZ = 'N', then Z is not referenced. Not referenced means not invited to the function. ๐Ÿ™ˆ
  • LDZ โ€” LDZ is INTEGER. The leading dimension of the array Z. LDZ >= 1, and if JOBZ = 'V', LDZ >= max(1,N). Rules are rules. ๐Ÿ“
  • WORK โ€” WORK is COMPLEX*16 array, dimension (MAX(1,LWORK)). On exit, if INFO = 0, WORK(1) returns the required LWORK. ๐Ÿ’œ
  • LWORK โ€” LWORK is INTEGER. The dimension of array WORK. If N <= 1, LWORK must be at least 1. If JOBZ = 'N' and N > 1, LWORK must be at least N. If JOBZ = 'V' and N > 1, LWORK must be at least 2*N. If LWORK = -1, then a workspace query is assumed; the routine only calculates the required 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 workspace query is lowkey iconic. โœจ
  • RWORK โ€” RWORK is DOUBLE PRECISION array, dimension (MAX(1,LRWORK)). On exit, if INFO = 0, RWORK(1) returns the required LRWORK. ๐ŸŽ€
  • LRWORK โ€” LRWORK is INTEGER. The dimension of 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 required 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. Big workspace energy. ๐Ÿ”ฅ
  • IWORK โ€” IWORK is INTEGER array, dimension (MAX(1,LIWORK)). On exit, if INFO = 0, IWORK(1) returns the required LIWORK. ๐Ÿซถ
  • LIWORK โ€”

Okay bestie, back to the parameter list โ€” hereโ€™s the tea on LIWORK and INFO, and theyโ€™re both giving โ€œread me carefullyโ€ energy:

  • LIWORK โ€” INTEGER, aka the dimension of array IWORK.
    • If JOBZ = 'N' or 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 required 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 โ€” INTEGER, the exit-status bestie. Hereโ€™s the breakdown:
    • = 0: successful exit.
    • < 0: if INFO = -i, the i-th argument had an illegal value.
    • > 0: if INFO = i, the algorithm failed to converge; i off-diagonal elements of an intermediate tridiagonal form did not converge to zero.

๐Ÿ‘‘ Author ๐Ÿ‘‘

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

๐Ÿ“ Definition at line 192 of file zhpevd.f.

๐Ÿ‘‘ Author ๐Ÿ‘‘ (the auto-generated encore)

Generated automatically by Doxygen for LAPACK from the source code.


Mwah! ๐Ÿ’‹ This little icon is from LAPACK Version 3.12.0, page hpevd(3) โ€” footer date? Not shown, so sheโ€™s timeless, periodt. ๐Ÿฆ‹โœจ

๐Ÿ“ฆ where this page comes from