Integer, Intent (In)	::	n, kl, ku, nrhs, ldab, ldb
Integer, Intent (Inout)	::	ifail
Integer, Intent (Out)	::	ipiv(n)
Real (Kind=nag_wp), Intent (Out)	::	rcond, errbnd
Complex (Kind=nag_wp), Intent (Inout)	::	ab(ldab,), b(ldb,)

C Header Interface

#include <nag.h>

void	f04cbf_ (const Integer n, const Integer kl, const Integer ku, const Integer nrhs, Complex ab[], const Integer ldab, Integer ipiv[], Complex b[], const Integer ldb, double rcond, double errbnd, Integer *ifail)

The routine may be called by the names f04cbf or nagf_linsys_complex_band_solve.

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 the product of permutation matrices and unit lower triangular matrices with

k_{l}

subdiagonals, and

U

is upper triangular with

(k_{l} + k_{u})

superdiagonals. 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 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:

n \geq 0

2: $kl$ – Integer Input

On entry: the number of subdiagonals

k_{l}

, within the band of

A

Constraint:

kl \geq 0

3: $ku$ – Integer Input

On entry: the number of superdiagonals

k_{u}

, within the band of

A

Constraint:

ku \geq 0

4: $nrhs$ – Integer Input

On entry: the number of right-hand sides

r

, i.e., the number of columns of the matrix

B

Constraint:

nrhs \geq 0

5: $ab (ldab, *)$ – Complex (Kind=nag_wp) array Input/Output

Note: the second dimension of the array ab must be at least

\max (1, n)

On entry: the

n \times n

matrix

A

The matrix is stored in rows

k_{l} + 1

2 k_{l} + k_{u} + 1

; the first

k_{l}

rows need not be set, more precisely, the element

A_{i j}

must be stored in

ab (k_{l} + k_{u} + 1 + i - j, j) = A_{i j} for ​ \max (1, j - k_{u}) \leq i \leq \min (n, j + k_{l}) .

See Section 9 for further details.

On exit: if

ifail \geq 0

, ab is overwritten by details of the factorization.

The upper triangular band matrix

U

, with

k_{l} + k_{u}

superdiagonals, is stored in rows

1

k_{l} + k_{u} + 1

of the array, and the multipliers used to form the matrix

L

are stored in rows

k_{l} + k_{u} + 2

2 k_{l} + k_{u} + 1

6: $ldab$ – Integer Input

On entry: the first dimension of the array ab as declared in the (sub)program from which f04cbf is called.

Constraint:

ldab \geq 2 \times kl + ku + 1

7: $ipiv (n)$ – Integer array Output

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.

8: $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 \times r

matrix of right-hand sides

B

On exit: if

ifail = 0

n + 1

, the

n \times r

solution matrix

X

9: $ldb$ – Integer Input

On entry: the first dimension of the array b as declared in the (sub)program from which f04cbf is called.

Constraint:

ldb \geq \max (1, n)

10: $rcond$ – Real (Kind=nag_wp) Output

On exit: if

ifail \geq 0

, an estimate of the reciprocal of the condition number of the matrix

A

, computed as

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

11: $errbnd$ – Real (Kind=nag_wp) Output

On exit: if

ifail = 0

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.

12: $ifail$ – Integer Input/Output

On entry: ifail must be set to

0

−1

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

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

−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, $kl = ⟨ value ⟩$ .
Constraint: $kl \geq 0$ .

$ifail = - 3$: On entry, $ku = ⟨ value ⟩$ .
Constraint: $ku \geq 0$ .

$ifail = - 4$: On entry, $nrhs = ⟨ value ⟩$ .
Constraint: $nrhs \geq 0$ .

$ifail = - 6$: On entry, $ldab = ⟨ value ⟩$ , $kl = ⟨ value ⟩$ and $ku = ⟨ value ⟩$ .
Constraint: $ldab \geq 2 \times kl + ku + 1$ .

$ifail = - 9$: 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 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 real allocatable memory required is n, and the complex 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 9 in the Introduction to the NAG Library FL Interface 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. f04cbf 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

f04cbf is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.

f04cbf 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 band storage scheme for the array ab is illustrated by the following example, when

n = 6

k_{l} = 1

, and

k_{u} = 2

. Storage of the band matrix

A

in the array ab:

\begin{matrix} * & * & * & + & + & + \\ * & * & a_{13} & a_{24} & a_{35} & a_{46} \\ * & a_{12} & a_{23} & a_{34} & a_{45} & a_{56} \\ a_{11} & a_{22} & a_{33} & a_{44} & a_{55} & a_{66} \\ a_{21} & a_{32} & a_{43} & a_{54} & a_{65} & * \end{matrix}

Array elements marked

*

need not be set and are not referenced by the routine. Array elements marked + need not be set, but are defined on exit from the routine and contain the elements

u_{14}

u_{25}

and

u_{36}

The total number of floating-point operations required to solve the equations

A X = B

depends upon the pivoting required, but if

n ≫ k_{l} + k_{u}

then it is approximately bounded by

O (n k_{l} (k_{l} + k_{u}))

for the factorization and

O (n (2 k_{l} + k_{u}), r)

for the solution following the factorization. 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 f04cbf is f04bbf.

10 Example

This example solves the equations

A X = B,

where

A

is the band matrix

A = (\begin{array}{r} - 1.65 + 2.26 i & - 2.05 - 0.85 i & 0.97 - 2.84 i & 0 \\ 0.00 + 6.30 i & - 1.48 - 1.75 i & - 3.99 + 4.01 i & 0.59 - 0.48 i \\ 0 & - 0.77 + 2.83 i & - 1.06 + 1.94 i & 3.33 - 1.04 i \\ 0 & 0 & 4.48 - 1.09 i & - 0.46 - 1.72 i \end{array})

and

B = (\begin{array}{r} - 1.06 + 21.50 i & 12.85 + 2.84 i \\ - 22.72 - 53.90 i & - 70.22 + 21.57 i \\ 28.24 - 38.60 i & - 20.73 - 1.23 i \\ - 34.56 + 16.73 i & 26.01 + 31.97 i \end{array}) .

An estimate of the condition number of

A

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

f04cb: FL CL CPP AD

NAG FL Interfacef04cbf (complex_​band_​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

NAG FL Interface
f04cbf (complex_band_solve)