NAG Library Routine Document
f07arf
(zgetrf)
1
Purpose
f07arf (zgetrf) computes the factorization of a complex by matrix.
2
Specification
Fortran Interface
Integer, Intent (In) | :: |
m,
n,
lda | Integer, Intent (Out) | :: |
ipiv(min(m,n)),
info | Complex (Kind=nag_wp), Intent (Inout) | :: |
a(lda,*) |
|
C Header Interface
#include nagmk26.h
void |
f07arf_ (
const Integer *m,
const Integer *n,
Complex a[],
const Integer *lda,
Integer ipiv[],
Integer *info) |
|
The routine may be called by its
LAPACK
name zgetrf.
3
Description
f07arf (zgetrf) forms the factorization of a complex by matrix as , where is a permutation matrix, is lower triangular with unit diagonal elements (lower trapezoidal if ) and is upper triangular (upper trapezoidal if ). Usually is square , and both and are triangular. The routine uses partial pivoting, with row interchanges.
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 number of rows of the matrix .
Constraint:
.
- 2: – IntegerInput
-
On entry: , the number of columns of the matrix .
Constraint:
.
- 3: – Complex (Kind=nag_wp) arrayInput/Output
-
Note: the second dimension of the array
a
must be at least
.
On entry: the by matrix .
On exit: the factors and from the factorization ; the unit diagonal elements of are not stored.
- 4: – IntegerInput
-
On entry: the first dimension of the array
a as declared in the (sub)program from which
f07arf (zgetrf) is called.
Constraint:
.
- 5: – Integer arrayOutput
-
On exit: the pivot indices that define the permutation matrix. At the
th step, if then row of the matrix was interchanged with row , for . indicates that, at the th step, a row interchange was not required.
- 6: – 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.
-
Element of the diagonal is exactly zero.
The factorization has been completed, but the factor is exactly singular, and division by zero will occur if it is used to solve
a system of equations.
7
Accuracy
The computed factors
and
are the exact factors of a perturbed matrix
, where
is a modest linear function of
, and
is the
machine precision.
8
Parallelism and Performance
f07arf (zgetrf) is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.
f07arf (zgetrf) 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 if (the usual case), if and if .
A call to this routine with
may be followed by calls to the routines:
The real analogue of this routine is
f07adf (dgetrf).
10
Example
This example computes the
factorization of the matrix
, where
10.1
Program Text
Program Text (f07arfe.f90)
10.2
Program Data
Program Data (f07arfe.d)
10.3
Program Results
Program Results (f07arfe.r)