pctrcon.f

Go to the documentation of this file.

      SUBROUTINE pctrcon( NORM, UPLO, DIAG, N, A, IA, JA, DESCA, RCOND,
     $                    WORK, LWORK, RWORK, LRWORK, INFO )
*
*  -- ScaLAPACK routine (version 1.7) --
*     University of Tennessee, Knoxville, Oak Ridge National Laboratory,
*     and University of California, Berkeley.
*     May 25, 2001
*
*
*     .. Scalar Arguments ..
      CHARACTER          DIAG, NORM, UPLO
      INTEGER            IA, JA, INFO, LRWORK, LWORK, N
      REAL               RCOND
*     ..
*     .. Array Arguments ..
      INTEGER            DESCA( * )
      REAL               RWORK( * )
      COMPLEX            A( * ), WORK( * )
*     ..
*
*  Purpose
*  =======
*
*  PCTRCON estimates the reciprocal of the condition number of a
*  triangular distributed matrix A(IA:IA+N-1,JA:JA+N-1), in either the
*  1-norm or the infinity-norm.
*
*  The norm of A(IA:IA+N-1,JA:JA+N-1) is computed and an estimate is
*  obtained for norm(inv(A(IA:IA+N-1,JA:JA+N-1))), then the reciprocal
*  of the condition number is computed as
*             RCOND = 1 / ( norm( A(IA:IA+N-1,JA:JA+N-1)      ) *
*                           norm( inv(A(IA:IA+N-1,JA:JA+N-1)) ) ).
*
*  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
*  =========
*
*  NORM    (global input) CHARACTER
*          Specifies whether the 1-norm condition number or the
*          infinity-norm condition number is required:
*          = '1' or 'O':  1-norm;
*          = 'I':         Infinity-norm.
*
*  UPLO    (global input) CHARACTER
*          = 'U':  A(IA:IA+N-1,JA:JA+N-1) is upper triangular;
*          = 'L':  A(IA:IA+N-1,JA:JA+N-1) is lower triangular.
*
*  DIAG    (global input) CHARACTER
*          = 'N':  A(IA:IA+N-1,JA:JA+N-1) is non-unit triangular;
*          = 'U':  A(IA:IA+N-1,JA:JA+N-1) is unit triangular.
*
*  N       (global input) INTEGER
*          The order of the distributed matrix A(IA:IA+N-1,JA:JA+N-1).
*          N >= 0.
*
*  A       (local input) COMPLEX pointer into the local memory
*          to an array of dimension ( LLD_A, LOCc(JA+N-1) ). This array
*          contains the local pieces of the triangular distributed
*          matrix A(IA:IA+N-1,JA:JA+N-1). If UPLO = 'U', the leading
*          N-by-N upper triangular part of this distributed matrix con-
*          tains the upper triangular matrix, and its strictly lower
*          triangular part is not referenced.  If UPLO = 'L', the
*          leading N-by-N lower triangular part of this ditributed
*          matrix contains the lower triangular matrix, and the strictly
*          upper triangular part is not referenced. If DIAG = 'U', the
*          diagonal elements of A(IA:IA+N-1,JA:JA+N-1) are also not
*          referenced and are assumed to be 1.
*
*  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.
*
*  RCOND   (global output) REAL
*          The reciprocal of the condition number of the distributed
*          matrix A(IA:IA+N-1,JA:JA+N-1), computed as
*             RCOND = 1 / ( norm( A(IA:IA+N-1,JA:JA+N-1)      ) *
*                           norm( inv(A(IA:IA+N-1,JA:JA+N-1)) ) ).
*
*  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 >= 2*LOCr(N+MOD(IA-1,MB_A)) +
*          MAX( 2, MAX(NB_A*CEIL(P-1,Q),LOCc(N+MOD(JA-1,NB_A)) +
*          NB_A*CEIL(Q-1,P)) ).
*
*          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.
*
*  RWORK   (local workspace/local output) REAL array,
*                                                  dimension (LRWORK)
*          On exit, RWORK(1) returns the minimal and optimal LRWORK.
*
*  LRWORK  (local or global input) INTEGER
*          The dimension of the array RWORK.
*          LRWORK is local input and must be at least
*          LRWORK >= LOCc(N+MOD(JA-1,NB_A)).
*
*          If LRWORK = -1, then LRWORK 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.
*
*  =====================================================================
*
*     .. Parameters ..
      INTEGER            BLOCK_CYCLIC_2D, CSRC_, CTXT_, DLEN_, DTYPE_,
     $                   lld_, mb_, m_, nb_, n_, rsrc_
      parameter( block_cyclic_2d = 1, dlen_ = 9, dtype_ = 1,
     $                     ctxt_ = 2, m_ = 3, n_ = 4, mb_ = 5, nb_ = 6,
     $                     rsrc_ = 7, csrc_ = 8, lld_ = 9 )
      REAL               ONE, ZERO
      parameter( one = 1.0e+0, zero = 0.0e+0 )
*     ..
*     .. Local Scalars ..
      LOGICAL            LQUERY, NOUNIT, ONENRM, UPPER
      CHARACTER          CBTOP, COLCTOP, NORMIN, ROWCTOP
      INTEGER            IACOL, IAROW, ICOFF, ICTXT, IIA, IPN, IPV, IPW,
     $                   ipx, iroff, iv, ix, ixx, jja, jv, jx, kase,
     $                   kase1, lrwmin, lwmin, mycol, myrow, np, npcol,
     $                   npmod, nprow, nqmod
      REAL               AINVNM, ANORM, SCALE, SMLNUM
      COMPLEX            WMAX, ZDUM
*     ..
*     .. Local Arrays ..
      INTEGER            DESCV( DLEN_ ), DESCX( DLEN_ ), IDUM1( 5 ),
     $                   idum2( 5 )
*     ..
*     .. External Subroutines ..
      EXTERNAL           blacs_gridinfo, cgebr2d, cgebs2d, chk1mat,
     $                   descset, infog2l, pcamax, pchk1mat, pclatrs,
     $                   pclacon, pcsrscl, pb_topget, pb_topset,
     $                   pxerbla
*     ..
*     .. External Functions ..
      LOGICAL            LSAME
      INTEGER            ICEIL, INDXG2P, NUMROC
      REAL               PCLANTR, PSLAMCH
      EXTERNAL           iceil, indxg2p, lsame, numroc, pclantr,
     $                   pslamch
*     ..
*     .. Intrinsic Functions ..
      INTRINSIC          abs, aimag, ichar, max, mod, real
*     ..
*     .. Statement Functions ..
      REAL               CABS1
*     ..
*     .. Statement Function definitions ..
      cabs1( zdum ) = abs( real( zdum ) ) + abs( aimag( zdum ) )
*     ..
*     .. Executable Statements ..
*
*     Get grid parameters
*
      ictxt = desca( ctxt_ )
      CALL blacs_gridinfo( ictxt, nprow, npcol, myrow, mycol )
*
*     Test the input parameters
*
      info = 0
      IF( nprow.EQ.-1 ) THEN
         info = -( 800 + ctxt_ )
      ELSE
         CALL chk1mat( n, 4, n, 4, ia, ja, desca, 8, info )
         IF( info.EQ.0 ) THEN
            upper = lsame( uplo, 'U' )
            onenrm = norm.EQ.'1' .OR. lsame( norm, 'O' )
            nounit = lsame( diag, 'N' )
            iarow = indxg2p( ia, desca( mb_ ), myrow, desca( rsrc_ ),
     $                       nprow )
            iacol = indxg2p( ja, desca( nb_ ), mycol, desca( csrc_ ),
     $                       npcol )
            npmod = numroc( n + mod( ia-1, desca( mb_ ) ), desca( mb_ ),
     $                      myrow, iarow, nprow )
            nqmod = numroc( n + mod( ja-1, desca( nb_ ) ), desca( nb_ ),
     $                      mycol, iacol, npcol )
            lwmin = 2*npmod +
     $              max( 2, max( desca( nb_ )*
     $                   max( 1, iceil( nprow-1, npcol ) ), nqmod +
     $                   desca( nb_ )*
     $                   max( 1, iceil( npcol-1, nprow ) ) ) )
            work( 1 ) = real( lwmin )
            lrwmin = nqmod
            rwork( 1 ) = real( lrwmin )
            lquery = ( lwork.EQ.-1 .OR. lrwork.EQ.-1 )
*
            IF( .NOT.onenrm .AND. .NOT.lsame( norm, 'I' ) ) THEN
               info = -1
            ELSE IF( .NOT.upper .AND. .NOT.lsame( uplo, 'L' ) ) THEN
               info = -2
            ELSE IF( .NOT.nounit .AND. .NOT.lsame( diag, 'U' ) ) THEN
               info = -3
            ELSE IF( lwork.LT.lwmin .AND. .NOT.lquery ) THEN
               info = -11
            ELSE IF( lrwork.LT.lrwmin .AND. .NOT.lquery ) THEN
               info = -13
            END IF
         END IF
*
         IF( onenrm ) THEN
            idum1( 1 ) = ichar( '1' )
         ELSE
            idum1( 1 ) = ichar( 'I' )
         END IF
         idum2( 1 ) = 1
         IF( upper ) THEN
            idum1( 2 ) = ichar( 'U' )
         ELSE
            idum1( 2 ) = ichar( 'L' )
         END IF
         idum2( 2 ) = 2
         IF( nounit ) THEN
            idum1( 3 ) = ichar( 'N' )
         ELSE
            idum1( 3 ) = ichar( 'U' )
         END IF
         idum2( 3 ) = 3
         IF( lwork.EQ.-1 ) THEN
            idum1( 4 ) = -1
         ELSE
            idum1( 4 ) = 1
         END IF
         idum2( 4 ) = 11
         IF( lrwork.EQ.-1 ) THEN
            idum1( 5 ) = -1
         ELSE
            idum1( 5 ) = 1
         END IF
         idum2( 5 ) = 13
         CALL pchk1mat( n, 4, n, 4, ia, ja, desca, 8, 5, idum1, idum2,
     $                  info )
      END IF
*
      IF( info.NE.0 ) THEN
         CALL pxerbla( ictxt, 'PCTRCON', -info )
         RETURN
      ELSE IF( lquery ) THEN
         RETURN
      END IF
*
*     Quick return if possible
*
      IF( n.EQ.0 ) THEN
         rcond = one
         RETURN
      END IF
*
      CALL pb_topget( ictxt, 'Combine', 'Columnwise', colctop )
      CALL pb_topget( ictxt, 'Combine', 'Rowwise',    rowctop )
      CALL pb_topset( ictxt, 'Combine', 'Columnwise', '1-tree' )
      CALL pb_topset( ictxt, 'Combine', 'Rowwise',    '1-tree' )
*
      rcond = zero
      smlnum = pslamch( ictxt, 'Safe minimum' )*real( max( 1, n ) )
      CALL infog2l( ia, ja, desca, nprow, npcol, myrow, mycol, iia, jja,
     $              iarow, iacol )
      iroff = mod( ia-1, desca( mb_ ) )
      icoff = mod( ja-1, desca( nb_ ) )
      np = numroc( n+iroff, desca( mb_ ), myrow, iarow, nprow )
      iv = iroff + 1
      ix = iv
      jv = icoff + 1
      jx = jv
*
      ipx = 1
      ipv = ipx + np
      ipw = ipv + np
      ipn = 1
*
      CALL descset( descv, n+iroff, 1, desca( mb_ ), 1, iarow, mycol,
     $              ictxt, max( 1, np ) )
      CALL descset( descx, n+iroff, 1, desca( mb_ ), 1, iarow, mycol,
     $              ictxt, max( 1, np ) )
*
*     Compute the norm of the triangular matrix A.
*
      anorm = pclantr( norm, uplo, diag, n, n, a, ia, ja, desca, rwork )
*
*     Continue only if ANORM > 0.
*
      IF( anorm.GT.zero ) THEN
*
*        Estimate the norm of the inverse of A.
*
         ainvnm = zero
         normin = 'N'
         IF( onenrm ) THEN
            kase1 = 1
         ELSE
            kase1 = 2
         END IF
         kase = 0
   10    CONTINUE
         CALL pclacon( n, work( ipv ), iv, jv, descv, work( ipx ),
     $                 ix, jx, descx, ainvnm, kase )
         IF( kase.NE.0 ) THEN
            IF( kase.EQ.kase1 ) THEN
*
*              Multiply by inv(A).
*
               descx( csrc_ ) = iacol
               CALL pclatrs( uplo, 'No transpose', diag, normin,
     $                       n, a, ia, ja, desca, work( ipx ), ix, jx,
     $                       descx, scale, rwork( ipn ), work( ipw ) )
               descx( csrc_ ) = mycol
            ELSE
*
*              Multiply by inv(A').
*
               descx( csrc_ ) = iacol
               CALL pclatrs( uplo, 'Conjugate transpose', diag, normin,
     $                       n, a, ia, ja, desca, work( ipx ), ix, jx,
     $                       descx, scale, rwork( ipn ), work( ipw ) )
               descx( csrc_ ) = mycol
            END IF
            normin = 'Y'
*
*           Multiply by 1/SCALE if doing so will not cause overflow.
*
            IF( scale.NE.one ) THEN
               CALL pcamax( n, wmax, ixx, work( ipx ), ix, jx,
     $                   descx, 1 )
               IF( descx( m_ ).EQ.1 .AND. n.EQ.1 ) THEN
                  CALL pb_topget( ictxt, 'Broadcast', 'Columnwise',
     $                          cbtop )
                  IF( myrow.EQ.iarow ) THEN
                     CALL cgebs2d( ictxt, 'Column', cbtop, 1, 1, wmax,
     $                             1 )
                  ELSE
                     CALL cgebr2d( ictxt, 'Column', cbtop, 1, 1, wmax,
     $                             1, iarow, mycol )
                  END IF
               END IF
               IF( scale.LT.cabs1( wmax )*smlnum .OR. scale.EQ.zero )
     $            GO TO 20
               CALL pcsrscl( n, scale, work( ipx ), ix, jx, descx, 1 )
            END IF
            GO TO 10
         END IF
*
*        Compute the estimate of the reciprocal condition number.
*
         IF( ainvnm.NE.zero )
     $      rcond = ( one / anorm ) / ainvnm
      END IF
*
   20 CONTINUE
*
      CALL pb_topset( ictxt, 'Combine', 'Columnwise', colctop )
      CALL pb_topset( ictxt, 'Combine', 'Rowwise',    rowctop )
*
      RETURN
*
*     End of PCTRCON
*
      END