Routine: PDGERQ2()  File: SRC\pdgerq2.f

 
 
# lines: 269
  # code: 269
  # comment: 0
  # blank:0
# Variables:38
# Callers:1
# Callings:2
# Words:100
# Keywords:54
 

 

..
     .. Array Arguments ..
     ..
  Purpose
  =======
  PDGERQ2 computes a RQ factorization of a real distributed M-by-N
  matrix sub( A ) = A(IA:IA+M-1,JA:JA+N-1) = R * 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) DOUBLE PRECISION 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, if M <= N, the
          upper triangle of A( IA:IA+M-1, JA+N-M:JA+N-1 ) contains the
          M by M upper triangular matrix R; if M >= N, the elements on
          and above the (M-N)-th subdiagonal contain the M by N upper
          trapezoidal matrix R; the remaining elements, with the array
          TAU, represent the orthogonal 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) DOUBLE PRECISION 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) DOUBLE PRECISION 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 >= Nq0 + MAX( 1, Mp0 ), 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    (local 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) H(ia+1) . . . H(ia+k-1), where k = min(m,n).
  Each H(i) has the form
     H(i) = I - tau * v * v'
  where tau is a real scalar, and v is a real vector with
  v(n-k+i+1:n) = 0 and v(n-k+i) = 1; v(1:n-k+i-1) is stored on exit in
  A(ia+m-k+i-1,ja:ja+n-k+i-2), and tau in TAU(ia+m-k+i-1).
  =====================================================================
     .. Parameters ..

 
Display dynamic version Find AutoScroll Reload FontSize: - + Hide Comments Hide Blanks Frame FullScreen MailPrint

 
001        SUBROUTINE PDGERQ2( 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        DOUBLE PRECISION ONE
017        PARAMETER( ONE = 1.0D + 0 )
018  *     ..
019  *     .. Local Scalars ..
020        LOGICAL LQUERY
021        CHARACTER COLBTOP , ROWBTOP
022        INTEGER IACOL , IAROW , I , ICTXT , J , K , LWMIN , MP , MYCOL ,
023       $MYROW , NPCOL , NPROW , NQ
024        DOUBLE PRECISION AII
025  *     ..
026  *     .. External Subroutines ..
027        EXTERNAL BLACS_ABORT , BLACS_GRIDINFO , CHK1MAT ,
028       $PDELSET , PDLARF , PDLARFG , PB_TOPGET ,
029       $PB_TOPSET , PXERBLA
030  *     ..
031  *     .. External Functions ..
032        INTEGER INDXG2P , NUMROC
033        EXTERNAL INDXG2P , NUMROC
034  *     ..
035  *     .. Intrinsic Functions ..
036        INTRINSIC DBLE , MAX , MIN , MOD
037  *     ..
038  *     .. Executable Statements ..
039  
040  *     Get grid parameters
041  
042        ICTXT = DESCA( CTXT_ )
043        CALL BLACS_GRIDINFO( ICTXT , NPROW , NPCOL , MYROW , MYCOL )
044  
045  *     Test the input parameters
046  
047        INFO = 0
048        IF( NPROW.EQ. - 1 ) THEN
049            INFO = - (600 + CTXT_)
050        ELSE
051            CALL CHK1MAT( M , 1 , N , 2 , IA , JA , DESCA , 6 , INFO )
052            IF( INFO.EQ.0 ) THEN
053                IAROW = INDXG2P( IA , DESCA( MB_ ) , MYROW , DESCA( RSRC_ ) ,
054       $        NPROW )
055                IACOL = INDXG2P( JA , DESCA( NB_ ) , MYCOL , DESCA( CSRC_ ) ,
056       $        NPCOL )
057                MP = NUMROC( M + MOD( IA - 1 , DESCA( MB_ ) ) , DESCA( MB_ ) ,
058       $        MYROW , IAROW , NPROW )
059                NQ = NUMROC( N + MOD( JA - 1 , DESCA( NB_ ) ) , DESCA( NB_ ) ,
060       $        MYCOL , IACOL , NPCOL )
061                LWMIN = NQ + MAX( 1 , MP )
062  
063                WORK( 1 ) = DBLE( LWMIN )
064                LQUERY =( LWORK.EQ. - 1 )
065                IF( LWORK.LT.LWMIN .AND. .NOT.LQUERY )
066       $            INFO = - 9
067                END IF
068            END IF
069  
070            IF( INFO.NE.0 ) THEN
071                CALL PXERBLA( ICTXT , 'PDGERQ2' , - INFO )
072                CALL BLACS_ABORT( ICTXT , 1 )
073                RETURN
074            ELSE IF( LQUERY ) THEN
075                RETURN
076            END IF
077  
078  *         Quick return if possible
079  
080            IF( M.EQ.0 .OR. N.EQ.0 )
081       $        RETURN
082  
083                CALL PB_TOPGET( ICTXT , 'Broadcast' , 'Rowwise' , ROWBTOP )
084                CALL PB_TOPGET( ICTXT , 'Broadcast' , 'Columnwise' , COLBTOP )
085                CALL PB_TOPSET( ICTXT , 'Broadcast' , 'Rowwise' , ' ' )
086                CALL PB_TOPSET( ICTXT , 'Broadcast' , 'Columnwise' , 'D - ring' )
087  
088                K = MIN( M , N )
089                DO 10 I = IA + K - 1 , IA , - 1
090                    J = JA + I - IA
091  
092  *                 Generate elementary reflector H(i) to annihilate
093  *                 A(i + m - k , ja : j + n - k - 1)
094  
095                    CALL PDLARFG ( N - K + J - JA + 1 , AII , I + M - K , J + N - K , A , I + M - K , JA ,
096       $            DESCA , DESCA( M_ ) , TAU )
097  
098  *                 Apply H(i) to A(ia : i + m - k - 1 , ja : j + n - k) from the right
099  
100                    CALL PDELSET( A , I + M - K , J + N - K , DESCA , ONE )
101                    CALL PDLARF ( 'Right' , M - K + I - IA , N - K + J - JA + 1 , A , M - K + I , JA ,
102       $            DESCA , DESCA( M_ ) , TAU , A , IA , JA , DESCA , WORK )
103                    CALL PDELSET( A , I + M - K , J + N - K , DESCA , AII )
104  
105     10         CONTINUE
106  
107                CALL PB_TOPSET( ICTXT , 'Broadcast' , 'Rowwise' , ROWBTOP )
108                CALL PB_TOPSET( ICTXT , 'Broadcast' , 'Columnwise' , COLBTOP )
109  
110                WORK( 1 ) = DBLE( LWMIN )
111  
112                RETURN
113  
114  *             End of PDGERQ2
115  
116            END