SRC/sspgv.f(3)

πŸ’– SRC/sspgv.f(3) πŸ’–

okay so bestie, this page is from the Library Functions Manual and it's all about SRC/sspgv.f. It's giving β€œI know linear algebra and I'm not afraid to use it” energy. πŸŽ€

🌸 NAME 🌸

SRC/sspgv.f β€” that's the file, periodt. πŸ’…

✨ SYNOPSIS ✨

Functions/Subroutines β€” literally the function/subroutine zone:

subroutine sspgv (itype, jobz, uplo, n, ap, bp, w, z, ldz, work, info)
    SSPGV

πŸ¦‹ Function/Subroutine Documentation πŸ¦‹

πŸŽ€ subroutine sspgv πŸŽ€

Here's the full signature, copied exactly because we do not play with code:

subroutine sspgv (integer itype, character jobz, character uplo, integer n,
     real, dimension( * ) ap, real, dimension( * ) bp, real, dimension( * )
     w, real, dimension( ldz, * ) z, integer ldz, real, dimension( * ) work,
     integer info)

SSPGV β€” yes bestie, that's the routine name, all caps and iconic. πŸ‘‘

πŸ’– Purpose πŸ’–

SSPGV computes all the eigenvalues and, optionally, the eigenvectors of a real generalized symmetric-definite eigenproblem, in one of these forms: A*x=(lambda)*B*x, A*Bx=(lambda)*x, or B*A*x=(lambda)*x.

Here A and B are assumed to be symmetric, stored in packed format, and B is also positive definite. No cap. ✨

🌈 Parameters 🌈

  • ITYPE β€” INTEGER. Specifies the problem type to be solved:
    • = 1: A*x = (lambda)*B*x
    • = 2: A*B*x = (lambda)*x
    • = 3: B*A*x = (lambda)*x
  • JOBZ β€” CHARACTER*1:
    • = 'N': Compute eigenvalues only;
    • = 'V': Compute eigenvalues and eigenvectors.
  • UPLO β€” CHARACTER*1:
    • = 'U': Upper triangles of A and B are stored;
    • = 'L': Lower triangles of A and B are stored.
  • N β€” INTEGER. The order of the matrices A and B. N >= 0.
  • AP β€” 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.
πŸ’€ Heads up: On exit, the contents of AP are destroyed. Not me warning you β€” that's literally the page.
  • BP β€” REAL array, dimension (N*(N+1)/2). On entry, the upper or lower triangle of the symmetric matrix B, packed columnwise in a linear array. The j-th column of B is stored in the array BP as follows:
if UPLO = 'U', BP(i + (j-1)*j/2) = B(i,j) for 1<=i<=j;
if UPLO = 'L', BP(i + (j-1)*(2*n-j)/2) = B(i,j) for j<=i<=n.

On exit, the triangular factor U or L from the Cholesky factorization B = U**T*U or B = L*L**T, in the same storage format as B. 🧚

  • W β€” REAL array, dimension (N). If INFO = 0, the eigenvalues in ascending order.
  • Z β€” REAL array, dimension (LDZ, N). If JOBZ = 'V', then if INFO = 0, Z contains the matrix Z of eigenvectors. The eigenvectors are normalized as follows:
    • if ITYPE = 1 or 2, Z**T*B*Z = I;
    • if ITYPE = 3, Z**T*inv(B)*Z = I. If JOBZ = 'N', then Z is not referenced.
  • LDZ β€” INTEGER. The leading dimension of the array Z. LDZ >= 1, and if JOBZ = 'V', LDZ >= max(1,N).
  • WORK β€” REAL array, dimension (3*N).
  • INFO β€” INTEGER:
    • = 0: successful exit
    • < 0: if INFO = -i, the i-th argument had an illegal value
    • > 0: SPPTRF or SSPEV returned an error code:
      • <= N: if INFO = i, SSPEV failed to converge; i off-diagonal elements of an intermediate tridiagonal form did not converge to zero.
      • > N: if INFO = n + i, for 1 <= i <= n, then the leading principal minor of order i of B is not positive. The factorization of B could not be completed and no eigenvalues or eigenvectors were computed.

🌟 Author 🌟

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

πŸ“ Definition πŸ“

Definition at line 158 of file sspgv.f.

πŸ’« Author πŸ’«

Generated automatically by Doxygen for LAPACK from the source code.


okay bestie that's the whole page πŸ’– β€” it's LAPACK Version 3.12.0, filed as SRC/sspgv.f(3), and it's giving β€œreference manual but make it cute.” periodt. πŸŽ€βœ¨

πŸ“¦ where this page comes from