Annotation of rpl/lapack/lapack/zungr2.f, revision 1.19

1.12      bertrand    1: *> \brief \b ZUNGR2 generates all or part of the unitary matrix Q from an RQ factorization determined by cgerqf (unblocked algorithm).
1.9       bertrand    2: *
                      3: *  =========== DOCUMENTATION ===========
                      4: *
1.16      bertrand    5: * Online html documentation available at
                      6: *            http://www.netlib.org/lapack/explore-html/
1.9       bertrand    7: *
                      8: *> \htmlonly
1.16      bertrand    9: *> Download ZUNGR2 + dependencies
                     10: *> <a href="http://www.netlib.org/cgi-bin/netlibfiles.tgz?format=tgz&filename=/lapack/lapack_routine/zungr2.f">
                     11: *> [TGZ]</a>
                     12: *> <a href="http://www.netlib.org/cgi-bin/netlibfiles.zip?format=zip&filename=/lapack/lapack_routine/zungr2.f">
                     13: *> [ZIP]</a>
                     14: *> <a href="http://www.netlib.org/cgi-bin/netlibfiles.txt?format=txt&filename=/lapack/lapack_routine/zungr2.f">
1.9       bertrand   15: *> [TXT]</a>
1.16      bertrand   16: *> \endhtmlonly
1.9       bertrand   17: *
                     18: *  Definition:
                     19: *  ===========
                     20: *
                     21: *       SUBROUTINE ZUNGR2( M, N, K, A, LDA, TAU, WORK, INFO )
1.16      bertrand   22: *
1.9       bertrand   23: *       .. Scalar Arguments ..
                     24: *       INTEGER            INFO, K, LDA, M, N
                     25: *       ..
                     26: *       .. Array Arguments ..
                     27: *       COMPLEX*16         A( LDA, * ), TAU( * ), WORK( * )
                     28: *       ..
1.16      bertrand   29: *
1.9       bertrand   30: *
                     31: *> \par Purpose:
                     32: *  =============
                     33: *>
                     34: *> \verbatim
                     35: *>
                     36: *> ZUNGR2 generates an m by n complex matrix Q with orthonormal rows,
                     37: *> which is defined as the last m rows of a product of k elementary
                     38: *> reflectors of order n
                     39: *>
                     40: *>       Q  =  H(1)**H H(2)**H . . . H(k)**H
                     41: *>
                     42: *> as returned by ZGERQF.
                     43: *> \endverbatim
                     44: *
                     45: *  Arguments:
                     46: *  ==========
                     47: *
                     48: *> \param[in] M
                     49: *> \verbatim
                     50: *>          M is INTEGER
                     51: *>          The number of rows of the matrix Q. M >= 0.
                     52: *> \endverbatim
                     53: *>
                     54: *> \param[in] N
                     55: *> \verbatim
                     56: *>          N is INTEGER
                     57: *>          The number of columns of the matrix Q. N >= M.
                     58: *> \endverbatim
                     59: *>
                     60: *> \param[in] K
                     61: *> \verbatim
                     62: *>          K is INTEGER
                     63: *>          The number of elementary reflectors whose product defines the
                     64: *>          matrix Q. M >= K >= 0.
                     65: *> \endverbatim
                     66: *>
                     67: *> \param[in,out] A
                     68: *> \verbatim
                     69: *>          A is COMPLEX*16 array, dimension (LDA,N)
                     70: *>          On entry, the (m-k+i)-th row must contain the vector which
                     71: *>          defines the elementary reflector H(i), for i = 1,2,...,k, as
                     72: *>          returned by ZGERQF in the last k rows of its array argument
                     73: *>          A.
                     74: *>          On exit, the m-by-n matrix Q.
                     75: *> \endverbatim
                     76: *>
                     77: *> \param[in] LDA
                     78: *> \verbatim
                     79: *>          LDA is INTEGER
                     80: *>          The first dimension of the array A. LDA >= max(1,M).
                     81: *> \endverbatim
                     82: *>
                     83: *> \param[in] TAU
                     84: *> \verbatim
                     85: *>          TAU is COMPLEX*16 array, dimension (K)
                     86: *>          TAU(i) must contain the scalar factor of the elementary
                     87: *>          reflector H(i), as returned by ZGERQF.
                     88: *> \endverbatim
                     89: *>
                     90: *> \param[out] WORK
                     91: *> \verbatim
                     92: *>          WORK is COMPLEX*16 array, dimension (M)
                     93: *> \endverbatim
                     94: *>
                     95: *> \param[out] INFO
                     96: *> \verbatim
                     97: *>          INFO is INTEGER
                     98: *>          = 0: successful exit
                     99: *>          < 0: if INFO = -i, the i-th argument has an illegal value
                    100: *> \endverbatim
                    101: *
                    102: *  Authors:
                    103: *  ========
                    104: *
1.16      bertrand  105: *> \author Univ. of Tennessee
                    106: *> \author Univ. of California Berkeley
                    107: *> \author Univ. of Colorado Denver
                    108: *> \author NAG Ltd.
1.9       bertrand  109: *
                    110: *> \ingroup complex16OTHERcomputational
                    111: *
                    112: *  =====================================================================
1.1       bertrand  113:       SUBROUTINE ZUNGR2( M, N, K, A, LDA, TAU, WORK, INFO )
                    114: *
1.19    ! bertrand  115: *  -- LAPACK computational routine --
1.1       bertrand  116: *  -- LAPACK is a software package provided by Univ. of Tennessee,    --
                    117: *  -- Univ. of California Berkeley, Univ. of Colorado Denver and NAG Ltd..--
                    118: *
                    119: *     .. Scalar Arguments ..
                    120:       INTEGER            INFO, K, LDA, M, N
                    121: *     ..
                    122: *     .. Array Arguments ..
                    123:       COMPLEX*16         A( LDA, * ), TAU( * ), WORK( * )
                    124: *     ..
                    125: *
                    126: *  =====================================================================
                    127: *
                    128: *     .. Parameters ..
                    129:       COMPLEX*16         ONE, ZERO
                    130:       PARAMETER          ( ONE = ( 1.0D+0, 0.0D+0 ),
                    131:      $                   ZERO = ( 0.0D+0, 0.0D+0 ) )
                    132: *     ..
                    133: *     .. Local Scalars ..
                    134:       INTEGER            I, II, J, L
                    135: *     ..
                    136: *     .. External Subroutines ..
                    137:       EXTERNAL           XERBLA, ZLACGV, ZLARF, ZSCAL
                    138: *     ..
                    139: *     .. Intrinsic Functions ..
                    140:       INTRINSIC          DCONJG, MAX
                    141: *     ..
                    142: *     .. Executable Statements ..
                    143: *
                    144: *     Test the input arguments
                    145: *
                    146:       INFO = 0
                    147:       IF( M.LT.0 ) THEN
                    148:          INFO = -1
                    149:       ELSE IF( N.LT.M ) THEN
                    150:          INFO = -2
                    151:       ELSE IF( K.LT.0 .OR. K.GT.M ) THEN
                    152:          INFO = -3
                    153:       ELSE IF( LDA.LT.MAX( 1, M ) ) THEN
                    154:          INFO = -5
                    155:       END IF
                    156:       IF( INFO.NE.0 ) THEN
                    157:          CALL XERBLA( 'ZUNGR2', -INFO )
                    158:          RETURN
                    159:       END IF
                    160: *
                    161: *     Quick return if possible
                    162: *
                    163:       IF( M.LE.0 )
                    164:      $   RETURN
                    165: *
                    166:       IF( K.LT.M ) THEN
                    167: *
                    168: *        Initialise rows 1:m-k to rows of the unit matrix
                    169: *
                    170:          DO 20 J = 1, N
                    171:             DO 10 L = 1, M - K
                    172:                A( L, J ) = ZERO
                    173:    10       CONTINUE
                    174:             IF( J.GT.N-M .AND. J.LE.N-K )
                    175:      $         A( M-N+J, J ) = ONE
                    176:    20    CONTINUE
                    177:       END IF
                    178: *
                    179:       DO 40 I = 1, K
                    180:          II = M - K + I
                    181: *
1.8       bertrand  182: *        Apply H(i)**H to A(1:m-k+i,1:n-k+i) from the right
1.1       bertrand  183: *
                    184:          CALL ZLACGV( N-M+II-1, A( II, 1 ), LDA )
                    185:          A( II, N-M+II ) = ONE
                    186:          CALL ZLARF( 'Right', II-1, N-M+II, A( II, 1 ), LDA,
                    187:      $               DCONJG( TAU( I ) ), A, LDA, WORK )
                    188:          CALL ZSCAL( N-M+II-1, -TAU( I ), A( II, 1 ), LDA )
                    189:          CALL ZLACGV( N-M+II-1, A( II, 1 ), LDA )
                    190:          A( II, N-M+II ) = ONE - DCONJG( TAU( I ) )
                    191: *
                    192: *        Set A(m-k+i,n-k+i+1:n) to zero
                    193: *
                    194:          DO 30 L = N - M + II + 1, N
                    195:             A( II, L ) = ZERO
                    196:    30    CONTINUE
                    197:    40 CONTINUE
                    198:       RETURN
                    199: *
                    200: *     End of ZUNGR2
                    201: *
                    202:       END

CVSweb interface <joel.bertrand@systella.fr>