Routine PZGELQF() Documented By Universal Report

Routine: PZGELQF()

File: SRC\pzgelqf.f

# lines:	313
# code:	313
# comment:	0
# blank:	0
# Variables:	44
# Callers:	1
# Callings:	3
# Words:	119
# Keywords:	68

..
     .. Array Arguments ..
     ..
  Purpose
  =======
  PZGELQF computes a LQ factorization of a complex distributed M-by-N
  matrix sub( A ) = A(IA:IA+M-1,JA:JA+N-1) = L * Q.
  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.
  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".
  NOTATION        STORED IN      EXPLANATION
  --------------- -------------- --------------------------------------
  DTYPE_A(global) DESCA( DTYPE_ )The descriptor type.  In this case,
                                 DTYPE_A = 1.
  CTXT_A (global) DESCA( CTXT_ ) The BLACS context handle, indicating
                                 the BLACS process grid A is distribu-
                                 ted over. The context itself is glo-
                                 bal, but the handle (the integer
                                 value) may vary.
  M_A    (global) DESCA( M_ )    The number of rows in the global
                                 array A.
  N_A    (global) DESCA( N_ )    The number of columns in the global
                                 array A.
  MB_A   (global) DESCA( MB_ )   The blocking factor used to distribute
                                 the rows of the array.
  NB_A   (global) DESCA( NB_ )   The blocking factor used to distribute
                                 the columns of the array.
  RSRC_A (global) DESCA( RSRC_ ) The process row over which the first
                                 row of the array A is distributed.
  CSRC_A (global) DESCA( CSRC_ ) The process column over which the
                                 first column of the array A is
                                 distributed.
  LLD_A  (local)  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 elements on
          and below the diagonal of sub( A ) contain the M by min(M,N)
          lower trapezoidal matrix L (L is lower triangular if M <= N);
          the elements above the diagonal, with the array TAU, repre-
          sent the unitary matrix Q as a product of elementary
          reflectors (see Further Details).
  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+MIN(M,N)-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.
  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 matrix Q is represented as a product of elementary reflectors
     Q = H(ia+k-1)' H(ia+k-2)' . . . H(ia)', where k = min(m,n).
  Each H(i) has the form
     H(i) = I - tau * v * v'
  where tau is a complex scalar, and v is a complex vector with
  v(1:i-1) = 0 and v(i) = 1; conjg(v(i+1:n)) is stored on exit in
  A(ia+i-1,ja+i:ja+n-1), and tau in TAU(ia+i-1).
  =====================================================================
     .. Parameters ..

Display dynamic version

FontSize: - +

001        SUBROUTINE PZGELQF( M , N , A , IA , JA , DESCA , TAU , WORK , LWORK ,
002       $INFO )
003  
004  *     -- ScaLAPACK routine(version 1.7) --
005  *     University of Tennessee , Knoxville , Oak Ridge National Laboratory ,
006  *     and University of California , Berkeley.
007  *     May 25 , 2001
008  
009  *     .. Scalar Arguments ..
010        INTEGER IA , INFO , JA , LWORK , M , N
011        INTEGER BLOCK_CYCLIC_2D , CSRC_ , CTXT_ , DLEN_ , DTYPE_ ,
012       $LLD_ , MB_ , M_ , NB_ , N_ , RSRC_
013        PARAMETER( BLOCK_CYCLIC_2D = 1 , DLEN_ = 9 , DTYPE_ = 1 ,
014       $CTXT_ = 2 , M_ = 3 , N_ = 4 , MB_ = 5 , NB_ = 6 ,
015       $RSRC_ = 7 , CSRC_ = 8 , LLD_ = 9 )
016  *     ..
017  *     .. Local Scalars ..
018        LOGICAL LQUERY
019        CHARACTER COLBTOP , ROWBTOP
020        INTEGER I , IACOL , IAROW , IB , ICTXT , IINFO , IN , IPW ,
021       $IROFF , J , K , LWMIN , MP0 , MYCOL , MYROW , NPCOL ,
022       $NPROW , NQ0
023  *     ..
024  *     .. Local Arrays ..
025        INTEGER IDUM1( 1 ) , IDUM2( 1 )
026  *     ..
027  *     .. External Subroutines ..
028        EXTERNAL BLACS_GRIDINFO , CHK1MAT , PCHK1MAT , PB_TOPGET ,
029       $PB_TOPSET , PXERBLA , PZGELQ2 , PZLARFB ,
030       $PZLARFT  
031  *     ..
032  *     .. External Functions ..
033        INTEGER ICEIL , INDXG2P , NUMROC
034        EXTERNAL ICEIL , INDXG2P , NUMROC
035  *     ..
036  *     .. Intrinsic Functions ..
037        INTRINSIC DBLE , DCMPLX , MIN , MOD
038  *     ..
039  *     .. Executable Statements ..
040  
041  *     Get grid parameters
042  
043        ICTXT = DESCA( CTXT_ )
044        CALL BLACS_GRIDINFO( ICTXT , NPROW , NPCOL , MYROW , MYCOL )
045  
046  *     Test the input parameters
047  
048        INFO = 0
049        IF( NPROW.EQ. - 1 ) THEN
049               
050            INFO = - (600 + CTXT_)
051        ELSE
051               
052            CALL CHK1MAT( M , 1 , N , 2 , IA , JA , DESCA , 6 , INFO )
053            IF( INFO.EQ.0 ) THEN
053                   
054                IROFF = MOD( IA - 1 , DESCA( MB_ ) )
055                IAROW = INDXG2P( IA , DESCA( MB_ ) , MYROW , DESCA( RSRC_ ) ,
056       $        NPROW )
057                IACOL = INDXG2P( JA , DESCA( NB_ ) , MYCOL , DESCA( CSRC_ ) ,
058       $        NPCOL )
059                MP0 = NUMROC( M + IROFF , DESCA( MB_ ) , MYROW , IAROW , NPROW )
060                NQ0 = NUMROC( N + MOD( JA - 1 , DESCA( NB_ ) ) , DESCA( NB_ ) ,
061       $        MYCOL , IACOL , NPCOL )
062                LWMIN = DESCA( MB_ ) * ( MP0 + NQ0 + DESCA( MB_ ) )
063  
064                WORK( 1 ) = DCMPLX( DBLE( LWMIN ) )
065                LQUERY =( LWORK.EQ. - 1 )
066                IF( LWORK.LT.LWMIN .AND. .NOT.LQUERY )
066                       
067       $            INFO = - 9
068                END IF
069                IF( LWORK.EQ. - 1 ) THEN
069                       
070                    IDUM1( 1 ) = - 1
071                ELSE
071                       
072                    IDUM1( 1 ) = 1
073                END IF
074                IDUM2( 1 ) = 9
075                CALL PCHK1MAT( M , 1 , N , 2 , IA , JA , DESCA , 6 , 1 , IDUM1 , IDUM2 ,
076       $        INFO )
077            END IF
078  
079            IF( INFO.NE.0 ) THEN
079                   
080                CALL PXERBLA( ICTXT , 'PZGELQF' , - INFO )
081                RETURN
082            ELSE IF( LQUERY ) THEN
082                   
083                RETURN
084            END IF
085  
086  *         Quick return if possible
087  
088            IF( M.EQ.0 .OR. N.EQ.0 )
088                   
089       $        RETURN
090  
091                K = MIN( M , N )
092                IPW = DESCA( MB_ ) * DESCA( MB_ ) + 1
093                CALL PB_TOPGET( ICTXT , 'Broadcast' , 'Rowwise' , ROWBTOP )
094                CALL PB_TOPGET( ICTXT , 'Broadcast' , 'Columnwise' , COLBTOP )
095                CALL PB_TOPSET( ICTXT , 'Broadcast' , 'Rowwise' , ' ' )
096                CALL PB_TOPSET( ICTXT , 'Broadcast' , 'Columnwise' , 'I - ring' )
097  
098  *             Handle the first block of rows separately
099  
100                IN = MIN( ICEIL( IA , DESCA( MB_ ) ) * DESCA( MB_ ) , IA + K - 1 )
101                IB = IN - IA + 1
102  
103  *             Compute the LQ factorization of the first block A(ia : in : ja : ja + n - 1)
104  
105                CALL PZGELQ2 ( IB , N , A , IA , JA , DESCA , TAU , WORK , LWORK , IINFO )
106  
107                IF( IA + IB.LE.IA + M - 1 ) THEN
108  
109  *                 Form the triangular factor of the block reflector
110  *                 H = H(ia) H(ia + 1) . . . H(in)
111  
111                       
112                    CALL PZLARFT ( 'Forward' , 'Rowwise' , N , IB , A , IA , JA , DESCA ,
113       $            TAU , WORK , WORK( IPW ) )
114  
115  *                 Apply H to A(ia + ib : ia + m - 1 , ja : ja + n - 1) from the right
116  
117                    CALL PZLARFB ( 'Right' , 'No transpose' , 'Forward' , 'Rowwise' ,
118       $            M - IB , N , IB , A , IA , JA , DESCA , WORK , A , IA + IB ,
119       $            JA , DESCA , WORK( IPW ) )
120                END IF
121  
122  *             Loop over the remaining blocks of rows
123  
124                DO 10 I = IN + 1 , IA + K - 1 , DESCA( MB_ )
124                       
125                    IB = MIN( K - I + IA , DESCA( MB_ ) )
126                    J = JA + I - IA
127  
128  *                 Compute the LQ factorization of the current block
129  *                 A(i : i + ib - 1 : j : ja + n - 1)
130  
131                    CALL PZGELQ2 ( IB , N - I + IA , A , I , J , DESCA , TAU , WORK , LWORK ,
132       $            IINFO )
133  
134                    IF( I + IB.LE.IA + M - 1 ) THEN
135  
136  *                     Form the triangular factor of the block reflector
137  *                     H = H(i) H(i + 1) . . . H(i + ib - 1)
138  
138                           
139                        CALL PZLARFT ( 'Forward' , 'Rowwise' , N - I + IA , IB , A , I , J ,
140       $                DESCA , TAU , WORK , WORK( IPW ) )
141  
142  *                     Apply H to A(i + ib : ia + m - 1 , j : ja + n - 1) from the right
143  
144                        CALL PZLARFB ( 'Right' , 'No transpose' , 'Forward' , 'Rowwise' ,
145       $                M - I - IB + IA , N - J + JA , IB , A , I , J , DESCA , WORK ,
146       $                A , I + IB , J , DESCA , WORK( IPW ) )
147                    END IF
148  
149     10         CONTINUE
150  
150                   
151                CALL PB_TOPSET( ICTXT , 'Broadcast' , 'Rowwise' , ROWBTOP )
152                CALL PB_TOPSET( ICTXT , 'Broadcast' , 'Columnwise' , COLBTOP )
153  
154                WORK( 1 ) = DCMPLX( DBLE( LWMIN ) )
155  
156                RETURN
157  
158  *             End of PZGELQF
159  
160            END3235

Variables in Routine PZGELQF()

Summary Report
Data Type	Quantity	Size(byte)
CHARACTER	2	2
INTEGER	40	164
LOGICAL	1	1
REAL	1	4
TOTAL	44	171

List of Variables

CHARACTER

COLBTOP ROWBTOP

INTEGER

BLOCK_CYCLIC_2D CSRC_ CTXT_ DLEN_ DTYPE_
I IA IACOL IAROW IB
ICEIL ICTXT IDUM1( 1 ) IDUM2( 1 ) IINFO
IN INDXG2P INFO IPW IROFF
J JA K LLD_ LWMIN
LWORK M M_ MB_ MP0
MYCOL MYROW N N_ NB_
NPCOL NPROW NQ0 NUMROC RSRC_

LOGICAL

LQUERY

REAL

WORK

Variables Dependence Graph
Put the mouse over a right hand side variable to display the corresponding line of the dependence
-
- -
I <--- INDO 10 I = IN+1, IA+K-1, DESCA( MB_ ), KDO 10 I = IN+1, IA+K-1, DESCA( MB_ ), MB_DO 10 I = IN+1, IA+K-1, DESCA( MB_ ), IADO 10 I = IN+1, IA+K-1, DESCA( MB_ )

IACOL <--- INDXG2P, JA, CSRC_, MYCOL, NB_, NPCOL

IAROW <--- INDXG2P, MB_, MYROW, NPROW, RSRC_, IA

IB <--- INIB = IN - IA + 1, KIB = MIN( K-I+IA, DESCA( MB_ ) ), MB_IB = MIN( K-I+IA, DESCA( MB_ ) ), IIB = MIN( K-I+IA, DESCA( MB_ ) ), IAIB = IN - IA + 1{2IB = MIN( K-I+IA, DESCA( MB_ ) )}

ICTXT <--- CTXT_ICTXT = DESCA( CTXT_ )

IN <--- ICEIL, K, MB_, IA

INFO <--- CTXT_INFO = -(600+CTXT_)

IPW <--- MB_IPW = DESCA( MB_ ) * DESCA( MB_ ) + 1

IROFF <--- MB_IROFF = MOD( IA-1, DESCA( MB_ ) ), IAIROFF = MOD( IA-1, DESCA( MB_ ) )

J <--- JAJ = JA + I - IA, IJ = JA + I - IA, IAJ = JA + I - IA

K <--- MK = MIN( M, N ), NK = MIN( M, N )

LWMIN <--- MB_, MP0, NQ0

MP0 <--- IAROW, IROFF, M, MB_, MYROW, NPROW, NUMROC

NQ0 <--- JA, MYCOL, N, NB_, NPCOL, NUMROC, IACOL

WORK <--- LWMINWORK( 1 ) = DCMPLX( DBLE( LWMIN ) ){2WORK( 1 ) = DCMPLX( DBLE( LWMIN ) )}