Integer, Intent (In)	::	n, kl, ku, nrhs, ldab, ldafb, ldb, ldx
Integer, Intent (Inout)	::	ipiv(*)
Integer, Intent (Out)	::	info
Real (Kind=nag_wp), Intent (Inout)	::	r(), c()
Real (Kind=nag_wp), Intent (Out)	::	rcond, ferr(nrhs), berr(nrhs), rwork(max(1,n))
Complex (Kind=nag_wp), Intent (Inout)	::	ab(ldab,), afb(ldafb,), b(ldb,), x(ldx,)
Complex (Kind=nag_wp), Intent (Out)	::	work(2*n)
Character (1), Intent (In)	::	fact, trans
Character (1), Intent (Inout)	::	equed

C Header Interface

#include nagmk26.h

void

f07bpf_ ( const char *fact, const char *trans, const Integer *n, const Integer *kl, const Integer *ku, const Integer *nrhs, Complex ab[], const Integer *ldab, Complex afb[], const Integer *ldafb, Integer ipiv[], char *equed, double r[], double c[], Complex b[], const Integer *ldb, Complex x[], const Integer *ldx, double *rcond, double ferr[], double berr[], Complex work[], double rwork[], Integer *info, const Charlen length_fact, const Charlen length_trans, const Charlen length_equed)

The routine may be called by its LAPACK name zgbsvx.

3

Description

f07bpf (zgbsvx) performs the following steps:

Equilibration

The linear system to be solved may be badly scaled. However, the system can be equilibrated as a first stage by setting

fact ='E'

. In this case, real scaling factors are computed and these factors then determine whether the system is to be equilibrated. Equilibrated forms of the systems

A X = B

A^{T} X = B

and

A^{H} X = B

are

(D_{R} A D_{C}) (D_{C}^{- 1} X) = D_{R} B,

{(D_{R} A D_{C})}^{T} (D_{R}^{- 1} X) = D_{C} B,

and

{(D_{R} A D_{C})}^{H} (D_{R}^{- 1} X) = D_{C} B,

respectively, where

D_{R}

and

D_{C}

are diagonal matrices, with positive diagonal elements, formed from the computed scaling factors.

When equilibration is used,

A

will be overwritten by

D_{R} A D_{C}

and

B

will be overwritten by

D_{R} B

(or

D_{C} B

when the solution of

A^{T} X = B

A^{H} X = B

is sought).

Factorization

The matrix

A

, or its scaled form, is copied and factored using the

L U

decomposition

A = P L U,

where

P

is a permutation matrix,

L

is a unit lower triangular matrix, and

U

is upper triangular.

This stage can be by-passed when a factored matrix (with scaled matrices and scaling factors) are supplied; for example, as provided by a previous call to f07bpf (zgbsvx) with the same matrix

A

Condition Number Estimation

The

L U

factorization of

A

determines whether a solution to the linear system exists. If some diagonal element of

U

is zero, then

U

is exactly singular, no solution exists and the routine returns with a failure. Otherwise the factorized form of

A

is used to estimate the condition number of the matrix

A

. If the reciprocal of the condition number is less than machine precision then a warning code is returned on final exit.

Solution

The (equilibrated) system is solved for

X

(

D_{C}^{- 1} X

D_{R}^{- 1} X

) using the factored form of

A

(

D_{R} A D_{C}

Iterative Refinement

Iterative refinement is applied to improve the computed solution matrix and to calculate error bounds and backward error estimates for the computed solution.

Construct Solution Matrix $X$

If equilibration was used, the matrix

X

is premultiplied by

D_{C}

(if

trans ='N'

) or

D_{R}

(if

trans ='T'

'C'

) so that it solves the original system before equilibration.

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

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

Higham N J (2002) Accuracy and Stability of Numerical Algorithms (2nd Edition) SIAM, Philadelphia

5

Arguments

1: $fact$ – Character(1)Input

On entry: specifies whether or not the factorized form of the matrix

A

is supplied on entry, and if not, whether the matrix

A

should be equilibrated before it is factorized.

$fact ='F'$: afb and ipiv contain the factorized form of $A$ . If $equed \neq'N'$ , the matrix $A$ has been equilibrated with scaling factors given by r and c. ab, afb and ipiv are not modified.
$fact ='N'$: The matrix $A$ will be copied to afb and factorized.
$fact ='E'$: The matrix $A$ will be equilibrated if necessary, then copied to afb and factorized.

Constraint:

fact ='F'

'N'

'E'

2: $trans$ – Character(1)Input

On entry: specifies the form of the system of equations.

$trans ='N'$: $A X = B$ (No transpose).
$trans ='T'$: $A^{T} X = B$ (Transpose).
$trans ='C'$: $A^{H} X = B$ (Conjugate transpose).

Constraint:

trans ='N'

'T'

'C'

3: $n$ – IntegerInput

On entry:

n

, the number of linear equations, i.e., 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, i.e., the number of columns of the matrix

B

Constraint:

nrhs \geq 0

7: $ab (ldab *)$ – Complex (Kind=nag_wp) arrayInput/Output

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

\max (1, n)

On entry: the

n

n

coefficient matrix

A

The matrix is stored in rows

1

k_{l} + k_{u} + 1

, more precisely, the element

A_{i j}

must be stored in

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

See Section 9 for further details.

fact ='F'

and

equed \neq'N'

A

must have been equilibrated by the scaling factors in r and/or c.

On exit: if

fact ='F'

'N'

, or if

fact ='E'

and

equed ='N'

, ab is not modified.

equed \neq'N'

then, if no constraints are violated,

A

is scaled as follows:

if $equed ='R'$ , $A = D_{r} A$ ;
if $equed ='C'$ , $A = A D_{c}$ ;
if $equed ='B'$ , $A = D_{r} A D_{c}$ .

8: $ldab$ – IntegerInput

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

Constraint:

ldab \geq kl + ku + 1

9: $afb (ldafb *)$ – Complex (Kind=nag_wp) arrayInput/Output

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

\max (1, n)

On entry: if

fact ='N'

'E'

, afb need not be set.

fact ='F'

, details of the

L U

factorization of the

n

n

band matrix

A

, as computed by f07brf (zgbtrf).

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

equed \neq'N'

, afb is the factorized form of the equilibrated matrix

A

On exit: if

fact ='F'

, afb is unchanged from entry.

Otherwise, if no constraints are violated, then if

fact ='N'

, afb returns details of the

L U

factorization of the band matrix

A

, and if

fact ='E'

, afb returns details of the

L U

factorization of the equilibrated band matrix

A

(see the description of ab for the form of the equilibrated matrix).

10: $ldafb$ – IntegerInput

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

Constraint:

ldafb \geq 2 \times kl + ku + 1

11: $ipiv (*)$ – Integer arrayInput/Output

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

\max (1, n)

On entry: if

fact ='N'

'E'

, ipiv need not be set.

fact ='F'

, ipiv contains the pivot indices from the factorization

A = L U

, as computed by f07bdf (dgbtrf); row

i

of the matrix was interchanged with row

ipiv (i)

On exit: if

fact ='F'

, ipiv is unchanged from entry.

Otherwise, if no constraints are violated, ipiv contains 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.

fact ='N'

, the pivot indices are those corresponding to the factorization

A = L U

of the original matrix

A

fact ='E'

, the pivot indices are those corresponding to the factorization of

A = L U

of the equilibrated matrix

A

12: $equed$ – Character(1)Input/Output

On entry: if

fact ='N'

'E'

, equed need not be set.

fact ='F'

, equed must specify the form of the equilibration that was performed as follows:

if $equed ='N'$ , no equilibration;
if $equed ='R'$ , row equilibration, i.e., $A$ has been premultiplied by $D_{R}$ ;
if $equed ='C'$ , column equilibration, i.e., $A$ has been postmultiplied by $D_{C}$ ;
if $equed ='B'$ , both row and column equilibration, i.e., $A$ has been replaced by $D_{R} A D_{C}$ .

On exit: if

fact ='F'

, equed is unchanged from entry.

Otherwise, if no constraints are violated, equed specifies the form of equilibration that was performed as specified above.

Constraint: if

fact ='F'

equed ='N'

'R'

'C'

'B'

13: $r (*)$ – Real (Kind=nag_wp) arrayInput/Output

Note: the dimension of the array r must be at least

\max (1, n)

On entry: if

fact ='N'

'E'

, r need not be set.

fact ='F'

and

equed ='R'

'B'

, r must contain the row scale factors for

A

D_{R}

; each element of r must be positive.

On exit: if

fact ='F'

, r is unchanged from entry.

Otherwise, if no constraints are violated and

equed ='R'

'B'

, r contains the row scale factors for

A

D_{R}

, such that

A

is multiplied on the left by

D_{R}

; each element of r is positive.

14: $c (*)$ – Real (Kind=nag_wp) arrayInput/Output

Note: the dimension of the array c must be at least

\max (1, n)

On entry: if

fact ='N'

'E'

, c need not be set.

fact ='F'

and

equed ='C'

'B'

, c must contain the column scale factors for

A

D_{C}

; each element of c must be positive.

On exit: if

fact ='F'

, c is unchanged from entry.

Otherwise, if no constraints are violated and

equed ='C'

'B'

, c contains the row scale factors for

A

D_{C}

; each element of c is positive.

15: $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

r

right-hand side matrix

B

On exit: if

equed ='N'

, b is not modified.

trans ='N'

and

equed ='R'

'B'

, b is overwritten by

D_{R} B

trans ='T'

'C'

and

equed ='C'

'B'

, b is overwritten by

D_{C} B

16: $ldb$ – IntegerInput

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

Constraint:

ldb \geq \max (1, n)

17: $x (ldx *)$ – Complex (Kind=nag_wp) arrayOutput

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

\max (1, nrhs)

On exit: if

info = 0

n + 1

, the

n

r

solution matrix

X

to the original system of equations. Note that the arrays

A

and

B

are modified on exit if

equed \neq'N'

, and the solution to the equilibrated system is

D_{C}^{- 1} X

trans ='N'

and

equed ='C'

'B'

, or

D_{R}^{- 1} X

trans ='T'

'C'

and

equed ='R'

'B'

18: $ldx$ – IntegerInput

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

Constraint:

ldx \geq \max (1, n)

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

On exit: if no constraints are violated, an estimate of the reciprocal condition number of the matrix

A

(after equilibration if that is performed), computed as

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

20: $ferr (nrhs)$ – Real (Kind=nag_wp) arrayOutput

On exit: if

info = 0

n + 1

, an estimate of the forward error bound for each computed solution vector, such that

{‖{\hat{x}}_{j} - x_{j}‖}_{\infty} / {‖x_{j}‖}_{\infty} \leq ferr (j)

where

{\hat{x}}_{j}

is the

j

th column of the computed solution returned in the array x and

x_{j}

is the corresponding column of the exact solution

X

. The estimate is as reliable as the estimate for rcond, and is almost always a slight overestimate of the true error.

21: $berr (nrhs)$ – Real (Kind=nag_wp) arrayOutput

On exit: if

info = 0

n + 1

, an estimate of the component-wise relative backward error of each computed solution vector

{\hat{x}}_{j}

(i.e., the smallest relative change in any element of

A

B

that makes

{\hat{x}}_{j}

an exact solution).

22: $work (2 \times n)$ – Complex (Kind=nag_wp) arrayWorkspace

23: $rwork (\max (1, n))$ – Real (Kind=nag_wp) arrayOutput

On exit: if

info = 0

rwork (1)

contains the reciprocal pivot growth factor

\max |a_{i j}| / \max |u_{i j}|

. If

rwork (1)

is much less than

1

, then the stability of the

L U

factorization of the (equilibrated) matrix

A

could be poor. This also means that the solution

X

, condition estimator rcond, and forward error bound ferr could be unreliable. If the factorization fails with

info > 0 and info \leq n

rwork (1)

contains the reciprocal pivot growth factor for the leading info columns of

A

24: $info$ – IntegerOutput

On exit:

info = 0

unless the routine detects an error (see Section 6).

6

Error Indicators and Warnings

$info < 0$: If $info = - i$ , argument $i$ had an illegal value. An explanatory message is output, and execution of the program is terminated.

$info > 0 and info \leq n$: Element $〈value〉$ of the diagonal is exactly zero. The factorization has been completed, but the factor $U$ is exactly singular, so the solution and error bounds could not be computed. $rcond = 0.0$ is returned.

$info = n + 1$: $U$ is nonsingular, but rcond is less than machine precision, meaning that the matrix is singular to working precision. Nevertheless, the solution and error bounds are computed because there are a number of situations where the computed solution can be more accurate than the value of rcond would suggest.

7

Accuracy

For each right-hand side vector

b

, the computed solution

\hat{x}

is the exact solution of a perturbed system of equations

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

, where

|E| \leq c (n) ε P |L| |U|,

c (n)

is a modest linear function of

n

, and

ε

is the machine precision. See Section 9.3 of Higham (2002) for further details.

x

is the true solution, then the computed solution

\hat{x}

satisfies a forward error bound of the form

\frac{{‖x - \hat{x}‖}_{\infty}}{{‖\hat{x}‖}_{\infty}} \leq w_{c} cond (A, \hat{x}, b)

where

cond (A, \hat{x}, b) = {‖|A^{- 1}| (|A| |\hat{x}| + |b|)‖}_{\infty} / {‖\hat{x}‖}_{\infty} \leq cond (A) = {‖|A^{- 1}| |A|‖}_{\infty} \leq κ_{\infty} (A)

. If

\hat{x}

is the

j

th column of

X

, then

w_{c}

is returned in

berr (j)

and a bound on

{‖x - \hat{x}‖}_{\infty} / {‖\hat{x}‖}_{\infty}

is returned in

ferr (j)

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

8

Parallelism and Performance

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

f07bpf (zgbsvx) 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}

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. The solution is then refined, and the errors estimated, using iterative refinement; see f07bvf (zgbrfs) for information on the floating-point operations required.

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 this routine is f07bbf (dgbsvx).

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 \\ 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}) .

Estimates for the backward errors, forward errors, condition number and pivot growth are also output, together with information on the equilibration of

A

NAG Library Routine Document

f07bpf (zgbsvx)

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