NAG C Library Function Document

nag_zggqrf (f08zsc)

1
Purpose

nag_zggqrf (f08zsc) computes a generalized QR factorization of a complex matrix pair A,B, where A is an n by m matrix and B is an n by p matrix.

2
Specification

#include <nag.h>
#include <nagf08.h>
void  nag_zggqrf (Nag_OrderType order, Integer n, Integer m, Integer p, Complex a[], Integer pda, Complex taua[], Complex b[], Integer pdb, Complex taub[], NagError *fail)

3
Description

nag_zggqrf (f08zsc) forms the generalized QR factorization of an n by m matrix A and an n by p matrix B 
A =QR ,   B=QTZ ,  
where Q is an n by n unitary matrix, Z is a p by p unitary matrix and R and T are of the form
R = mmR11n-m0() ,   if ​nm; nm-nnR11R12() ,   if ​n<m,  
with R11 upper triangular,
T = p-nnn0T12() ,   if ​np, pn-pT11pT21() ,   if ​n>p,  
with T12 or T21 upper triangular.
In particular, if B is square and nonsingular, the generalized QR factorization of A and B implicitly gives the QR factorization of B-1A as
B-1A= ZH T-1 R .  

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
Anderson E, Bai Z and Dongarra J (1992) Generalized QR factorization and its applications Linear Algebra Appl. (Volume 162–164) 243–271
Hammarling S (1987) The numerical solution of the general Gauss-Markov linear model Mathematics in Signal Processing (eds T S Durrani, J B Abbiss, J E Hudson, R N Madan, J G McWhirter and T A Moore) 441–456 Oxford University Press
Paige C C (1990) Some aspects of generalized QR factorizations . In Reliable Numerical Computation (eds M G Cox and S Hammarling) 73–91 Oxford University Press

5
Arguments

1:     order Nag_OrderTypeInput
On entry: the order argument specifies the two-dimensional storage scheme being used, i.e., row-major ordering or column-major ordering. C language defined storage is specified by order=Nag_RowMajor. See Section 3.3.1.3 in How to Use the NAG Library and its Documentation for a more detailed explanation of the use of this argument.
Constraint: order=Nag_RowMajor or Nag_ColMajor.
2:     n IntegerInput
On entry: n, the number of rows of the matrices A and B.
Constraint: n0.
3:     m IntegerInput
On entry: m, the number of columns of the matrix A.
Constraint: m0.
4:     p IntegerInput
On entry: p, the number of columns of the matrix B.
Constraint: p0.
5:     a[dim] ComplexInput/Output
Note: the dimension, dim, of the array a must be at least
  • max1,pda×m when order=Nag_ColMajor;
  • max1,n×pda when order=Nag_RowMajor.
The i,jth element of the matrix A is stored in
  • a[j-1×pda+i-1] when order=Nag_ColMajor;
  • a[i-1×pda+j-1] when order=Nag_RowMajor.
On entry: the n by m matrix A.
On exit: the elements on and above the diagonal of the array contain the minn,m by m upper trapezoidal matrix R (R is upper triangular if nm); the elements below the diagonal, with the array taua, represent the unitary matrix Q as a product of minn,m elementary reflectors (see Section 3.3.6 in the f08 Chapter Introduction).
6:     pda IntegerInput
On entry: the stride separating row or column elements (depending on the value of order) in the array a.
Constraints:
  • if order=Nag_ColMajor, pdamax1,n;
  • if order=Nag_RowMajor, pdamax1,m.
7:     taua[minn,m] ComplexOutput
On exit: the scalar factors of the elementary reflectors which represent the unitary matrix Q.
8:     b[dim] ComplexInput/Output
Note: the dimension, dim, of the array b must be at least
  • max1,pdb×p when order=Nag_ColMajor;
  • max1,n×pdb when order=Nag_RowMajor.
Where Bi,j appears in this document, it refers to the array element
  • b[j-1×pdb+i-1] when order=Nag_ColMajor;
  • b[i-1×pdb+j-1] when order=Nag_RowMajor.
On entry: the n by p matrix B.
On exit: if np, the upper triangle of the subarray B1:n,p-n+1:p  contains the n by n upper triangular matrix T12.
If n>p, the elements on and above the n-pth subdiagonal contain the n by p upper trapezoidal matrix T; the remaining elements, with the array taub, represent the unitary matrix Z as a product of elementary reflectors (see Section 3.3.6 in the f08 Chapter Introduction).
9:     pdb IntegerInput
On entry: the stride separating row or column elements (depending on the value of order) in the array b.
Constraints:
  • if order=Nag_ColMajor, pdbmax1,n;
  • if order=Nag_RowMajor, pdbmax1,p.
10:   taub[minn,p] ComplexOutput
On exit: the scalar factors of the elementary reflectors which represent the unitary matrix Z.
11:   fail NagError *Input/Output
The NAG error argument (see Section 3.7 in How to Use the NAG Library and its Documentation).

6
Error Indicators and Warnings

NE_ALLOC_FAIL
Dynamic memory allocation failed.
See Section 2.3.1.2 in How to Use the NAG Library and its Documentation for further information.
NE_BAD_PARAM
On entry, argument value had an illegal value.
NE_INT
On entry, m=value.
Constraint: m0.
On entry, n=value.
Constraint: n0.
On entry, p=value.
Constraint: p0.
On entry, pda=value.
Constraint: pda>0.
On entry, pdb=value.
Constraint: pdb>0.
NE_INT_2
On entry, pda=value and m=value.
Constraint: pdamax1,m.
On entry, pda=value and n=value.
Constraint: pdamax1,n.
On entry, pdb=value and n=value.
Constraint: pdbmax1,n.
On entry, pdb=value and p=value.
Constraint: pdbmax1,p.
NE_INTERNAL_ERROR
An internal error has occurred in this function. Check the function call and any array sizes. If the call is correct then please contact NAG for assistance.
See Section 2.7.6 in How to Use the NAG Library and its Documentation for further information.
NE_NO_LICENCE
Your licence key may have expired or may not have been installed correctly.
See Section 2.7.5 in How to Use the NAG Library and its Documentation for further information.

7
Accuracy

The computed generalized QR factorization is the exact factorization for nearby matrices A+E and B+F, where
E2 = Oε A2   and   F2= Oε B2 ,  
and ε is the machine precision.

8
Parallelism and Performance

nag_zggqrf (f08zsc) is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.
nag_zggqrf (f08zsc) 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 function. Please also consult the Users' Note for your implementation for any additional implementation-specific information.

9
Further Comments

The unitary matrices Q and Z may be formed explicitly by calls to nag_zungqr (f08atc) and nag_zungrq (f08cwc) respectively. nag_zunmqr (f08auc) may be used to multiply Q by another matrix and nag_zunmrq (f08cxc) may be used to multiply Z by another matrix.
The real analogue of this function is nag_dggqrf (f08zec).

10
Example

This example solves the general Gauss–Markov linear model problem
minx y2   subject to   d=Ax+By  
where
A = 0.96-0.81i -0.03+0.96i -0.91+2.06i -0.98+1.98i -1.20+0.19i -0.66+0.42i 0.62-0.46i 1.01+0.02i 0.63-0.17i 1.08-0.28i 0.20-0.12i -0.07+1.23i ,  
B = 0.5-1.0i 0.0i+0.0 0.0i+0.0 0.0i+0.0 0.0i+0.0 1.0-2.0i 0.0i+0.0 0.0i+0.0 0.0i+0.0 0.0i+0.0 2.0-3.0i 0.0i+0.0 0.0i+0.0 0.0i+0.0 0.0i+0.0 5.0-4.0i  
and
d = 6.00-0.40i -5.27+0.90i 2.72-2.13i -1.30-2.80i .  
The solution is obtained by first computing a generalized QR factorization of the matrix pair A,B. The example illustrates the general solution process, although the above data corresponds to a simple weighted least squares problem.

10.1
Program Text

Program Text (f08zsce.c)

10.2
Program Data

Program Data (f08zsce.d)

10.3
Program Results

Program Results (f08zsce.r)