SRC/cunmlq.f

   1 *> \brief \b CUNMLQ
   2 *
   3 *  =========== DOCUMENTATION ===========
   4 *
   5 * Online html documentation available at
   6 *            http://www.netlib.org/lapack/explore-html/
   7 *
   8 *> \htmlonly
   9 *> Download CUNMLQ + dependencies
  10 *> <a href="http://www.netlib.org/cgi-bin/netlibfiles.tgz?format=tgz&filename=/lapack/lapack_routine/cunmlq.f">
  11 *> [TGZ]</a>
  12 *> <a href="http://www.netlib.org/cgi-bin/netlibfiles.zip?format=zip&filename=/lapack/lapack_routine/cunmlq.f">
  13 *> [ZIP]</a>
  14 *> <a href="http://www.netlib.org/cgi-bin/netlibfiles.txt?format=txt&filename=/lapack/lapack_routine/cunmlq.f">
  15 *> [TXT]</a>
  16 *> \endhtmlonly
  17 *
  18 *  Definition:
  19 *  ===========
  20 *
  21 *       SUBROUTINE CUNMLQ( SIDE, TRANS, M, N, K, A, LDA, TAU, C, LDC,
  22 *                          WORK, LWORK, INFO )
  23 *
  24 *       .. Scalar Arguments ..
  25 *       CHARACTER          SIDE, TRANS
  26 *       INTEGER            INFO, K, LDA, LDC, LWORK, M, N
  27 *       ..
  28 *       .. Array Arguments ..
  29 *       COMPLEX            A( LDA, * ), C( LDC, * ), TAU( * ),
  30 *      $                   WORK( * )
  31 *       ..
  32 *
  33 *
  34 *> \par Purpose:
  35 *  =============
  36 *>
  37 *> \verbatim
  38 *>
  39 *> CUNMLQ overwrites the general complex M-by-N matrix C with
  40 *>
  41 *>                 SIDE = 'L'     SIDE = 'R'
  42 *> TRANS = 'N':      Q * C          C * Q
  43 *> TRANS = 'C':      Q**H * C       C * Q**H
  44 *>
  45 *> where Q is a complex unitary matrix defined as the product of k
  46 *> elementary reflectors
  47 *>
  48 *>       Q = H(k)**H . . . H(2)**H H(1)**H
  49 *>
  50 *> as returned by CGELQF. Q is of order M if SIDE = 'L' and of order N
  51 *> if SIDE = 'R'.
  52 *> \endverbatim
  53 *
  54 *  Arguments:
  55 *  ==========
  56 *
  57 *> \param[in] SIDE
  58 *> \verbatim
  59 *>          SIDE is CHARACTER*1
  60 *>          = 'L': apply Q or Q**H from the Left;
  61 *>          = 'R': apply Q or Q**H from the Right.
  62 *> \endverbatim
  63 *>
  64 *> \param[in] TRANS
  65 *> \verbatim
  66 *>          TRANS is CHARACTER*1
  67 *>          = 'N':  No transpose, apply Q;
  68 *>          = 'C':  Conjugate transpose, apply Q**H.
  69 *> \endverbatim
  70 *>
  71 *> \param[in] M
  72 *> \verbatim
  73 *>          M is INTEGER
  74 *>          The number of rows of the matrix C. M >= 0.
  75 *> \endverbatim
  76 *>
  77 *> \param[in] N
  78 *> \verbatim
  79 *>          N is INTEGER
  80 *>          The number of columns of the matrix C. N >= 0.
  81 *> \endverbatim
  82 *>
  83 *> \param[in] K
  84 *> \verbatim
  85 *>          K is INTEGER
  86 *>          The number of elementary reflectors whose product defines
  87 *>          the matrix Q.
  88 *>          If SIDE = 'L', M >= K >= 0;
  89 *>          if SIDE = 'R', N >= K >= 0.
  90 *> \endverbatim
  91 *>
  92 *> \param[in] A
  93 *> \verbatim
  94 *>          A is COMPLEX array, dimension
  95 *>                               (LDA,M) if SIDE = 'L',
  96 *>                               (LDA,N) if SIDE = 'R'
  97 *>          The i-th row must contain the vector which defines the
  98 *>          elementary reflector H(i), for i = 1,2,...,k, as returned by
  99 *>          CGELQF in the first k rows of its array argument A.
 100 *> \endverbatim
 101 *>
 102 *> \param[in] LDA
 103 *> \verbatim
 104 *>          LDA is INTEGER
 105 *>          The leading dimension of the array A. LDA >= max(1,K).
 106 *> \endverbatim
 107 *>
 108 *> \param[in] TAU
 109 *> \verbatim
 110 *>          TAU is COMPLEX array, dimension (K)
 111 *>          TAU(i) must contain the scalar factor of the elementary
 112 *>          reflector H(i), as returned by CGELQF.
 113 *> \endverbatim
 114 *>
 115 *> \param[in,out] C
 116 *> \verbatim
 117 *>          C is COMPLEX array, dimension (LDC,N)
 118 *>          On entry, the M-by-N matrix C.
 119 *>          On exit, C is overwritten by Q*C or Q**H*C or C*Q**H or C*Q.
 120 *> \endverbatim
 121 *>
 122 *> \param[in] LDC
 123 *> \verbatim
 124 *>          LDC is INTEGER
 125 *>          The leading dimension of the array C. LDC >= max(1,M).
 126 *> \endverbatim
 127 *>
 128 *> \param[out] WORK
 129 *> \verbatim
 130 *>          WORK is COMPLEX array, dimension (MAX(1,LWORK))
 131 *>          On exit, if INFO = 0, WORK(1) returns the optimal LWORK.
 132 *> \endverbatim
 133 *>
 134 *> \param[in] LWORK
 135 *> \verbatim
 136 *>          LWORK is INTEGER
 137 *>          The dimension of the array WORK.
 138 *>          If SIDE = 'L', LWORK >= max(1,N);
 139 *>          if SIDE = 'R', LWORK >= max(1,M).
 140 *>          For good performance, LWORK should generally be larger.
 141 *>
 142 *>          If LWORK = -1, then a workspace query is assumed; the routine
 143 *>          only calculates the optimal size of the WORK array, returns
 144 *>          this value as the first entry of the WORK array, and no error
 145 *>          message related to LWORK is issued by XERBLA.
 146 *> \endverbatim
 147 *>
 148 *> \param[out] INFO
 149 *> \verbatim
 150 *>          INFO is INTEGER
 151 *>          = 0:  successful exit
 152 *>          < 0:  if INFO = -i, the i-th argument had an illegal value
 153 *> \endverbatim
 154 *
 155 *  Authors:
 156 *  ========
 157 *
 158 *> \author Univ. of Tennessee
 159 *> \author Univ. of California Berkeley
 160 *> \author Univ. of Colorado Denver
 161 *> \author NAG Ltd.
 162 *
 163 *> \date November 2015
 164 *
 165 *> \ingroup complexOTHERcomputational
 166 *
 167 *  =====================================================================
 168       SUBROUTINE CUNMLQ( SIDE, TRANS, M, N, K, A, LDA, TAU, C, LDC,
 169      $                   WORK, LWORK, INFO )
 170 *
 171 *  -- LAPACK computational routine (version 3.6.0) --
 172 *  -- LAPACK is a software package provided by Univ. of Tennessee,    --
 173 *  -- Univ. of California Berkeley, Univ. of Colorado Denver and NAG Ltd..--
 174 *     November 2015
 175 *
 176 *     .. Scalar Arguments ..
 177       CHARACTER          SIDE, TRANS
 178       INTEGER            INFO, K, LDA, LDC, LWORK, M, N
 179 *     ..
 180 *     .. Array Arguments ..
 181       COMPLEX            A( LDA, * ), C( LDC, * ), TAU( * ),
 182      $                   WORK( * )
 183 *     ..
 184 *
 185 *  =====================================================================
 186 *
 187 *     .. Parameters ..
 188       INTEGER            NBMAX, LDT, TSIZE
 189       PARAMETER          ( NBMAX = 64, LDT = NBMAX+1,
 190      $                     TSIZE = LDT*NBMAX )
 191 *     ..
 192 *     .. Local Scalars ..
 193       LOGICAL            LEFT, LQUERY, NOTRAN
 194       CHARACTER          TRANST
 195       INTEGER            I, I1, I2, I3, IB, IC, IINFO, IWT, JC, LDWORK,
 196      $                   LWKOPT, MI, NB, NBMIN, NI, NQ, NW
 197 *     ..
 198 *     .. External Functions ..
 199       LOGICAL            LSAME
 200       INTEGER            ILAENV
 201       EXTERNAL           LSAME, ILAENV
 202 *     ..
 203 *     .. External Subroutines ..
 204       EXTERNAL           CLARFB, CLARFT, CUNML2, XERBLA
 205 *     ..
 206 *     .. Intrinsic Functions ..
 207       INTRINSIC          MAX, MIN
 208 *     ..
 209 *     .. Executable Statements ..
 210 *
 211 *     Test the input arguments
 212 *
 213       INFO = 0
 214       LEFT = LSAME( SIDE, 'L' )
 215       NOTRAN = LSAME( TRANS, 'N' )
 216       LQUERY = ( LWORK.EQ.-1 )
 217 *
 218 *     NQ is the order of Q and NW is the minimum dimension of WORK
 219 *
 220       IF( LEFT ) THEN
 221          NQ = M
 222          NW = N
 223       ELSE
 224          NQ = N
 225          NW = M
 226       END IF
 227       IF( .NOT.LEFT .AND. .NOT.LSAME( SIDE, 'R' ) ) THEN
 228          INFO = -1
 229       ELSE IF( .NOT.NOTRAN .AND. .NOT.LSAME( TRANS, 'C' ) ) THEN
 230          INFO = -2
 231       ELSE IF( M.LT.0 ) THEN
 232          INFO = -3
 233       ELSE IF( N.LT.0 ) THEN
 234          INFO = -4
 235       ELSE IF( K.LT.0 .OR. K.GT.NQ ) THEN
 236          INFO = -5
 237       ELSE IF( LDA.LT.MAX( 1, K ) ) THEN
 238          INFO = -7
 239       ELSE IF( LDC.LT.MAX( 1, M ) ) THEN
 240          INFO = -10
 241       ELSE IF( LWORK.LT.MAX( 1, NW ) .AND. .NOT.LQUERY ) THEN
 242          INFO = -12
 243       END IF
 244 *
 245       IF( INFO.EQ.0 ) THEN
 246 *
 247 *        Compute the workspace requirements
 248 *
 249          IF( M.EQ.0 .OR. N.EQ.0 .OR. K.EQ.0 ) THEN
 250             LWKOPT = 1
 251          ELSE
 252             NB = MIN( NBMAX, ILAENV( 1, 'CUNMLQ', SIDE // TRANS, M, N,
 253      $                               K, -1 ) )
 254             LWKOPT = MAX( 1, NW )*NB + TSIZE
 255          END IF
 256          WORK( 1 ) = LWKOPT
 257       END IF
 258 *
 259       IF( INFO.NE.0 ) THEN
 260          CALL XERBLA( 'CUNMLQ', -INFO )
 261          RETURN
 262       ELSE IF( LQUERY ) THEN
 263          RETURN
 264       END IF
 265 *
 266 *     Quick return if possible
 267 *
 268       IF( M.EQ.0 .OR. N.EQ.0 .OR. K.EQ.0 ) THEN
 269          RETURN
 270       END IF
 271 *
 272 *     Determine the block size
 273 *
 274       NBMIN = 2
 275       LDWORK = NW
 276       IF( NB.GT.1 .AND. NB.LT.K ) THEN
 277          IF( LWORK.LT.NW*NB+TSIZE ) THEN
 278             NB = (LWORK-TSIZE) / LDWORK
 279             NBMIN = MAX( 2, ILAENV( 2, 'CUNMLQ', SIDE // TRANS, M, N, K,
 280      $              -1 ) )
 281          END IF
 282       END IF
 283 *
 284       IF( NB.LT.NBMIN .OR. NB.GE.K ) THEN
 285 *
 286 *        Use unblocked code
 287 *
 288          CALL CUNML2( SIDE, TRANS, M, N, K, A, LDA, TAU, C, LDC, WORK,
 289      $                IINFO )
 290       ELSE
 291 *
 292 *        Use blocked code
 293 *
 294          IWT = 1 + NW*NB
 295          IF( ( LEFT .AND. NOTRAN ) .OR.
 296      $       ( .NOT.LEFT .AND. .NOT.NOTRAN ) ) THEN
 297             I1 = 1
 298             I2 = K
 299             I3 = NB
 300          ELSE
 301             I1 = ( ( K-1 ) / NB )*NB + 1
 302             I2 = 1
 303             I3 = -NB
 304          END IF
 305 *
 306          IF( LEFT ) THEN
 307             NI = N
 308             JC = 1
 309          ELSE
 310             MI = M
 311             IC = 1
 312          END IF
 313 *
 314          IF( NOTRAN ) THEN
 315             TRANST = 'C'
 316          ELSE
 317             TRANST = 'N'
 318          END IF
 319 *
 320          DO 10 I = I1, I2, I3
 321             IB = MIN( NB, K-I+1 )
 322 *
 323 *           Form the triangular factor of the block reflector
 324 *           H = H(i) H(i+1) . . . H(i+ib-1)
 325 *
 326             CALL CLARFT( 'Forward', 'Rowwise', NQ-I+1, IB, A( I, I ),
 327      $                   LDA, TAU( I ), WORK( IWT ), LDT )
 328             IF( LEFT ) THEN
 329 *
 330 *              H or H**H is applied to C(i:m,1:n)
 331 *
 332                MI = M - I + 1
 333                IC = I
 334             ELSE
 335 *
 336 *              H or H**H is applied to C(1:m,i:n)
 337 *
 338                NI = N - I + 1
 339                JC = I
 340             END IF
 341 *
 342 *           Apply H or H**H
 343 *
 344             CALL CLARFB( SIDE, TRANST, 'Forward', 'Rowwise', MI, NI, IB,
 345      $                   A( I, I ), LDA, WORK( IWT ), LDT,
 346      $                   C( IC, JC ), LDC, WORK, LDWORK )
 347    10    CONTINUE
 348       END IF
 349       WORK( 1 ) = LWKOPT
 350       RETURN
 351 *
 352 *     End of CUNMLQ
 353 *
 354       END