NAG Library Function Document
nag_zgeqrf (f08asc)
1 Purpose
nag_zgeqrf (f08asc) computes the factorization of a complex by matrix.
2 Specification
#include <nag.h> |
#include <nagf08.h> |
void |
nag_zgeqrf (Nag_OrderType order,
Integer m,
Integer n,
Complex a[],
Integer pda,
Complex tau[],
NagError *fail) |
|
3 Description
nag_zgeqrf (f08asc) forms the factorization of an arbitrary rectangular complex by matrix. No pivoting is performed.
If
, the factorization is given by:
where
is an
by
upper triangular matrix (with real diagonal elements) and
is an
by
unitary matrix. It is sometimes more convenient to write the factorization as
which reduces to
where
consists of the first
columns of
, and
the remaining
columns.
If
,
is trapezoidal, and the factorization can be written
where
is upper triangular and
is rectangular.
The matrix
is not formed explicitly but is represented as a product of
elementary reflectors (see the
f08 Chapter Introduction for details). Functions are provided to work with
in this representation (see
Section 9).
Note also that for any
, the information returned in the first
columns of the array
a represents a
factorization of the first
columns of the original matrix
.
4 References
Golub G H and Van Loan C F (1996) Matrix Computations (3rd Edition) Johns Hopkins University Press, Baltimore
5 Arguments
- 1:
– Nag_OrderTypeInput
-
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 2.3.1.3 in How to Use the NAG Library and its Documentation for a more detailed explanation of the use of this argument.
Constraint:
or .
- 2:
– IntegerInput
-
On entry: , the number of rows of the matrix .
Constraint:
.
- 3:
– IntegerInput
-
On entry: , the number of columns of the matrix .
Constraint:
.
- 4:
– ComplexInput/Output
-
Note: the dimension,
dim, of the array
a
must be at least
- when
;
- when
.
The
th element of the matrix
is stored in
- when ;
- when .
On entry: the by matrix .
On exit: if
, the elements below the diagonal are overwritten by details of the unitary matrix
and the upper triangle is overwritten by the corresponding elements of the
by
upper triangular matrix
.
If , the strictly lower triangular part is overwritten by details of the unitary matrix and the remaining elements are overwritten by the corresponding elements of the by upper trapezoidal matrix .
The diagonal elements of are real.
- 5:
– IntegerInput
-
On entry: the stride separating row or column elements (depending on the value of
order) in the array
a.
Constraints:
- if ,
;
- if , .
- 6:
– ComplexOutput
-
Note: the dimension,
dim, of the array
tau
must be at least
.
On exit: further details of the unitary matrix .
- 7:
– NagError *Input/Output
-
The NAG error argument (see
Section 2.7 in How to Use the NAG Library and its Documentation).
6 Error Indicators and Warnings
- NE_ALLOC_FAIL
-
Dynamic memory allocation failed.
See
Section 2.3.1.2 in How to Use the NAG Library and its Documentation for further information.
- NE_BAD_PARAM
-
On entry, argument had an illegal value.
- NE_INT
-
On entry, .
Constraint: .
On entry, .
Constraint: .
On entry, .
Constraint: .
- NE_INT_2
-
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.
An unexpected error has been triggered by this function. Please contact
NAG.
See
Section 2.7.6 in How to Use the NAG Library and its Documentation for further information.
- NE_NO_LICENCE
-
Your licence key may have expired or may not have been installed correctly.
See
Section 2.7.5 in How to Use the NAG Library and its Documentation for further information.
7 Accuracy
The computed factorization is the exact factorization of a nearby matrix
, where
and
is the
machine precision.
8 Parallelism and Performance
nag_zgeqrf (f08asc) is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.
nag_zgeqrf (f08asc) 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 if or if .
To form the unitary matrix
nag_zgeqrf (f08asc) may be followed by a call to
nag_zungqr (f08atc):
nag_zungqr(order,m,m,MIN(m,n),&a,pda,tau,&fail)
but note that the second dimension of the array
a must be at least
m, which may be larger than was required by nag_zgeqrf (f08asc).
When
, it is often only the first
columns of
that are required, and they may be formed by the call:
nag_zungqr(order,m,n,n,&a,pda,tau,&fail)
To apply
to an arbitrary complex rectangular matrix
, nag_zgeqrf (f08asc) may be followed by a call to
nag_zunmqr (f08auc). For example,
nag_zunmqr(order,Nag_LeftSide,Nag_ConjTrans,m,p,MIN(m,n),&a,pda,
tau,&c,pdc,&fail)
forms
, where
is
by
.
To compute a
factorization with column pivoting, use
nag_zgeqpf (f08bsc).
The real analogue of this function is
nag_dgeqrf (f08aec).
10 Example
This example solves the linear least squares problems
where
and
are the columns of the matrix
,
and
10.1 Program Text
Program Text (f08asce.c)
10.2 Program Data
Program Data (f08asce.d)
10.3 Program Results
Program Results (f08asce.r)