NAG FL Interface
f04caf (complex_​square_​solve)

Settings help

FL Name Style:


FL Specification Language:


1 Purpose

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

2 Specification

Fortran Interface
Subroutine f04caf ( n, nrhs, a, lda, ipiv, b, ldb, rcond, errbnd, ifail)
Integer, Intent (In) :: n, nrhs, lda, ldb
Integer, Intent (Inout) :: ifail
Integer, Intent (Out) :: ipiv(n)
Real (Kind=nag_wp), Intent (Out) :: rcond, errbnd
Complex (Kind=nag_wp), Intent (Inout) :: a(lda,*), b(ldb,*)
C Header Interface
#include <nag.h>
void  f04caf_ (const Integer *n, const Integer *nrhs, Complex a[], const Integer *lda, Integer ipiv[], Complex b[], const Integer *ldb, double *rcond, double *errbnd, Integer *ifail)
The routine may be called by the names f04caf or nagf_linsys_complex_square_solve.

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 https://www.netlib.org/lapack/lug
Higham N J (2002) Accuracy and Stability of Numerical Algorithms (2nd Edition) SIAM, Philadelphia

5 Arguments

1: n Integer Input
On entry: the number of linear equations n, i.e., the order of the matrix A.
Constraint: n0.
2: nrhs Integer Input
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) array Input/Output
Note: the second dimension of the array a must be at least max(1,n).
On entry: the n×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 Integer Input
On entry: the first dimension of the array a as declared in the (sub)program from which f04caf is called.
Constraint: ldamax(1,n).
5: ipiv(n) Integer array Output
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 ipiv(i). ipiv(i)=i indicates a row interchange was not required.
6: b(ldb,*) Complex (Kind=nag_wp) array Input/Output
Note: the second dimension of the array b must be at least max(1,nrhs).
On entry: the n×r matrix of right-hand sides B.
On exit: if ifail=0 or n+1, the n×r solution matrix X.
7: ldb Integer Input
On entry: the first dimension of the array b as declared in the (sub)program from which f04caf is called.
Constraint: ldbmax(1,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, errbnd is returned as unity.
10: ifail Integer Input/Output
On entry: ifail must be set to 0, −1 or 1 to set behaviour on detection of an error; these values have no effect when no error is detected.
A value of 0 causes the printing of an error message and program execution will be halted; otherwise program execution continues. A value of −1 means that an error message is printed while a value of 1 means that it is not.
If halting is not appropriate, the value −1 or 1 is recommended. If message printing is undesirable, then the value 1 is recommended. Otherwise, the value 0 is recommended. 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>0andifailn
Diagonal element value of the upper triangular factor is zero. The factorization has been completed, but the solution could not be computed.
ifail=n+1
A solution has been computed, but rcond is less than machine precision so that the matrix A is numerically singular.
ifail=-1
On entry, n=value.
Constraint: n0.
ifail=-2
On entry, nrhs=value.
Constraint: nrhs0.
ifail=-4
On entry, lda=value and n=value.
Constraint: ldamax(1,n).
ifail=-7
On entry, ldb=value and n=value.
Constraint: ldbmax(1,n).
ifail=-99
An unexpected error has been triggered by this routine. Please contact NAG.
See Section 7 in the Introduction to the NAG Library FL Interface for further information.
ifail=-399
Your licence key may have expired or may not have been installed correctly.
See Section 8 in the Introduction to the NAG Library FL Interface for further information.
ifail=-999
Dynamic memory allocation 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.
See Section 9 in the Introduction to the NAG Library FL Interface for further information.

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 Parallelism and Performance

Background information to multithreading can be found in the Multithreading documentation.
f04caf is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.
f04caf 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.

9 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.

10 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.

10.1 Program Text

Program Text (f04cafe.f90)

10.2 Program Data

Program Data (f04cafe.d)

10.3 Program Results

Program Results (f04cafe.r)