SRC/sormbr.f

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