SLAMSWLQ(3)

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

πŸ’… SLAMSWLQ(3) β€” Library Functions Manual

Okay bestie, this is the manual name folded in near the top: Library Functions Manual. Now the actual page, with all the receipts. πŸ’–


🌸 NAME 🌸

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

That’s the source file this page is documenting, no cap. ✨


✨ SYNOPSIS ✨

🧚 Functions/Subroutines 🧚

       subroutine SLAMSWLQ (side, trans, m, n, k, mb, nb, a, lda, t, ldt, c,
           ldc, work, lwork, info)
           SLAMSWLQ

Highkey the whole vibe is: one subroutine, many arguments. Keep scrolling. 🫢


πŸ¦‹ Function/Subroutine Documentation πŸ¦‹

Full signature, exactly as the source says it:

   subroutine SLAMSWLQ (character side, character trans, integer m, integer n,
       integer k, integer mb, integer nb, real, dimension( lda, * ) a, integer
       lda, real, dimension( ldt, * ) t, integer ldt, real, dimension(ldc, * )
       c, integer ldc, real, dimension( * ) work, integer lwork, integer info)
       SLAMSWLQ

πŸŽ€ Purpose πŸŽ€

SLAMSWLQ overwrites the general real M-by-N matrix C with:

                    SIDE = 'L'     SIDE = 'R'
    TRANS = 'N':      Q * C          C * Q
    TRANS = 'T':      Q**T * C       C * Q**T

where Q is a real orthogonal matrix defined as the product of blocked elementary reflectors computed by short wide LQ factorization (SLASWLQ). Periodt. πŸ’…

πŸ’– Parameters πŸ’–

Okay, parameter-by-parameter, bestie. Every single one is here:

  • SIDE β€” CHARACTER*1
    • = 'L': apply Q or Q**T from the Left;
    • = 'R': apply Q or Q**T from the Right.
  • TRANS β€” CHARACTER*1
    • = 'N': No transpose, apply Q;
    • = 'T': Transpose, apply Q**T.
  • M β€” INTEGER β€” the number of rows of the matrix C. Constraint: M >=0.
  • N β€” INTEGER β€” the number of columns of the matrix C. Constraint: N >= 0.
  • K β€” INTEGER β€” the number of elementary reflectors whose product defines the matrix Q. Constraint: M >= K >= 0;
  • MB β€” INTEGER β€” the row block size to be used in the blocked LQ. Constraint: M >= MB >= 1
  • NB β€” INTEGER β€” the column block size to be used in the blocked LQ. Constraint: NB > M.
  • A β€” REAL array, dimension
(LDA,M) if SIDE = 'L',
(LDA,N) if SIDE = 'R'

The i-th row must contain the vector which defines the blocked elementary reflector H(i), for i = 1,2,...,k, as returned by SLASWLQ in the first k rows of its array argument A.

  • LDA β€” INTEGER β€” the leading dimension of the array A. Constraint: LDA >= max(1,K).
  • T β€” REAL array, dimension
( M * Number of blocks(CEIL(N-K/NB-K)),

The blocked upper triangular block reflectors stored in compact form as a sequence of upper triangular blocks. See below for further details.

  • LDT β€” INTEGER β€” the leading dimension of the array T. Constraint: LDT >= MB.
  • C β€” REAL array, dimension (LDC,N) On entry, the M-by-N matrix C. On exit, C is overwritten by Q*C or Q**T*C or C*Q**T or C*Q.
  • LDC β€” INTEGER β€” the leading dimension of the array C. Constraint: LDC >= max(1,M).
  • WORK β€” (workspace) REAL array, dimension (MAX(1,LWORK))
  • LWORK β€” INTEGER β€” the dimension of the array WORK. If SIDE = 'L', LWORK >= max(1,NB) * MB; if SIDE = 'R', LWORK >= max(1,M) * MB. 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.
  • INFO β€” 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.

πŸ”₯ 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 TPLQT.

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 195 of file slamswlq.f.

πŸ“ Author πŸ“

Generated automatically by Doxygen for LAPACK from the source code.


πŸ’– That’s the whole page, bestie β€” LAPACK Version 3.12.0, from /home/abui.../slamswlq.f(3). Go off, icon. πŸŽ€βœ¨

πŸ“¦ where this page comes from