/home/abui.../sorbdb1.f(3)

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

🌸 NAME 🌸

Okay bestie, welcome to the LAPACK Library Functions Manual page for SORBDB1 πŸ’… β€” the source file is /home/abuild/rpmbuild/BUILD/lapack-static-3.12.0-build/lapack-3.12.0/SRC/sorbdb1.f ✨


✨ SYNOPSIS ✨

Functions/Subroutines

subroutine SORBDB1 (m, p, q, x11, ldx11, x21, ldx21, theta, phi, taup1,
    taup2, tauq1, work, lwork, info)
    SORBDB1

πŸŽ€ Function/Subroutine Documentation πŸŽ€

Here's the full signature one more time, because Doxygen said so and we respect the lore 🫢

subroutine SORBDB1 (integer m, integer p, integer q, real,
    dimension(ldx11,*) x11, integer ldx11, real, dimension(ldx21,*) x21,
    integer ldx21, real, dimension(*) theta, real, dimension(*) phi, real,
    dimension(*) taup1, real, dimension(*) taup2, real, dimension(*) tauq1,
    real, dimension(*) work, integer lwork, integer info)
    SORBDB1

πŸ’« Purpose πŸ’«

SORBDB1 is out here doing the absolute most: it simultaneously bidiagonalizes the blocks of a tall and skinny matrix X with orthonormal columns πŸ˜­πŸ’– The glow-up looks like this:

                            [ B11 ]
      [ X11 ]   [ P1 |    ] [  0  ]
      [-----] = [---------] [-----] Q1**T .
      [ X21 ]   [    | P2 ] [ B21 ]
                            [  0  ]

X11 is P-by-Q, and X21 is (M-P)-by-Q. Q must be no larger than P, M-P, or M-Q. Routines SORBDB2, SORBDB3, and SORBDB4 handle cases in which Q is not the minimum dimension πŸ‘‘

The orthogonal matrices P1, P2, and Q1 are P-by-P, (M-P)-by-(M-P), and (M-Q)-by-(M-Q), respectively. They are represented implicitly by Householder vectors ✨

B11 and B12 are Q-by-Q bidiagonal matrices represented implicitly by angles THETA, PHI πŸ¦‹

πŸ“‹ Parameters πŸ“‹

  • M β€” M is INTEGER. The number of rows X11 plus the number of rows in X21.
  • P β€” P is INTEGER. The number of rows in X11. 0 <= P <= M.
  • Q β€” Q is INTEGER. The number of columns in X11 and X21. 0 <= Q <= MIN(P,M-P,M-Q).
  • X11 β€” X11 is REAL array, dimension (LDX11,Q). On entry, the top block of the matrix X to be reduced. On exit, the columns of tril(X11) specify reflectors for P1 and the rows of triu(X11,1) specify reflectors for Q1.
  • LDX11 β€” LDX11 is INTEGER. The leading dimension of X11. LDX11 >= P.
  • X21 β€” X21 is REAL array, dimension (LDX21,Q). On entry, the bottom block of the matrix X to be reduced. On exit, the columns of tril(X21) specify reflectors for P2.
  • LDX21 β€” LDX21 is INTEGER. The leading dimension of X21. LDX21 >= M-P.
  • THETA β€” THETA is REAL array, dimension (Q). The entries of the bidiagonal blocks B11, B21 are defined by THETA and PHI. See Further Details.
  • PHI β€” PHI is REAL array, dimension (Q-1). The entries of the bidiagonal blocks B11, B21 are defined by THETA and PHI. See Further Details.
  • TAUP1 β€” TAUP1 is REAL array, dimension (P). The scalar factors of the elementary reflectors that define P1.
  • TAUP2 β€” TAUP2 is REAL array, dimension (M-P). The scalar factors of the elementary reflectors that define P2.
  • TAUQ1 β€” TAUQ1 is REAL array, dimension (Q). The scalar factors of the elementary reflectors that define Q1.
  • WORK β€” WORK is REAL array, dimension (LWORK).
  • LWORK β€” LWORK is INTEGER. The dimension of the array WORK. LWORK >= M-Q. 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 β€” 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.

πŸ” Further Details πŸ”

The upper-bidiagonal blocks B11, B21 are represented implicitly by angles THETA(1), ..., THETA(Q) and PHI(1), ..., PHI(Q-1). Every entry in each bidiagonal band is a product of a sine or cosine of a THETA with a sine or cosine of a PHI. See [1] or SORCSD for details 🌈

P1, P2, and Q1 are represented as products of elementary reflectors. See SORCSD2BY1 for details on generating P1, P2, and Q1 using SORGQR and SORGLQ πŸ’œ

πŸ“š References πŸ“š

  • [1] Brian D. Sutton. Computing the complete CS decomposition. Numer. Algorithms, 50(1):33-65, 2009.

πŸ“ Definition at line 201 of file sorbdb1.f.


πŸ’Œ Author πŸ’Œ

Generated automatically by Doxygen for LAPACK from the source code.


Cute sign-off: this page is LAPACK Version 3.12.0, sourced from /home/abui.../sorbdb1.f(3). Bye bestie, go bidiagonalize something iconic πŸ’…βœ¨

πŸ“¦ where this page comes from