SRC/dorml2.f(3)

🌸 SRC/dorml2.f(3)

okay bestie, welcome to this page from the Library Functions Manual β€” it's the SRC/dorml2.f one, and it's all about dorml2. No cap, it's an unblocked LAPACK routine and it's lowkey iconic. πŸ’…

✨ NAME ✨

SRC/dorml2.f β€” that's the file/page name, periodt. πŸŽ€

πŸ’… SYNOPSIS πŸ’…

Functions/Subroutines

subroutine dorml2 (side, trans, m, n, k, a, lda, tau, c, ldc, work,
    info)

DORML2 multiplies a general matrix by the orthogonal matrix from the LQ factorization determined by sgelqf (unblocked algorithm). That's the whole vibe. πŸ¦‹

🫢 Function/Subroutine Documentation 🫢

subroutine dorml2 (character side, character trans, integer m, integer n,
    integer k, double precision, dimension( lda, * ) a, integer lda, double
    precision, dimension( * ) tau, double precision, dimension( ldc, * ) c,
    integer ldc, double precision, dimension( * ) work, integer info)

DORML2 multiplies a general matrix by the orthogonal matrix from the LQ factorization determined by sgelqf (unblocked algorithm). (Yes, same glow-up as the synopsis β€” the routine is the main character.) ✨

πŸŽ€ Purpose πŸŽ€

The source comments spell it out like this, and we're keeping them exactly:

!>
!> DORML2 overwrites the general real m by n matrix C with
!>
!>       Q * C  if SIDE = 'L' and TRANS = 'N', or
!>
!>       Q**T* C  if SIDE = 'L' and TRANS = 'T', or
!>
!>       C * Q  if SIDE = 'R' and TRANS = 'N', or
!>
!>       C * Q**T if SIDE = 'R' and TRANS = 'T',
!>
!> where Q is a real orthogonal matrix defined as the product of k
!> elementary reflectors
!>
!>       Q = H(k) . . . H(2) H(1)
!>
!> as returned by DGELQF. Q is of order m if SIDE = 'L' and of order n
!> if SIDE = 'R'.
!>

So basically: overwrite real m by n matrix C with one of those four products, where Q is a real orthogonal matrix made from k elementary reflectors. Q has order m when SIDE = 'L', order n when SIDE = 'R'. Slay. πŸ’–

🌈 Parameters 🌈

  • SIDE β€” SIDE is CHARACTER*1.
    • = 'L': apply Q or Q**T from the Left.
    • = 'R': apply Q or Q**T from the Right.
  • TRANS β€” TRANS is CHARACTER*1.
    • = 'N': apply Q (No transpose).
    • = 'T': apply Q**T (Transpose).
  • M β€” M is INTEGER. The number of rows of the matrix C. M >= 0.
  • N β€” N is INTEGER. The number of columns of the matrix C. N >= 0.
  • K β€” K is INTEGER. The number of elementary reflectors whose product defines the matrix Q. If SIDE = 'L', M >= K >= 0; if SIDE = 'R', N >= K >= 0.
  • A β€” A is DOUBLE PRECISION array, dimension (LDA,M) if SIDE = 'L', (LDA,N) if SIDE = 'R'. The i-th row must contain the vector which defines the elementary reflector H(i), for i = 1,2,...,k, as returned by DGELQF in the first k rows of its array argument A.
  • LDA β€” LDA is INTEGER. The leading dimension of the array A. LDA >= max(1,K).
  • TAU β€” TAU is DOUBLE PRECISION array, dimension (K). TAU(i) must contain the scalar factor of the elementary reflector H(i), as returned by DGELQF.
  • C β€” C is DOUBLE PRECISION 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 β€” LDC is INTEGER. The leading dimension of the array C. LDC >= max(1,M).
  • WORK β€” WORK is DOUBLE PRECISION array, dimension (N) if SIDE = 'L', (M) if SIDE = 'R'.
  • 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 156 of file dorml2.f.

🧚 Author 🧚

Generated automatically by Doxygen for LAPACK from the source code.


πŸ’– That's the whole page, bestie β€” brought to you by LAPACK Version 3.12.0 and the SRC/dorml2.f(3) era. Stay orthogonal. πŸ’…

πŸ“¦ where this page comes from