ZLARHS(3)

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

πŸ’… zlarhs.f(3) β€” like, the whole manual page, bestie ✨

okay so real quick: this is zlarhs.f(3) from the LAPACK library functions manual, and it lives at /home/abuild/rpmbuild/BUILD/lapack-static-3.12.0-build/lapack-3.12.0/TESTING/LIN/zlarhs.f 🫢 that's literally the NAME section, that's it, that's the name. moving on πŸ’–


✨ SYNOPSIS ✨

🌸 Functions/Subroutines

subroutine ZLARHS (path, xtype, uplo, trans, m, n, kl, ku, nrhs, a, lda,
    x, ldx, b, ldb, iseed, info)

ZLARHS β€” that's the whole vibe, she's the function πŸŽ€


πŸ’œ Function/Subroutine Documentation πŸ’œ

subroutine ZLARHS (character*3 path, character xtype, character uplo,
    character trans, integer m, integer n, integer kl, integer ku, integer
    nrhs, complex*16, dimension( lda, * ) a, integer lda, complex*16,
    dimension( ldx, * ) x, integer ldx, complex*16, dimension( ldb, * ) b,
    integer ldb, integer, dimension( 4 ) iseed, integer info)

ZLARHS

🌈 Purpose 🌈

!> ZLARHS chooses a set of NRHS random solution vectors and sets !> up the right hand sides for the linear system !> op(A) * X = B, !> where op(A) = A, A**T, or A**H, depending on TRANS. !>

like, she's out here picking random solution vectors and building your right hand sides. iconic behavior honestly πŸ‘‘


πŸ’– Parameters πŸ’–

  • PATH β€” so PATH is CHARACTER*3 and it's giving what kind of complex matrix is A, bestie. PATH may be given in any combination of upper and lower case. Valid paths include:
    • xGE: General m x n matrix
    • xGB: General banded matrix
    • xPO: Hermitian positive definite, 2-D storage
    • xPP: Hermitian positive definite packed
    • xPB: Hermitian positive definite banded
    • xHE: Hermitian indefinite, 2-D storage
    • xHP: Hermitian indefinite packed
    • xHB: Hermitian indefinite banded
    • xSY: Symmetric indefinite, 2-D storage
    • xSP: Symmetric indefinite packed
    • xSB: Symmetric indefinite banded
    • xTR: Triangular
    • xTP: Triangular packed
    • xTB: Triangular banded
    • xQR: General m x n matrix
    • xLQ: General m x n matrix
    • xQL: General m x n matrix
    • xRQ: General m x n matrix

where the leading character indicates the precision ✨ (iykyk)

  • XTYPE β€” XTYPE is CHARACTER*1 and specifies how the exact solution X will be determined:
    • = 'N': New solution; generate a random X.
    • = 'C': Computed; use value of X on entry.

so either she makes one up for you or you bring your own, no in-between πŸŽ€

  • UPLO β€” UPLO is CHARACTER*1. Used only if A is symmetric or triangular; specifies whether the upper or lower triangular part of the matrix A is stored.
    • = 'U': Upper triangular
    • = 'L': Lower triangular
  • TRANS β€” TRANS is CHARACTER*1. Used only if A is nonsymmetric; specifies the operation applied to the matrix A.
    • = 'N': B := A * X (No transpose)
    • = 'T': B := A**T * X (Transpose)
    • = 'C': B := A**H * X (Conjugate transpose)

three flavors, all valid, pick your fighter πŸ’…

  • M β€” M is INTEGER. The number of rows of the matrix A. M >= 0.
  • N β€” N is INTEGER. The number of columns of the matrix A. N >= 0.
  • KL β€” KL is INTEGER. Used only if A is a band matrix; specifies the number of subdiagonals of A if A is a general band matrix or if A is symmetric or triangular and UPLO = 'L'; specifies the number of superdiagonals of A if A is symmetric or triangular and UPLO = 'U'. 0 <= KL <= M-1.
  • KU β€” KU is INTEGER. Used only if A is a general band matrix or if A is triangular.
    • If PATH = xGB, specifies the number of superdiagonals of A, and 0 <= KU <= N-1.
    • If PATH = xTR, xTP, or xTB, specifies whether or not the matrix has unit diagonal:
      • = 1: matrix has non-unit diagonal (default)
      • = 2: matrix has unit diagonal

two whole personality modes for one variable, she's versatile 😭

  • NRHS β€” NRHS is INTEGER. The number of right hand side vectors in the system A*X = B.
  • A β€” A is COMPLEX*16 array, dimension (LDA,N). The test matrix whose type is given by PATH.
  • LDA β€” LDA is INTEGER. The leading dimension of the array A.
    • If PATH = xGB, LDA >= KL+KU+1.
    • If PATH = xPB, xSB, xHB, or xTB, LDA >= KL+1.
    • Otherwise, LDA >= max(1,M).
  • X β€” X is or output) COMPLEX*16 array, dimension (LDX,NRHS). On entry, if XTYPE = 'C' (for 'Computed'), then X contains the exact solution to the system of linear equations. On exit, if XTYPE = 'N' (for 'New'), then X is initialized with random values. πŸ¦‹
  • LDX β€” LDX is INTEGER. The leading dimension of the array X. If TRANS = 'N', LDX >= max(1,N); if TRANS = 'T', LDX >= max(1,M).
  • B β€” B is COMPLEX*16 array, dimension (LDB,NRHS). The right hand side vector(s) for the system of equations, computed from B = op(A) * X, where op(A) is determined by TRANS.
  • LDB β€” LDB is INTEGER. The leading dimension of the array B. If TRANS = 'N', LDB >= max(1,M); if TRANS = 'T', LDB >= max(1,N).
  • ISEED β€” ISEED is INTEGER array, dimension (4). The seed vector for the random number generator (used in ZLATMS). Modified on exit. πŸ™ˆ heads up, she will touch your seed.
  • INFO β€” INFO is INTEGER.
    • = 0: successful exit
    • < 0: if INFO = -i, the i-th argument had an illegal value
⚠️ bestie watch the signs: INFO = 0 is the slay outcome, and any negative INFO means argument number -i was being messy. no cap.

πŸ‘‘ Author πŸ‘‘

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

Definition at line 206 of file zlarhs.f.


🌸 Author 🌸

Generated automatically by Doxygen for LAPACK from the source code. (yes the robot wrote this one, not me πŸ’€)


LAPACK β€” Version 3.12.0 β€” and that's the whole page from /home/abui...IN/zlarhs.f(3), mwah πŸ’‹ thanks for reading bestie, go call ZLARHS responsibly πŸ«Άβœ¨πŸŽ€

πŸ“¦ where this page comes from