LAPACK 3.12.1
LAPACK: Linear Algebra PACKage
Loading...
Searching...
No Matches

◆ cunbdb3()

subroutine cunbdb3 ( integer m,
integer p,
integer q,
complex, dimension(ldx11,*) x11,
integer ldx11,
complex, dimension(ldx21,*) x21,
integer ldx21,
real, dimension(*) theta,
real, dimension(*) phi,
complex, dimension(*) taup1,
complex, dimension(*) taup2,
complex, dimension(*) tauq1,
complex, dimension(*) work,
integer lwork,
integer info )

CUNBDB3

Download CUNBDB3 + dependencies [TGZ] [ZIP] [TXT]

Purpose:
!>
!> CUNBDB3 simultaneously bidiagonalizes the blocks of a tall and skinny
!> matrix X with orthonormal columns:
!>
!>                            [ B11 ]
!>      [ X11 ]   [ P1 |    ] [  0  ]
!>      [-----] = [---------] [-----] Q1**T .
!>      [ X21 ]   [    | P2 ] [ B21 ]
!>                            [  0  ]
!>
!> X11 is P-by-Q, and X21 is (M-P)-by-Q. M-P must be no larger than P,
!> Q, or M-Q. Routines CUNBDB1, CUNBDB2, and CUNBDB4 handle cases in
!> which M-P is not the minimum dimension.
!>
!> The unitary matrices P1, P2, and Q1 are P-by-P, (M-P)-by-(M-P),
!> and (M-Q)-by-(M-Q), respectively. They are represented implicitly by
!> Householder vectors.
!>
!> B11 and B12 are (M-P)-by-(M-P) bidiagonal matrices represented
!> implicitly by angles THETA, PHI.
!>
!>
Parameters
[in]M
!>          M is INTEGER
!>           The number of rows X11 plus the number of rows in X21.
!>
[in]P
!>          P is INTEGER
!>           The number of rows in X11. 0 <= P <= M. M-P <= min(P,Q,M-Q).
!>
[in]Q
!>          Q is INTEGER
!>           The number of columns in X11 and X21. 0 <= Q <= M.
!>
[in,out]X11
!>          X11 is COMPLEX array, dimension (LDX11,Q)
!>           On entry, the top block of the matrix X to be reduced. On
!>           exit, the columns of tril(X11) specify reflectors for P1 and
!>           the rows of triu(X11,1) specify reflectors for Q1.
!>
[in]LDX11
!>          LDX11 is INTEGER
!>           The leading dimension of X11. LDX11 >= P.
!>
[in,out]X21
!>          X21 is COMPLEX array, dimension (LDX21,Q)
!>           On entry, the bottom block of the matrix X to be reduced. On
!>           exit, the columns of tril(X21) specify reflectors for P2.
!>
[in]LDX21
!>          LDX21 is INTEGER
!>           The leading dimension of X21. LDX21 >= M-P.
!>
[out]THETA
!>          THETA is REAL array, dimension (Q)
!>           The entries of the bidiagonal blocks B11, B21 are defined by
!>           THETA and PHI. See Further Details.
!>
[out]PHI
!>          PHI is REAL array, dimension (Q-1)
!>           The entries of the bidiagonal blocks B11, B21 are defined by
!>           THETA and PHI. See Further Details.
!>
[out]TAUP1
!>          TAUP1 is COMPLEX array, dimension (P)
!>           The scalar factors of the elementary reflectors that define
!>           P1.
!>
[out]TAUP2
!>          TAUP2 is COMPLEX array, dimension (M-P)
!>           The scalar factors of the elementary reflectors that define
!>           P2.
!>
[out]TAUQ1
!>          TAUQ1 is COMPLEX array, dimension (Q)
!>           The scalar factors of the elementary reflectors that define
!>           Q1.
!>
[out]WORK
!>          WORK is COMPLEX array, dimension (LWORK)
!>
[in]LWORK
!>          LWORK is INTEGER
!>           The dimension of the array WORK. LWORK >= M-Q.
!>
!>           If LWORK = -1, then a workspace query is assumed; the routine
!>           only calculates the optimal size of the WORK array, returns
!>           this value as the first entry of the WORK array, and no error
!>           message related to LWORK is issued by XERBLA.
!>
[out]INFO
!>          INFO is INTEGER
!>           = 0:  successful exit.
!>           < 0:  if INFO = -i, the i-th argument had an illegal value.
!>
Author
Univ. of Tennessee
Univ. of California Berkeley
Univ. of Colorado Denver
NAG Ltd.
Further Details:
!>
!>  The upper-bidiagonal blocks B11, B21 are represented implicitly by
!>  angles THETA(1), ..., THETA(Q) and PHI(1), ..., PHI(Q-1). Every entry
!>  in each bidiagonal band is a product of a sine or cosine of a THETA
!>  with a sine or cosine of a PHI. See [1] or CUNCSD for details.
!>
!>  P1, P2, and Q1 are represented as products of elementary reflectors.
!>  See CUNCSD2BY1 for details on generating P1, P2, and Q1 using CUNGQR
!>  and CUNGLQ.
!>
References:
[1] Brian D. Sutton. Computing the complete CS decomposition. Numer. Algorithms, 50(1):33-65, 2009.

Definition at line 198 of file cunbdb3.f.

201*
202* -- LAPACK computational routine --
203* -- LAPACK is a software package provided by Univ. of Tennessee, --
204* -- Univ. of California Berkeley, Univ. of Colorado Denver and NAG Ltd..--
205*
206* .. Scalar Arguments ..
207 INTEGER INFO, LWORK, M, P, Q, LDX11, LDX21
208* ..
209* .. Array Arguments ..
210 REAL PHI(*), THETA(*)
211 COMPLEX TAUP1(*), TAUP2(*), TAUQ1(*), WORK(*),
212 $ X11(LDX11,*), X21(LDX21,*)
213* ..
214*
215* ====================================================================
216*
217* .. Local Scalars ..
218 REAL C, S
219 INTEGER CHILDINFO, I, ILARF, IORBDB5, LLARF, LORBDB5,
220 $ LWORKMIN, LWORKOPT
221 LOGICAL LQUERY
222* ..
223* .. External Subroutines ..
224 EXTERNAL clarf1f, clarfgp, cunbdb5, csrot, clacgv,
225 $ xerbla
226* ..
227* .. External Functions ..
228 REAL SCNRM2, SROUNDUP_LWORK
229 EXTERNAL scnrm2, sroundup_lwork
230* ..
231* .. Intrinsic Function ..
232 INTRINSIC atan2, cos, max, sin, sqrt
233* ..
234* .. Executable Statements ..
235*
236* Test input arguments
237*
238 info = 0
239 lquery = lwork .EQ. -1
240*
241 IF( m .LT. 0 ) THEN
242 info = -1
243 ELSE IF( 2*p .LT. m .OR. p .GT. m ) THEN
244 info = -2
245 ELSE IF( q .LT. m-p .OR. m-q .LT. m-p ) THEN
246 info = -3
247 ELSE IF( ldx11 .LT. max( 1, p ) ) THEN
248 info = -5
249 ELSE IF( ldx21 .LT. max( 1, m-p ) ) THEN
250 info = -7
251 END IF
252*
253* Compute workspace
254*
255 IF( info .EQ. 0 ) THEN
256 ilarf = 2
257 llarf = max( p, m-p-1, q-1 )
258 iorbdb5 = 2
259 lorbdb5 = q-1
260 lworkopt = max( ilarf+llarf-1, iorbdb5+lorbdb5-1 )
261 lworkmin = lworkopt
262 work(1) = sroundup_lwork(lworkopt)
263 IF( lwork .LT. lworkmin .AND. .NOT.lquery ) THEN
264 info = -14
265 END IF
266 END IF
267 IF( info .NE. 0 ) THEN
268 CALL xerbla( 'CUNBDB3', -info )
269 RETURN
270 ELSE IF( lquery ) THEN
271 RETURN
272 END IF
273*
274* Reduce rows 1, ..., M-P of X11 and X21
275*
276 DO i = 1, m-p
277*
278 IF( i .GT. 1 ) THEN
279 CALL csrot( q-i+1, x11(i-1,i), ldx11, x21(i,i), ldx11, c,
280 $ s )
281 END IF
282*
283 CALL clacgv( q-i+1, x21(i,i), ldx21 )
284 CALL clarfgp( q-i+1, x21(i,i), x21(i,i+1), ldx21, tauq1(i) )
285 s = real( x21(i,i) )
286 CALL clarf1f( 'R', p-i+1, q-i+1, x21(i,i), ldx21, tauq1(i),
287 $ x11(i,i), ldx11, work(ilarf) )
288 CALL clarf1f( 'R', m-p-i, q-i+1, x21(i,i), ldx21, tauq1(i),
289 $ x21(i+1,i), ldx21, work(ilarf) )
290 CALL clacgv( q-i+1, x21(i,i), ldx21 )
291 c = sqrt( scnrm2( p-i+1, x11(i,i), 1 )**2
292 $ + scnrm2( m-p-i, x21(i+1,i), 1 )**2 )
293 theta(i) = atan2( s, c )
294*
295 CALL cunbdb5( p-i+1, m-p-i, q-i, x11(i,i), 1, x21(i+1,i), 1,
296 $ x11(i,i+1), ldx11, x21(i+1,i+1), ldx21,
297 $ work(iorbdb5), lorbdb5, childinfo )
298 CALL clarfgp( p-i+1, x11(i,i), x11(i+1,i), 1, taup1(i) )
299 IF( i .LT. m-p ) THEN
300 CALL clarfgp( m-p-i, x21(i+1,i), x21(i+2,i), 1,
301 $ taup2(i) )
302 phi(i) = atan2( real( x21(i+1,i) ), real( x11(i,i) ) )
303 c = cos( phi(i) )
304 s = sin( phi(i) )
305 CALL clarf1f( 'L', m-p-i, q-i, x21(i+1,i), 1,
306 $ conjg(taup2(i)), x21(i+1,i+1), ldx21,
307 $ work(ilarf) )
308 END IF
309 CALL clarf1f( 'L', p-i+1, q-i, x11(i,i), 1, conjg(taup1(i)),
310 $ x11(i,i+1), ldx11, work(ilarf) )
311*
312 END DO
313*
314* Reduce the bottom-right portion of X11 to the identity matrix
315*
316 DO i = m-p + 1, q
317 CALL clarfgp( p-i+1, x11(i,i), x11(i+1,i), 1, taup1(i) )
318 CALL clarf1f( 'L', p-i+1, q-i, x11(i,i), 1, conjg(taup1(i)),
319 $ x11(i,i+1), ldx11, work(ilarf) )
320 END DO
321*
322 RETURN
323*
324* End of CUNBDB3
325*
xerbla
subroutine xerbla(srname, info)
Definition cblat2.f:3285
clarf1f
subroutine clarf1f(side, m, n, v, incv, tau, c, ldc, work)
CLARF1F applies an elementary reflector to a general rectangular
Definition clarf1f.f:126
clacgv
subroutine clacgv(n, x, incx)
CLACGV conjugates a complex vector.
Definition clacgv.f:72
clarfgp
subroutine clarfgp(n, alpha, x, incx, tau)
CLARFGP generates an elementary reflector (Householder matrix) with non-negative beta.
Definition clarfgp.f:102
scnrm2
real(wp) function scnrm2(n, x, incx)
SCNRM2
Definition scnrm2.f90:90
csrot
subroutine csrot(n, cx, incx, cy, incy, c, s)
CSROT
Definition csrot.f:98
sroundup_lwork
real function sroundup_lwork(lwork)
SROUNDUP_LWORK
Definition sroundup_lwork.f:59
cunbdb5
subroutine cunbdb5(m1, m2, n, x1, incx1, x2, incx2, q1, ldq1, q2, ldq2, work, lwork, info)
CUNBDB5
Definition cunbdb5.f:155
Here is the call graph for this function:
Here is the caller graph for this function: