|
|
| |
| # lines: |
274 | | # code: |
274 | | # comment: | 0 | |
# blank: | 0 |
| # Variables: | 38 |
| # Callers: | 1 |
| # Callings: | 3 |
| # Words: | 112 |
| # Keywords: | 60 |
|
|
|
|
|
..
.. Array Arguments ..
..
Purpose
=======
PCGELQ2 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 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, 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 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 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 ..
|
|
|
|
001 SUBROUTINE PCGELQ2( 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 COMPLEX ONE
017 PARAMETER( ONE =( 1.0E + 0 , 0.0E + 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 COMPLEX AII
025 * ..
026 * .. External Subroutines ..
027 EXTERNAL BLACS_ABORT , BLACS_GRIDINFO , CHK1MAT , PCELSET ,
028 $PCLACGV , PCLARF , PCLARFG , PB_TOPGET ,
029 $PB_TOPSET , PXERBLA
030 * ..
031 * .. External Functions ..
032 INTEGER INDXG2P , NUMROC
033 EXTERNAL INDXG2P , NUMROC
034 * ..
035 * .. Intrinsic Functions ..
036 INTRINSIC CMPLX , MAX , MIN , MOD , REAL
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
048
049 INFO = - (600 + CTXT_)
050 ELSE
050
051 CALL CHK1MAT( M , 1 , N , 2 , IA , JA , DESCA , 6 , INFO )
052 IF( INFO.EQ.0 ) THEN
052
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 ) = CMPLX( REAL( LWMIN ) )
064 LQUERY =( LWORK.EQ. - 1 )
065 IF( LWORK.LT.LWMIN .AND. .NOT.LQUERY )
065
066 $ INFO = - 9
067 END IF
068 END IF
069
070 IF( INFO.NE.0 ) THEN
070
071 CALL PXERBLA( ICTXT , 'PCGELQ2' , - INFO )
072 CALL BLACS_ABORT( ICTXT , 1 )
073 RETURN
074 ELSE IF( LQUERY ) THEN
074
075 RETURN
076 END IF
077
078 * Quick return if possible
079
080 IF( M.EQ.0 .OR. N.EQ.0 )
080
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' , 'I - ring' )
087
088 K = MIN( M , N )
089 DO 10 I = IA , IA + K - 1
089
090 J = JA + I - IA
091
092 * Generate elementary reflector H(i) to annihilate
093 * A(i , j + 1 : ja + n - 1)
094
095 CALL PCLACGV ( N - J + JA , A , I , J , DESCA , DESCA( M_ ) )
096 CALL PCLARFG ( N - J + JA , AII , I , J , A , I , MIN( J + 1 , JA + N - 1 ) ,
097 $ DESCA , DESCA( M_ ) , TAU )
098
099 IF( I.LT.IA + M - 1 ) THEN
100
101 * Apply H(i) to A(i + 1 : ia + m - 1 , j : ja + n - 1) from the right
102
102
103 CALL PCELSET( A , I , J , DESCA , ONE )
104 CALL PCLARF ( 'Right' , M - I + IA - 1 , N - J + JA , A , I , J , DESCA ,
105 $ DESCA( M_ ) , TAU , A , I + 1 , J , DESCA , WORK )
106 END IF
107 CALL PCELSET( A , I , J , DESCA , AII )
108 CALL PCLACGV ( N - J + JA , A , I , J , DESCA , DESCA( M_ ) )
109
110 10 CONTINUE
111
111
112 CALL PB_TOPSET( ICTXT , 'Broadcast' , 'Rowwise' , ROWBTOP )
113 CALL PB_TOPSET( ICTXT , 'Broadcast' , 'Columnwise' , COLBTOP )
114
115 WORK( 1 ) = CMPLX( REAL( LWMIN ) )
116
117 RETURN
118
119 * End of PCGELQ2
120
121 END23
10
|
|
Variables in Routine PCGELQ2()
| Summary Report |
| Data Type | Quantity | Size(byte) |
| CHARACTER | 2 | 2 |
| COMPLEX | 2 | 8 |
| INTEGER | 32 | 128 |
| LOGICAL | 1 | 1 |
| REAL | 1 | 4 |
| TOTAL | 38 | 143 |
List of Variables
CHARACTER
COMPLEX
INTEGER
| BLOCK_CYCLIC_2D | CSRC_ | CTXT_ | DLEN_ | DTYPE_ |
| I | IA | IACOL | IAROW | ICTXT |
| INDXG2P | INFO | J | JA | K |
| LLD_ | LWMIN | LWORK | M | M_ |
| MB_ | MP | MYCOL | MYROW | N |
| N_ | NB_ | NPCOL | NPROW | NQ |
| NUMROC | RSRC_ | | | |
LOGICAL
REAL
Variables Dependence Graph Put the mouse over a right hand side variable to display the corresponding line of the dependence | | - | | - | - | | I | <--- | KDO 10 I = IA, IA+K-1, IADO 10 I = IA, IA+K-1 |
| IACOL | <--- | INDXG2PIACOL = INDXG2P( JA, DESCA( NB_ ), MYCOL, DESCA( CSRC_ ),, JAIACOL = INDXG2P( JA, DESCA( NB_ ), MYCOL, DESCA( CSRC_ ),, MYCOLIACOL = INDXG2P( JA, DESCA( NB_ ), MYCOL, DESCA( CSRC_ ),, NB_IACOL = INDXG2P( JA, DESCA( NB_ ), MYCOL, DESCA( CSRC_ ),, NPCOLIACOL = INDXG2P( JA, DESCA( NB_ ), MYCOL, DESCA( CSRC_ ),, CSRC_IACOL = INDXG2P( JA, DESCA( NB_ ), MYCOL, DESCA( CSRC_ ), |
| IAROW | <--- | INDXG2PIAROW = INDXG2P( IA, DESCA( MB_ ), MYROW, DESCA( RSRC_ ),, MB_IAROW = INDXG2P( IA, DESCA( MB_ ), MYROW, DESCA( RSRC_ ),, MYROWIAROW = INDXG2P( IA, DESCA( MB_ ), MYROW, DESCA( RSRC_ ),, NPROWIAROW = INDXG2P( IA, DESCA( MB_ ), MYROW, DESCA( RSRC_ ),, RSRC_IAROW = INDXG2P( IA, DESCA( MB_ ), MYROW, DESCA( RSRC_ ),, IAIAROW = INDXG2P( IA, DESCA( MB_ ), MYROW, DESCA( RSRC_ ), |
| ICTXT | <--- | CTXT_ICTXT = DESCA( CTXT_ ) |
| INFO | <--- | CTXT_INFO = -(600+CTXT_) |
| J | <--- | JAJ = JA + I - IA, IJ = JA + I - IA, IAJ = JA + I - IA |
| K | <--- | MK = MIN( M, N ), NK = MIN( M, N ) |
| LWMIN | <--- | MPLWMIN = NQ + MAX( 1, MP ), NQLWMIN = NQ + MAX( 1, MP ) |
| MP | <--- | IAROWMP = NUMROC( M+MOD( IA-1, DESCA( MB_ ) ), DESCA( MB_ ),, MMP = NUMROC( M+MOD( IA-1, DESCA( MB_ ) ), DESCA( MB_ ),, MB_MP = NUMROC( M+MOD( IA-1, DESCA( MB_ ) ), DESCA( MB_ ),, MYROWMP = NUMROC( M+MOD( IA-1, DESCA( MB_ ) ), DESCA( MB_ ),, NPROWMP = NUMROC( M+MOD( IA-1, DESCA( MB_ ) ), DESCA( MB_ ),, NUMROCMP = NUMROC( M+MOD( IA-1, DESCA( MB_ ) ), DESCA( MB_ ),, IAMP = NUMROC( M+MOD( IA-1, DESCA( MB_ ) ), DESCA( MB_ ), |
| NQ | <--- | IACOLNQ = NUMROC( N+MOD( JA-1, DESCA( NB_ ) ), DESCA( NB_ ),, JANQ = NUMROC( N+MOD( JA-1, DESCA( NB_ ) ), DESCA( NB_ ),, MYCOLNQ = NUMROC( N+MOD( JA-1, DESCA( NB_ ) ), DESCA( NB_ ),, NNQ = NUMROC( N+MOD( JA-1, DESCA( NB_ ) ), DESCA( NB_ ),, NB_NQ = NUMROC( N+MOD( JA-1, DESCA( NB_ ) ), DESCA( NB_ ),, NPCOLNQ = NUMROC( N+MOD( JA-1, DESCA( NB_ ) ), DESCA( NB_ ),, NUMROCNQ = NUMROC( N+MOD( JA-1, DESCA( NB_ ) ), DESCA( NB_ ), |
| WORK | <--- | LWMINWORK( 1 ) = CMPLX( REAL( LWMIN ) ){2WORK( 1 ) = CMPLX( REAL( LWMIN ) )} |
|
|
Analysis elements of the routine PCGELQ2() Put the mouse over each element to display detailed matching information
Assigned variables |
| | | BLOCK_CYCLIC_2D , CSRC_ , CTXT_ , DLEN_ , DTYPE_ , I , IACOL , IAROW , ICTXT , INFO , J , K , LLD_ , LQUERY , LWMIN , M_ , MB_ , MP , N_ , NB_ , NQ , ONE , RSRC_ , WORK |
|
Active variables |
| | | A , AII , BLOCK_CYCLIC_2D , COLBTOP , CSRC_ , CTXT_ , DESCA , DLEN_ , DTYPE_ , I , IA , IACOL , IAROW , ICTXT , INDXG2P , INFO , J , JA , K , LLD_ , LQUERY , LWMIN , LWORK , M , M_ , MB_ , MP , MYCOL , MYROW , N , N_ , NB_ , NPCOL , NPROW , NQ , NUMROC , ONE , ROWBTOP , RSRC_ , TAU , WORK |
|
Accessed arrays [ array name : associated index ] |
| | A | : i,j+1:ja+n-1 , i+1:ia+m-1,j:ja+n-1 |
| | DESCA | : CSRC_ , CTXT_ , M_ , M_ , M_ , M_ , MB_ , MB_ , NB_ , NB_ , RSRC_ |
| | WORK | : 1 , 1 |
|
Conditional statements [ statement : associated predicate ] |
| | do | : ( 10 I = IA , IA + K - 1 ) |
| | if | : ( NPROW.EQ. - 1 ) , ( INFO.EQ.0 ) , ( LWORK.LT.LWMIN .AND. .NOT.LQUERY ) , ( INFO.NE.0 ) , ( LQUERY ) , ( possible ) , ( M.EQ.0 .OR. N.EQ.0 ) , ( I.LT.IA + M - 1 ) |
|
| List of variables | AII BLOCK_CYCLIC_2D COLBTOP CSRC_ CTXT_ DLEN_ DTYPE_
| I IA IACOL IAROW ICTXT INDXG2P INFO J
| JA K LLD_ LQUERY LWMIN LWORK M M_
| MB_ MP MYCOL MYROW N N_ NB_ NPCOL
| NPROW NQ NUMROC ONE ROWBTOP RSRC_ WORK | | close
| |
AII
BLOCK_CYCLIC_2D
COLBTOP
CSRC_
CTXT_
DLEN_
DTYPE_
I
IA
IACOL
IAROW
ICTXT
INDXG2P
INFO
J
JA
K
LLD_
LQUERY
LWMIN
LWORK
M
M_
MB_
MP
MYCOL
MYROW
N
N_
NB_
NPCOL
NPROW
NQ
NUMROC
ONE
ROWBTOP
RSRC_
WORK
75#97#94
| |