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 nagmk26.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)

3

Description

The

L U

decomposition with partial pivoting and row interchanges is used to factor

A

A = P L U

, 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

A X = 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

Arguments

1: $n$ – IntegerInput: On entry: the number of linear equations $n$ , i.e., the order of the matrix $A$ .

Constraint: $n \geq 0$ .
2: $nrhs$ – IntegerInput: On entry: the number of right-hand sides $r$ , i.e., the number of columns of the matrix $B$ .

Constraint: $nrhs \geq 0$ .
3: $a (lda *)$ – Complex (Kind=nag_wp) arrayInput/Output: Note: the second dimension of the array a must be at least $\max (1, n)$ .

On entry: the $n$ by $n$ coefficient matrix $A$ .

On exit: if $ifail \geq 0$ , the factors $L$ and $U$ from the factorization $A = P L U$ . 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: $lda \geq \max (1, n)$ .
5: $ipiv (n)$ – Integer arrayOutput: On exit: if $ifail \geq 0$ , the pivot indices that define the permutation matrix $P$ ; at the $i$ th 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) arrayInput/Output: Note: the second dimension of the array b must be at least $\max (1, 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: $ldb \geq \max (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 / ({‖A‖}_{1} {‖A^{- 1}‖}_{1})$ .
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 $\hat{x}$ , such that ${‖\hat{x} - x‖}_{1} / {‖x‖}_{1} \leq errbnd$ , where $\hat{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$ – IntegerInput/Output: On entry: ifail must be set to $0$ , $- 1 or 1$ . If you are unfamiliar with this argument you should refer to Section 3.4 in How to Use the NAG Library and its Documentation 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 argument, 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

- 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 \leq n$: 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: $n \geq 0$ .

$ifail = - 2$: On entry, $nrhs = 〈value〉$ .
Constraint: $nrhs \geq 0$ .

$ifail = - 4$: On entry, $lda = 〈value〉$ and $n = 〈value〉$ .
Constraint: $lda \geq \max (1, n)$ .

$ifail = - 7$: On entry, $ldb = 〈value〉$ and $n = 〈value〉$ .
Constraint: $ldb \geq \max (1, n)$ .

$ifail = - 99$: An unexpected error has been triggered by this routine. Please contact NAG.
See Section 3.9 in How to Use the NAG Library and its Documentation for further information.

$ifail = - 399$: Your licence key may have expired or may not have been installed correctly.
See Section 3.8 in How to Use the NAG Library and its Documentation for further information.

$ifail = - 999$: Dynamic memory allocation failed.
The complex allocatable memory required is $2 \times n$ , and the real allocatable memory required is $2 \times n$ . In this case the factorization and the solution $X$ have been computed, but rcond and errbnd have not been computed.
See Section 3.7 in How to Use the NAG Library and its Documentation for further information.

7

Accuracy

The computed solution for a single right-hand side,

\hat{x}

, satisfies an equation of the form

(A + E) \hat{x} = b,

where

{‖E‖}_{1} = O (ε) {‖A‖}_{1}

and

ε

is the machine precision. An approximate error bound for the computed solution is given by

\frac{{‖\hat{x} - x‖}_{1}}{{‖x‖}_{1}} \leq κ (A) \frac{{‖E‖}_{1}}{{‖A‖}_{1}},

where

κ (A) = {‖A^{- 1}‖}_{1} {‖A‖}_{1}

, the condition number of

A

with respect to the solution of the linear equations. f04caf uses the approximation

{‖E‖}_{1} = ε {‖A‖}_{1}

to estimate errbnd. See Section 4.4 of Anderson et al. (1999) for further details.

8

Parallelism and Performance

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

A X = B

is proportional to

(\frac{2}{3} n^{3} + n^{2} r)

. 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

A X = B,

where

A = (\begin{array}{r} - 1.34 + 2.55 i & 0.28 + 3.17 i & - 6.39 - 2.20 i & 0.72 - 0.92 i \\ - 0.17 - 1.41 i & 3.31 - 0.15 i & - 0.15 + 1.34 i & 1.29 + 1.38 i \\ - 3.29 - 2.39 i & - 1.91 + 4.42 i & - 0.14 - 1.35 i & 1.72 + 1.35 i \\ 2.41 + 0.39 i & - 0.56 + 1.47 i & - 0.83 - 0.69 i & - 1.96 + 0.67 i \end{array})

and

B = (\begin{array}{r} 26.26 + 51.78 i & 31.32 - 6.70 i \\ 6.43 - 8.68 i & 15.86 - 1.42 i \\ - 5.75 + 25.31 i & - 2.15 + 30.19 i \\ 1.16 + 2.57 i & - 2.56 + 7.55 i \end{array}) .

An estimate of the condition number of

A

and an approximate error bound for the computed solutions are also printed.

NAG Library Routine Document

f04caf (complex_square_solve)

▸▿ Contents

1 Purpose

2 Specification

3 Description

4 References

5 Arguments

6 Error Indicators and Warnings

7 Accuracy

8 Parallelism and Performance

9 Further Comments

10 Example

10.1 Program Text

10.2 Program Data

10.3 Program Results

1

Purpose

2

Specification

3

Description

4

References

5

Arguments

6

Error Indicators and Warnings

7

Accuracy

8

Parallelism and Performance

9

Further Comments

10

Example

10.1

Program Text

10.2

Program Data

10.3

Program Results