NAG Library Routine Document
f08csf (zgeqlf)
1
Purpose
f08csf (zgeqlf) computes a factorization of a complex by matrix .
2
Specification
Fortran Interface
Integer, Intent (In) | :: | m, n, lda, lwork | Integer, Intent (Out) | :: | info | Complex (Kind=nag_wp), Intent (Inout) | :: | a(lda,*), tau(*) | Complex (Kind=nag_wp), Intent (Out) | :: | work(max(1,lwork)) |
|
C Header Interface
#include <nagmk26.h>
void |
f08csf_ (const Integer *m, const Integer *n, Complex a[], const Integer *lda, Complex tau[], Complex work[], const Integer *lwork, Integer *info) |
|
The routine may be called by its
LAPACK
name zgeqlf.
3
Description
f08csf (zgeqlf) forms the factorization of an arbitrary rectangular complex by matrix.
If
, the factorization is given by:
where
is an
by
lower triangular matrix and
is an
by
unitary matrix. If
the factorization is given by
where
is an
by
lower trapezoidal matrix and
is again an
by
unitary matrix. In the case where
the factorization can be expressed as
where
consists of the first
columns of
, and
the remaining
columns.
The matrix
is not formed explicitly but is represented as a product of
elementary reflectors (see
Section 3.3.6 in the F08 Chapter Introduction for details). Routines are provided to work with
in this representation (see
Section 9).
Note also that for any
, the information returned in the last
columns of the array
a represents a
factorization of the last
columns of the original matrix
.
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
Arguments
- 1: – IntegerInput
-
On entry: , the number of rows of the matrix .
Constraint:
.
- 2: – IntegerInput
-
On entry: , the number of columns of the matrix .
Constraint:
.
- 3: – Complex (Kind=nag_wp) arrayInput/Output
-
Note: the second dimension of the array
a
must be at least
.
On entry: the by matrix .
On exit: if
, the lower triangle of the subarray
contains the
by
lower triangular matrix
.
If
, the elements on and below the
th superdiagonal contain the
by
lower trapezoidal matrix
. The remaining elements, with the array
tau, represent the unitary matrix
as a product of elementary reflectors (see
Section 3.3.6 in the F08 Chapter Introduction).
- 4: – IntegerInput
-
On entry: the first dimension of the array
a as declared in the (sub)program from which
f08csf (zgeqlf) is called.
Constraint:
.
- 5: – Complex (Kind=nag_wp) arrayOutput
-
Note: the dimension of the array
tau
must be at least
.
On exit: the scalar factors of the elementary reflectors (see
Section 9).
- 6: – Complex (Kind=nag_wp) arrayWorkspace
-
On exit: if
, the real part of
contains the minimum value of
lwork required for optimal performance.
- 7: – IntegerInput
-
On entry: the dimension of the array
work as declared in the (sub)program from which
f08csf (zgeqlf) 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:
.
- 8: – IntegerOutput
On exit:
unless the routine detects an error (see
Section 6).
6
Error Indicators and Warnings
If , argument had an illegal value. An explanatory message is output, and execution of the program is terminated.
7
Accuracy
The computed factorization is the exact factorization of a nearby matrix
, where
and
is the
machine precision.
8
Parallelism and Performance
f08csf (zgeqlf) makes calls to BLAS and/or LAPACK routines, which may be threaded within the vendor library used by this implementation. Consult the documentation for the vendor library for further information.
Please consult the
X06 Chapter Introduction for information on how to control and interrogate the OpenMP environment used within this routine. Please also consult the
Users' Note for your implementation for any additional implementation-specific information.
The total number of real floating-point operations is approximately if or if .
To form the unitary matrix
f08csf (zgeqlf) may be followed by a call to
f08ctf (zungql):
Call zungql(m,m,min(m,n),a,lda,tau,work,lwork,info)
but note that the second dimension of the array
a must be at least
m, which may be larger than was required by
f08csf (zgeqlf).
When
, it is often only the first
columns of
that are required, and they may be formed by the call:
Call zungql(m,n,n,a,lda,tau,work,lwork,info)
To apply
to an arbitrary complex rectangular matrix
,
f08csf (zgeqlf) may be followed by a call to
f08cuf (zunmql). For example,
Call zunmql('Left','Conjugate Transpose',m,p,min(m,n),a,lda,tau, &
c,ldc,work,lwork,info)
forms
, where
is
by
.
The real analogue of this routine is
f08cef (dgeqlf).
10
Example
This example solves the linear least squares problems
for
and
, where
is the
th column of the matrix
,
and
The solution is obtained by first obtaining a factorization of the matrix .
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.
10.1
Program Text
Program Text (f08csfe.f90)
10.2
Program Data
Program Data (f08csfe.d)
10.3
Program Results
Program Results (f08csfe.r)