Integer, Intent (In)	::	m, n, lda, lwork
Integer, Intent (Out)	::	info
Complex (Kind=nag_wp), Intent (Inout)	::	a(lda,), tau()
Complex (Kind=nag_wp), Intent (Out)	::	work(max(1,lwork))

C Header Interface

#include <nag.h>

void	f08csf_ (const Integer m, const Integer n, Complex a[], const Integer lda, Complex tau[], Complex work[], const Integer lwork, Integer *info)

The routine may be called by the names f08csf, nagf_lapackeig_zgeqlf or its LAPACK name zgeqlf.

3 Description

f08csf forms the

Q L

factorization of an arbitrary rectangular complex

m

n

matrix.

m \geq n

, the factorization is given by:

A = Q (\begin{array}{r} 0 \\ L \end{array}),

where

L

is an

n

n

lower triangular matrix and

Q

is an

m

m

unitary matrix. If

m < n

the factorization is given by

A = Q L,

where

L

is an

m

n

lower trapezoidal matrix and

Q

is again an

m

m

unitary matrix. In the case where

m > n

the factorization can be expressed as

A = (\begin{array}{r} Q_{1} & Q_{2} \end{array}) (\begin{array}{r} 0 \\ L \end{array}) = Q_{2} L,

where

Q_{1}

consists of the first

m - n

columns of

Q

, and

Q_{2}

the remaining

n

columns.

The matrix

Q

is not formed explicitly but is represented as a product of

\min (m, n)

elementary reflectors (see Section 3.3.6 in 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 in the last

k

columns of the array a represents a

Q L

factorization of the last

k

columns of the original matrix

A

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 https://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: $m$ – Integer Input: On entry: $m$ , the number of rows of the matrix $A$ .

Constraint: $m \geq 0$ .
2: $n$ – Integer Input: On entry: $n$ , the number of columns of the matrix $A$ .

Constraint: $n \geq 0$ .
3: $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$ by $n$ matrix $A$ .

On exit: if $m \geq n$ , the lower triangle of the subarray $a (m - n + 1 : m, 1 : n)$ contains the $n$ by $n$ lower triangular matrix $L$ .
If $m \leq n$ , the elements on and below the $(n - m)$ th superdiagonal contain the $m$ by $n$ lower trapezoidal matrix $L$ . The remaining elements, with the array tau, represent the unitary matrix $Q$ as a product of elementary reflectors (see Section 3.3.6 in the F08 Chapter Introduction).
4: $lda$ – Integer Input: On entry: the first dimension of the array a as declared in the (sub)program from which f08csf is called.

Constraint: $lda \geq \max (1, m)$ .
5: $tau (*)$ – Complex (Kind=nag_wp) array Output: Note: the dimension of the array tau must be at least $\max (1, \min (m, n))$ .

On exit: the scalar factors of the elementary reflectors (see Section 9).
6: $work (\max (1, lwork))$ – Complex (Kind=nag_wp) array Workspace: On exit: if $info = 0$ , the real part of $work (1)$ contains the minimum value of lwork required for optimal performance.
7: $lwork$ – Integer Input: On entry: the dimension of the array work as declared in the (sub)program from which f08csf 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, $lwork \geq n \times nb$ , where $nb$ is the optimal block size.

Constraint: $lwork \geq \max (1, n)$ .
8: $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

{‖E‖}_{2} = O (ε) {‖A‖}_{2},

and

ε

is the machine precision.

8 Parallelism and Performance

f08csf 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

\frac{8}{3} n^{2} (3 m - n)

m \geq n

\frac{8}{3} m^{2} (3 n - m)

m < n

To form the unitary matrix

Q

f08csf may be followed by a call to f08ctf:

Call zungql(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 f08csf.

When

m \geq n

, it is often only the first

n

columns of

Q

that are required, and they may be formed by the call:

Call zungql(m,n,n,a,lda,tau,work,lwork,info)

To apply

Q

to an arbitrary complex rectangular matrix

C

, f08csf may be followed by a call to f08cuf. For example,

Call zunmql('Left','Conjugate Transpose',m,p,min(m,n),a,lda,tau, &
              c,ldc,work,lwork,info)

forms

C = Q^{H} C

, where

C

m

p

The real analogue of this routine is f08cef.

10 Example

This example solves the linear least squares problems

\min_{x} {‖b_{j} - A x_{j}‖}_{2}, ​ j = 1, 2

for

x_{1}

and

x_{2}

, where

b_{j}

is the

j

th column of the matrix

B

A = (\begin{array}{r} 0.96 - 0.81 i & - 0.03 + 0.96 i & - 0.91 + 2.06 i & - 0.05 + 0.41 i \\ - 0.98 + 1.98 i & - 1.20 + 0.19 i & - 0.66 + 0.42 i & - 0.81 + 0.56 i \\ 0.62 - 0.46 i & 1.01 + 0.02 i & 0.63 - 0.17 i & - 1.11 + 0.60 i \\ - 0.37 + 0.38 i & 0.19 - 0.54 i & - 0.98 - 0.36 i & 0.22 - 0.20 i \\ 0.83 + 0.51 i & 0.20 + 0.01 i & - 0.17 - 0.46 i & 1.47 + 1.59 i \\ 1.08 - 0.28 i & 0.20 - 0.12 i & - 0.07 + 1.23 i & 0.26 + 0.26 i \end{array})

and

B = (\begin{array}{r} - 2.09 + 1.93 i & 3.26 - 2.70 i \\ 3.34 - 3.53 i & - 6.22 + 1.16 i \\ - 4.94 - 2.04 i & 7.94 - 3.13 i \\ 0.17 + 4.23 i & 1.04 - 4.26 i \\ - 5.19 + 3.63 i & - 2.31 - 2.12 i \\ 0.98 + 2.53 i & - 1.39 - 4.05 i \end{array}) .

The solution is obtained by first obtaining a

Q L

factorization of the matrix

A

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.

Interfaces: FL CL AD

NAG FL Interface Introduction

F08 (Lapackeig) Chapter Contents

F08 (Lapackeig) Chapter Introduction

f08cs: FL CL AD

NAG FL Interfacef08csf (zgeqlf)

▸▿ Contents

1 Purpose

2 Specification

3 Description

4 References

5 Arguments

6 Error Indicators and Warnings

7 Accuracy

8 Parallelism and Performance

9 Further Comments

10 Example

10.1 Program Text

10.2 Program Data

10.3 Program Results

NAG FL Interface
f08csf (zgeqlf)