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

C Header Interface

#include <nag.h>

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

The routine may be called by the names f08ctf, nagf_lapackeig_zungql or its LAPACK name zungql.

3 Description

f08ctf is intended to be used after a call to f08csf, which performs a

Q L

factorization of a complex matrix

A

. The unitary matrix

Q

is represented as a product of elementary reflectors.

This routine may be used to generate

Q

explicitly as a square matrix, or to form only its trailing columns.

Usually

Q

is determined from the

Q L

factorization of an

m \times p

matrix

A

with

m \geq p

. The whole of

Q

may be computed by :

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

(note that the array a must have at least

m

columns) or its trailing

p

columns by :

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

The columns of

Q

returned by the last call form an orthonormal basis for the space spanned by the columns of

A

; thus f08csf followed by f08ctf can be used to orthogonalize the columns of

A

The information returned by f08csf also yields the

Q L

factorization of the trailing

k

columns of

A

, where

k < p

. The unitary matrix arising from this factorization can be computed by :

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

or its trailing

k

columns by :

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

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 $Q$ .

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

Constraint: $m \geq n \geq 0$ .
3: $k$ – Integer Input: On entry: $k$ , the number of elementary reflectors whose product defines the matrix $Q$ .

Constraint: $n \geq k \geq 0$ .
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: details of the vectors which define the elementary reflectors, as returned by f08csf.

On exit: the $m \times n$ matrix $Q$ .
5: $lda$ – Integer Input: On entry: the first dimension of the array a as declared in the (sub)program from which f08ctf is called.

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

On entry: further details of the elementary reflectors, as returned by f08csf.
7: $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.
8: $lwork$ – Integer Input: On entry: the dimension of the array work as declared in the (sub)program from which f08ctf 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)$ or $lwork = −1$ .
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 matrix

Q

differs from an exactly unitary matrix by a matrix

E

such that

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

where

ε

is the machine precision.

8 Parallelism and Performance

Background information to multithreading can be found in the Multithreading documentation.

f08ctf 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

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

; when

n = k

, the number is approximately

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

The real analogue of this routine is f08cff.

10 Example

This example generates the first four columns of the matrix

Q

of the

Q L

factorization of

A

as returned by f08csf, where

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}) .

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.

f08ct: FL CL CPP AD PY MB

NAG FL Interfacef08ctf (zungql)

▸▿ 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
f08ctf (zungql)