NAG FL Interface
f08apf (zgeqrt)

Settings help

FL Name Style:


FL Specification Language:


1 Purpose

f08apf recursively computes, with explicit blocking, the QR factorization of a complex m×n matrix.

2 Specification

Fortran Interface
Subroutine f08apf ( m, n, nb, a, lda, t, ldt, work, info)
Integer, Intent (In) :: m, n, nb, lda, ldt
Integer, Intent (Out) :: info
Complex (Kind=nag_wp), Intent (Inout) :: a(lda,*), t(ldt,*)
Complex (Kind=nag_wp), Intent (Out) :: work(nb*n)
C Header Interface
#include <nag.h>
void  f08apf_ (const Integer *m, const Integer *n, const Integer *nb, Complex a[], const Integer *lda, Complex t[], const Integer *ldt, Complex work[], Integer *info)
The routine may be called by the names f08apf, nagf_lapackeig_zgeqrt or its LAPACK name zgeqrt.

3 Description

f08apf forms the QR factorization of an arbitrary rectangular complex m×n matrix. No pivoting is performed.
It differs from f08asf in that it: requires an explicit block size; stores reflector factors that are upper triangular matrices of the chosen block size (rather than scalars); and recursively computes the QR factorization based on the algorithm of Elmroth and Gustavson (2000).
If mn, the factorization is given by:
A = Q ( R 0 ) ,  
where R is an n×n upper triangular matrix (with real diagonal elements) and Q is an m×m unitary matrix. It is sometimes more convenient to write the factorization as
A = ( Q1 Q2 ) ( R 0 ) ,  
which reduces to
A = Q1 R ,  
where Q1 consists of the first n columns of Q, and Q2 the remaining m-n columns.
If m<n, R is upper trapezoidal, and the factorization can be written
A = 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 min(m,n) elementary reflectors (see the F08 Chapter Introduction for details). Routines are provided to work with Q in this representation (see Section 9).
Note also that for any k<n, the information returned represents a QR factorization of the first k columns of the original matrix A.

4 References

Elmroth E and Gustavson F (2000) Applying Recursion to Serial and Parallel QR Factorization Leads to Better Performance IBM Journal of Research and Development. (Volume 44) 4 605–624
Golub G H and Van Loan C F (2012) Matrix Computations (4th Edition) Johns Hopkins University Press, Baltimore

5 Arguments

1: m Integer Input
On entry: m, the number of rows of the matrix A.
Constraint: m0.
2: n Integer Input
On entry: n, the number of columns of the matrix A.
Constraint: n0.
3: nb Integer Input
On entry: the explicitly chosen block size to be used in computing the QR factorization. See Section 9 for details.
Constraint: if min(m,n)>0, 1nbmin(m,n).
4: a(lda,*) Complex (Kind=nag_wp) array Input/Output
Note: the second dimension of the array a must be at least max(1,n).
On entry: the m×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×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×n upper trapezoidal matrix R.
The diagonal elements of R are real.
5: lda Integer Input
On entry: the first dimension of the array a as declared in the (sub)program from which f08apf is called.
Constraint: ldamax(1,m).
6: t(ldt,*) Complex (Kind=nag_wp) array Output
Note: the second dimension of the array t must be at least max(1,min(m,n)).
On exit: further details of the unitary matrix Q. The number of blocks is b=knb, where k=min(m,n) and each block is of order nb except for the last block, which is of order k-(b-1)×nb. For each of the blocks, an upper triangular block reflector factor is computed: T1,T2,,Tb. These are stored in the nb×n matrix T as T=[T1|T2||Tb].
7: ldt Integer Input
On entry: the first dimension of the array t as declared in the (sub)program from which f08apf is called.
Constraint: ldtnb.
8: work(nb×n) Complex (Kind=nag_wp) array Workspace
9: info Integer Output
On exit: info=0 unless the routine detects an error (see Section 6).

6 Error Indicators and Warnings

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 Parallelism and Performance

f08apf 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.

9 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 apply Q to an arbitrary m×p complex rectangular matrix C, f08apf may be followed by a call to f08aqf . For example,
Call zgemqrt('Left','Conjugate Transpose',m,p,min(m,n),nb,a,lda, &
              t,ldt,c,ldc,work,info)
forms the matrix product C=QHC.
To form the unitary matrix Q explicitly, simply initialize the m×m matrix C to the identity matrix and form C=QC using f08aqf as above.
The block size, nb, used by f08apf is supplied explicitly through the interface. For moderate and large sizes of matrix, the block size can have a marked effect on the efficiency of the algorithm with the optimal value being dependent on problem size and platform. A value of nb=64min(m,n) is likely to achieve good efficiency and it is unlikely that an optimal value would exceed 340.
To compute a QR factorization with column pivoting, use f08bpf or f08btf.
The real analogue of this routine is f08abf.

10 Example

This example solves the linear least squares problems
minimizeAxi-bi2 ,   i=1,2  
where b1 and b2 are the columns of the matrix B,
A = ( 0.96-0.81i -0.03+0.96i -0.91+2.06i -0.05+0.41i -0.98+1.98i -1.20+0.19i -0.66+0.42i -0.81+0.56i 0.62-0.46i 1.01+0.02i 0.63-0.17i -1.11+0.60i -0.37+0.38i 0.19-0.54i -0.98-0.36i 0.22-0.20i 0.83+0.51i 0.20+0.01i -0.17-0.46i 1.47+1.59i 1.08-0.28i 0.20-0.12i -0.07+1.23i 0.26+0.26i )  
and
B = ( -2.09+1.93i 3.26-2.70i 3.34-3.53i -6.22+1.16i -4.94-2.04i 7.94-3.13i 0.17+4.23i 1.04-4.26i -5.19+3.63i -2.31-2.12i 0.98+2.53i -1.39-4.05i ) .  

10.1 Program Text

Program Text (f08apfe.f90)

10.2 Program Data

Program Data (f08apfe.d)

10.3 Program Results

Program Results (f08apfe.r)