gemlqt(3)

πŸ’– gemlqt(3) πŸ’–

okay bestie, welcome to gemlqt(3) β€” yes, that's the page name, it's a Library Functions Manual situation, and it's literally four subroutines in a trench coat. the whole vibe is: "multiply by Q from gelqt" ✨


✨ NAME ✨

gemlqt β€” gemlqt: multiply by Q from gelqt πŸŽ€


πŸ¦‹ SYNOPSIS πŸ¦‹

πŸ“š Functions

here's the whole friend group, all four of them take the exact same argument list and only the types change. iconique πŸ’…

subroutine cgemlqt (side, trans, m, n, k, mb, v, ldv, t, ldt, c, ldc,
    work, info)

CGEMLQT 🌸

subroutine dgemlqt (side, trans, m, n, k, mb, v, ldv, t, ldt, c, ldc,
    work, info)

DGEMLQT 🌸

subroutine sgemlqt (side, trans, m, n, k, mb, v, ldv, t, ldt, c, ldc,
    work, info)

SGEMLQT 🌸

subroutine zgemlqt (side, trans, m, n, k, mb, v, ldv, t, ldt, c, ldc,
    work, info)

ZGEMLQT 🌸


πŸ’« DETAILED DESCRIPTION πŸ’«

okay so this is where the full breakdown lives β€” every single function gets its own little spotlight down below πŸ‘‡ and yes, we're going to go through all of them, no skipping, that's the rules 🫢


πŸ”₯ FUNCTION DOCUMENTATION πŸ”₯

πŸ‘‘ cgemlqt πŸ‘‘

subroutine cgemlqt (character side, character trans, integer m, integer n,
    integer k, integer mb, complex, dimension( ldv, * ) v, integer ldv,
    complex, dimension( ldt, * ) t, integer ldt, complex, dimension( ldc, *
    ) c, integer ldc, complex, dimension( * ) work, integer info)

CGEMLQT ✨

πŸŽ€ Purpose

bestie, CGEMLQT overwrites the general complex M-by-N matrix C with:

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

where Q is a complex unitary matrix defined as the product of K elementary reflectors:

      Q = H(1) H(2) . . . H(K) = I - V T V**H

generated using the compact WY representation as returned by CGELQT. πŸ¦‹

and where's Q from? Q is of order M if SIDE = 'L' and of order N if SIDE = 'R'. periodt πŸ’…

🌸 Parameters

  • SIDE β€” is CHARACTER*1
    • = 'L': apply Q or Q**H from the Left;
    • = 'R': apply Q or Q**H from the Right.
  • TRANS β€” is CHARACTER*1
    • = 'N': No transpose, apply Q;
    • = 'C': Conjugate transpose, apply Q**H.
  • M β€” is INTEGER. The number of rows of the matrix C. M >= 0.
  • N β€” is INTEGER. The number of columns of the matrix C. N >= 0.
  • 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.
  • MB β€” is INTEGER. The block size used for the storage of T. K >= MB >= 1. This must be the same value of MB used to generate T in CGELQT πŸ™ˆ
  • V β€” is COMPLEX array, dimension
(LDV,M) if SIDE = 'L',
(LDV,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 CGELQT in the first K rows of its array argument A.

  • LDV β€” is INTEGER. The leading dimension of the array V. LDV >= max(1,K).
  • T β€” is COMPLEX array, dimension (LDT,K). The upper triangular factors of the block reflectors as returned by CGELQT, stored as a MB-by-K matrix.
  • LDT β€” is INTEGER. The leading dimension of the array T. LDT >= MB.
  • C β€” is COMPLEX array, dimension (LDC,N). On entry, the M-by-N matrix C. On exit, C is overwritten by Q C, QH C, C QH or C Q. πŸ”₯
  • LDC β€” is INTEGER. The leading dimension of the array C. LDC >= max(1,M).
  • WORK β€” is COMPLEX array. The dimension of WORK is N*MB if SIDE = 'L', or M*MB if SIDE = 'R'.
  • 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

Definition at line 151 of file cgemlqt.f.


πŸ‘‘ dgemlqt πŸ‘‘

subroutine dgemlqt (character side, character trans, integer m, integer n,
    integer k, integer mb, double precision, dimension( ldv, * ) v, integer
    ldv, double precision, dimension( ldt, * ) t, integer ldt, double
    precision, dimension( ldc, * ) c, integer ldc, double precision,
    dimension( * ) work, integer info)

DGEMLQT ✨

πŸŽ€ Purpose

now the real one β€” DGEMLQT 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 K elementary reflectors:

      Q = H(1) H(2) . . . H(K) = I - V T V**T

generated using the compact WY representation as returned by DGELQT. πŸ¦‹

Q is of order M if SIDE = 'L' and of order N if SIDE = 'R'. πŸ’…

🌸 Parameters

  • SIDE β€” is CHARACTER*1
    • = 'L': apply Q or Q**T from the Left;
    • = 'R': apply Q or Q**T from the Right.
  • TRANS β€” is CHARACTER*1
    • = 'N': No transpose, apply Q;
    • = 'C': Transpose, apply Q*T. *(yep, 'C' β€” that's literally what the docs say bestie, iykyk πŸ™ˆ)
  • M β€” is INTEGER. The number of rows of the matrix C. M >= 0.
  • N β€” is INTEGER. The number of columns of the matrix C. N >= 0.
  • 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.
  • MB β€” is INTEGER. The block size used for the storage of T. K >= MB >= 1. This must be the same value of MB used to generate T in DGELQT.
  • V β€” is DOUBLE PRECISION array, dimension
(LDV,M) if SIDE = 'L',
(LDV,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 DGELQT in the first K rows of its array argument A.

  • LDV β€” is INTEGER. The leading dimension of the array V. LDV >= max(1,K).
  • T β€” is DOUBLE PRECISION array, dimension (LDT,K). The upper triangular factors of the block reflectors as returned by DGELQT, stored as a MB-by-K matrix.
  • LDT β€” is INTEGER. The leading dimension of the array T. LDT >= MB.
  • C β€” is DOUBLE PRECISION array, dimension (LDC,N). On entry, the M-by-N matrix C. On exit, C is overwritten by Q C, QT C, C QT or C Q. πŸ”₯
  • LDC β€” is INTEGER. The leading dimension of the array C. LDC >= max(1,M).
  • WORK β€” is DOUBLE PRECISION array. The dimension of WORK is N*MB if SIDE = 'L', or M*MB if SIDE = 'R'.
  • 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

Definition at line 166 of file dgemlqt.f.


πŸ‘‘ sgemlqt πŸ‘‘

subroutine sgemlqt (character side, character trans, integer m, integer n,
    integer k, integer mb, real, dimension( ldv, * ) v, integer ldv, real,
    dimension( ldt, * ) t, integer ldt, real, dimension( ldc, * ) c, integer
    ldc, real, dimension( * ) work, integer info)

SGEMLQT ✨

πŸŽ€ Purpose

same energy, single precision β€” SGEMLQT 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 K elementary reflectors:

      Q = H(1) H(2) . . . H(K) = I - V T V**T

generated using the compact WY representation as returned by SGELQT. πŸ¦‹

Q is of order M if SIDE = 'L' and of order N if SIDE = 'R'. πŸ’…

🌸 Parameters

  • SIDE β€” is CHARACTER*1
    • = 'L': apply Q or Q**T from the Left;
    • = 'R': apply Q or Q**T from the Right.
  • TRANS β€” is CHARACTER*1
    • = 'N': No transpose, apply Q;
    • = 'C': Transpose, apply Q*T. *(again with the 'C', bestie β€” that's what the page says, no cap πŸ™ˆ)
  • M β€” is INTEGER. The number of rows of the matrix C. M >= 0.
  • N β€” is INTEGER. The number of columns of the matrix C. N >= 0.
  • 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.
  • MB β€” is INTEGER. The block size used for the storage of T. K >= MB >= 1. This must be the same value of MB used to generate T in SGELQT.
  • V β€” is REAL array, dimension
(LDV,M) if SIDE = 'L',
(LDV,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 SGELQT in the first K rows of its array argument A.

  • LDV β€” is INTEGER. The leading dimension of the array V. LDV >= max(1,K).

and T is literally the very next thing β€” part 2 is gonna catch you up on that one, don't go anywhere πŸ«ΆπŸ’–

back to sgemlqt β€” here are the rest of its parameters, bestie πŸ’…

  • T β€” T is REAL array, dimension (LDT,K) β€” the upper triangular factors of the block reflectors as returned by SGELQT, stored as a MB-by-K matrix. πŸ’–
  • LDT β€” LDT is INTEGER β€” the leading dimension of the array T. LDT >= MB. ✨
  • C β€” C is REAL array, dimension (LDC,N) β€” on entry, the M-by-N matrix C. On exit, C is overwritten by Q C, Q**T C, C Q**T or C Q. πŸ”₯
  • LDC β€” LDC is INTEGER β€” the leading dimension of the array C. LDC >= max(1,M). 🌸
  • WORK β€” WORK is REAL array. The dimension of WORK is N*MB if SIDE = 'L', or M*MB 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 151 of file sgemlqt.f.


πŸ’œ subroutine zgemlqt πŸ’œ

subroutine zgemlqt (character side, character trans, integer m, integer n,
    integer k, integer mb, complex*16, dimension( ldv, * ) v, integer ldv,
    complex*16, dimension( ldt, * ) t, integer ldt, complex*16, dimension(
    ldc, * ) c, integer ldc, complex*16, dimension( * ) work, integer info)
    ZGEMLQT

Purpose

ZGEMLQT overwrites the general complex M-by-N matrix C with:

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

where Q is a complex unitary matrix defined as the product of K elementary reflectors:

Q = H(1) H(2) . . . H(K) = I - V T V**H

generated using the compact WY representation as returned by ZGELQT.

Q is of order M if SIDE = 'L' and of order N if SIDE = 'R'. 🌈

Parameters

  • SIDE β€” SIDE is CHARACTER*1 β€” = 'L': apply Q or Q**H from the Left; = 'R': apply Q or Q**H from the Right. πŸ‘‘
  • TRANS β€” TRANS is CHARACTER*1 β€” = 'N': No transpose, apply Q; = 'C': Conjugate transpose, apply Q**H. 🌟
  • 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. πŸ”‘
  • MB β€” MB is INTEGER β€” the block size used for the storage of T. K >= MB >= 1. This must be the same value of MB used to generate T in ZGELQT. πŸ¦‹
  • V β€” V is COMPLEX*16 array, dimension (LDV,M) if SIDE = 'L', (LDV,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 ZGELQT in the first K rows of its array argument A. πŸ’œ
  • LDV β€” LDV is INTEGER β€” the leading dimension of the array V. LDV >= max(1,K). ✨
  • T β€” T is COMPLEX*16 array, dimension (LDT,K) β€” the upper triangular factors of the block reflectors as returned by ZGELQT, stored as a MB-by-K matrix. πŸŽ€
  • LDT β€” LDT is INTEGER β€” the leading dimension of the array T. LDT >= MB. πŸ”₯
  • C β€” C is COMPLEX*16 array, dimension (LDC,N) β€” on entry, the M-by-N matrix C. On exit, C is overwritten by Q C, Q**H C, C Q**H or C Q. 🌸
  • LDC β€” LDC is INTEGER β€” the leading dimension of the array C. LDC >= max(1,M). πŸ’…
  • WORK β€” WORK is COMPLEX*16 array. The dimension of WORK is N*MB if SIDE = 'L', or M*MB 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 166 of file zgemlqt.f.


πŸ“œ Author πŸ“œ

Generated automatically by Doxygen for LAPACK from the source code.

and that's a wrap on gemlqt(3)! This page is LAPACK Version 3.12.0, gemlqt(3), and it was auto-generated by Doxygen for LAPACK from the source code. Slay bestie, go apply those reflectors πŸ’…βœ¨πŸ’–

πŸ“¦ where this page comes from