PCLAQSY(l)

📦 version 1.5, in ubuntu jammy

💖 PCLAQSY — bestie edition 💖

okay so this is a LAPACK auxiliary routine, version 1.5, and it's literally the glow-up routine for symmetric distributed matrices. no cap. let me tell you everything 🫶

✨ NAME ✨

PCLAQSY — it equilibrates a symmetric distributed matrix sub( A ) = A(IA:IA+N-1,JA:JA+N-1) using the scaling factors chilling in the vectors SR and SC. that's the whole vibe. 💅

🌸 SYNOPSIS 🌸

SUBROUTINE PCLAQSY( UPLO, N, A, IA, JA, DESCA, SR, SC, SCOND, AMAX,
                    EQUED )

    CHARACTER       EQUED, UPLO

    INTEGER         IA, JA, N

    REAL            AMAX, SCOND

    INTEGER         DESCA( * )

    REAL            SC( * ), SR( * )

    COMPLEX         A( * )

👑 PURPOSE 👑

PCLAQSY equilibrates a symmetric distributed matrix sub( A ) = A(IA:IA+N-1,JA:JA+N-1) using the scaling factors in the vectors SR and SC.

that's it, that's the job. iconic behavior honestly ✨

🎀 Notes 🎀

every global data object has an associated description vector, and that vector is the one holding the info you need to map an object element to its corresponding process and memory location. main character energy for a little integer array, but go off.

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 comments below, the character _ should be read as "of the global array".

here's the whole lore, one entry at a time:

  • 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 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 💅

  • UPLO — (global input) CHARACTER. specifies whether the upper or lower triangular part of the symmetric distributed matrix sub( A ) is to be referenced:
    • = 'U': upper triangular
    • = 'L': lower triangular
  • N — (global input) INTEGER. the number of rows and columns to be operated on, i.e. the order of the distributed submatrix sub( A ). N >= 0.
  • A — (input/output) COMPLEX pointer into the local memory to an array of local dimension (LLD_A,LOCc(JA+N-1)). on entry, the local pieces of the distributed symmetric matrix sub( A ). if UPLO = 'U', the leading N-by-N upper triangular part of sub( A ) contains the upper triangular part of the matrix, and the strictly lower triangular part of sub( A ) is not referenced. if UPLO = 'L', the leading N-by-N lower triangular part of sub( A ) contains the lower triangular part of the matrix, and the strictly upper triangular part of sub( A ) is not referenced. on exit, if EQUED = 'Y', the equilibrated matrix:
diag(SR(IA:IA+N-1)) * sub( A ) * diag(SC(JA:JA+N-1)).
  • 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.
  • SR — (local input) REAL array, dimension LOCr(M_A). the scale factors for A(IA:IA+M-1,JA:JA+N-1). SR is aligned with the distributed matrix A, and replicated across every process column. SR is tied to the distributed matrix A.
  • SC — (local input) REAL array, dimension LOCc(N_A). the scale factors for sub( A ). SC is aligned with the distributed matrix A, and replicated down every process row. SC is tied to the distributed matrix A.
  • SCOND — (global input) REAL. ratio of the smallest SR(i) (respectively SC(j)) to the largest SR(i) (respectively SC(j)), with IA <= i <= IA+N-1 and JA <= j <= JA+N-1.
  • AMAX — (global input) REAL. absolute value of the largest distributed submatrix entry.
  • EQUED — (output) CHARACTER*1. specifies whether or not equilibration was done.
    • = 'N': no equilibration.
    • = 'Y': equilibration was done, i.e., sub( A ) has been replaced by:
diag(SR(IA:IA+N-1)) * sub( A ) * diag(SC(JA:JA+N-1)).

🌈 PARAMETERS 🌈

THRESH is a threshold value used to decide if scaling should be done based on the ratio of the scaling factors. if SCOND < THRESH, scaling is done.

LARGE and SMALL are threshold values used to decide if scaling should be done based on the absolute size of the largest matrix element. if AMAX > LARGE or AMAX < SMALL, scaling is done.

okay bestie that's the whole page 💖 this was LAPACK version 1.5, dated 12 May 1997 — yeah she's vintage but she's still serving. periodt. 🦋✨🎀

📦 where this page comes from