/home/abui...RC/ssysv.f(3)

πŸ“¦ version 3.12.0, in opensuse-leap 16.0

πŸ’… NAME

okay so bestie, this is the manual page for /home/abuild/rpmbuild/BUILD/lapack-static-3.12.0-build/lapack-3.12.0/SRC/ssysv.f β€” like yes that's a whole entire path and it's giving "my home address on the first day of school" 🏠✨ but that's literally the name of this thing, no cap.

This is part of the LAPACK Library Functions Manual, and it's about one specific little icon: the SSYSV subroutine. πŸŽ€


✨ SYNOPSIS ✨

🌸 Functions/Subroutines

  • subroutine SSYSV (uplo, n, nrhs, a, lda, ipiv, b, ldb, work, lwork, info) β€” and like, what does it do? It SSYSV computes the solution to system of linear equations A * X = B for SY matrices. that's the whole vibe. πŸ’«

πŸ”₯ Function/Subroutine Documentation πŸ”₯

🫢 the full signature (yes, all of it)

subroutine SSYSV (character uplo, integer n, integer nrhs, real, dimension(
    lda, * ) a, integer lda, integer, dimension( * ) ipiv, real, dimension(
    ldb, * ) b, integer ldb, real, dimension( * ) work, integer lwork,
    integer info)

and again, for the people in the back: SSYSV computes the solution to system of linear equations A * X = B for SY matrices. πŸ‘‘

πŸ¦‹ Purpose

so here's the tea, bestie β€” SSYSV computes the solution to a real system of linear equations

   A * X = B,

where A is an N-by-N symmetric matrix and X and B are N-by-NRHS matrices. like, it's solving for X, that's the whole plot. 😌

The diagonal pivoting method is used to factor A as

   A = U * D * U**T,  if UPLO = 'U', or
   A = L * D * L**T,  if UPLO = 'L',

where U (or L) is a product of permutation and unit upper (lower) triangular matrices, and D is symmetric and block diagonal with 1-by-1 and 2-by-2 diagonal blocks. The factored form of A is then used to solve the system of equations A * X = B. slay, honestly. πŸ’…


🌈 Parameters

πŸ“ UPLO

UPLO is CHARACTER*1 and it's literally just "which triangle of A are we even looking at":

  • = 'U': Upper triangle of A is stored;
  • = 'L': Lower triangle of A is stored.

pick one, bestie, don't be indecisive. πŸ™ˆ

πŸ“ N

N is INTEGER β€” the number of linear equations, i.e., the order of the matrix A. constraint era: N >= 0. ✨

πŸ“ NRHS

NRHS is INTEGER β€” the number of right hand sides, i.e., the number of columns of the matrix B. also NRHS >= 0. so many right-hand sides, so little time. 😭

πŸ“ A

A is REAL array, dimension (LDA,N).

On entry, it's 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, and the strictly lower triangular part of A is not referenced (it's just sitting there, unbothered, not invited to the function 🧚). If UPLO = 'L', the leading N-by-N lower triangular part of A contains the lower triangular part of the matrix A, and the strictly upper triangular part of A is not referenced.

On exit, if INFO = 0, you get the block diagonal matrix D and the multipliers used to obtain the factor U or L from the factorization A = U*D*U**T or A = L*D*L**T as computed by SSYTRF. glow-up complete. ⭐

πŸ“ LDA

LDA is INTEGER β€” the leading dimension of the array A. rule of law: LDA >= max(1,N). πŸ‘‘

πŸ“ IPIV

IPIV is INTEGER array, dimension (N) β€” details of the interchanges and the block structure of D, as determined by SSYTRF. and this part is lowkey the whole lore, so pay attention:

  • If IPIV(k) > 0, then rows and columns k and IPIV(k) were interchanged, and D(k,k) is a 1-by-1 diagonal block.
  • If UPLO = 'U' and IPIV(k) = IPIV(k-1) < 0, then rows and columns k-1 and -IPIV(k) were interchanged and D(k-1:k,k-1:k) is a 2-by-2 diagonal block.
  • If UPLO = 'L' and IPIV(k) = IPIV(k+1) < 0, then rows and columns k+1 and -IPIV(k) were interchanged and D(k:k+1,k:k+1) is a 2-by-2 diagonal block.

see? 2-by-2 blocks are the main characters here. πŸ’€

πŸ“ B

B is REAL array, dimension (LDB,NRHS).

On entry, the N-by-NRHS right hand side matrix B. On exit, if INFO = 0, the N-by-NRHS solution matrix X. it literally transforms. ate and left no crumbs. πŸ”₯

πŸ“ LDB

LDB is INTEGER β€” the leading dimension of the array B, and LDB >= max(1,N). yes we're checking again. πŸ’œ

πŸ“ WORK

WORK is REAL array, dimension (MAX(1,LWORK)). On exit, if INFO = 0, WORK(1) returns the optimal LWORK. it's the little helper that could. 🫢

πŸ“ LWORK

LWORK is INTEGER β€” the length of WORK. LWORK >= 1, and for best performance LWORK >= max(1,N*NB), where NB is the optimal blocksize for SSYTRF.

  • for LWORK < N, TRS will be done with Level BLAS 2
  • for LWORK >= N, TRS will be done with Level BLAS 3

and, iconic behaviour: 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. so it's like asking "how much room do I need" and it just tells you instead of screaming. 🌸

πŸ“ INFO

INFO is INTEGER and it's the vibe check at the end:

  • = 0: successful exit πŸŽ‰
  • < 0: if INFO = -i, the i-th argument had an illegal value 🚨
  • > 0: if INFO = i, D(i,i) is exactly zero. The factorization has been completed, but the block diagonal matrix D is exactly singular, so the solution could not be computed. 😭 like it tried, it finished the factorization, and then there was just... no solution. tragic.

πŸ’– Author

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

πŸ“ Definition at line 169 of file ssysv.f.


πŸ‘‘ Author

Generated automatically by Doxygen for LAPACK from the source code. so nobody hand-wrote this one, a robot did it, and honestly? respect. πŸ€–βœ¨


and that's the whole page, bestie!! πŸ’– LAPACK, Version 3.12.0, live from /home/abui...RC/ssysv.f(3) β€” go forth and solve your symmetric systems. mwah. πŸŽ€πŸ¦‹πŸ’…

πŸ“¦ where this page comes from