LAPACK 3.12.0
LAPACK: Linear Algebra PACKage
Loading...
Searching...
No Matches
sorgbr.f
Go to the documentation of this file.
1*> \brief \b SORGBR
2*
3* =========== DOCUMENTATION ===========
4*
5* Online html documentation available at
6* http://www.netlib.org/lapack/explore-html/
7*
8*> \htmlonly
9*> Download SORGBR + dependencies
10*> <a href="http://www.netlib.org/cgi-bin/netlibfiles.tgz?format=tgz&filename=/lapack/lapack_routine/sorgbr.f">
11*> [TGZ]</a>
12*> <a href="http://www.netlib.org/cgi-bin/netlibfiles.zip?format=zip&filename=/lapack/lapack_routine/sorgbr.f">
13*> [ZIP]</a>
14*> <a href="http://www.netlib.org/cgi-bin/netlibfiles.txt?format=txt&filename=/lapack/lapack_routine/sorgbr.f">
15*> [TXT]</a>
16*> \endhtmlonly
17*
18* Definition:
19* ===========
20*
21* SUBROUTINE SORGBR( VECT, M, N, K, A, LDA, TAU, WORK, LWORK, INFO )
22*
23* .. Scalar Arguments ..
24* CHARACTER VECT
25* INTEGER INFO, K, LDA, LWORK, M, N
26* ..
27* .. Array Arguments ..
28* REAL A( LDA, * ), TAU( * ), WORK( * )
29* ..
30*
31*
32*> \par Purpose:
33* =============
34*>
35*> \verbatim
36*>
37*> SORGBR generates one of the real orthogonal matrices Q or P**T
38*> determined by SGEBRD when reducing a real matrix A to bidiagonal
39*> form: A = Q * B * P**T. Q and P**T are defined as products of
40*> elementary reflectors H(i) or G(i) respectively.
41*>
42*> If VECT = 'Q', A is assumed to have been an M-by-K matrix, and Q
43*> is of order M:
44*> if m >= k, Q = H(1) H(2) . . . H(k) and SORGBR returns the first n
45*> columns of Q, where m >= n >= k;
46*> if m < k, Q = H(1) H(2) . . . H(m-1) and SORGBR returns Q as an
47*> M-by-M matrix.
48*>
49*> If VECT = 'P', A is assumed to have been a K-by-N matrix, and P**T
50*> is of order N:
51*> if k < n, P**T = G(k) . . . G(2) G(1) and SORGBR returns the first m
52*> rows of P**T, where n >= m >= k;
53*> if k >= n, P**T = G(n-1) . . . G(2) G(1) and SORGBR returns P**T as
54*> an N-by-N matrix.
55*> \endverbatim
56*
57* Arguments:
58* ==========
59*
60*> \param[in] VECT
61*> \verbatim
62*> VECT is CHARACTER*1
63*> Specifies whether the matrix Q or the matrix P**T is
64*> required, as defined in the transformation applied by SGEBRD:
65*> = 'Q': generate Q;
66*> = 'P': generate P**T.
67*> \endverbatim
68*>
69*> \param[in] M
70*> \verbatim
71*> M is INTEGER
72*> The number of rows of the matrix Q or P**T to be returned.
73*> M >= 0.
74*> \endverbatim
75*>
76*> \param[in] N
77*> \verbatim
78*> N is INTEGER
79*> The number of columns of the matrix Q or P**T to be returned.
80*> N >= 0.
81*> If VECT = 'Q', M >= N >= min(M,K);
82*> if VECT = 'P', N >= M >= min(N,K).
83*> \endverbatim
84*>
85*> \param[in] K
86*> \verbatim
87*> K is INTEGER
88*> If VECT = 'Q', the number of columns in the original M-by-K
89*> matrix reduced by SGEBRD.
90*> If VECT = 'P', the number of rows in the original K-by-N
91*> matrix reduced by SGEBRD.
92*> K >= 0.
93*> \endverbatim
94*>
95*> \param[in,out] A
96*> \verbatim
97*> A is REAL array, dimension (LDA,N)
98*> On entry, the vectors which define the elementary reflectors,
99*> as returned by SGEBRD.
100*> On exit, the M-by-N matrix Q or P**T.
101*> \endverbatim
102*>
103*> \param[in] LDA
104*> \verbatim
105*> LDA is INTEGER
106*> The leading dimension of the array A. LDA >= max(1,M).
107*> \endverbatim
108*>
109*> \param[in] TAU
110*> \verbatim
111*> TAU is REAL array, dimension
112*> (min(M,K)) if VECT = 'Q'
113*> (min(N,K)) if VECT = 'P'
114*> TAU(i) must contain the scalar factor of the elementary
115*> reflector H(i) or G(i), which determines Q or P**T, as
116*> returned by SGEBRD in its array argument TAUQ or TAUP.
117*> \endverbatim
118*>
119*> \param[out] WORK
120*> \verbatim
121*> WORK is REAL array, dimension (MAX(1,LWORK))
122*> On exit, if INFO = 0, WORK(1) returns the optimal LWORK.
123*> \endverbatim
124*>
125*> \param[in] LWORK
126*> \verbatim
127*> LWORK is INTEGER
128*> The dimension of the array WORK. LWORK >= max(1,min(M,N)).
129*> For optimum performance LWORK >= min(M,N)*NB, where NB
130*> is the optimal blocksize.
131*>
132*> If LWORK = -1, then a workspace query is assumed; the routine
133*> only calculates the optimal size of the WORK array, returns
134*> this value as the first entry of the WORK array, and no error
135*> message related to LWORK is issued by XERBLA.
136*> \endverbatim
137*>
138*> \param[out] INFO
139*> \verbatim
140*> INFO is INTEGER
141*> = 0: successful exit
142*> < 0: if INFO = -i, the i-th argument had an illegal value
143*> \endverbatim
144*
145* Authors:
146* ========
147*
148*> \author Univ. of Tennessee
149*> \author Univ. of California Berkeley
150*> \author Univ. of Colorado Denver
151*> \author NAG Ltd.
152*
153*> \ingroup ungbr
154*
155* =====================================================================
156 SUBROUTINE sorgbr( VECT, M, N, K, A, LDA, TAU, WORK, LWORK, INFO )
157*
158* -- LAPACK computational routine --
159* -- LAPACK is a software package provided by Univ. of Tennessee, --
160* -- Univ. of California Berkeley, Univ. of Colorado Denver and NAG Ltd..--
161*
162* .. Scalar Arguments ..
163 CHARACTER VECT
164 INTEGER INFO, K, LDA, LWORK, M, N
165* ..
166* .. Array Arguments ..
167 REAL A( LDA, * ), TAU( * ), WORK( * )
168* ..
169*
170* =====================================================================
171*
172* .. Parameters ..
173 REAL ZERO, ONE
174 parameter( zero = 0.0e+0, one = 1.0e+0 )
175* ..
176* .. Local Scalars ..
177 LOGICAL LQUERY, WANTQ
178 INTEGER I, IINFO, J, LWKOPT, MN
179* ..
180* .. External Functions ..
181 LOGICAL LSAME
182 REAL SROUNDUP_LWORK
183 EXTERNAL lsame, sroundup_lwork
184* ..
185* .. External Subroutines ..
186 EXTERNAL sorglq, sorgqr, xerbla
187* ..
188* .. Intrinsic Functions ..
189 INTRINSIC max, min
190* ..
191* .. Executable Statements ..
192*
193* Test the input arguments
194*
195 info = 0
196 wantq = lsame( vect, 'Q' )
197 mn = min( m, n )
198 lquery = ( lwork.EQ.-1 )
199 IF( .NOT.wantq .AND. .NOT.lsame( vect, 'P' ) ) THEN
200 info = -1
201 ELSE IF( m.LT.0 ) THEN
202 info = -2
203 ELSE IF( n.LT.0 .OR. ( wantq .AND. ( n.GT.m .OR. n.LT.min( m,
204 $ k ) ) ) .OR. ( .NOT.wantq .AND. ( m.GT.n .OR. m.LT.
205 $ min( n, k ) ) ) ) THEN
206 info = -3
207 ELSE IF( k.LT.0 ) THEN
208 info = -4
209 ELSE IF( lda.LT.max( 1, m ) ) THEN
210 info = -6
211 ELSE IF( lwork.LT.max( 1, mn ) .AND. .NOT.lquery ) THEN
212 info = -9
213 END IF
214*
215 IF( info.EQ.0 ) THEN
216 work( 1 ) = 1
217 IF( wantq ) THEN
218 IF( m.GE.k ) THEN
219 CALL sorgqr( m, n, k, a, lda, tau, work, -1, iinfo )
220 ELSE
221 IF( m.GT.1 ) THEN
222 CALL sorgqr( m-1, m-1, m-1, a, lda, tau, work, -1,
223 $ iinfo )
224 END IF
225 END IF
226 ELSE
227 IF( k.LT.n ) THEN
228 CALL sorglq( m, n, k, a, lda, tau, work, -1, iinfo )
229 ELSE
230 IF( n.GT.1 ) THEN
231 CALL sorglq( n-1, n-1, n-1, a, lda, tau, work, -1,
232 $ iinfo )
233 END IF
234 END IF
235 END IF
236 lwkopt = int( work( 1 ) )
237 lwkopt = max(lwkopt, mn)
238 END IF
239*
240 IF( info.NE.0 ) THEN
241 CALL xerbla( 'SORGBR', -info )
242 RETURN
243 ELSE IF( lquery ) THEN
244 work( 1 ) = sroundup_lwork(lwkopt)
245 RETURN
246 END IF
247*
248* Quick return if possible
249*
250 IF( m.EQ.0 .OR. n.EQ.0 ) THEN
251 work( 1 ) = 1
252 RETURN
253 END IF
254*
255 IF( wantq ) THEN
256*
257* Form Q, determined by a call to SGEBRD to reduce an m-by-k
258* matrix
259*
260 IF( m.GE.k ) THEN
261*
262* If m >= k, assume m >= n >= k
263*
264 CALL sorgqr( m, n, k, a, lda, tau, work, lwork, iinfo )
265*
266 ELSE
267*
268* If m < k, assume m = n
269*
270* Shift the vectors which define the elementary reflectors one
271* column to the right, and set the first row and column of Q
272* to those of the unit matrix
273*
274 DO 20 j = m, 2, -1
275 a( 1, j ) = zero
276 DO 10 i = j + 1, m
277 a( i, j ) = a( i, j-1 )
278 10 CONTINUE
279 20 CONTINUE
280 a( 1, 1 ) = one
281 DO 30 i = 2, m
282 a( i, 1 ) = zero
283 30 CONTINUE
284 IF( m.GT.1 ) THEN
285*
286* Form Q(2:m,2:m)
287*
288 CALL sorgqr( m-1, m-1, m-1, a( 2, 2 ), lda, tau, work,
289 $ lwork, iinfo )
290 END IF
291 END IF
292 ELSE
293*
294* Form P**T, determined by a call to SGEBRD to reduce a k-by-n
295* matrix
296*
297 IF( k.LT.n ) THEN
298*
299* If k < n, assume k <= m <= n
300*
301 CALL sorglq( m, n, k, a, lda, tau, work, lwork, iinfo )
302*
303 ELSE
304*
305* If k >= n, assume m = n
306*
307* Shift the vectors which define the elementary reflectors one
308* row downward, and set the first row and column of P**T to
309* those of the unit matrix
310*
311 a( 1, 1 ) = one
312 DO 40 i = 2, n
313 a( i, 1 ) = zero
314 40 CONTINUE
315 DO 60 j = 2, n
316 DO 50 i = j - 1, 2, -1
317 a( i, j ) = a( i-1, j )
318 50 CONTINUE
319 a( 1, j ) = zero
320 60 CONTINUE
321 IF( n.GT.1 ) THEN
322*
323* Form P**T(2:n,2:n)
324*
325 CALL sorglq( n-1, n-1, n-1, a( 2, 2 ), lda, tau, work,
326 $ lwork, iinfo )
327 END IF
328 END IF
329 END IF
330 work( 1 ) = sroundup_lwork(lwkopt)
331 RETURN
332*
333* End of SORGBR
334*
335 END
subroutine xerbla(srname, info)
Definition cblat2.f:3285
subroutine sorgbr(vect, m, n, k, a, lda, tau, work, lwork, info)
SORGBR
Definition sorgbr.f:157
subroutine sorglq(m, n, k, a, lda, tau, work, lwork, info)
SORGLQ
Definition sorglq.f:127
subroutine sorgqr(m, n, k, a, lda, tau, work, lwork, info)
SORGQR
Definition sorgqr.f:128