NAG Library Routine Document
f07bnf (zgbsv)
1
Purpose
f07bnf (zgbsv) computes the solution to a complex system of linear equations
where
is an
by
band matrix, with
subdiagonals and
superdiagonals, and
and
are
by
matrices.
2
Specification
Fortran Interface
Integer, Intent (In) | :: | n, kl, ku, nrhs, ldab, ldb | Integer, Intent (Out) | :: | ipiv(n), info | Complex (Kind=nag_wp), Intent (Inout) | :: | ab(ldab,*), b(ldb,*) |
|
C Header Interface
#include <nagmk26.h>
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 its
LAPACK
name zgbsv.
3
Description
f07bnf (zgbsv) uses the decomposition with partial pivoting and row interchanges to factor as , where is a permutation matrix, is a product of permutation and unit lower triangular matrices with subdiagonals, and is upper triangular with superdiagonals. The factored form of is then used to solve the system of equations .
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
5
Arguments
- 1: – IntegerInput
-
On entry: , the number of linear equations, i.e., the order of the matrix .
Constraint:
.
- 2: – IntegerInput
-
On entry: , the number of subdiagonals within the band of the matrix .
Constraint:
.
- 3: – IntegerInput
-
On entry: , the number of superdiagonals within the band of the matrix .
Constraint:
.
- 4: – IntegerInput
-
On entry: , the number of right-hand sides, i.e., the number of columns of the matrix .
Constraint:
.
- 5: – Complex (Kind=nag_wp) arrayInput/Output
-
Note: the second dimension of the array
ab
must be at least
.
On entry: the
by
coefficient matrix
.
The matrix is stored in rows
to
; the first
rows need not be set, more precisely, the element
must be stored in
See
Section 9 for further details.
On exit: if
,
ab is overwritten by details of the factorization.
The upper triangular band matrix , with superdiagonals, is stored in rows to of the array, and the multipliers used to form the matrix are stored in rows to .
- 6: – IntegerInput
-
On entry: the first dimension of the array
ab as declared in the (sub)program from which
f07bnf (zgbsv) is called.
Constraint:
.
- 7: – Integer arrayOutput
-
On exit: if no constraints are violated, the pivot indices that define the permutation matrix ; at the th step row of the matrix was interchanged with row . indicates a row interchange was not required.
- 8: – Complex (Kind=nag_wp) arrayInput/Output
-
Note: the second dimension of the array
b
must be at least
.
On entry: the by right-hand side matrix .
On exit: if , the by solution matrix .
- 9: – IntegerInput
-
On entry: the first dimension of the array
b as declared in the (sub)program from which
f07bnf (zgbsv) is called.
Constraint:
.
- 10: – IntegerOutput
On exit:
unless the routine detects an error (see
Section 6).
6
Error Indicators and Warnings
If , argument had an illegal value. An explanatory message is output, and execution of the program is terminated.
-
Element of the diagonal is exactly zero.
The factorization has been completed, but the factor is exactly singular, so the solution could not be computed.
7
Accuracy
The computed solution for a single right-hand side,
, satisfies an equation of the form
where
and
is the
machine precision. An approximate error bound for the computed solution is given by
where
, the condition number of
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 (zgbsv),
f07buf (zgbcon) can be used to estimate the condition number of
and
f07bvf (zgbrfs) can be used to obtain approximate error bounds. Alternatives to
f07bnf (zgbsv), which return condition and error estimates directly are
f04cbf and
f07bpf (zgbsvx).
8
Parallelism and Performance
f07bnf (zgbsv) is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.
f07bnf (zgbsv) 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.
The band storage scheme for the array
ab is illustrated by the following example, when
,
, and
. Storage of the band matrix
in the array
ab:
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 , and .
The total number of floating-point operations required to solve the equations depends upon the pivoting required, but if then it is approximately bounded by for the factorization and for the solution following the factorization.
The real analogue of this routine is
f07baf (dgbsv).
10
Example
This example solves the equations
where
is the band matrix
and
Details of the
factorization of
are also output.
10.1
Program Text
Program Text (f07bnfe.f90)
10.2
Program Data
Program Data (f07bnfe.d)
10.3
Program Results
Program Results (f07bnfe.r)