Routine: PDGELQ2()  File: SRC\pdgelq2.f

 
 
# lines: 271
  # code: 271
  # comment: 0
  # blank:0
# Variables:38
# Callers:1
# Callings:2
# Words:106
# Keywords:57
 

 

..
     .. Array Arguments ..
     ..
  Purpose
  =======
  PDGELQ2 computes a LQ factorization of a real 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) 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, 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 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+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) 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+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 real scalar, and v is a real vector with v(1:i-1)=0
  and v(i) = 1; 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 Find AutoScroll Reload FontSize: - + Hide Comments Hide Blanks Frame FullScreen MailPrint

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