F08BTF (ZGEQP3) (PDF version)
F08 Chapter Contents
F08 Chapter Introduction
NAG Library Manual

NAG Library Routine Document

F08BTF (ZGEQP3)

Note:  before using this routine, please read the Users' Note for your implementation to check the interpretation of bold italicised terms and other implementation-dependent details.

+ Contents

    1  Purpose
    7  Accuracy

1  Purpose

F08BTF (ZGEQP3) computes the QR factorization, with column pivoting, of a complex m by n matrix.

2  Specification

SUBROUTINE F08BTF ( M, N, A, LDA, JPVT, TAU, WORK, LWORK, RWORK, INFO)
INTEGER  M, N, LDA, JPVT(*), LWORK, INFO
REAL (KIND=nag_wp)  RWORK(*)
COMPLEX (KIND=nag_wp)  A(LDA,*), TAU(*), WORK(max(1,LWORK))
The routine may be called by its LAPACK name zgeqp3.

3  Description

F08BTF (ZGEQP3) forms the QR factorization, with column pivoting, of an arbitrary rectangular complex m by n matrix.
If mn, the factorization is given by:
AP= Q R 0 ,
where R is an n by n upper triangular matrix (with real diagonal elements), Q is an m by m unitary matrix and P is an n by n permutation matrix. It is sometimes more convenient to write the factorization as
AP= Q1 Q2 R 0 ,
which reduces to
AP= Q1 R ,
where Q1 consists of the first n columns of Q, and Q2 the remaining m-n columns.
If m<n, R is trapezoidal, and the factorization can be written
AP= Q R1 R2 ,
where R1 is upper triangular and R2 is rectangular.
The matrix Q is not formed explicitly but is represented as a product of minm,n elementary reflectors (see the F08 Chapter Introduction for details). Routines are provided to work with Q in this representation (see Section 8).
Note also that for any k<n, the information returned in the first k columns of the array A represents a QR factorization of the first k columns of the permuted matrix AP.
The routine allows specified columns of A to be moved to the leading columns of AP at the start of the factorization and fixed there. The remaining columns are free to be interchanged so that at the ith stage the pivot column is chosen to be the column which maximizes the 2-norm of elements i to m over columns i to n.

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: m, the number of rows of the matrix A.
Constraint: M0.
2:     N – INTEGERInput
On entry: n, the number of columns of the matrix A.
Constraint: N0.
3:     A(LDA,*) – COMPLEX (KIND=nag_wp) arrayInput/Output
Note: the second dimension of the array A must be at least max1,N.
On entry: the m by n matrix A.
On exit: if mn, the elements below the diagonal are overwritten by details of the unitary matrix Q and the upper triangle is overwritten by the corresponding elements of the n by n upper triangular matrix R.
If m<n, the strictly lower triangular part is overwritten by details of the unitary matrix Q and the remaining elements are overwritten by the corresponding elements of the m by n upper trapezoidal matrix R.
The diagonal elements of R are real.
4:     LDA – INTEGERInput
On entry: the first dimension of the array A as declared in the (sub)program from which F08BTF (ZGEQP3) is called.
Constraint: LDAmax1,M.
5:     JPVT(*) – INTEGER arrayInput/Output
Note: the dimension of the array JPVT must be at least max1,N.
On entry: if JPVTj0, then the jth column of A is moved to the beginning of AP before the decomposition is computed and is fixed in place during the computation. Otherwise, the jth column of A 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 P. More precisely, if JPVTj=k, then the kth column of A is moved to become the jth column of AP; in other words, the columns of AP are the columns of A in the order JPVT1,JPVT2,,JPVTn.
6:     TAU(*) – COMPLEX (KIND=nag_wp) arrayOutput
Note: the dimension of the array TAU must be at least max1,minM,N.
On exit: further details of the unitary matrix Q.
7:     WORK(max1,LWORK) – COMPLEX (KIND=nag_wp) arrayWorkspace
8:     LWORK – INTEGERInput
On entry: the dimension of the array WORK as declared in the (sub)program from which F08BTF (ZGEQP3) is called.
If LWORK=-1, 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, LWORKN+1×nb, where nb is the optimal block size.
Constraint: LWORKN+1 or LWORK=-1.
9:     RWORK(*) – REAL (KIND=nag_wp) arrayWorkspace
Note: the dimension of the array RWORK must be at least max1,2×N.
10:   INFO – INTEGEROutput

6  Error Indicators and Warnings

Errors or warnings detected by the routine:
INFO<0
If INFO=-i, argument i 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 A+E, where
E2 = Oε A2 ,
and ε is the machine precision.

8  Further Comments

The total number of real floating point operations is approximately 83 n2 3m-n  if mn or 83 m2 3n-m  if m<n.
To form the unitary matrix Q 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 mn, it is often only the first n columns of Q that are required, and they may be formed by the call:
 CALL ZUNGQR(M,N,N,A,LDA,TAU,WORK,LWORK,INFO)
To apply Q to an arbitrary complex rectangular matrix C, 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 C=QHC, where C is m by p.
To compute a QR factorization without column pivoting, use F08ASF (ZGEQRF).
The real analogue of this routine is F08BFF (DGEQP3).

9  Example

This example solves the linear least squares problems
minx bj - Axj 2 ,   j=1,2
for the basic solutions x1 and x2, where
A = 0.47-0.34i -0.40+0.54i 0.60+0.01i 0.80-1.02i -0.32-0.23i -0.05+0.20i -0.26-0.44i -0.43+0.17i 0.35-0.60i -0.52-0.34i 0.87-0.11i -0.34-0.09i 0.89+0.71i -0.45-0.45i -0.02-0.57i 1.14-0.78i -0.19+0.06i 0.11-0.85i 1.44+0.80i 0.07+1.14i
and
B = -1.08-2.59i 2.22+2.35i -2.61-1.49i 1.62-1.48i 3.13-3.61i 1.65+3.43i 7.33-8.01i -0.98+3.08i 9.12+7.63i -2.84+2.78i .
and bj is the jth column of the matrix B. The solution is obtained by first obtaining a QR factorization with column pivoting of the matrix A. A tolerance of 0.01 is used to estimate the rank of A from the upper triangular factor, R.
Note that the block size (NB) of 64 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 (f08btfe.f90)

9.2  Program Data

Program Data (f08btfe.d)

9.3  Program Results

Program Results (f08btfe.r)


F08BTF (ZGEQP3) (PDF version)
F08 Chapter Contents
F08 Chapter Introduction
NAG Library Manual

© The Numerical Algorithms Group Ltd, Oxford, UK. 2011