NAG Library Routine Document

f01rgf (complex_trapez_rq)


    1  Purpose
    7  Accuracy


f01rgf reduces the complex m by n (mn) upper trapezoidal matrix A to upper triangular form by means of unitary transformations.


Fortran Interface
Subroutine f01rgf ( m, n, a, lda, theta, ifail)
Integer, Intent (In):: m, n, lda
Integer, Intent (Inout):: ifail
Complex (Kind=nag_wp), Intent (Inout):: a(lda,*)
Complex (Kind=nag_wp), Intent (Out):: theta(m)
C Header Interface
#include nagmk26.h
void  f01rgf_ (const Integer *m, const Integer *n, Complex a[], const Integer *lda, Complex theta[], Integer *ifail)


The m by nmn upper trapezoidal matrix A given by
A= U X ,  
where U is an m by m upper triangular matrix, is factorized as
A= R 0 PH,  
where P is an n by n unitary matrix and R is an m by m upper triangular matrix.
P is given as a sequence of Householder transformation matrices
the m-k+1th transformation matrix, Pk, being used to introduce zeros into the kth row of A. Pk has the form
Pk= I 0 0 Tk ,  
Tk=I-γkukukH, uk= ζk 0 zk cr ,  
γk is a scalar for which Reγk=1.0, ζk is a real scalar and zk is an n-m element vector. γk, ζk and zk are chosen to annihilate the elements of the kth row of X and to make the diagonal elements of R real.
The scalar γk and the vector uk are returned in the kth element of the array theta and in the kth row of a, such that θk, given by
is in thetak and the elements of zk are in akm+1,,akn. The elements of R are returned in the upper triangular part of a.
For further information on this factorization and its use see Section 6.5 of Golub and Van Loan (1996).


Golub G H and Van Loan C F (1996) Matrix Computations (3rd Edition) Johns Hopkins University Press, Baltimore
Wilkinson J H (1965) The Algebraic Eigenvalue Problem Oxford University Press, Oxford


1:     m – IntegerInput
On entry: m, the number of rows of the matrix A.
When m=0 then an immediate return is effected.
Constraint: m0.
2:     n – IntegerInput
On entry: n, the number of columns of the matrix A.
Constraint: nm.
3:     alda* – Complex (Kind=nag_wp) arrayInput/Output
Note: the second dimension of the array a must be at least max1,n.
On entry: the leading m by n upper trapezoidal part of the array a must contain the matrix to be factorized.
On exit: the m by m upper triangular part of a will contain the upper triangular matrix R, and the m by n-m upper trapezoidal part of a will contain details of the factorization as described in Section 3.
4:     lda – IntegerInput
On entry: the first dimension of the array a as declared in the (sub)program from which f01rgf is called.
Constraint: ldamax1,m.
5:     thetam – Complex (Kind=nag_wp) arrayOutput
On exit: thetak contains the scalar θk for the m-k+1th transformation. If Tk=I then thetak=0.0; if
Tk= α 0 0 I ,  Reα<0.0  
then thetak=α, otherwise thetak contains θk as described in Section 3 and Reθk is always in the range 1.0,2.0.
6:     ifail – IntegerInput/Output
On entry: ifail must be set to 0, -1​ or ​1. If you are unfamiliar with this argument you should refer to Section 3.4 in How to Use the NAG Library and its Documentation for details.
For environments where it might be inappropriate to halt program execution when an error is detected, the value -1​ or ​1 is recommended. If the output of error messages is undesirable, then the value 1 is recommended. Otherwise, if you are not familiar with this argument, the recommended value is 0. When the value -1​ or ​1 is used it is essential to test the value of ifail on exit.
On exit: ifail=0 unless the routine detects an error or a warning has been flagged (see Section 6).

Error Indicators and Warnings

If on entry ifail=0 or -1, explanatory error messages are output on the current error message unit (as defined by x04aaf).
Errors or warnings detected by the routine:
On entry,m<0,
An unexpected error has been triggered by this routine. Please contact NAG.
See Section 3.9 in How to Use the NAG Library and its Documentation for further information.
Your licence key may have expired or may not have been installed correctly.
See Section 3.8 in How to Use the NAG Library and its Documentation for further information.
Dynamic memory allocation failed.
See Section 3.7 in How to Use the NAG Library and its Documentation for further information.


The computed factors R and P satisfy the relation
R 0 PH=A+E,  
Ecε A,  
ε is the machine precision (see x02ajf), c is a modest function of m and n, and . denotes the spectral (two) norm.

Parallelism and Performance

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

Further Comments

The approximate number of floating-point operations is given by 8×m2n-m.


This example reduces the 3 by 4 matrix
2.4 0.8+0.8i -1.4+0.6i 3.0-1.0i 0.0 1.6i+0.0 0.8+0.3i 0.4+0.5i 0.0 0.0i+0.0 1.0i+0.0 2.0-1.0i  
to upper triangular form.

Program Text

Program Text (f01rgfe.f90)

Program Data

Program Data (f01rgfe.d)

Program Results

Program Results (f01rgfe.r)

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