PCLAPV2(l)

📦 version 1.5, in ubuntu jammy

🌸 NAME 🌸

okay so bestie, let me put you on: PCLAPV2 is a LAPACK auxiliary routine — and not to be dramatic but it's giving very important. What she does is apply either P (the permutation matrix indicated by IPIV) or inv( P ) to a M-by-N distributed matrix sub( A ) denoting A(IA:IA+M-1,JA:JA+N-1), resulting in row or column pivoting. that's the whole vibe. periodt. 💅

✨ SYNOPSIS ✨

SUBROUTINE PCLAPV2( DIREC, ROWCOL, M, N, A, IA, JA, DESCA, IPIV, IP, JP,
                    DESCIP )

    CHARACTER       DIREC, ROWCOL

    INTEGER         IA, IP, JA, JP, M, N

    INTEGER         DESCA( * ), DESCIP( * ), IPIV( * )

    COMPLEX         A( * )

🦋 PURPOSE 🦋

PCLAPV2 applies either P (the permutation matrix indicated by IPIV) or inv( P ) to a M-by-N distributed matrix sub( A ) denoting A(IA:IA+M-1,JA:JA+N-1), resulting in row or column pivoting. 🫶

and listen, the pivot vector has to be aligned with the distributed matrix A. no cap, this part matters:

  • for pivoting the rows of sub( A ), IPIV should be distributed along a process column and replicated over all process rows.
  • similarly, IPIV should be distributed along a process row and replicated over all process columns for column pivoting.

📝 Notes 📝

each global data object is described by an associated description vector. this vector stores the info required to establish the mapping between an object element and its corresponding process and memory location. slay. 💖

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".

  • 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)).

now let K be the number of rows or columns of a distributed matrix, and assume 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

👑 ARGUMENTS 👑

  • DIREC (global input) CHARACTER — specifies in which order the permutation is applied:
    • = 'F' (Forward) applies pivots Forward from top of matrix. computes P * sub( A ).
    • = 'B' (Backward) applies pivots Backward from bottom of matrix. computes inv( P ) * sub( A ).
  • ROWCOL (global input) CHARACTER — specifies if the rows or columns are to be permuted:
    • = 'R' Rows will be permuted.
    • = 'C' Columns will be permuted.
  • 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 ). N >= 0.
  • A (local input/local output) COMPLEX — pointer into the local memory to an array of dimension (LLD_A, LOCc(JA+N-1)). on entry, this local array contains the local pieces of the distributed matrix sub( A ) to which the row or columns interchanges will be applied. on exit, this array contains the local pieces of the permuted distributed matrix. ✨
  • 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 (input) INTEGER array, dimension >= LOCr(M_A)+MB_A if ROWCOL = 'R', LOCc(N_A)+NB_A otherwise. it contains the pivoting information. IPIV(i) is the global row (column), local row (column) i was swapped with. the last piece of the array of size MB_A (resp. NB_A) is used as workspace. IPIV is tied to the distributed matrix A.
  • IP (global input) INTEGER — IPIV's global row index, which points to the beginning of the submatrix which is to be operated on.
  • JP (global input) INTEGER — IPIV's global column index, which points to the beginning of the submatrix which is to be operated on.
  • DESCIP (global and local input) INTEGER array of dimension 8. the array descriptor for the distributed matrix IPIV.
heads up bestie: every single one of those arguments is doing something, so don't go skipping them. the descriptor math is not a suggestion, it's the whole plot. 😭

okay and that's the tea 🍓 — this page is LAPACK version 1.5, dated 12 May 1997, so yeah she's an icon, she's a legend, and she's the moment. now go pivot something. 👑💖

📦 where this page comes from