SRC/sormql.f

   1 *> \brief \b SORMQL
   2 *
   3 *  =========== DOCUMENTATION ===========
   4 *
   5 * Online html documentation available at
   6 *            http://www.netlib.org/lapack/explore-html/
   7 *
   8 *> \htmlonly
   9 *> Download SORMQL + dependencies
  10 *> <a href="http://www.netlib.org/cgi-bin/netlibfiles.tgz?format=tgz&filename=/lapack/lapack_routine/sormql.f">
  11 *> [TGZ]</a>
  12 *> <a href="http://www.netlib.org/cgi-bin/netlibfiles.zip?format=zip&filename=/lapack/lapack_routine/sormql.f">
  13 *> [ZIP]</a>
  14 *> <a href="http://www.netlib.org/cgi-bin/netlibfiles.txt?format=txt&filename=/lapack/lapack_routine/sormql.f">
  15 *> [TXT]</a>
  16 *> \endhtmlonly
  17 *
  18 *  Definition:
  19 *  ===========
  20 *
  21 *       SUBROUTINE SORMQL( 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 *       REAL               A( LDA, * ), C( LDC, * ), TAU( * ),
  30 *      $                   WORK( * )
  31 *       ..
  32 *
  33 *
  34 *> \par Purpose:
  35 *  =============
  36 *>
  37 *> \verbatim
  38 *>
  39 *> SORMQL overwrites the general real M-by-N matrix C with
  40 *>
  41 *>                 SIDE = 'L'     SIDE = 'R'
  42 *> TRANS = 'N':      Q * C          C * Q
  43 *> TRANS = 'T':      Q**T * C       C * Q**T
  44 *>
  45 *> where Q is a real orthogonal matrix defined as the product of k
  46 *> elementary reflectors
  47 *>
  48 *>       Q = H(k) . . . H(2) H(1)
  49 *>
  50 *> as returned by SGEQLF. 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**T from the Left;
  61 *>          = 'R': apply Q or Q**T from the Right.
  62 *> \endverbatim
  63 *>
  64 *> \param[in] TRANS
  65 *> \verbatim
  66 *>          TRANS is CHARACTER*1
  67 *>          = 'N':  No transpose, apply Q;
  68 *>          = 'T':  Transpose, apply Q**T.
  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 REAL array, dimension (LDA,K)
  95 *>          The i-th column must contain the vector which defines the
  96 *>          elementary reflector H(i), for i = 1,2,...,k, as returned by
  97 *>          SGEQLF in the last k columns of its array argument A.
  98 *> \endverbatim
  99 *>
 100 *> \param[in] LDA
 101 *> \verbatim
 102 *>          LDA is INTEGER
 103 *>          The leading dimension of the array A.
 104 *>          If SIDE = 'L', LDA >= max(1,M);
 105 *>          if SIDE = 'R', LDA >= max(1,N).
 106 *> \endverbatim
 107 *>
 108 *> \param[in] TAU
 109 *> \verbatim
 110 *>          TAU is REAL array, dimension (K)
 111 *>          TAU(i) must contain the scalar factor of the elementary
 112 *>          reflector H(i), as returned by SGEQLF.
 113 *> \endverbatim
 114 *>
 115 *> \param[in,out] C
 116 *> \verbatim
 117 *>          C is REAL array, dimension (LDC,N)
 118 *>          On entry, the M-by-N matrix C.
 119 *>          On exit, C is overwritten by Q*C or Q**T*C or C*Q**T 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 REAL 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 realOTHERcomputational
 166 *
 167 *  =====================================================================
 168       SUBROUTINE SORMQL( 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       REAL               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       INTEGER            I, I1, I2, I3, IB, IINFO, IWT, LDWORK, LWKOPT,
 195      $                   MI, NB, NBMIN, NI, NQ, NW
 196 *     ..
 197 *     .. External Functions ..
 198       LOGICAL            LSAME
 199       INTEGER            ILAENV
 200       EXTERNAL           LSAME, ILAENV
 201 *     ..
 202 *     .. External Subroutines ..
 203       EXTERNAL           SLARFB, SLARFT, SORM2L, XERBLA
 204 *     ..
 205 *     .. Intrinsic Functions ..
 206       INTRINSIC          MAX, MIN
 207 *     ..
 208 *     .. Executable Statements ..
 209 *
 210 *     Test the input arguments
 211 *
 212       INFO = 0
 213       LEFT = LSAME( SIDE, 'L' )
 214       NOTRAN = LSAME( TRANS, 'N' )
 215       LQUERY = ( LWORK.EQ.-1 )
 216 *
 217 *     NQ is the order of Q and NW is the minimum dimension of WORK
 218 *
 219       IF( LEFT ) THEN
 220          NQ = M
 221          NW = MAX( 1, N )
 222       ELSE
 223          NQ = N
 224          NW = MAX( 1, M )
 225       END IF
 226       IF( .NOT.LEFT .AND. .NOT.LSAME( SIDE, 'R' ) ) THEN
 227          INFO = -1
 228       ELSE IF( .NOT.NOTRAN .AND. .NOT.LSAME( TRANS, 'T' ) ) THEN
 229          INFO = -2
 230       ELSE IF( M.LT.0 ) THEN
 231          INFO = -3
 232       ELSE IF( N.LT.0 ) THEN
 233          INFO = -4
 234       ELSE IF( K.LT.0 .OR. K.GT.NQ ) THEN
 235          INFO = -5
 236       ELSE IF( LDA.LT.MAX( 1, NQ ) ) THEN
 237          INFO = -7
 238       ELSE IF( LDC.LT.MAX( 1, M ) ) THEN
 239          INFO = -10
 240       ELSE IF( LWORK.LT.NW .AND. .NOT.LQUERY ) THEN
 241          INFO = -12
 242       END IF
 243 *
 244       IF( INFO.EQ.0 ) THEN
 245 *
 246 *     Compute the workspace requirements
 247 *
 248          IF( M.EQ.0 .OR. N.EQ.0 ) THEN
 249             LWKOPT = 1
 250          ELSE
 251             NB = MIN( NBMAX, ILAENV( 1, 'SORMQL', SIDE // TRANS, M, N,
 252      $                               K, -1 ) )
 253             LWKOPT = NW*NB + TSIZE
 254          END IF
 255          WORK( 1 ) = LWKOPT
 256       END IF
 257 *
 258       IF( INFO.NE.0 ) THEN
 259          CALL XERBLA( 'SORMQL', -INFO )
 260          RETURN
 261       ELSE IF( LQUERY ) THEN
 262          RETURN
 263       END IF
 264 *
 265 *     Quick return if possible
 266 *
 267       IF( M.EQ.0 .OR. N.EQ.0 ) THEN
 268          RETURN
 269       END IF
 270 *
 271       NBMIN = 2
 272       LDWORK = NW
 273       IF( NB.GT.1 .AND. NB.LT.K ) THEN
 274          IF( LWORK.LT.NW*NB+TSIZE ) THEN
 275             NB = (LWORK-TSIZE) / LDWORK
 276             NBMIN = MAX( 2, ILAENV( 2, 'SORMQL', SIDE // TRANS, M, N, K,
 277      $              -1 ) )
 278          END IF
 279       END IF
 280 *
 281       IF( NB.LT.NBMIN .OR. NB.GE.K ) THEN
 282 *
 283 *        Use unblocked code
 284 *
 285          CALL SORM2L( SIDE, TRANS, M, N, K, A, LDA, TAU, C, LDC, WORK,
 286      $                IINFO )
 287       ELSE
 288 *
 289 *        Use blocked code
 290 *
 291          IWT = 1 + NW*NB
 292          IF( ( LEFT .AND. NOTRAN ) .OR.
 293      $       ( .NOT.LEFT .AND. .NOT.NOTRAN ) ) THEN
 294             I1 = 1
 295             I2 = K
 296             I3 = NB
 297          ELSE
 298             I1 = ( ( K-1 ) / NB )*NB + 1
 299             I2 = 1
 300             I3 = -NB
 301          END IF
 302 *
 303          IF( LEFT ) THEN
 304             NI = N
 305          ELSE
 306             MI = M
 307          END IF
 308 *
 309          DO 10 I = I1, I2, I3
 310             IB = MIN( NB, K-I+1 )
 311 *
 312 *           Form the triangular factor of the block reflector
 313 *           H = H(i+ib-1) . . . H(i+1) H(i)
 314 *
 315             CALL SLARFT( 'Backward', 'Columnwise', NQ-K+I+IB-1, IB,
 316      $                   A( 1, I ), LDA, TAU( I ), WORK( IWT ), LDT )
 317             IF( LEFT ) THEN
 318 *
 319 *              H or H**T is applied to C(1:m-k+i+ib-1,1:n)
 320 *
 321                MI = M - K + I + IB - 1
 322             ELSE
 323 *
 324 *              H or H**T is applied to C(1:m,1:n-k+i+ib-1)
 325 *
 326                NI = N - K + I + IB - 1
 327             END IF
 328 *
 329 *           Apply H or H**T
 330 *
 331             CALL SLARFB( SIDE, TRANS, 'Backward', 'Columnwise', MI, NI,
 332      $                   IB, A( 1, I ), LDA, WORK( IWT ), LDT, C, LDC,
 333      $                   WORK, LDWORK )
 334    10    CONTINUE
 335       END IF
 336       WORK( 1 ) = LWKOPT
 337       RETURN
 338 *
 339 *     End of SORMQL
 340 *
 341       END