NAG Library Routine Document
f08atf
(zungqr)
1
Purpose
f08atf (zungqr) generates all or part of the complex unitary matrix
from a
factorization computed by
f08asf (zgeqrf),
f08bsf (zgeqpf) or
f08btf (zgeqp3).
2
Specification
Fortran Interface
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 nagmk26.h
void |
f08atf_ (
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 its
LAPACK
name zungqr.
3
Description
f08atf (zungqr) is intended to be used after a call to
f08asf (zgeqrf),
f08bsf (zgeqpf) or
f08btf (zgeqp3), which perform a
factorization of a complex matrix
. The unitary matrix
is represented as a product of elementary reflectors.
This routine may be used to generate explicitly as a square matrix, or to form only its leading columns.
Usually
is determined from the
factorization of an
by
matrix
with
. The whole of
may be computed by:
Call ZUNGQR(m,m,p,a,lda,tau,work,lwork,info)
(note that the array
a must have at least
columns) or its leading
columns by:
Call ZUNGQR(m,p,p,a,lda,tau,work,lwork,info)
The columns of
returned by the last call form an orthonormal basis for the space spanned by the columns of
; thus
f08asf (zgeqrf) followed by
f08atf (zungqr) can be used to orthogonalize the columns of
.
The information returned by the
factorization routines also yields the
factorization of the leading
columns of
, where
. The unitary matrix arising from this factorization can be computed by:
Call ZUNGQR(m,m,k,a,lda,tau,work,lwork,info)
or its leading
columns by:
Call ZUNGQR(m,k,k,a,lda,tau,work,lwork,info)
4
References
Golub G H and Van Loan C F (1996) Matrix Computations (3rd Edition) Johns Hopkins University Press, Baltimore
5
Arguments
- 1: – IntegerInput
-
On entry: , the order of the unitary matrix .
Constraint:
.
- 2: – IntegerInput
-
On entry: , the number of columns of the matrix .
Constraint:
.
- 3: – IntegerInput
-
On entry: , the number of elementary reflectors whose product defines the matrix .
Constraint:
.
- 4: – Complex (Kind=nag_wp) arrayInput/Output
-
Note: the second dimension of the array
a
must be at least
.
On entry: details of the vectors which define the elementary reflectors, as returned by
f08asf (zgeqrf),
f08bsf (zgeqpf) or
f08btf (zgeqp3).
On exit: the by matrix .
- 5: – IntegerInput
-
On entry: the first dimension of the array
a as declared in the (sub)program from which
f08atf (zungqr) is called.
Constraint:
.
- 6: – Complex (Kind=nag_wp) arrayInput
-
Note: the dimension of the array
tau
must be at least
.
On entry: further details of the elementary reflectors, as returned by
f08asf (zgeqrf),
f08bsf (zgeqpf) or
f08btf (zgeqp3).
- 7: – Complex (Kind=nag_wp) arrayWorkspace
-
On exit: if
, the real part of
contains the minimum value of
lwork required for optimal performance.
- 8: – IntegerInput
-
On entry: the dimension of the array
work as declared in the (sub)program from which
f08atf (zungqr) is called.
If
, 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, , where is the optimal block size.
Constraint:
or .
- 9: – IntegerOutput
On exit:
unless the routine detects an error (see
Section 6).
6
Error Indicators and Warnings
-
If , argument had an illegal value. An explanatory message is output, and execution of the program is terminated.
7
Accuracy
The computed matrix
differs from an exactly unitary matrix by a matrix
such that
where
is the
machine precision.
8
Parallelism and Performance
f08atf (zungqr) is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.
f08atf (zungqr) 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.
The total number of real floating-point operations is approximately ; when , the number is approximately .
The real analogue of this routine is
f08aff (dorgqr).
10
Example
This example forms the leading
columns of the unitary matrix
from the
factorization of the matrix
, where
The columns of
form an orthonormal basis for the space spanned by the columns of
.
10.1
Program Text
Program Text (f08atfe.f90)
10.2
Program Data
Program Data (f08atfe.d)
10.3
Program Results
Program Results (f08atfe.r)