PZGETF2(l)

📦 version 1.5, in ubuntu jammy

💖 PZGETF2 💖

okay bestie, welcome to the LAPACK routine glow-up of PZGETF2 — this is the Parallel Level 2 BLAS girlie and she's here to do exactly one thing: factorize your distributed matrix. let's get into it ✨

🎀 NAME 🎀

PZGETF2 — compute an LU factorization of a general M-by-N distributed matrix sub( A ) = A(IA:IA+M-1,JA:JA+N-1) using partial pivoting with row interchanges.

🌸 SYNOPSIS 🌸

SUBROUTINE PZGETF2( M, N, A, IA, JA, DESCA, IPIV, INFO )

    INTEGER         IA, INFO, JA, M, N

    INTEGER         DESCA( * ), IPIV( * )

    COMPLEX*16      A( * )

✨ PURPOSE ✨

so PZGETF2 computes an LU factorization of a general M-by-N distributed matrix sub( A ) = A(IA:IA+M-1,JA:JA+N-1) using partial pivoting with row interchanges. no cap.

the factorization has the form sub( A ) = P * L * U, where P is a permutation matrix, L is lower triangular with unit diagonal elements (lower trapezoidal if m > n), and U is upper triangular (upper trapezoidal if m < n). 💅

this is the right-looking Parallel Level 2 BLAS version of the algorithm. she's the real one. periodt.

📝 Notes 📝

every global data object is described by an associated description vector. this vector stores the information required to establish the mapping between an object element and its corresponding process and memory location. 🫶

let A be a generic term for any 2D block cyclicly distributed array. such a global array has an associated description vector DESCA. in the following comments, the character _ should be read as "of the global array". iykyk.

here's the whole mapping, no gatekeeping:

  • DTYPE_A(global) stored in DESCA( DTYPE_ ) — the descriptor type. in this case, DTYPE_A = 1.
  • CTXT_A (global) stored in DESCA( CTXT_ ) — the BLACS context handle, indicating the BLACS process grid A is distributed over. the context itself is global, but the handle (the integer value) may vary.
  • M_A (global) stored in DESCA( M_ ) — the number of rows in the global array A.
  • N_A (global) stored in DESCA( N_ ) — the number of columns in the global array A.
  • MB_A (global) stored in DESCA( MB_ ) — the blocking factor used to distribute the rows of the array.
  • NB_A (global) stored in DESCA( NB_ ) — the blocking factor used to distribute the columns of the array.
  • RSRC_A (global) stored in DESCA( RSRC_ ) — the process row over which the first row of the array A is distributed.
  • CSRC_A (global) stored in DESCA( CSRC_ ) — the process column over which the first column of the array A is distributed.
  • LLD_A (local) stored in DESCA( LLD_ ) — the leading dimension of the local array. LLD_A >= MAX(1,LOCr(M_A)).

let K be the number of rows or columns of a distributed matrix, and assume that its process grid has dimension p x q.

LOCr( K ) denotes the number of elements of K that a process would receive if K were distributed over the p processes of its process column. 🔥

similarly, LOCc( K ) denotes the number of elements of K that a process would receive if K were distributed over the q processes of its process row.

the values of LOCr() and LOCc() may be determined via a call to the ScaLAPACK tool function, NUMROC:

LOCr( M ) = NUMROC( M, MB_A, MYROW, RSRC_A, NPROW ),
LOCc( N ) = NUMROC( N, NB_A, MYCOL, CSRC_A, NPCOL ).

an upper bound for these quantities may be computed by:

LOCr( M ) <= ceil( ceil(M/MB_A)/NPROW )*MB_A
LOCc( N ) <= ceil( ceil(N/NB_A)/NPCOL )*NB_A
🌈 heads up bestie: this routine requires N <= NB_A-MOD(JA-1, NB_A) and square block decomposition (MB_A = NB_A). don't skip that, it's not optional.

👑 ARGUMENTS 👑

  • M — (global input) INTEGER. the number of rows to be operated on, i.e. the number of rows of the distributed submatrix sub( A ). M >= 0.
  • N — (global input) INTEGER. the number of columns to be operated on, i.e. the number of columns of the distributed submatrix sub( A ). NB_A-MOD(JA-1, NB_A) >= N >= 0.
  • A — (local input/local output) COMPLEX*16 pointer into the local memory to an array of dimension (LLD_A, LOCc(JA+N-1)). on entry, this array contains the local pieces of the M-by-N distributed matrix sub( A ). on exit, this array contains the local pieces of the factors L and U from the factorization sub( A ) = P*L*U; the unit diagonal elements of L are not stored. she said what she said 💅
  • IA — (global input) INTEGER. the row index in the global array A indicating the first row of sub( A ).
  • JA — (global input) INTEGER. the column index in the global array A indicating the first column of sub( A ).
  • DESCA — (global and local input) INTEGER array of dimension DLEN_. the array descriptor for the distributed matrix A.
  • IPIV — (local output) INTEGER array, dimension ( LOCr(M_A)+MB_A ). this array contains the pivoting information. IPIV(i) -> the global row local row i was swapped with. this array is tied to the distributed matrix A.
  • INFO — (local output) INTEGER. the vibe check report, fr fr:
    • = 0: successful exit ✨
    • < 0: if the i-th argument is an array and the j-entry had an illegal value, then INFO = -(i*100+j); if the i-th argument is a scalar and had an illegal value, then INFO = -i.
    • > 0: if INFO = K, U(IA+K-1,JA+K-1) is exactly zero. the factorization has been completed, but the factor U is exactly singular, and division by zero will occur if it is used to solve a system of equations. 😭 that's not a drill, bestie.

and that's the whole page, you ate that 💅✨

this was LAPACK version 1.5, dated 12 May 1997 — yeah she's vintage and still iconic, we love a legacy queen 👑🦋 mwah, go factorize something 🫶💖

📦 where this page comes from