Routine: PSTZRZF()  File: SRC\pstzrzf.f

 
 
# lines: 334
  # code: 334
  # comment: 0
  # blank:0
# Variables:48
# Callers:0
# Callings:3
# Words:130
# Keywords:76
 

 

..
     .. Array Arguments ..
     ..
  Purpose
  =======
  PSTZRZF reduces the M-by-N ( M<=N ) real upper trapezoidal matrix
  sub( A ) = A(IA:IA+M-1,JA:JA+N-1) to upper triangular form by means
  of orthogonal transformations.
  The upper trapezoidal matrix sub( A ) is factored as
     sub( A ) = ( R  0 ) * Z,
  where Z is an N-by-N orthogonal 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.
  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) REAL 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 trian-
          gular matrix R, and elements M+1 to N of the first M rows of
          sub( A ), with the array TAU, represent the orthogonal matrix
          Z as a product of M elementary reflectors.
  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) REAL, 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) REAL 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  factorization is obtained by Householder's method.  The kth
  transformation matrix, Z( k ), which 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 ).
  =====================================================================
     .. Parameters ..

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

 
001        SUBROUTINE PSTZRZF( 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        REAL ZERO
017        PARAMETER( ZERO = 0.0E + 0 )
018  *     ..
019  *     .. Local Scalars ..
020        LOGICAL LQUERY
021        CHARACTER COLBTOP , ROWBTOP
022        INTEGER I , IACOL , IAROW , IB , ICTXT , IIA , IL , IN , IPW ,
023       $IROFFA , J , JM1 , L , LWMIN , MP0 , MYCOL , MYROW ,
024       $NPCOL , NPROW , NQ0
025  *     ..
026  *     .. Local Arrays ..
027        INTEGER IDUM1( 1 ) , IDUM2( 1 )
028  *     ..
029  *     .. External Subroutines ..
030        EXTERNAL BLACS_GRIDINFO , CHK1MAT , INFOG1L , PCHK1MAT ,
031       $PSLATRZ , PSLARZB , PSLARZT , PB_TOPGET ,
032       $PB_TOPSET , PXERBLA
033  *     ..
034  *     .. External Functions ..
035        INTEGER ICEIL , INDXG2P , NUMROC
036        EXTERNAL ICEIL , INDXG2P , NUMROC
037  *     ..
038  *     .. Intrinsic Functions ..
039        INTRINSIC MAX , MIN , MOD , REAL
040  *     ..
041  *     .. Executable Statements ..
042  
043  *     Get grid parameters
044  
045        ICTXT = DESCA( CTXT_ )
046        CALL BLACS_GRIDINFO( ICTXT , NPROW , NPCOL , MYROW , MYCOL )
047  
048  *     Test the input parameters
049  
050        INFO = 0
051        IF( NPROW.EQ. - 1 ) THEN
052            INFO = - (600 + CTXT_)
053        ELSE
054            CALL CHK1MAT( M , 1 , N , 2 , IA , JA , DESCA , 6 , INFO )
055            IF( INFO.EQ.0 ) THEN
056                IROFFA = MOD( IA - 1 , DESCA( MB_ ) )
057                IAROW = INDXG2P( IA , DESCA( MB_ ) , MYROW , DESCA( RSRC_ ) ,
058       $        NPROW )
059                IACOL = INDXG2P( JA , DESCA( NB_ ) , MYCOL , DESCA( CSRC_ ) ,
060       $        NPCOL )
061                MP0 = NUMROC( M + IROFFA , DESCA( MB_ ) , MYROW , IAROW , NPROW )
062                NQ0 = NUMROC( N + MOD( JA - 1 , DESCA( NB_ ) ) , DESCA( NB_ ) ,
063       $        MYCOL , IACOL , NPCOL )
064                LWMIN = DESCA( MB_ ) * ( MP0 + NQ0 + DESCA( MB_ ) )
065  
066                WORK( 1 ) = REAL( LWMIN )
067                LQUERY =( LWORK.EQ. - 1 )
068                IF( N.LT.M ) THEN
069                    INFO = - 2
070                ELSE IF( LWORK.LT.LWMIN .AND. .NOT.LQUERY ) THEN
071                    INFO = - 9
072                END IF
073            END IF
074            IF( LQUERY ) THEN
075                IDUM1( 1 ) = - 1
076            ELSE
077                IDUM1( 1 ) = 1
078            END IF
079            IDUM2( 1 ) = 9
080            CALL PCHK1MAT( M , 1 , N , 2 , IA , JA , DESCA , 6 , 1 , IDUM1 , IDUM2 ,
081       $    INFO )
082        END IF
083  
084        IF( INFO.NE.0 ) THEN
085            CALL PXERBLA( ICTXT , 'PSTZRZF' , - INFO )
086            RETURN
087        ELSE IF( LQUERY ) THEN
088            RETURN
089        END IF
090  
091  *     Quick return if possible
092  
093        IF( M.EQ.0 .OR. N.EQ.0 )
094       $    RETURN
095  
096            IF( M.EQ.N ) THEN
097  
098                CALL INFOG1L( IA , DESCA( MB_ ) , NPROW , MYROW , DESCA( RSRC_ ) ,
099       $        IIA , IAROW )
100                IF( MYROW.EQ.IAROW )
101       $            MP0 = MP0 - IROFFA
102                    DO 10 I = IIA , IIA + MP0 - 1
103                        TAU( I ) = ZERO
104     10             CONTINUE
105  
106                ELSE
107  
108                    L = N - M
109                    JM1 = JA + MIN( M + 1 , N ) - 1
110                    IPW = DESCA( MB_ ) * DESCA( MB_ ) + 1
111                    IN = MIN( ICEIL( IA , DESCA( MB_ ) ) * DESCA( MB_ ) , IA + M - 1 )
112                    IL = MAX(((IA + M - 2) / DESCA( MB_ ) ) * DESCA( MB_ ) + 1 , IA )
113                    CALL PB_TOPGET( ICTXT , 'Broadcast' , 'Rowwise' , ROWBTOP )
114                    CALL PB_TOPGET( ICTXT , 'Broadcast' , 'Columnwise' , COLBTOP )
115                    CALL PB_TOPSET( ICTXT , 'Broadcast' , 'Rowwise' , ' ' )
116                    CALL PB_TOPSET( ICTXT , 'Broadcast' , 'Columnwise' , 'D - ring' )
117  
118  *                 Use blocked code initially
119  
120                    DO 20 I = IL , IN + 1 , - DESCA( MB_ )
121                        IB = MIN( IA + M - I , DESCA( MB_ ) )
122                        J = JA + I - IA
123  
124  *                     Compute the complete orthogonal factorization of the current
125  *                     block A(i : i + ib - 1 , j : ja + n - 1)
126  
127                        CALL PSLATRZ ( IB , JA + N - J , L , A , I , J , DESCA , TAU , WORK )
128  
129                        IF( I.GT.IA ) THEN
130  
131  *                         Form the triangular factor of the block reflector
132  *                         H = H(i + ib - 1) . . . H(i + 1) H(i)
133  
134                            CALL PSLARZT ( 'Backward' , 'Rowwise' , L , IB , A , I , JM1 ,
135       $                    DESCA , TAU , WORK , WORK( IPW ) )
136  
137  *                         Apply H to A(ia : i - 1 , j : ja + n - 1) from the right
138  
139                            CALL PSLARZB ( 'Right' , 'No transpose' , 'Backward' ,
140       $                    'Rowwise' , I - IA , JA + N - J , IB , L , A , I , JM1 ,
141       $                    DESCA , WORK , A , IA , J , DESCA , WORK( IPW ) )
142                        END IF
143  
144     20             CONTINUE
145  
146  *                 Use unblocked code to factor the last or only block
147  
148                    CALL PSLATRZ ( IN - IA + 1 , N , N - M , A , IA , JA , DESCA , TAU , WORK )
149  
150                    CALL PB_TOPSET( ICTXT , 'Broadcast' , 'Rowwise' , ROWBTOP )
151                    CALL PB_TOPSET( ICTXT , 'Broadcast' , 'Columnwise' , COLBTOP )
152  
153                END IF
154  
155                WORK( 1 ) = REAL( LWMIN )
156  
157                RETURN
158  
159  *             End of PSTZRZF
160  
161            END