PZTZRZF(l)

📦 version 1.5, in ubuntu jammy

✨ PZTZRZF ✨

okay bestie, sit down, hydrate, because today we're talking about PZTZRZF from the LAPACK family (version 1.5, the ScaLAPACK girlies know 💅). this is a routine page from manual section l, and it's about taking a complex upper trapezoidal matrix and making it upper triangular with unitary transformations. glow-up of the century tbh 🦋

🌸 NAME 🌸

PZTZRZF — reduce the M-by-N ( M<=N ) complex upper trapezoidal matrix sub( A ) = A(IA:IA+M-1,JA:JA+N-1) to upper triangular form by means of unitary transformations

like. that's the whole job. that's her main character arc. ✨

🎀 SYNOPSIS 🎀

SUBROUTINE PZTZRZF( M, N, A, IA, JA, DESCA, TAU, WORK, LWORK, INFO )

    INTEGER         IA, INFO, JA, LWORK, M, N

    INTEGER         DESCA( * )

    COMPLEX*16      A( * ), TAU( * ), WORK( * )

no cap, that's the whole signature. memorize it or keep it in your notes app 💖

👑 PURPOSE 👑

PZTZRZF reduces the M-by-N ( M<=N ) complex upper trapezoidal matrix sub( A ) = A(IA:IA+M-1,JA:JA+N-1) to upper triangular form by means of unitary transformations.

the upper trapezoidal matrix sub( A ) is factored as

sub( A ) = ( R  0 ) * Z,

where Z is an N-by-N unitary matrix and R is an M-by-M upper triangular matrix.

💫 Notes 💫

each 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. it's giving ✨bookkeeping✨ but make it distributed.

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

okay so here's the lore, one bullet per entry because tables aren't the vibe here 🫶:

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

💖 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 ). 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, the local pieces of the M-by-N distributed matrix sub( A ) which is to be factored. on exit, the leading M-by-M upper triangular part of sub( A ) contains the upper triangular matrix R, and elements M+1 to N of the first M rows of sub( A ), with the array TAU, represent the unitary matrix Z as a product of M elementary reflectors. (she contains multitudes fr fr 😭)
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.
TAU — (local output) COMPLEX*16, array, dimension LOCr(IA+M-1). this array contains the scalar factors of the elementary reflectors. TAU is tied to the distributed matrix A.
WORK — (local workspace/local output) COMPLEX*16 array, dimension (LWORK). on exit, WORK(1) returns the minimal and optimal LWORK.
LWORK — (local or global input) INTEGER. the dimension of the array WORK. LWORK is local input and must be at least LWORK >= MB_A * ( Mp0 + Nq0 + MB_A ), where

IROFF = MOD( IA-1, MB_A ), ICOFF = MOD( JA-1, NB_A ), IAROW =
INDXG2P( IA, MB_A, MYROW, RSRC_A, NPROW ), IACOL = INDXG2P( JA,
NB_A, MYCOL, CSRC_A, NPCOL ), Mp0   = NUMROC( M+IROFF, MB_A,
MYROW, IAROW, NPROW ), Nq0   = NUMROC( N+ICOFF, NB_A, MYCOL,
IACOL, NPCOL ),

and NUMROC, INDXG2P are ScaLAPACK tool functions; MYROW, MYCOL, NPROW and NPCOL can be determined by calling the subroutine BLACS_GRIDINFO.

if LWORK = -1, then LWORK is global input and a workspace query is assumed; the routine only calculates the minimum and optimal size for all work arrays. each of these values is returned in the first entry of the corresponding work array, and no error message is issued by PXERBLA. (yes queen, give us nothing and everything at once 💅)

INFO — (global output) INTEGER.
- = 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.

🔥 FURTHER DETAILS 🔥

the factorization is obtained by Householder's method. the kth transformation matrix, Z( k ), whose conjugate transpose is used to introduce zeros into the (m - k + 1)th row of sub( A ), is given in the form

Z( k ) = ( I     0   ),
         ( 0  T( k ) )

where

T( k ) = I - tau*u( k )*u( k )',   u( k ) = (   1    ),
                                            (   0    )
                                            ( z( k ) )

tau is a scalar and z( k ) is an ( n - m ) element vector. tau and z( k ) are chosen to annihilate the elements of the kth row of sub( A ).

the scalar tau is returned in the kth element of TAU and the vector u( k ) in the kth row of sub( A ), such that the elements of z( k ) are in a( k, m + 1 ), ..., a( k, n ). the elements of R are returned in the upper triangular part of sub( A ).

Z is given by

Z =  Z( 1 ) * Z( 2 ) * ... * Z( m ).

ok bestie one (1) tiny reminder: this is a real LAPACK/ScaLAPACK routine, so respect the descriptor, respect LWORK, and read the argument constraints before you go wild. the math is not playing around, even if i am 🫶

and that's the page!! 💜 this was PZTZRZF(l) from LAPACK version 1.5, dated 12 May 1997 — yes she's an elder icon and she's still serving upper triangular realness. periodt. 👑✨🌸💖🦋

📦 where this page comes from

ubuntu jammy: scalapack-doc 1.5-11
💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash on 2026-10-14: a language model's rewrite of the original, under its terms