NAG C Library Function Document

void	nag_zgbrfs (Nag_OrderType order, Nag_TransType trans, Integer n, Integer kl, Integer ku, Integer nrhs, const Complex ab[], Integer pdab, const Complex afb[], Integer pdafb, const Integer ipiv[], const Complex b[], Integer pdb, Complex x[], Integer pdx, double ferr[], double berr[], NagError *fail)

3

Description

nag_zgbrfs (f07bvc) returns the backward errors and estimated bounds on the forward errors for the solution of a complex band system of linear equations with multiple right-hand sides

A X = B

A^{T} X = B

A^{H} X = B

. The function handles each right-hand side vector (stored as a column of the matrix

B

) independently, so we describe the function of nag_zgbrfs (f07bvc) in terms of a single right-hand side

b

and solution

x

Given a computed solution

x

, the function computes the component-wise backward error

β

. This is the size of the smallest relative perturbation in each element of

A

and

b

such that

x

is the exact solution of a perturbed system

\begin{matrix} (A + δ A) x = b + δ b \\ |δ a_{i j}| \leq β |a_{i j}| and |δ b_{i}| \leq β |b_{i}| . \end{matrix}

Then the function estimates a bound for the component-wise forward error in the computed solution, defined by:

\max_{i} |x_{i} - {\hat{x}}_{i}| / \max_{i} |x_{i}|

where

\hat{x}

is the true solution.

For details of the method, see the f07 Chapter Introduction.

4

References

Golub G H and Van Loan C F (1996) Matrix Computations (3rd Edition) Johns Hopkins University Press, Baltimore

5

Arguments

1: $order$ – Nag_OrderTypeInput

On entry: the order argument specifies the two-dimensional storage scheme being used, i.e., row-major ordering or column-major ordering. C language defined storage is specified by

order = Nag_RowMajor

. See Section 3.3.1.3 in How to Use the NAG Library and its Documentation for a more detailed explanation of the use of this argument.

Constraint:

order = Nag_RowMajor

Nag_ColMajor

2: $trans$ – Nag_TransTypeInput

On entry: indicates the form of the linear equations for which

X

is the computed solution as follows:

$trans = Nag_NoTrans$: The linear equations are of the form $A X = B$ .
$trans = Nag_Trans$: The linear equations are of the form $A^{T} X = B$ .
$trans = Nag_ConjTrans$: The linear equations are of the form $A^{H} X = B$ .

Constraint:

trans = Nag_NoTrans

Nag_Trans

Nag_ConjTrans

3: $n$ – IntegerInput

On entry:

n

, the order of the matrix

A

Constraint:

n \geq 0

4: $kl$ – IntegerInput

On entry:

k_{l}

, the number of subdiagonals within the band of the matrix

A

Constraint:

kl \geq 0

5: $ku$ – IntegerInput

On entry:

k_{u}

, the number of superdiagonals within the band of the matrix

A

Constraint:

ku \geq 0

6: $nrhs$ – IntegerInput

On entry:

r

, the number of right-hand sides.

Constraint:

nrhs \geq 0

7: $ab [\dim]$ – const ComplexInput

Note: the dimension, dim, of the array ab must be at least

\max (1, pdab \times n)

On entry: the original

n

n

band matrix

A

as supplied to nag_zgbtrf (f07brc) but with reduced requirements since the matrix is not factorized.

This is stored as a notional two-dimensional array with row elements or column elements stored contiguously. The storage of elements

A_{i j}

, for row

i = 1, \dots, n

and column

j = \max (1, i - k_{l}), \dots, \min (n, i + k_{u})

, depends on the order argument as follows:

if $order = Nag_ColMajor$ , $A_{i j}$ is stored as $ab [(j - 1) \times pdab + ku + i - j]$ ;
if $order = Nag_RowMajor$ , $A_{i j}$ is stored as $ab [(i - 1) \times pdab + kl + j - i]$ .

See Section 9 in nag_zgbsv (f07bnc) for further details.

8: $pdab$ – IntegerInput

On entry: the stride separating row or column elements (depending on the value of order) of the matrix

A

in the array ab.

Constraint:

pdab \geq kl + ku + 1

9: $afb [\dim]$ – const ComplexInput

Note: the dimension, dim, of the array afb must be at least

\max (1, pdafb \times n)

On entry: the

L U

factorization of

A

, as returned by nag_zgbtrf (f07brc).

10: $pdafb$ – IntegerInput

On entry: the stride separating row or column elements (depending on the value of order) of the matrix in the array afb.

Constraint:

pdafb \geq 2 \times kl + ku + 1

11: $ipiv [\dim]$ – const IntegerInput

Note: the dimension, dim, of the array ipiv must be at least

\max (1, n)

On entry: the pivot indices, as returned by nag_zgbtrf (f07brc).

12: $b [\dim]$ – const ComplexInput

Note: the dimension, dim, of the array b must be at least

$\max (1, pdb \times nrhs)$ when $order = Nag_ColMajor$ ;
$\max (1, n \times pdb)$ when $order = Nag_RowMajor$ .

The

(i, j)

th element of the matrix

B

is stored in

$b [(j - 1) \times pdb + i - 1]$ when $order = Nag_ColMajor$ ;
$b [(i - 1) \times pdb + j - 1]$ when $order = Nag_RowMajor$ .

On entry: the

n

r

right-hand side matrix

B

13: $pdb$ – IntegerInput

On entry: the stride separating row or column elements (depending on the value of order) in the array b.

Constraints:

if $order = Nag_ColMajor$ , $pdb \geq \max (1, n)$ ;
if $order = Nag_RowMajor$ , $pdb \geq \max (1, nrhs)$ .

14: $x [\dim]$ – ComplexInput/Output

Note: the dimension, dim, of the array x must be at least

$\max (1, pdx \times nrhs)$ when $order = Nag_ColMajor$ ;
$\max (1, n \times pdx)$ when $order = Nag_RowMajor$ .

The

(i, j)

th element of the matrix

X

is stored in

$x [(j - 1) \times pdx + i - 1]$ when $order = Nag_ColMajor$ ;
$x [(i - 1) \times pdx + j - 1]$ when $order = Nag_RowMajor$ .

On entry: the

n

r

solution matrix

X

, as returned by nag_zgbtrs (f07bsc).

On exit: the improved solution matrix

X

15: $pdx$ – IntegerInput

On entry: the stride separating row or column elements (depending on the value of order) in the array x.

Constraints:

if $order = Nag_ColMajor$ , $pdx \geq \max (1, n)$ ;
if $order = Nag_RowMajor$ , $pdx \geq \max (1, nrhs)$ .

16: $ferr [nrhs]$ – doubleOutput

On exit:

ferr [j - 1]

contains an estimated error bound for the

j

th solution vector, that is, the

j

th column of

X

, for

j = 1, 2, \dots, r

17: $berr [nrhs]$ – doubleOutput

On exit:

berr [j - 1]

contains the component-wise backward error bound

β

for the

j

th solution vector, that is, the

j

th column of

X

, for

j = 1, 2, \dots, r

18: $fail$ – NagError *Input/Output

The NAG error argument (see Section 3.7 in How to Use the NAG Library and its Documentation).

6

Error Indicators and Warnings

NE_ALLOC_FAIL: Dynamic memory allocation failed.
See Section 2.3.1.2 in How to Use the NAG Library and its Documentation for further information.
NE_BAD_PARAM: On entry, argument $〈value〉$ had an illegal value.
NE_INT: On entry, $kl = 〈value〉$ .
Constraint: $kl \geq 0$ .

On entry, $ku = 〈value〉$ .
Constraint: $ku \geq 0$ .

On entry, $n = 〈value〉$ .
Constraint: $n \geq 0$ .

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

On entry, $pdab = 〈value〉$ .
Constraint: $pdab > 0$ .

On entry, $pdafb = 〈value〉$ .
Constraint: $pdafb > 0$ .

On entry, $pdb = 〈value〉$ .
Constraint: $pdb > 0$ .

On entry, $pdx = 〈value〉$ .
Constraint: $pdx > 0$ .
NE_INT_2: On entry, $pdb = 〈value〉$ and $n = 〈value〉$ .
Constraint: $pdb \geq \max (1, n)$ .

On entry, $pdb = 〈value〉$ and $nrhs = 〈value〉$ .
Constraint: $pdb \geq \max (1, nrhs)$ .

On entry, $pdx = 〈value〉$ and $n = 〈value〉$ .
Constraint: $pdx \geq \max (1, n)$ .

On entry, $pdx = 〈value〉$ and $nrhs = 〈value〉$ .
Constraint: $pdx \geq \max (1, nrhs)$ .
NE_INT_3: On entry, $pdab = 〈value〉$ , $kl = 〈value〉$ and $ku = 〈value〉$ .
Constraint: $pdab \geq kl + ku + 1$ .

On entry, $pdafb = 〈value〉$ , $kl = 〈value〉$ and $ku = 〈value〉$ .
Constraint: $pdafb \geq 2 \times kl + ku + 1$ .
NE_INTERNAL_ERROR: An internal error has occurred in this function. Check the function call and any array sizes. If the call is correct then please contact NAG for assistance.
See Section 2.7.6 in How to Use the NAG Library and its Documentation for further information.
NE_NO_LICENCE: Your licence key may have expired or may not have been installed correctly.
See Section 2.7.5 in How to Use the NAG Library and its Documentation for further information.

7

Accuracy

The bounds returned in ferr are not rigorous, because they are estimated, not computed exactly; but in practice they almost always overestimate the actual error.

8

Parallelism and Performance

nag_zgbrfs (f07bvc) is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.

nag_zgbrfs (f07bvc) 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 function. Please also consult the Users' Note for your implementation for any additional implementation-specific information.

9

Further Comments

For each right-hand side, computation of the backward error involves a minimum of

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

real floating-point operations. Each step of iterative refinement involves an additional

8 n (4 k_{l} + 3 k_{u})

real operations. This assumes

n ≫ k_{l}

and

n ≫ k_{u}

. At most five steps of iterative refinement are performed, but usually only one or two steps are required.

Estimating the forward error involves solving a number of systems of linear equations of the form

A x = b

A^{H} x = b

; the number is usually

5

and never more than

11

. Each solution involves approximately

8 n (2 k_{l} + k_{u})

real operations.

The real analogue of this function is nag_dgbrfs (f07bhc).

10

Example

This example solves the system of equations

A X = B

using iterative refinement and to compute the forward and backward error bounds, where

A = (\begin{array}{r} - 1.65 + 2.26 i & - 2.05 - 0.85 i & 0.97 - 2.84 i & 0.00 + 0.00 i \\ 0.00 + 6.30 i & - 1.48 - 1.75 i & - 3.99 + 4.01 i & 0.59 - 0.48 i \\ 0.00 + 0.00 i & - 0.77 + 2.83 i & - 1.06 + 1.94 i & 3.33 - 1.04 i \\ 0.00 + 0.00 i & 0.00 + 0.00 i & 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}) .

Here

A

is nonsymmetric and is treated as a band matrix, which must first be factorized by nag_zgbtrf (f07brc).

NAG C Library Function Document

nag_zgbrfs (f07bvc)

▸▿ 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