|
|
| |
| # lines: |
279 | | # code: |
279 | | # comment: | 0 | |
# blank: | 0 |
| # Variables: | 40 |
| # Callers: | 1 |
| # Callings: | 2 |
| # Words: | 122 |
| # Keywords: | 65 |
|
|
|
|
|
..
.. Array Arguments ..
..
Purpose
=======
PCUNG2L generates an M-by-N complex distributed matrix Q denoting
A(IA:IA+M-1,JA:JA+N-1) with orthonormal columns, which is defined as
the last N columns of a product of K elementary reflectors of order M
Q = H(k) . . . H(2) H(1)
as returned by PCGEQLF.
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 Q. M >= 0.
N (global input) INTEGER
The number of columns to be operated on i.e the number of
columns of the distributed submatrix Q. M >= N >= 0.
K (global input) INTEGER
The number of elementary reflectors whose product defines the
matrix Q. N >= K >= 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 j-th column must contain the vector which
defines the elementary reflector H(j), JA+N-K <= j <= JA+N-1,
as returned by PCGEQLF in the K columns of its distributed
matrix argument A(IA:*,JA+N-K:JA+N-1). On exit, this array
contains the local pieces of the M-by-N distributed matrix Q.
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 input) COMPLEX, array, dimension LOCc(JA+N-1)
This array contains the scalar factors TAU(j) of the
elementary reflectors H(j) as returned by PCGEQLF.
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 >= MpA0 + MAX( 1, NqA0 ), where
IROFFA = MOD( IA-1, MB_A ), ICOFFA = MOD( JA-1, NB_A ),
IAROW = INDXG2P( IA, MB_A, MYROW, RSRC_A, NPROW ),
IACOL = INDXG2P( JA, NB_A, MYCOL, CSRC_A, NPCOL ),
MpA0 = NUMROC( M+IROFFA, MB_A, MYROW, IAROW, NPROW ),
NqA0 = NUMROC( N+ICOFFA, NB_A, MYCOL, IACOL, NPCOL ),
INDXG2P and NUMROC 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.
=====================================================================
.. Parameters ..
|
|
|
|
001 SUBROUTINE PCUNG2L( M , N , K , 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 , K , 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 , ZERO
017 PARAMETER( ONE =( 1.0E + 0 , 0.0E + 0 ) ,
018 $ZERO =( 0.0E + 0 , 0.0E + 0 ) )
019 * ..
020 * .. Local Scalars ..
021 LOGICAL LQUERY
022 CHARACTER COLBTOP , ROWBTOP
023 INTEGER IACOL , IAROW , ICTXT , J , JJ , LWMIN , MPA0 , MYCOL ,
024 $MYROW , NPCOL , NPROW , NQA0
025 COMPLEX TAUJ
026 * ..
027 * .. External Subroutines ..
028 EXTERNAL BLACS_ABORT , BLACS_GRIDINFO , CHK1MAT , PCELSET ,
029 $PCLARF , PCLASET , PCSCAL , PB_TOPGET ,
030 $PB_TOPSET , PXERBLA
031 * ..
032 * .. External Functions ..
033 INTEGER INDXG2L , INDXG2P , NUMROC
034 EXTERNAL INDXG2L , INDXG2P , NUMROC
035 * ..
036 * .. Intrinsic Functions ..
037 INTRINSIC CMPLX , MAX , MIN , MOD , REAL
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 = - (700 + CTXT_)
051 ELSE
051
052 CALL CHK1MAT( M , 1 , N , 2 , IA , JA , DESCA , 7 , INFO )
053 IF( INFO.EQ.0 ) THEN
053
054 IAROW = INDXG2P( IA , DESCA( MB_ ) , MYROW , DESCA( RSRC_ ) ,
055 $ NPROW )
056 IACOL = INDXG2P( JA , DESCA( NB_ ) , MYCOL , DESCA( CSRC_ ) ,
057 $ NPCOL )
058 MPA0 = NUMROC( M + MOD( IA - 1 , DESCA( MB_ ) ) , DESCA( MB_ ) ,
059 $ MYROW , IAROW , NPROW )
060 NQA0 = NUMROC( N + MOD( JA - 1 , DESCA( NB_ ) ) , DESCA( NB_ ) ,
061 $ MYCOL , IACOL , NPCOL )
062 LWMIN = MPA0 + MAX( 1 , NQA0 )
063
064 WORK( 1 ) = CMPLX( REAL( LWMIN ) )
065 LQUERY =( LWORK.EQ. - 1 )
066 IF( N.GT.M ) THEN
066
067 INFO = - 2
068 ELSE IF( K.LT.0 .OR. K.GT.N ) THEN
068
069 INFO = - 3
070 ELSE IF( LWORK.LT.LWMIN .AND. .NOT.LQUERY ) THEN
070
071 INFO = - 10
072 END IF
073 END IF
074 END IF
075 IF( INFO.NE.0 ) THEN
075
076 CALL PXERBLA( ICTXT , 'PCUNG2L' , - INFO )
077 CALL BLACS_ABORT( ICTXT , 1 )
078 RETURN
079 ELSE IF( LQUERY ) THEN
079
080 RETURN
081 END IF
082
083 * Quick return if possible
084
085 IF( N.LE.0 )
085
086 $ RETURN
087
088 CALL PB_TOPGET( ICTXT , 'Broadcast' , 'Rowwise' , ROWBTOP )
089 CALL PB_TOPGET( ICTXT , 'Broadcast' , 'Columnwise' , COLBTOP )
090 CALL PB_TOPSET( ICTXT , 'Broadcast' , 'Rowwise' , 'I - ring' )
091 CALL PB_TOPSET( ICTXT , 'Broadcast' , 'Columnwise' , ' ' )
092
093 * Initialise columns ja : ja + n - k - 1 to columns of the unit matrix
094
095 CALL PCLASET ( 'All' , M - N , N - K , ZERO , ZERO , A , IA , JA , DESCA )
096 CALL PCLASET ( 'All' , N , N - K , ZERO , ONE , A , IA + M - N , JA , DESCA )
097
098 TAUJ = ZERO
099 NQA0 = MAX( 1 , NUMROC( JA + N - 1 , DESCA( NB_ ) , MYCOL ,
100 $ DESCA( CSRC_ ) , NPCOL ) )
101 DO 10 J = JA + N - K , JA + N - 1
102
103 * Apply H(j) to A(ia : ia + m - n + j - ja , ja : j) from the left
104
104
105 CALL PCELSET( A , IA + M - N + J - JA , J , DESCA , ONE )
106 CALL PCLARF ( 'Left' , M - N + J - JA + 1 , J - JA , A , IA , J , DESCA , 1 , TAU ,
107 $ A , IA , JA , DESCA , WORK )
108
109 JJ = INDXG2L( J , DESCA( NB_ ) , MYCOL , DESCA( CSRC_ ) , NPCOL )
110 IACOL = INDXG2P( J , DESCA( NB_ ) , MYCOL , DESCA( CSRC_ ) ,
111 $ NPCOL )
112 IF( MYCOL.EQ.IACOL )
112
113 $ TAUJ = TAU( MIN( JJ , NQA0 ) )
114 CALL PCSCAL( M - N + J - JA , - TAUJ , A , IA , J , DESCA , 1 )
115 CALL PCELSET( A , IA + M - N + J - JA , J , DESCA , ONE - TAUJ )
116
117 * Set A(ia + m - n + j - ja + 1 : ia + m - 1 , j) to zero
118
119 CALL PCLASET ( 'All' , JA + N - 1 - J , 1 , ZERO , ZERO , A , IA + M - N + J - JA + 1 ,
120 $ J , DESCA )
121
122 10 CONTINUE
123
123
124 CALL PB_TOPSET( ICTXT , 'Broadcast' , 'Rowwise' , ROWBTOP )
125 CALL PB_TOPSET( ICTXT , 'Broadcast' , 'Columnwise' , COLBTOP )
126
127 WORK( 1 ) = CMPLX( REAL( LWMIN ) )
128
129 RETURN
130
131 * End of PCUNG2L
132
133 END24
12
|
|
Variables in Routine PCUNG2L()
| Summary Report |
| Data Type | Quantity | Size(byte) |
| CHARACTER | 2 | 2 |
| COMPLEX | 3 | 12 |
| INTEGER | 33 | 132 |
| LOGICAL | 1 | 1 |
| REAL | 1 | 4 |
| TOTAL | 40 | 151 |
List of Variables
CHARACTER
COMPLEX
INTEGER
| BLOCK_CYCLIC_2D | CSRC_ | CTXT_ | DLEN_ | DTYPE_ |
| IA | IACOL | IAROW | ICTXT | INDXG2L |
| INDXG2P | INFO | J | JA | JJ |
| K | LLD_ | LWMIN | LWORK | M |
| M_ | MB_ | MPA0 | MYCOL | MYROW |
| N | N_ | NB_ | NPCOL | NPROW |
| NQA0 | NUMROC | RSRC_ | | |
LOGICAL
REAL
Variables Dependence Graph Put the mouse over a right hand side variable to display the corresponding line of the dependence | | - | | - | - | | IACOL | <--- | INDXG2PIACOL = INDXG2P( J, DESCA( NB_ ), MYCOL, DESCA( CSRC_ ),{2IACOL = INDXG2P( JA, DESCA( NB_ ), MYCOL, DESCA( CSRC_ ),}, JIACOL = INDXG2P( J, DESCA( NB_ ), MYCOL, DESCA( CSRC_ ),, JAIACOL = INDXG2P( JA, DESCA( NB_ ), MYCOL, DESCA( CSRC_ ),, MYCOLIACOL = INDXG2P( J, DESCA( NB_ ), MYCOL, DESCA( CSRC_ ),{2IACOL = INDXG2P( JA, DESCA( NB_ ), MYCOL, DESCA( CSRC_ ),}, CSRC_IACOL = INDXG2P( J, DESCA( NB_ ), MYCOL, DESCA( CSRC_ ),{2IACOL = INDXG2P( JA, DESCA( NB_ ), MYCOL, DESCA( CSRC_ ),}, NB_IACOL = INDXG2P( J, DESCA( NB_ ), MYCOL, DESCA( CSRC_ ),{2IACOL = INDXG2P( JA, DESCA( NB_ ), MYCOL, DESCA( CSRC_ ),}, NPCOLIACOL = INDXG2P( J, DESCA( NB_ ), MYCOL, DESCA( CSRC_ ),{2IACOL = 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 = -(700+CTXT_) |
| J | <--- | JADO 10 J = JA+N-K, JA+N-1, KDO 10 J = JA+N-K, JA+N-1, NDO 10 J = JA+N-K, JA+N-1 |
| JJ | <--- | INDXG2LJJ = INDXG2L( J, DESCA( NB_ ), MYCOL, DESCA( CSRC_ ), NPCOL ), JJJ = INDXG2L( J, DESCA( NB_ ), MYCOL, DESCA( CSRC_ ), NPCOL ), MYCOLJJ = INDXG2L( J, DESCA( NB_ ), MYCOL, DESCA( CSRC_ ), NPCOL ), CSRC_JJ = INDXG2L( J, DESCA( NB_ ), MYCOL, DESCA( CSRC_ ), NPCOL ), NB_JJ = INDXG2L( J, DESCA( NB_ ), MYCOL, DESCA( CSRC_ ), NPCOL ), NPCOLJJ = INDXG2L( J, DESCA( NB_ ), MYCOL, DESCA( CSRC_ ), NPCOL ) |
| LWMIN | <--- | MPA0LWMIN = MPA0 + MAX( 1, NQA0 ), NQA0LWMIN = MPA0 + MAX( 1, NQA0 ) |
| MPA0 | <--- | MMPA0 = NUMROC( M+MOD( IA-1, DESCA( MB_ ) ), DESCA( MB_ ),, MB_MPA0 = NUMROC( M+MOD( IA-1, DESCA( MB_ ) ), DESCA( MB_ ),, MYROWMPA0 = NUMROC( M+MOD( IA-1, DESCA( MB_ ) ), DESCA( MB_ ),, NPROWMPA0 = NUMROC( M+MOD( IA-1, DESCA( MB_ ) ), DESCA( MB_ ),, NUMROCMPA0 = NUMROC( M+MOD( IA-1, DESCA( MB_ ) ), DESCA( MB_ ),, IAMPA0 = NUMROC( M+MOD( IA-1, DESCA( MB_ ) ), DESCA( MB_ ),, IAROWMPA0 = NUMROC( M+MOD( IA-1, DESCA( MB_ ) ), DESCA( MB_ ), |
| NQA0 | <--- | JANQA0 = NUMROC( N+MOD( JA-1, DESCA( NB_ ) ), DESCA( NB_ ),{2NQA0 = MAX( 1, NUMROC( JA+N-1, DESCA( NB_ ), MYCOL,}, MYCOLNQA0 = NUMROC( N+MOD( JA-1, DESCA( NB_ ) ), DESCA( NB_ ),{2NQA0 = MAX( 1, NUMROC( JA+N-1, DESCA( NB_ ), MYCOL,}, NNQA0 = NUMROC( N+MOD( JA-1, DESCA( NB_ ) ), DESCA( NB_ ),{2NQA0 = MAX( 1, NUMROC( JA+N-1, DESCA( NB_ ), MYCOL,}, CSRC_NQA0 = MAX( 1, NUMROC( JA+N-1, DESCA( NB_ ), MYCOL,, NB_NQA0 = NUMROC( N+MOD( JA-1, DESCA( NB_ ) ), DESCA( NB_ ),{2NQA0 = MAX( 1, NUMROC( JA+N-1, DESCA( NB_ ), MYCOL,}, NPCOLNQA0 = NUMROC( N+MOD( JA-1, DESCA( NB_ ) ), DESCA( NB_ ),{2NQA0 = MAX( 1, NUMROC( JA+N-1, DESCA( NB_ ), MYCOL,}, NUMROCNQA0 = NUMROC( N+MOD( JA-1, DESCA( NB_ ) ), DESCA( NB_ ),{2NQA0 = MAX( 1, NUMROC( JA+N-1, DESCA( NB_ ), MYCOL,}, IACOLNQA0 = NUMROC( N+MOD( JA-1, DESCA( NB_ ) ), DESCA( NB_ ), |
| TAUJ | <--- | ZEROTAUJ = ZERO |
| WORK | <--- | LWMINWORK( 1 ) = CMPLX( REAL( LWMIN ) ){2WORK( 1 ) = CMPLX( REAL( LWMIN ) )} |
|
|
Analysis elements of the routine PCUNG2L() Put the mouse over each element to display detailed matching information
Assigned variables |
| | | BLOCK_CYCLIC_2D , CSRC_ , CTXT_ , DLEN_ , DTYPE_ , IACOL , IAROW , ICTXT , INFO , J , JJ , LLD_ , LQUERY , LWMIN , M_ , MB_ , MPA0 , N_ , NB_ , NQA0 , ONE , RSRC_ , TAUJ , WORK , ZERO |
|
Active variables |
| | | A , BLOCK_CYCLIC_2D , COLBTOP , CSRC_ , CTXT_ , DESCA , DLEN_ , DTYPE_ , IA , IACOL , IAROW , ICTXT , INDXG2L , INDXG2P , INFO , J , JA , JJ , K , LLD_ , LQUERY , LWMIN , LWORK , M , M_ , MB_ , MPA0 , MYCOL , MYROW , N , N_ , NB_ , NPCOL , NPROW , NQA0 , NUMROC , ONE , ROWBTOP , RSRC_ , TAU , TAUJ , WORK , ZERO |
|
Accessed arrays [ array name : associated index ] |
| | A | : ia:ia+m-n+j-ja,ja:j , ia+m-n+j-ja+1:ia+m-1,j |
| | DESCA | : CSRC_ , CSRC_ , CSRC_ , CSRC_ , CTXT_ , MB_ , MB_ , NB_ , NB_ , NB_ , NB_ , NB_ , RSRC_ |
| | INDXG2L | : J, DESCA( NB_ ), MYCOL, DESCA( CSRC_ ), NPCOL |
| | TAU | : MIN( JJ, NQA0 ) |
| | WORK | : 1 , 1 |
|
Conditional statements [ statement : associated predicate ] |
| | do | : ( 10 J = JA + N - K , JA + N - 1 ) |
| | if | : ( NPROW.EQ. - 1 ) , ( INFO.EQ.0 ) , ( N.GT.M ) , ( K.LT.0 .OR. K.GT.N ) , ( LWORK.LT.LWMIN .AND. .NOT.LQUERY ) , ( INFO.NE.0 ) , ( LQUERY ) , ( possible ) , ( N.LE.0 ) , ( MYCOL.EQ.IACOL ) |
|
| List of variables | BLOCK_CYCLIC_2D COLBTOP CSRC_ CTXT_ DLEN_ DTYPE_ IA
| IACOL IAROW ICTXT INDXG2L INDXG2P INFO J JA
| JJ K LLD_ LQUERY LWMIN LWORK M M_
| MB_ MPA0 MYCOL MYROW N N_ NB_ NPCOL
| NPROW NQA0 NUMROC ONE ROWBTOP RSRC_ TAUJ WORK
| ZERO | | close
| |
BLOCK_CYCLIC_2D
COLBTOP
CSRC_
CTXT_
DLEN_
DTYPE_
IA
IACOL
IAROW
ICTXT
INDXG2L
INDXG2P
INFO
J
JA
JJ
K
LLD_
LQUERY
LWMIN
LWORK
M
M_
MB_
MPA0
MYCOL
MYROW
N
N_
NB_
NPCOL
NPROW
NQA0
NUMROC
ONE
ROWBTOP
RSRC_
TAUJ
WORK
ZERO
105#94
| |