NAG CL Interface
f08atc (zungqr)
1
Purpose
f08atc generates all or part of the complex unitary matrix
from a
factorization computed by
f08asc,
f08bsc or
f08btc.
2
Specification
void |
f08atc (Nag_OrderType order,
Integer m,
Integer n,
Integer k,
Complex a[],
Integer pda,
const Complex tau[],
NagError *fail) |
|
The function may be called by the names: f08atc, nag_lapackeig_zungqr or nag_zungqr.
3
Description
f08atc is intended to be used after a call to
f08asc,
f08bsc or
f08btc, which perform a
factorization of a complex matrix
. The unitary matrix
is represented as a product of elementary reflectors.
This function 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:
nag_lapackeig_zungqr(order,m,m,p,a,pda,tau,&fail)
(note that the array
a must have at least
columns) or its leading
columns by:
nag_lapackeig_zungqr(order,m,p,p,a,pda,tau,&fail)
The columns of
returned by the last call form an orthonormal basis for the space spanned by the columns of
; thus
f08asc followed by
f08atc can be used to orthogonalize the columns of
.
The information returned by the
factorization functions also yields the
factorization of the leading
columns of
, where
. The unitary matrix arising from this factorization can be computed by:
nag_lapackeig_zungqr(order,m,m,k,a,pda,tau,&fail)
or its leading
columns by:
nag_lapackeig_zungqr(order,m,k,k,a,pda,tau,&fail)
4
References
Golub G H and Van Loan C F (1996) Matrix Computations (3rd Edition) Johns Hopkins University Press, Baltimore
5
Arguments
-
1:
– Nag_OrderType
Input
-
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
. See
Section 3.1.3 in the Introduction to the NAG Library CL Interface for a more detailed explanation of the use of this argument.
Constraint:
or .
-
2:
– Integer
Input
-
On entry: , the order of the unitary matrix .
Constraint:
.
-
3:
– Integer
Input
-
On entry: , the number of columns of the matrix .
Constraint:
.
-
4:
– Integer
Input
-
On entry: , the number of elementary reflectors whose product defines the matrix .
Constraint:
.
-
5:
– Complex
Input/Output
-
Note: the dimension,
dim, of the array
a
must be at least
- when
;
- when
.
On entry: details of the vectors which define the elementary reflectors, as returned by
f08asc,
f08bsc or
f08btc.
On exit: the by matrix .
-
6:
– Integer
Input
-
On entry: the stride separating row or column elements (depending on the value of
order) in the array
a.
Constraints:
- if ,
;
- if , .
-
7:
– const Complex
Input
-
Note: the dimension,
dim, of the array
tau
must be at least
.
On entry: further details of the elementary reflectors, as returned by
f08asc,
f08bsc or
f08btc.
-
8:
– NagError *
Input/Output
-
The NAG error argument (see
Section 7 in the Introduction to the NAG Library CL Interface).
6
Error Indicators and Warnings
- NE_ALLOC_FAIL
-
Dynamic memory allocation failed.
See
Section 3.1.2 in the Introduction to the NAG Library CL Interface for further information.
- NE_BAD_PARAM
-
On entry, argument had an illegal value.
- NE_INT
-
On entry, .
Constraint: .
On entry, .
Constraint: .
- NE_INT_2
-
On entry, and .
Constraint: .
On entry, and .
Constraint: .
On entry, and .
Constraint: .
On entry, and .
Constraint: .
- 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 7.5 in the Introduction to the NAG Library CL Interface for further information.
- NE_NO_LICENCE
-
Your licence key may have expired or may not have been installed correctly.
See
Section 8 in the Introduction to the NAG Library CL Interface for further information.
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
f08atc is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.
f08atc 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.
The total number of real floating-point operations is approximately ; when , the number is approximately .
The real analogue of this function is
f08afc.
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
10.2
Program Data
10.3
Program Results