F04CAF (PDF version)
F04 Chapter Contents
F04 Chapter Introduction
NAG Library Manual

NAG Library Routine Document

F04CAF

Note:  before using this routine, please read the Users' Note for your implementation to check the interpretation of bold italicised terms and other implementation-dependent details.

+ Contents

    1  Purpose
    7  Accuracy

1  Purpose

F04CAF computes the solution to a complex system of linear equations AX=B, where A is an n by n matrix and X and B are n by r matrices. An estimate of the condition number of A and an error bound for the computed solution are also returned.

2  Specification

SUBROUTINE F04CAF ( N, NRHS, A, LDA, IPIV, B, LDB, RCOND, ERRBND, IFAIL)
INTEGER  N, NRHS, LDA, IPIV(N), LDB, IFAIL
REAL (KIND=nag_wp)  RCOND, ERRBND
COMPLEX (KIND=nag_wp)  A(LDA,*), B(LDB,*)

3  Description

The LU decomposition with partial pivoting and row interchanges is used to factor A as A=PLU, where P is a permutation matrix, L is unit lower triangular, and U is upper triangular. The factored form of A is then used to solve the system of equations AX=B.

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
Higham N J (2002) Accuracy and Stability of Numerical Algorithms (2nd Edition) SIAM, Philadelphia

5  Parameters

1:     N – INTEGERInput
On entry: the number of linear equations n, i.e., the order of the matrix A.
Constraint: N0.
2:     NRHS – INTEGERInput
On entry: the number of right-hand sides r, i.e., the number of columns of the matrix B.
Constraint: NRHS0.
3:     A(LDA,*) – COMPLEX (KIND=nag_wp) arrayInput/Output
Note: the second dimension of the array A must be at least max1,N.
On entry: the n by n coefficient matrix A.
On exit: if IFAIL0, the factors L and U from the factorization A=PLU. The unit diagonal elements of L are not stored.
4:     LDA – INTEGERInput
On entry: the first dimension of the array A as declared in the (sub)program from which F04CAF is called.
Constraint: LDAmax1,N.
5:     IPIV(N) – INTEGER arrayOutput
On exit: if IFAIL0, the pivot indices that define the permutation matrix P; at the ith step row i of the matrix was interchanged with row IPIVi. IPIVi=i indicates a row interchange was not required.
6:     B(LDB,*) – COMPLEX (KIND=nag_wp) arrayInput/Output
Note: the second dimension of the array B must be at least max1,NRHS.
On entry: the n by r matrix of right-hand sides B.
On exit: if IFAIL=0 or N+1, the n by r solution matrix X.
7:     LDB – INTEGERInput
On entry: the first dimension of the array B as declared in the (sub)program from which F04CAF is called.
Constraint: LDBmax1,N.
8:     RCOND – REAL (KIND=nag_wp)Output
On exit: if no constraints are violated, an estimate of the reciprocal of the condition number of the matrix A, computed as RCOND=1/A1A-11.
9:     ERRBND – REAL (KIND=nag_wp)Output
On exit: if IFAIL=0 or N+1, an estimate of the forward error bound for a computed solution x^, such that x^-x1/x1ERRBND, where x^ is a column of the computed solution returned in the array B and x is the corresponding column of the exact solution X. If RCOND is less than machine precision, then ERRBND is returned as unity.
10:   IFAIL – INTEGERInput/Output
On entry: IFAIL must be set to 0, -1​ or ​1. If you are unfamiliar with this parameter you should refer to Section 3.3 in the Essential Introduction for details.
For environments where it might be inappropriate to halt program execution when an error is detected, the value -1​ or ​1 is recommended. If the output of error messages is undesirable, then the value 1 is recommended. Otherwise, if you are not familiar with this parameter, the recommended value is 0. When the value -1​ or ​1 is used it is essential to test the value of IFAIL on exit.
On exit: IFAIL=0 unless the routine detects an error or a warning has been flagged (see Section 6).

6  Error Indicators and Warnings

If on entry IFAIL=0 or -1, explanatory error messages are output on the current error message unit (as defined by X04AAF).
Errors or warnings detected by the routine:
IFAIL<0 and IFAIL-999
If IFAIL=-i, the ith argument had an illegal value.
IFAIL=-999
Allocation of memory failed. The complex allocatable memory required is 2×N, and the real allocatable memory required is 2×N. In this case the factorization and the solution X have been computed, but RCOND and ERRBND have not been computed.
IFAIL<0 and IFAILN
If IFAIL=i, uii is exactly zero. The factorization has been completed, but the factor U is exactly singular, so the solution could not be computed.
IFAIL=N+1
RCOND is less than machine precision, so that the matrix A is numerically singular. A solution to the equations AX=B has nevertheless been computed.

7  Accuracy

The computed solution for a single right-hand side, x^, satisfies an equation of the form
A+E x^=b,
where
E1 = Oε A1
and ε is the machine precision. An approximate error bound for the computed solution is given by
x^-x1 x1 κA E1 A1 ,
where κA = A-11 A1 , the condition number of A with respect to the solution of the linear equations. F04CAF uses the approximation E1=εA1 to estimate ERRBND. See Section 4.4 of Anderson et al. (1999) for further details.

8  Further Comments

The total number of floating point operations required to solve the equations AX=B is proportional to 23n3+n2r. The condition number estimation typically requires between four and five solves and never more than eleven solves, following the factorization.
In practice the condition number estimator is very reliable, but it can underestimate the true condition number; see Section 15.3 of Higham (2002) for further details.
The real analogue of F04CAF is F04BAF.

9  Example

This example solves the equations
AX=B,
where
A = -1.34+2.55i 0.28+3.17i -6.39-2.20i 0.72-0.92i -0.17-1.41i 3.31-0.15i -0.15+1.34i 1.29+1.38i -3.29-2.39i -1.91+4.42i -0.14-1.35i 1.72+1.35i 2.41+0.39i -0.56+1.47i -0.83-0.69i -1.96+0.67i
and
B= 26.26+51.78i 31.32-06.70i 6.43-08.68i 15.86-01.42i -5.75+25.31i -2.15+30.19i 1.16+02.57i -2.56+07.55i .
An estimate of the condition number of A and an approximate error bound for the computed solutions are also printed.

9.1  Program Text

Program Text (f04cafe.f90)

9.2  Program Data

Program Data (f04cafe.d)

9.3  Program Results

Program Results (f04cafe.r)


F04CAF (PDF version)
F04 Chapter Contents
F04 Chapter Introduction
NAG Library Manual

© The Numerical Algorithms Group Ltd, Oxford, UK. 2012