/home/abui.../clatrs3.f(3)

✨ clatrs3.f(3) — Library Functions Manual ✨

okay bestie, this is the page for /home/abui.../clatrs3.f(3) from the Library Functions Manual, and it is giving big LAPACK energy. The actual source path in the NAME section is the long one below. Let’s go. 💖

💅 NAME

/home/abuild/rpmbuild/BUILD/lapack-static-3.12.0-build/lapack-3.12.0/SRC/clatrs3.f

That’s the whole NAME section, no cap. This page also shows up as /home/abui.../clatrs3.f(3) up in the manual header. 🫶

✨ SYNOPSIS

Functions/Subroutines

• subroutine CLATRS3 (uplo, trans, diag, normin, n, nrhs, a, lda, x, ldx, scale, cnorm, work, lwork, info) — CLATRS3 solves a triangular system of equations with the scale factors set to prevent overflow. 🔥

🫶 Function/Subroutine Documentation 🫶

subroutine CLATRS3 (character uplo, character trans, character diag,
       character normin, integer n, integer nrhs, complex, dimension( lda, * )
       a, integer lda, complex, dimension( ldx, * ) x, integer ldx, real,
       dimension( * ) scale, real, dimension( * ) cnorm, real, dimension( * )
       work, integer lwork, integer info)

CLATRS3 solves a triangular system of equations with the scale factors set to prevent overflow. periodt. 💅

🎀 Purpose

Doxygen !> comment-block time, but make it cute: CLATRS3 solves one of the triangular systems

A * X = B * diag(scale),  A**T * X = B * diag(scale), or
A**H * X = B * diag(scale)

with scaling to prevent overflow. Here A is an upper or lower triangular matrix, A**T denotes the transpose of A, A**H denotes the conjugate transpose of A. X and B are n-by-nrhs matrices and scale is an nrhs-element vector of scaling factors. A scaling factor scale(j) is usually less than or equal to 1, chosen such that X(:,j) is less than the overflow threshold. If the matrix A is singular (A(j,j) = 0 for some j), then a non-trivial solution to A*X = 0 is returned. If the system is so badly scaled that the solution cannot be represented as (1/scale(k))*X(:,k), then x(:,k) = 0 and scale(k) is returned.

This is a BLAS-3 version of LATRS for solving several right hand sides simultaneously. slay. 🌈

💖 Parameters

• UPLO — UPLO is CHARACTER*1. Bestie, it says whether A is upper or lower triangular. ✨
  • = 'U': Upper triangular
  • = 'L': Lower triangular
• TRANS — TRANS is CHARACTER*1. This is the operation applied to A, lowkey important.
  • = 'N': Solve A * x = s*b (No transpose)
  • = 'T': Solve A**T* x = s*b (Transpose)
  • = 'C': Solve A**T* x = s*b (Conjugate transpose)
• DIAG — DIAG is CHARACTER*1. It says whether or not A is unit triangular.
  • = 'N': Non-unit triangular
  • = 'U': Unit triangular
• NORMIN — NORMIN is CHARACTER*1. It says whether CNORM has been set or not.
  • = 'Y': CNORM contains the column norms on entry
  • = 'N': CNORM is not set on entry. On exit, the norms will be computed and stored in CNORM.
• N — N is INTEGER. The order of the matrix A. N >= 0.
• NRHS — NRHS is INTEGER. The number of columns of X. NRHS >= 0.
• A — A is COMPLEX array, dimension (LDA,N). The triangular matrix A. If UPLO = 'U', the leading n by n upper triangular part of the array A contains the upper triangular matrix, and the strictly lower triangular part of A is not referenced. If UPLO = 'L', the leading n by n lower triangular part of the array A contains the lower triangular matrix, and the strictly upper triangular part of A is not referenced. If DIAG = 'U', the diagonal elements of A are also not referenced and are assumed to be 1. 🦋
• LDA — LDA is INTEGER. The leading dimension of the array A. LDA >= max (1,N).
• X — X is COMPLEX array, dimension (LDX,NRHS). On entry, the right hand side B of the triangular system. On exit, X is overwritten by the solution matrix X.
• LDX — LDX is INTEGER. The leading dimension of the array X. LDX >= max (1,N).
• SCALE — SCALE is REAL array, dimension (NRHS). The scaling factor s(k) is for the triangular system A * x(:,k) = s(k)*b(:,k) or A**T* x(:,k) = s(k)*b(:,k). If SCALE = 0, the matrix A is singular or badly scaled. If A(j,j) = 0 is encountered, a non-trivial vector x(:,k) that is an exact or approximate solution to A*x(:,k) = 0 is returned. If the system so badly scaled that solution cannot be presented as x(:,k) * 1/s(k), then x(:,k) = 0 is returned. 💀
• CNORM — CNORM is REAL array, dimension (N). If NORMIN = 'Y', CNORM is an input argument and CNORM(j) contains the norm of the off-diagonal part of the j-th column of A. If TRANS = 'N', CNORM(j) must be greater than or equal to the infinity-norm, and if TRANS = 'T' or 'C', CNORM(j) must be greater than or equal to the 1-norm. If NORMIN = 'N', CNORM is an output argument and CNORM(j) returns the 1-norm of the offdiagonal part of the j-th column of A.
• WORK — WORK is REAL array, dimension (LWORK). On exit, if INFO = 0, WORK(1) returns the optimal size of WORK.
• LWORK — LWORK is INTEGER. The page literally double-drops the name as LWORK LWORK is INTEGER, and we’re keeping the energy. The constraint is:

LWORK >= MAX(1, 2*NBA * MAX(NBA, MIN(NRHS,
32)), where NBA = (N + NB - 1)/NB and NB is the optimal block size.

If LWORK = -1, then a workspace query is assumed; the routine only calculates the optimal dimensions 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.

💖 Parameters

• INFO — INFO is INTEGER.
  • = 0: successful exit
  • < 0: if INFO = -k, the k-th argument had an illegal value

🌸 Author

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

🌈 Further Details

Definition at line 228 of file clatrs3.f.

🌸 Author

Generated automatically by Doxygen for LAPACK from the source code.

---

okay bestie, that’s the whole page. Footer sign-off vibes: LAPACK, Version 3.12.0 — page path /home/abui.../clatrs3.f(3). 💖✨🎀