/home/abui...D/sgelsx.f(3)

🌸 NAME 🌸

Okay bestie, this is the Library Functions Manual page for /home/abui...D/sgelsx.f(3), and the actual name/path it’s carrying is:

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

That’s the deprecated LAPACK source file for SGELSX, and it is lowkey iconic but highkey replaced. 👑

✨ SYNOPSIS ✨

🦋 Functions/Subroutines 🦋

subroutine SGELSX (m, n, nrhs, a, lda, b, ldb, jpvt, rcond, rank, work,
    info)
     SGELSX solves overdetermined or underdetermined systems for GE
    matrices

💖 Function/Subroutine Documentation 💖

🌟 subroutine SGELSX 🌟

subroutine SGELSX (integer m, integer n, integer nrhs, real, dimension( lda,
    * ) a, integer lda, real, dimension( ldb, * ) b, integer ldb, integer,
    dimension( * ) jpvt, real rcond, integer rank, real, dimension( * )
    work, integer info)

SGELSX solves overdetermined or underdetermined systems for GE matrices. Periodt. 💅

🧚 Purpose 🧚

Deprecated alert, bestie: this routine is deprecated and has been replaced by routine SGELSY. No cap. 🫶

SGELSX computes the minimum-norm solution to a real linear least squares problem:

minimize || A * X - B ||

using a complete orthogonal factorization of A. A is an M-by-N matrix which may be rank-deficient.

Several right hand side vectors b and solution vectors x can be handled in a single call; they are stored as the columns of the M-by-NRHS right hand side matrix B and the N-by-NRHS solution matrix X.

The routine first computes a QR factorization with column pivoting:

A * P = Q * [ R11 R12 ]
            [  0  R22 ]

with R11 defined as the largest leading submatrix whose estimated condition number is less than 1/RCOND. The order of R11, RANK, is the effective rank of A.

Then, R22 is considered to be negligible, and R12 is annihilated by orthogonal transformations from the right, arriving at the complete orthogonal factorization:

A * P = Q * [ T11 0 ] * Z
            [  0  0 ]

The minimum-norm solution is then

X = P * Z**T [ inv(T11)*Q1**T*B ]
             [        0         ]

where Q1 consists of the first RANK columns of Q. It’s giving “complete orthogonal factorization main character energy.” ✨

🍓 Parameters 🍓

M

M is INTEGER. It’s the number of rows of the matrix A, and M >= 0. 🎀

N

N is INTEGER. It’s the number of columns of the matrix A, and N >= 0. 🦋

NRHS

NRHS is INTEGER. It’s the number of right hand sides, i.e., the number of columns of matrices B and X. NRHS >= 0. 💫

A

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

On entry, it’s the M-by-N matrix A.

On exit, A has been overwritten by details of its complete orthogonal factorization. So don’t expect your original A to survive, bestie. 😭

LDA

LDA is INTEGER. It’s the leading dimension of the array A, and LDA >= max(1,M). 🌸

B

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

On entry, it’s the M-by-NRHS right hand side matrix B.

On exit, it’s the N-by-NRHS solution matrix X.

If m >= n and RANK = n, the residual sum-of-squares for the solution in the i-th column is given by the sum of squares of elements N+1:M in that column. 🔥

LDB

LDB is INTEGER. It’s the leading dimension of the array B, and LDB >= max(1,M,N). 🎀

JPVT

JPVT is INTEGER array, dimension (N).

On entry, if JPVT(i) .ne. 0, the i-th column of A is an initial column, otherwise it is a free column. Before the QR factorization of A, all initial columns are permuted to the leading positions; only the remaining free columns are moved as a result of column pivoting during the factorization.

On exit, if JPVT(i) = k, then the i-th column of A*P was the k-th column of A. Permutation tea, iykyk. 💅

RCOND

RCOND is REAL.

RCOND is used to determine the effective rank of A, which is defined as the order of the largest leading triangular submatrix R11 in the QR factorization with pivoting of A, whose estimated condition number < 1/RCOND. ⭐

RANK

RANK is INTEGER.

It’s the effective rank of A, i.e., the order of the submatrix R11. This is the same as the order of the submatrix T11 in the complete orthogonal factorization of A. 👑

WORK

WORK is REAL array, dimension

(max( min(M,N)+3*N, 2*min(M,N)+NRHS )),

INFO

INFO is INTEGER.

= 0:  successful exit
< 0:  if INFO = -i, the i-th argument had an illegal value

🌈 Author 🌈

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

Definition at line 176 of file sgelsx.f.

💜 Author 💜

Generated automatically by Doxygen for LAPACK from the source code.

---

💖 That’s the whole page, bestie — LAPACK Version 3.12.0, page /home/abui...D/sgelsx.f(3). Footer tea, served. ✨