bdsdc(3)

🌸 NAME 🌸

bdsdc β€” bidiagonal SVD, divide and conquer. Yes bestie, that's the whole name, and it's giving iconic πŸ’…


✨ SYNOPSIS ✨

Functions 🫢

subroutine dbdsdc (uplo, compq, n, d, e, u, ldu, vt, ldvt, q, iq, work,
    iwork, info)
    DBDSDC
subroutine sbdsdc (uplo, compq, n, d, e, u, ldu, vt, ldvt, q, iq, work,
    iwork, info)
    SBDSDC

πŸ’– Detailed Description πŸ’–

okay so like, this is the part where the actual docs live. keep scrolling, beautiful, the good stuff is right below ⬇️


πŸ”₯ Function Documentation πŸ”₯

subroutine dbdsdc β€” the double precision one πŸ‘‘

subroutine dbdsdc (character uplo, character compq, integer n, double
    precision, dimension( * ) d, double precision, dimension( * ) e, double
    precision, dimension( ldu, * ) u, integer ldu, double precision,
    dimension( ldvt, * ) vt, integer ldvt, double precision, dimension( * )
    q, integer, dimension( * ) iq, double precision, dimension( * ) work,
    integer, dimension( * ) iwork, integer info)
    DBDSDC

πŸ¦‹ Purpose:

no cap, here's the whole vibe:

DBDSDC computes the singular value decomposition (SVD) of a real N-by-N (upper or lower) bidiagonal matrix B:

B = U * S * VT

…using a divide and conquer method, where S is a diagonal matrix with non-negative diagonal elements (the singular values of B), and U and VT are orthogonal matrices of left and right singular vectors, respectively. DBDSDC can be used to compute all singular values, and optionally, singular vectors or singular vectors in compact form. πŸŽ€

ngl there's one little detail: the code currently calls DLASDQ if singular values only are desired. However, it can be slightly modified to compute singular values using the divide and conquer method. iykyk πŸ”₯

πŸŽ€ Parameters

  • UPLO β€” CHARACTER*1. which way is the bidiagonal leaning, bestie?
    • = 'U': B is upper bidiagonal.
    • = 'L': B is lower bidiagonal.
  • COMPQ β€” CHARACTER*1. says whether singular vectors are to be computed, as follows:
    • = 'N': Compute singular values only;
    • = 'P': Compute singular values and compute singular vectors in compact form;
    • = 'I': Compute singular values and singular vectors.
  • N β€” INTEGER. The order of the matrix B. N >= 0. (yes, zero is allowed, she's inclusive ✨)
  • D β€” DOUBLE PRECISION array, dimension (N). On entry, the n diagonal elements of the bidiagonal matrix B. On exit, if INFO=0, the singular values of B. glow-up fr fr πŸ’«
  • E β€” DOUBLE PRECISION array, dimension (N-1). On entry, the elements of E contain the offdiagonal elements of the bidiagonal matrix whose SVD is desired. On exit, E has been destroyed. πŸ’€ like, gone gone. don't come looking for it.
  • U β€” DOUBLE PRECISION array, dimension (LDU,N). If COMPQ = 'I', then: on exit, if INFO = 0, U contains the left singular vectors of the bidiagonal matrix. For other values of COMPQ, U is not referenced. (she's on standby, not invited to every party πŸ™ˆ)
  • LDU β€” INTEGER. The leading dimension of the array U. LDU >= 1. If singular vectors are desired, then LDU >= max( 1, N ).
  • VT β€” DOUBLE PRECISION array, dimension (LDVT,N). If COMPQ = 'I', then: on exit, if INFO = 0, VT**T contains the right singular vectors of the bidiagonal matrix. For other values of COMPQ, VT is not referenced. (transpose queen πŸ‘‘ note the **T!)
  • LDVT β€” INTEGER. The leading dimension of the array VT. LDVT >= 1. If singular vectors are desired, then LDVT >= max( 1, N ).
  • Q β€” DOUBLE PRECISION array, dimension (LDQ). If COMPQ = 'P', then: on exit, if INFO = 0, Q and IQ contain the left and right singular vectors in a compact form, requiring O(N log N) space instead of 2*N**2. In particular, Q contains all the DOUBLE PRECISION data in
LDQ >= N*(11 + 2*SMLSIZ + 8*INT(LOG_2(N/(SMLSIZ+1))))

words of memory, where SMLSIZ is returned by ILAENV and is equal to the maximum size of the subproblems at the bottom of the computation tree (usually about 25). For other values of COMPQ, Q is not referenced. 🧚 saving so much space, she's thrifty.

  • IQ β€” INTEGER array, dimension (LDIQ). If COMPQ = 'P', then: on exit, if INFO = 0, Q and IQ contain the left and right singular vectors in a compact form, requiring O(N log N) space instead of 2*N**2. In particular, IQ contains all INTEGER data in
LDIQ >= N*(3 + 3*INT(LOG_2(N/(SMLSIZ+1))))

words of memory, where SMLSIZ is returned by ILAENV and is equal to the maximum size of the subproblems at the bottom of the computation tree (usually about 25). For other values of COMPQ, IQ is not referenced. (same deal as Q, but make it integers πŸ’œ)

  • WORK β€” DOUBLE PRECISION array, dimension (MAX(1,LWORK)). the workspace, sized like this:
    • If COMPQ = 'N' then LWORK >= (4 * N).
    • If COMPQ = 'P' then LWORK >= (6 * N).
    • If COMPQ = 'I' then LWORK >= (3 * N**2 + 4 * N).
  • IWORK β€” INTEGER array, dimension (8*N). that's it, that's the whole description, she's low maintenance πŸ“
  • INFO β€” INTEGER. the vibe check at the end:
    • = 0: successful exit. slay πŸŽ‰
    • < 0: if INFO = -i, the i-th argument had an illegal value. 😭
    • > 0: The algorithm failed to compute a singular value. The update process of divide and conquer failed. πŸ’€ not the divide and conquer falling apart mid-update.

πŸ‘‘ Author

  • Univ. of Tennessee
  • Univ. of California Berkeley
  • Univ. of Colorado Denver
  • NAG Ltd.

🌈 Contributors:

Ming Gu and Huan Ren, Computer Science Division, University of California at Berkeley, USA 🫢

Definition at line 196 of file dbdsdc.f.


subroutine sbdsdc β€” the single precision sibling 🌸

subroutine sbdsdc (character uplo, character compq, integer n, real,
    dimension( * ) d, real, dimension( * ) e, real, dimension( ldu, * ) u,
    integer ldu, real, dimension( ldvt, * ) vt, integer ldvt, real,
    dimension( * ) q, integer, dimension( * ) iq, real, dimension( * ) work,
    integer, dimension( * ) iwork, integer info)
    SBDSDC

πŸ¦‹ Purpose:

literally the same energy as above, just REAL:

SBDSDC computes the singular value decomposition (SVD) of a real N-by-N (upper or lower) bidiagonal matrix B:

B = U * S * VT

…using a divide and conquer method, where S is a diagonal matrix with non-negative diagonal elements (the singular values of B), and U and VT are orthogonal matrices of left and right singular vectors, respectively. SBDSDC can be used to compute all singular values, and optionally, singular vectors or singular vectors in compact form. ✨

and the same caveat, bestie: the code currently calls SLASDQ if singular values only are desired. However, it can be slightly modified to compute singular values using the divide and conquer method. (note SLASDQ here, not DLASDQ β€” precision matters πŸ’…)

πŸŽ€ Parameters

  • UPLO β€” CHARACTER*1. which way is she leaning?
    • = 'U': B is upper bidiagonal.
    • = 'L': B is lower bidiagonal.
  • COMPQ β€” CHARACTER*1. Specifies whether singular vectors are to be computed as follows:
    • = 'N': Compute singular values only;
    • = 'P': Compute singular values and compute singular vectors in compact form;
    • = 'I': Compute singular values and singular vectors.
  • N β€” INTEGER. The order of the matrix B. N >= 0.
  • D β€” REAL array, dimension (N). On entry, the n diagonal elements of the bidiagonal matrix B. On exit, if INFO=0, the singular values of B. πŸ’–
  • E β€” REAL array, dimension (N-1). On entry, the elements of E contain the offdiagonal elements of the bidiagonal matrix whose SVD is desired. On exit, E has been destroyed. 😭 rip.
  • U β€” REAL array, dimension (LDU,N). If COMPQ = 'I', then: on exit, if INFO = 0, U contains the left singular vectors of the bidiagonal matrix. For other values of COMPQ, U is not referenced.
  • LDU β€” INTEGER. The leading dimension of the array U. LDU >= 1. If singular vectors are desired, then LDU >= max( 1, N ).
  • VT β€” REAL array, dimension (LDVT,N). If COMPQ = 'I', then: on exit, if INFO = 0, VT**T contains the right singular vectors of the bidiagonal matrix. For other values of COMPQ, VT is not referenced. (again β€” the **T is doing the work, don't sleep on it πŸ‘‘)
  • LDVT β€” INTEGER. The leading dimension of the array VT. LDVT >= 1. If singular vectors are desired, then LDVT >= max( 1, N ).
  • Q β€” REAL array, dimension (LDQ). If COMPQ = 'P', then: on exit, if INFO = 0, Q and IQ contain the left and right singular vectors in a compact form, requiring O(N log N) space instead of 2*N**2. In particular, Q contains all the REAL data in
LDQ >= N*(11 + 2*SMLSIZ + 8*INT(LOG_2(N/(SMLSIZ+1))))

words of memory, where SMLSIZ is returned by ILAENV and is equal to the maximum size of the subproblems at the bottom of the computation tree (usually about 25). For other values of COMPQ, Q is not referenced. 🌈

  • IQ β€” INTEGER array, dimension (LDIQ). If COMPQ = 'P', then: on exit, if INFO = 0, Q and IQ contain the left and right singular vectors in a compact form, requiring O(N log N) space instead of 2*N**2. In particular, IQ contains all INTEGER data in
  • IQ β€” INTEGER array, dimension (LDIQ) πŸ’–
    • If COMPQ = 'P', then: on exit, if INFO = 0, Q and IQ contain the left and right singular vectors in a compact form, requiring O(N log N) space instead of 2*N**2. In particular, IQ contains all INTEGER data in LDIQ >= N*(3 + 3*INT(LOG_2(N/(SMLSIZ+1)))) words of memory, where SMLSIZ is returned by ILAENV and is equal to the maximum size of the subproblems at the bottom of the computation tree (usually about 25). 🧚
    • For other values of COMPQ, IQ is not referenced. literally doesn't even get a vibe check bestie, it's just sitting there πŸ™ˆ
  • WORK β€” WORK is REAL array, dimension (MAX(1,LWORK)) ✨
    • If COMPQ = 'N' then LWORK >= (4 * N).
    • If COMPQ = 'P' then LWORK >= (6 * N).
    • If COMPQ = 'I' then LWORK >= (3 * N**2 + 4 * N). 😭 that third one is giving "my RAM is crying" energy ngl
  • IWORK β€” IWORK is INTEGER array, dimension (8*N) πŸŽ€
  • INFO β€” INFO is INTEGER, and this icon is the whole mood report πŸ‘‘
    • = 0: successful exit. slay, we ate πŸ’…
    • < 0: if INFO = -i, the i-th argument had an illegal value. not me calling out your arg by number πŸ’€
    • > 0: The algorithm failed to compute a singular value. The update process of divide and conquer failed. 🫢 lowkey devastating, sending hugs

πŸ‘‘ Author

  • Univ. of Tennessee
  • Univ. of California Berkeley
  • Univ. of Colorado Denver
  • NAG Ltd.

🫢 Contributors:

Ming Gu and Huan Ren, Computer Science Division, University of California at Berkeley, USA 🌈

⭐ Definition at line 196 of file sbdsdc.f.

πŸ’œ Author

Generated automatically by Doxygen for LAPACK from the source code. yes bestie the robots wrote the bio, that's just how it is πŸ™ˆ


and that's the whole page, bestie! πŸŽ€βœ¨ quick cute sign-off for the footer: this is bdsdc(3) from LAPACK Version 3.12.0 β€” that's the source and the version the footer's repping, so don't come for me about the date, it's not on the page πŸ˜­πŸ’–

πŸ“¦ where this page comes from