LAPACK 3.12.1
LAPACK: Linear Algebra PACKage
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
cungql.f
Go to the documentation of this file.
1*> \brief \b CUNGQL
2*
3* =========== DOCUMENTATION ===========
4*
5* Online html documentation available at
6* http://www.netlib.org/lapack/explore-html/
7*
8*> Download CUNGQL + dependencies
9*> <a href="http://www.netlib.org/cgi-bin/netlibfiles.tgz?format=tgz&filename=/lapack/lapack_routine/cungql.f">
10*> [TGZ]</a>
11*> <a href="http://www.netlib.org/cgi-bin/netlibfiles.zip?format=zip&filename=/lapack/lapack_routine/cungql.f">
12*> [ZIP]</a>
13*> <a href="http://www.netlib.org/cgi-bin/netlibfiles.txt?format=txt&filename=/lapack/lapack_routine/cungql.f">
14*> [TXT]</a>
15*
16* Definition:
17* ===========
18*
19* SUBROUTINE CUNGQL( M, N, K, A, LDA, TAU, WORK, LWORK, INFO )
20*
21* .. Scalar Arguments ..
22* INTEGER INFO, K, LDA, LWORK, M, N
23* ..
24* .. Array Arguments ..
25* COMPLEX A( LDA, * ), TAU( * ), WORK( * )
26* ..
27*
28*
29*> \par Purpose:
30* =============
31*>
32*> \verbatim
33*>
34*> CUNGQL generates an M-by-N complex matrix Q with orthonormal columns,
35*> which is defined as the last N columns of a product of K elementary
36*> reflectors of order M
37*>
38*> Q = H(k) . . . H(2) H(1)
39*>
40*> as returned by CGEQLF.
41*> \endverbatim
42*
43* Arguments:
44* ==========
45*
46*> \param[in] M
47*> \verbatim
48*> M is INTEGER
49*> The number of rows of the matrix Q. M >= 0.
50*> \endverbatim
51*>
52*> \param[in] N
53*> \verbatim
54*> N is INTEGER
55*> The number of columns of the matrix Q. M >= N >= 0.
56*> \endverbatim
57*>
58*> \param[in] K
59*> \verbatim
60*> K is INTEGER
61*> The number of elementary reflectors whose product defines the
62*> matrix Q. N >= K >= 0.
63*> \endverbatim
64*>
65*> \param[in,out] A
66*> \verbatim
67*> A is COMPLEX array, dimension (LDA,N)
68*> On entry, the (n-k+i)-th column must contain the vector which
69*> defines the elementary reflector H(i), for i = 1,2,...,k, as
70*> returned by CGEQLF in the last k columns of its array
71*> argument A.
72*> On exit, the M-by-N matrix Q.
73*> \endverbatim
74*>
75*> \param[in] LDA
76*> \verbatim
77*> LDA is INTEGER
78*> The first dimension of the array A. LDA >= max(1,M).
79*> \endverbatim
80*>
81*> \param[in] TAU
82*> \verbatim
83*> TAU is COMPLEX array, dimension (K)
84*> TAU(i) must contain the scalar factor of the elementary
85*> reflector H(i), as returned by CGEQLF.
86*> \endverbatim
87*>
88*> \param[out] WORK
89*> \verbatim
90*> WORK is COMPLEX array, dimension (MAX(1,LWORK))
91*> On exit, if INFO = 0, WORK(1) returns the optimal LWORK.
92*> \endverbatim
93*>
94*> \param[in] LWORK
95*> \verbatim
96*> LWORK is INTEGER
97*> The dimension of the array WORK. LWORK >= max(1,N).
98*> For optimum performance LWORK >= N*NB, where NB is the
99*> optimal blocksize.
100*>
101*> If LWORK = -1, then a workspace query is assumed; the routine
102*> only calculates the optimal size of the WORK array, returns
103*> this value as the first entry of the WORK array, and no error
104*> message related to LWORK is issued by XERBLA.
105*> \endverbatim
106*>
107*> \param[out] INFO
108*> \verbatim
109*> INFO is INTEGER
110*> = 0: successful exit
111*> < 0: if INFO = -i, the i-th argument has an illegal value
112*> \endverbatim
113*
114* Authors:
115* ========
116*
117*> \author Univ. of Tennessee
118*> \author Univ. of California Berkeley
119*> \author Univ. of Colorado Denver
120*> \author NAG Ltd.
121*
122*> \ingroup ungql
123*
124* =====================================================================
125 SUBROUTINE cungql( M, N, K, A, LDA, TAU, WORK, LWORK, INFO )
126*
127* -- LAPACK computational routine --
128* -- LAPACK is a software package provided by Univ. of Tennessee, --
129* -- Univ. of California Berkeley, Univ. of Colorado Denver and NAG Ltd..--
130*
131* .. Scalar Arguments ..
132 INTEGER INFO, K, LDA, LWORK, M, N
133* ..
134* .. Array Arguments ..
135 COMPLEX A( LDA, * ), TAU( * ), WORK( * )
136* ..
137*
138* =====================================================================
139*
140* .. Parameters ..
141 COMPLEX ZERO
142 parameter( zero = ( 0.0e+0, 0.0e+0 ) )
143* ..
144* .. Local Scalars ..
145 LOGICAL LQUERY
146 INTEGER I, IB, IINFO, IWS, J, KK, L, LDWORK, LWKOPT,
147 $ NB, NBMIN, NX
148* ..
149* .. External Subroutines ..
150 EXTERNAL clarfb, clarft, cung2l, xerbla
151* ..
152* .. Intrinsic Functions ..
153 INTRINSIC max, min
154* ..
155* .. External Functions ..
156 INTEGER ILAENV
157 REAL SROUNDUP_LWORK
158 EXTERNAL ilaenv, sroundup_lwork
159* ..
160* .. Executable Statements ..
161*
162* Test the input arguments
163*
164 info = 0
165 lquery = ( lwork.EQ.-1 )
166 IF( m.LT.0 ) THEN
167 info = -1
168 ELSE IF( n.LT.0 .OR. n.GT.m ) THEN
169 info = -2
170 ELSE IF( k.LT.0 .OR. k.GT.n ) THEN
171 info = -3
172 ELSE IF( lda.LT.max( 1, m ) ) THEN
173 info = -5
174 END IF
175*
176 IF( info.EQ.0 ) THEN
177 IF( n.EQ.0 ) THEN
178 lwkopt = 1
179 ELSE
180 nb = ilaenv( 1, 'CUNGQL', ' ', m, n, k, -1 )
181 lwkopt = n*nb
182 END IF
183 work( 1 ) = sroundup_lwork(lwkopt)
184*
185 IF( lwork.LT.max( 1, n ) .AND. .NOT.lquery ) THEN
186 info = -8
187 END IF
188 END IF
189*
190 IF( info.NE.0 ) THEN
191 CALL xerbla( 'CUNGQL', -info )
192 RETURN
193 ELSE IF( lquery ) THEN
194 RETURN
195 END IF
196*
197* Quick return if possible
198*
199 IF( n.LE.0 ) THEN
200 RETURN
201 END IF
202*
203 nbmin = 2
204 nx = 0
205 iws = n
206 IF( nb.GT.1 .AND. nb.LT.k ) THEN
207*
208* Determine when to cross over from blocked to unblocked code.
209*
210 nx = max( 0, ilaenv( 3, 'CUNGQL', ' ', m, n, k, -1 ) )
211 IF( nx.LT.k ) THEN
212*
213* Determine if workspace is large enough for blocked code.
214*
215 ldwork = n
216 iws = ldwork*nb
217 IF( lwork.LT.iws ) THEN
218*
219* Not enough workspace to use optimal NB: reduce NB and
220* determine the minimum value of NB.
221*
222 nb = lwork / ldwork
223 nbmin = max( 2, ilaenv( 2, 'CUNGQL', ' ', m, n, k,
224 $ -1 ) )
225 END IF
226 END IF
227 END IF
228*
229 IF( nb.GE.nbmin .AND. nb.LT.k .AND. nx.LT.k ) THEN
230*
231* Use blocked code after the first block.
232* The last kk columns are handled by the block method.
233*
234 kk = min( k, ( ( k-nx+nb-1 ) / nb )*nb )
235*
236* Set A(m-kk+1:m,1:n-kk) to zero.
237*
238 DO 20 j = 1, n - kk
239 DO 10 i = m - kk + 1, m
240 a( i, j ) = zero
241 10 CONTINUE
242 20 CONTINUE
243 ELSE
244 kk = 0
245 END IF
246*
247* Use unblocked code for the first or only block.
248*
249 CALL cung2l( m-kk, n-kk, k-kk, a, lda, tau, work, iinfo )
250*
251 IF( kk.GT.0 ) THEN
252*
253* Use blocked code
254*
255 DO 50 i = k - kk + 1, k, nb
256 ib = min( nb, k-i+1 )
257 IF( n-k+i.GT.1 ) THEN
258*
259* Form the triangular factor of the block reflector
260* H = H(i+ib-1) . . . H(i+1) H(i)
261*
262 CALL clarft( 'Backward', 'Columnwise', m-k+i+ib-1, ib,
263 $ a( 1, n-k+i ), lda, tau( i ), work, ldwork )
264*
265* Apply H to A(1:m-k+i+ib-1,1:n-k+i-1) from the left
266*
267 CALL clarfb( 'Left', 'No transpose', 'Backward',
268 $ 'Columnwise', m-k+i+ib-1, n-k+i-1, ib,
269 $ a( 1, n-k+i ), lda, work, ldwork, a, lda,
270 $ work( ib+1 ), ldwork )
271 END IF
272*
273* Apply H to rows 1:m-k+i+ib-1 of current block
274*
275 CALL cung2l( m-k+i+ib-1, ib, ib, a( 1, n-k+i ), lda,
276 $ tau( i ), work, iinfo )
277*
278* Set rows m-k+i+ib:m of current block to zero
279*
280 DO 40 j = n - k + i, n - k + i + ib - 1
281 DO 30 l = m - k + i + ib, m
282 a( l, j ) = zero
283 30 CONTINUE
284 40 CONTINUE
285 50 CONTINUE
286 END IF
287*
288 work( 1 ) = cmplx( iws )
289 RETURN
290*
291* End of CUNGQL
292*
293 END
subroutine xerbla(srname, info)
Definition cblat2.f:3285
subroutine clarfb(side, trans, direct, storev, m, n, k, v, ldv, t, ldt, c, ldc, work, ldwork)
CLARFB applies a block reflector or its conjugate-transpose to a general rectangular matrix.
Definition clarfb.f:195
recursive subroutine clarft(direct, storev, n, k, v, ldv, tau, t, ldt)
CLARFT forms the triangular factor T of a block reflector H = I - vtvH
Definition clarft.f:162
subroutine cung2l(m, n, k, a, lda, tau, work, info)
CUNG2L generates all or part of the unitary matrix Q from a QL factorization determined by cgeqlf (un...
Definition cung2l.f:112
subroutine cungql(m, n, k, a, lda, tau, work, lwork, info)
CUNGQL
Definition cungql.f:126