NAG Library Routine Document
f08cwf
(zungrq)
1
Purpose
f08cwf (zungrq) generates all or part of the complex
by
unitary matrix
from an
factorization computed by
f08cvf (zgerqf).
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 |
f08cwf_ (
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 zungrq.
3
Description
f08cwf (zungrq) is intended to be used following a call to
f08cvf (zgerqf), which performs an
factorization of a complex matrix
and represents the unitary matrix
as a product of
elementary reflectors of order
.
This routine may be used to generate explicitly as a square matrix, or to form only its trailing rows.
Usually
is determined from the
factorization of a
by
matrix
with
. The whole of
may be computed by:
Call ZUNGRQ(n,n,p,a,lda,tau,work,lwork,info)
(note that the matrix
must have at least
rows), or its trailing
rows as:
Call ZUNGRQ(p,n,p,a,lda,tau,work,lwork,info)
The rows of
returned by the last call form an orthonormal basis for the space spanned by the rows of
; thus
f08cvf (zgerqf) followed by
f08cwf (zungrq) can be used to orthogonalize the rows of
.
The information returned by
f08cvf (zgerqf) also yields the
factorization of the trailing
rows of
, where
. The unitary matrix arising from this factorization can be computed by:
Call ZUNGRQ(n,n,k,a,lda,tau,work,lwork,info)
or its leading
columns by:
Call ZUNGRQ(k,n,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
http://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: – IntegerInput
-
On entry: , the number of rows of the 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
f08cvf (zgerqf).
On exit: the by matrix .
- 5: – IntegerInput
-
On entry: the first dimension of the array
a as declared in the (sub)program from which
f08cwf (zungrq) is called.
Constraint:
.
- 6: – Complex (Kind=nag_wp) arrayInput
-
Note: the dimension of the array
tau
must be at least
.
On entry:
must contain the scalar factor of the elementary reflector
, as returned by
f08cvf (zgerqf).
- 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
f08cwf (zungrq) 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
and
is the
machine precision.
8
Parallelism and Performance
f08cwf (zungrq) 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 floating-point operations is approximately ; when this becomes .
The real analogue of this routine is
f08cjf (dorgrq).
10
Example
This example generates the first four rows of the matrix
of the
factorization of
as returned by
f08cvf (zgerqf), where
Note that the block size (NB) of assumed in this example is not realistic for such a small problem, but should be suitable for large problems.
10.1
Program Text
Program Text (f08cwfe.f90)
10.2
Program Data
Program Data (f08cwfe.d)
10.3
Program Results
Program Results (f08cwfe.r)