NAG Library Routine Document
f08btf
(zgeqp3)
1
Purpose
f08btf (zgeqp3) computes the factorization, with column pivoting, of a complex by matrix.
2
Specification
Fortran Interface
Integer, Intent (In) | :: |
m,
n,
lda,
lwork | Integer, Intent (Inout) | :: |
jpvt(*) | Integer, Intent (Out) | :: |
info | Real (Kind=nag_wp), Intent (Inout) | :: |
rwork(*) | 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 |
f08btf_ (
const Integer *m,
const Integer *n,
Complex a[],
const Integer *lda,
Integer jpvt[],
Complex tau[],
Complex work[],
const Integer *lwork,
double rwork[],
Integer *info) |
|
The routine may be called by its
LAPACK
name zgeqp3.
3
Description
f08btf (zgeqp3) forms the factorization, with column pivoting, of an arbitrary rectangular complex by matrix.
If
, the factorization is given by:
where
is an
by
upper triangular matrix (with real diagonal elements),
is an
by
unitary matrix and
is an
by
permutation matrix. It is sometimes more convenient to write the factorization as
which reduces to
where
consists of the first
columns of
, and
the remaining
columns.
If
,
is trapezoidal, and the factorization can be written
where
is upper triangular and
is rectangular.
The matrix
is not formed explicitly but is represented as a product of
elementary reflectors (see 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 first
columns of the array
a represents a
factorization of the first
columns of the permuted matrix
.
The routine allows specified columns of to be moved to the leading columns of at the start of the factorization and fixed there. The remaining columns are free to be interchanged so that at the th stage the pivot column is chosen to be the column which maximizes the -norm of elements to over columns to .
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 elements below the diagonal are overwritten by details of the unitary matrix
and the upper triangle is overwritten by the corresponding elements of the
by
upper triangular matrix
.
If , the strictly lower triangular part is overwritten by details of the unitary matrix and the remaining elements are overwritten by the corresponding elements of the by upper trapezoidal matrix .
The diagonal elements of are real.
- 4: – IntegerInput
-
On entry: the first dimension of the array
a as declared in the (sub)program from which
f08btf (zgeqp3) is called.
Constraint:
.
- 5: – Integer arrayInput/Output
-
Note: the dimension of the array
jpvt
must be at least
.
On entry: if , the th column of is moved to the beginning of before the decomposition is computed and is fixed in place during the computation. Otherwise, the th column of is a free column (i.e., one which may be interchanged during the computation with any other free column).
On exit: details of the permutation matrix . More precisely, if , the th column of is moved to become the th column of ; in other words, the columns of are the columns of in the order .
- 6: – Complex (Kind=nag_wp) arrayOutput
-
Note: the dimension of the array
tau
must be at least
.
On exit: further details of the unitary matrix .
- 7: – Complex (Kind=nag_wp) arrayWorkspace
-
On exit: if
, the real part of
contains the minimum value of
lwork required for optimal performance.
- 8: – IntegerInput
-
On entry: the dimension of the array
work as declared in the (sub)program from which
f08btf (zgeqp3) 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:
or .
- 9: – Real (Kind=nag_wp) arrayWorkspace
-
Note: the dimension of the array
rwork
must be at least
.
- 10: – 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
f08btf (zgeqp3) is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.
f08btf (zgeqp3) 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
f08btf (zgeqp3) may be followed by a call to
f08atf (zungqr):
Call ZUNGQR(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
f08btf (zgeqp3).
When
, it is often only the first
columns of
that are required, and they may be formed by the call:
Call ZUNGQR(m,n,n,a,lda,tau,work,lwork,info)
To apply
to an arbitrary complex rectangular matrix
,
f08btf (zgeqp3) may be followed by a call to
f08auf (zunmqr). For example,
Call ZUNMQR('Left','Conjugate Transpose',m,p,min(m,n),a,lda,tau, &
c,ldc,work,lwork,info)
forms
, where
is
by
.
To compute a
factorization without column pivoting, use
f08asf (zgeqrf).
The real analogue of this routine is
f08bff (dgeqp3).
10
Example
This example solves the linear least squares problems
for the basic solutions
and
, where
and
and
is the
th column of the matrix
. The solution is obtained by first obtaining a
factorization with column pivoting of the matrix
. A tolerance of
is used to estimate the rank of
from the upper triangular factor,
.
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 (f08btfe.f90)
10.2
Program Data
Program Data (f08btfe.d)
10.3
Program Results
Program Results (f08btfe.r)