NAG Library Routine Document
F08CTF (ZUNGQL)
1 Purpose
F08CTF (ZUNGQL) generates all or part of the complex
by
unitary matrix
from a
factorization computed by
F08CSF (ZGEQLF).
2 Specification
INTEGER |
M, N, K, LDA, LWORK, INFO |
COMPLEX (KIND=nag_wp) |
A(LDA,*), TAU(*), WORK(max(1,LWORK)) |
|
The routine may be called by its
LAPACK
name zungql.
3 Description
F08CTF (ZUNGQL) is intended to be used after a call to
F08CSF (ZGEQLF), which performs a
factorization of a complex matrix
. The unitary matrix
is represented as a product of elementary reflectors.
This routine may be used to generate explicitly as a square matrix, or to form only its trailing columns.
Usually
is determined from the
factorization of an
by
matrix
with
. The whole of
may be computed by:
CALL ZUNGQL(M,M,P,A,LDA,TAU,WORK,LWORK,INFO)
(note that the array
A must have at least
columns) or its trailing
columns by:
CALL ZUNGQL(M,P,P,A,LDA,TAU,WORK,LWORK,INFO)
The columns of
returned by the last call form an orthonormal basis for the space spanned by the columns of
; thus
F08CSF (ZGEQLF) followed by F08CTF (ZUNGQL) can be used to orthogonalize the columns of
.
The information returned by
F08CSF (ZGEQLF) also yields the
factorization of the trailing
columns of
, where
. The unitary matrix arising from this factorization can be computed by:
CALL ZUNGQL(M,M,K,A,LDA,TAU,WORK,LWORK,INFO)
or its trailing
columns by:
CALL ZUNGQL(M,K,K,A,LDA,TAU,WORK,LWORK,INFO)
4 References
Anderson E, Bai Z, Bischof C, Blackford S, Demmel J, Dongarra J J, Du Croz J J, Greenbaum A, Hammarling S, McKenney A and Sorensen D (1999)
LAPACK Users' Guide (3rd Edition) SIAM, Philadelphia
http://www.netlib.org/lapack/lug
Golub G H and Van Loan C F (1996) Matrix Computations (3rd Edition) Johns Hopkins University Press, Baltimore
5 Parameters
- 1: M – INTEGERInput
On entry: , the number of rows of the matrix .
Constraint:
.
- 2: N – INTEGERInput
On entry: , the number of columns of the matrix .
Constraint:
.
- 3: K – INTEGERInput
On entry: , the number of elementary reflectors whose product defines the matrix .
Constraint:
.
- 4: A(LDA,) – COMPLEX (KIND=nag_wp) arrayInput/Output
-
Note: the second dimension of the array
A
must be at least
.
On entry: details of the vectors which define the elementary reflectors, as returned by
F08CSF (ZGEQLF).
On exit: the by matrix .
- 5: LDA – INTEGERInput
On entry: the first dimension of the array
A as declared in the (sub)program from which F08CTF (ZUNGQL) is called.
Constraint:
.
- 6: TAU() – COMPLEX (KIND=nag_wp) arrayInput
-
Note: the dimension of the array
TAU
must be at least
.
On entry: further details of the elementary reflectors, as returned by
F08CSF (ZGEQLF).
- 7: WORK() – COMPLEX (KIND=nag_wp) arrayWorkspace
On exit: if
, the real part of
contains the minimum value of
LWORK required for optimal performance.
- 8: LWORK – INTEGERInput
On entry: the dimension of the array
WORK as declared in the (sub)program from which F08CTF (ZUNGQL) is called.
If
, 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.
Suggested value:
for optimal performance, , where is the optimal block size.
Constraint:
.
- 9: INFO – INTEGEROutput
On exit:
unless the routine detects an error (see
Section 6).
6 Error Indicators and Warnings
Errors or warnings detected by the routine:
If , argument had an illegal value. An explanatory message is output, and execution of the program is terminated.
7 Accuracy
The computed matrix
differs from an exactly unitary matrix by a matrix
such that
where
is the
machine precision.
The total number of real floating point operations is approximately ; when , the number is approximately .
The real analogue of this routine is
F08CFF (DORGQL).
9 Example
This example generates the first four columns of the matrix
of the
factorization of
as returned by
F08CSF (ZGEQLF), where
Note that the block size (NB) of assumed in this example is not realistic for such a small problem, but should be suitable for large problems.
9.1 Program Text
Program Text (f08ctfe.f90)
9.2 Program Data
Program Data (f08ctfe.d)
9.3 Program Results
Program Results (f08ctfe.r)