SRC/claswlq.f(3)

πŸ’– SRC/claswlq.f πŸ’–

okay so this is a page straight outta the Library Functions Manual and it's all about one very specific, very iconic LAPACK subroutine. buckle up bestie, we're doing linear algebra πŸ’…


✨ NAME ✨

SRC/claswlq.f β€” that's it, that's the name, no notes πŸŽ€


πŸ¦‹ SYNOPSIS πŸ¦‹

Functions/Subroutines

  • subroutine claswlq (m, n, mb, nb, a, lda, t, ldt, work, lwork, info) β€” CLASWLQ. the one, the only πŸ’«

🌸 Function/Subroutine Documentation 🌸

subroutine claswlq (integer m, integer n, integer mb, integer nb, complex,
    dimension( lda, * ) a, integer lda, complex, dimension( ldt, * ) t,
    integer ldt, complex, dimension( * ) work, integer lwork, integer info)

CLASWLQ 🫢

🎯 Purpose

okay so here's the whole vibe: CLASWLQ computes a blocked Tall-Skinny LQ factorization of a complex M-by-N matrix A β€” and this is only for when M <= N, bestie, write that down πŸ“

A = ( L 0 ) *  Q,

where:

  • Q is a n-by-N orthogonal matrix, stored on exit in an implicit form in the elements above the diagonal of the array A and in the elements of the array T πŸ¦‹
  • L is a lower-triangular M-by-M matrix stored on exit in the elements on and below the diagonal of the array A πŸ’œ
  • 0 is a M-by-(N-M) zero matrix, if M < N, and is not stored. literally not even invited to the party πŸ™ˆ

🌈 Parameters 🌈

  • M β€” M is INTEGER. The number of rows of the matrix A. M >= 0. count 'em πŸ‘‘
  • N β€” N is INTEGER. The number of columns of the matrix A. N >= M >= 0. and remember N can never be smaller than M, that's the rule fr fr
  • MB β€” MB is INTEGER. The row block size to be used in the blocked QR. M >= MB >= 1 πŸ“
  • NB β€” NB is INTEGER. The column block size to be used in the blocked QR. NB > 0. strictly greater, no zeroes allowed πŸ’€
  • A β€” A is COMPLEX array, dimension (LDA,N). On entry, the M-by-N matrix A. On exit, the elements on and below the diagonal of the array contain the N-by-N lower triangular matrix L; the elements above the diagonal represent Q by the rows of blocked V (see Further Details). so yeah she does a full glow-up on exit ✨
  • LDA β€” LDA is INTEGER. The leading dimension of the array A. LDA >= max(1,M). don't skip the max(1,...) part, that's load-bearing 🫢
  • T β€” T is COMPLEX array, dimension (LDT, N * Number_of_row_blocks) where Number_of_row_blocks = CEIL((N-M)/(NB-M)). The blocked upper triangular block reflectors stored in compact form as a sequence of upper triangular blocks. See Further Details below. compact form = it's giving minimalism πŸ’…
  • LDT β€” LDT is INTEGER. The leading dimension of the array T. LDT >= MB πŸŽ€
  • WORK β€” (workspace) COMPLEX array, dimension (MAX(1,LWORK)). On exit, if INFO = 0, WORK(1) returns the minimal LWORK. the little workspace that could 🌸
  • LWORK β€” LWORK is INTEGER. The dimension of the array WORK. LWORK >= 1, if MIN(M,N) = 0, and LWORK >= MB*M, otherwise.
🚨 and if LWORK = -1, then a workspace query is assumed; the routine only calculates the minimal 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 -1 = "just tell me how much room you need, no drama" 😌
  • 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.

the whole squad showed up for this one 🫢


πŸ”₯ Further Details πŸ”₯

Short-Wide LQ (SWLQ) performs LQ by a sequence of orthogonal transformations, representing Q as a product of other orthogonal matrices:

Q = Q(1) * Q(2) * . . . * Q(k)

where each Q(i) zeros out upper diagonal entries of a block of NB rows of A:

Q(1) zeros out the upper diagonal entries of rows 1:NB of A
Q(2) zeros out the bottom MB-N rows of rows [1:M,NB+1:2*NB-M] of A
Q(3) zeros out the bottom MB-N rows of rows [1:M,2*NB-M+1:3*NB-2*M] of A
. . .

Q(1) is computed by GELQT, which represents Q(1) by Householder vectors stored under the diagonal of rows 1:MB of A, and by upper triangular block reflectors, stored in array T(1:LDT,1:N). For more information see Further Details in GELQT 🧚

Q(i) for i>1 is computed by TPLQT, which represents Q(i) by Householder vectors stored in columns [(i-1)*(NB-M)+M+1:i*(NB-M)+M] of A, and by upper triangular block reflectors, stored in array T(1:LDT,(i-1)*M+1:i*M). The last Q(k) may use fewer rows. For more information see Further Details in TPQRT πŸ’œ

For more details of the overall algorithm, see the description of Sequential TSQR in Section 2.2 of [1].

[1] β€œCommunication-Optimal Parallel and Sequential QR and LU Factorizations,” J. Demmel, L. Grigori, M. Hoemmen, J. Langou, SIAM J. Sci. Comput, vol. 34, no. 1, 2012 πŸ“š

πŸ“ Definition at line 167 of file claswlq.f.


πŸ’« Author πŸ’«

Generated automatically by Doxygen for LAPACK from the source code. yes bestie, a robot wrote the meta part, but the math is all human πŸ”₯


and that's the whole page! this came to you from LAPACK, Version 3.12.0, out of SRC/claswlq.f(3) β€” mwah, go factor something tall and skinny πŸ’‹πŸŽ€πŸ¦‹

πŸ“¦ where this page comes from