void	f07bnf_ (const Integer n, const Integer kl, const Integer ku, const Integer nrhs, Complex ab[], const Integer ldab, Integer ipiv[], Complex b[], const Integer ldb, Integer *info)

The routine may be called by the names f07bnf, nagf_lapacklin_zgbsv or its LAPACK name zgbsv.

3 Description

f07bnf uses the

L U

decomposition with partial pivoting and row interchanges to factor

A

A = P L U

, where

P

is a permutation matrix,

L

is a product of permutation 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

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

5 Arguments

1: $n$ – Integer Input

On entry:

n

, the number of linear equations, i.e., the order of the matrix

A

Constraint:

n \geq 0

2: $kl$ – Integer Input

On entry:

k_{l}

, the number of subdiagonals within the band of the matrix

A

Constraint:

kl \geq 0

3: $ku$ – Integer Input

On entry:

k_{u}

, the number of superdiagonals within the band of the matrix

A

Constraint:

ku \geq 0

4: $nrhs$ – Integer Input

On entry:

r

, the number of right-hand sides, 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

n

coefficient 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

info \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 f07bnf is called.

Constraint:

ldab \geq 2 \times kl + ku + 1

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

On exit: if no constraints are violated, 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

r

right-hand side matrix

B

On exit: if

info = 0

, the

n

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 f07bnf is called.

Constraint:

ldb \geq \max (1, n)

10: $info$ – Integer Output

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$: Element $〈value〉$ of the diagonal is exactly zero. The factorization has been completed, but the factor $U$ is exactly singular, so the solution could not be computed.

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. See Section 4.4 of Anderson et al. (1999) for further details.

Following the use of f07bnf, f07buf can be used to estimate the condition number of

A

and f07bvf can be used to obtain approximate error bounds. Alternatives to f07bnf, which return condition and error estimates directly are f04cbf and f07bpf.

8 Parallelism and Performance

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

f07bnf 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 real analogue of this routine is f07baf.

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 \\ - 22.72 - 53.90 i \\ 28.24 - 38.60 i \\ - 34.56 + 16.73 i \end{array}) .

Details of the

L U

factorization of

A

are also output.

Interfaces: FL CL AD

NAG FL Interface Introduction

F07 (Lapacklin) Chapter Contents

F07 (Lapacklin) Chapter Introduction

f07bn: FL CL AD

NAG FL Interfacef07bnf (zgbsv)

▸▿ 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
f07bnf (zgbsv)