F04CBF (PDF version)
F04 Chapter Contents
F04 Chapter Introduction
NAG Library Manual

NAG Library Routine Document

F04CBF

Note:  before using this routine, please read the Users' Note for your implementation to check the interpretation of bold italicised terms and other implementation-dependent details.

 Contents

    1  Purpose
    7  Accuracy

1  Purpose

F04CBF computes the solution to a complex system of linear equations AX=B, where A is an n by n band matrix, with kl subdiagonals and ku superdiagonals, and X and B are n by r matrices. An estimate of the condition number of A and an error bound for the computed solution are also returned.

2  Specification

SUBROUTINE F04CBF ( N, KL, KU, NRHS, AB, LDAB, IPIV, B, LDB, RCOND, ERRBND, IFAIL)
INTEGER  N, KL, KU, NRHS, LDAB, IPIV(N), LDB, IFAIL
REAL (KIND=nag_wp)  RCOND, ERRBND
COMPLEX (KIND=nag_wp)  AB(LDAB,*), B(LDB,*)

3  Description

The LU decomposition with partial pivoting and row interchanges is used to factor A as A=PLU, where P is a permutation matrix, L is the product of permutation matrices and unit lower triangular matrices with kl subdiagonals, and U is upper triangular with kl+ku superdiagonals. The factored form of A is then used to solve the system of equations AX=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 http://www.netlib.org/lapack/lug
Higham N J (2002) Accuracy and Stability of Numerical Algorithms (2nd Edition) SIAM, Philadelphia

5  Parameters

1:     N – INTEGERInput
On entry: the number of linear equations n, i.e., the order of the matrix A.
Constraint: N0.
2:     KL – INTEGERInput
On entry: the number of subdiagonals kl, within the band of A.
Constraint: KL0.
3:     KU – INTEGERInput
On entry: the number of superdiagonals ku, within the band of A.
Constraint: KU0.
4:     NRHS – INTEGERInput
On entry: the number of right-hand sides r, i.e., the number of columns of the matrix B.
Constraint: NRHS0.
5:     ABLDAB* – COMPLEX (KIND=nag_wp) arrayInput/Output
Note: the second dimension of the array AB must be at least max1,N.
On entry: the n by n matrix A.
The matrix is stored in rows kl+1 to 2kl+ku+1; the first kl rows need not be set, more precisely, the element Aij must be stored in
ABkl+ku+1+i-jj=Aij  for ​max1,j-kuiminn,j+kl. 
See Section 9 for further details.
On exit: if IFAIL0, AB is overwritten by details of the factorization.
The upper triangular band matrix U, with kl+ku superdiagonals, is stored in rows 1 to kl+ku+1 of the array, and the multipliers used to form the matrix L are stored in rows kl+ku+2 to 2kl+ku+1.
6:     LDAB – INTEGERInput
On entry: the first dimension of the array AB as declared in the (sub)program from which F04CBF is called.
Constraint: LDAB2×KL+KU+1.
7:     IPIVN – INTEGER arrayOutput
On exit: if IFAIL0, the pivot indices that define the permutation matrix P; at the ith step row i of the matrix was interchanged with row IPIVi. IPIVi=i indicates a row interchange was not required.
8:     BLDB* – COMPLEX (KIND=nag_wp) arrayInput/Output
Note: the second dimension of the array B must be at least max1,NRHS.
On entry: the n by r matrix of right-hand sides B.
On exit: if IFAIL=0 or N+1, the n by r solution matrix X.
9:     LDB – INTEGERInput
On entry: the first dimension of the array B as declared in the (sub)program from which F04CBF is called.
Constraint: LDBmax1,N.
10:   RCOND – REAL (KIND=nag_wp)Output
On exit: if IFAIL0, an estimate of the reciprocal of the condition number of the matrix A, computed as RCOND=A1A-11.
11:   ERRBND – REAL (KIND=nag_wp)Output
On exit: if IFAIL=0 or N+1, an estimate of the forward error bound for a computed solution x^, such that x^-x1/x1ERRBND, where 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, then ERRBND is returned as unity.
12:   IFAIL – INTEGERInput/Output
On entry: IFAIL must be set to 0, -1​ or ​1. If you are unfamiliar with this parameter you should refer to Section 3.3 in the Essential Introduction for details.
For environments where it might be inappropriate to halt program execution when an error is detected, the value -1​ or ​1 is recommended. If the output of error messages is undesirable, then the value 1 is recommended. Otherwise, if you are not familiar with this parameter, the recommended value is 0. 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 or -1, explanatory error messages are output on the current error message unit (as defined by X04AAF).
Errors or warnings detected by the routine:
IFAIL<0andIFAIL-999
If IFAIL=-i, the ith argument had an illegal value.
IFAIL>0andIFAILN
If IFAIL=i, uii is exactly zero. The factorization has been completed, but the factor U is exactly singular, so the solution could not be computed.
IFAIL=N+1
RCOND is less than machine precision, so that the matrix A is numerically singular. A solution to the equations AX=B has nevertheless been computed.
IFAIL=-99
An unexpected error has been triggered by this routine. Please contact NAG.
See Section 3.8 in the Essential Introduction for further information.
IFAIL=-399
Your licence key may have expired or may not have been installed correctly.
See Section 3.7 in the Essential Introduction for further information.
IFAIL=-999
Dynamic memory allocation failed.
See Section 3.6 in the Essential Introduction for further information.

7  Accuracy

The computed solution for a single right-hand side, x^, satisfies an equation of the form
A+E x^=b,  
where
E1=Oε A1  
and ε is the machine precision. An approximate error bound for the computed solution is given by
x^-x1 x1 κA E1 A1 ,  
where κA=A-11A1, the condition number of A with respect to the solution of the linear equations. F04CBF uses the approximation E1=εA1 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 real allocatable memory required is N, and the complex allocatable memory required is 2×N. In this case the factorization and the solution X have been computed, but RCOND and ERRBND have not been computed.
The band storage scheme for the array AB is illustrated by the following example, when n=6, kl=1, and ku=2. Storage of the band matrix A in the array AB:
* * * + + + * * a13 a24 a35 a46 * a12 a23 a34 a45 a56 a11 a22 a33 a44 a55 a66 a21 a32 a43 a54 a65 *  
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 u14, u25 and u36.
The total number of floating-point operations required to solve the equations AX=B depends upon the pivoting required, but if nkl+ku then it is approximately bounded by O n kl kl + ku  for the factorization and O n 2 kl + ku ,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
AX=B,  
where A is the band matrix
A= -1.65+2.26i -2.05-0.85i 0.97-2.84i 0.00i+0.00 0.00+6.30i -1.48-1.75i -3.99+4.01i 0.59-0.48i 0.00i+0.00 -0.77+2.83i -1.06+1.94i 3.33-1.04i 0.00i+0.00 0.00i+0.00 4.48-1.09i -0.46-1.72i  
and
B= -1.06+21.50i 12.85+02.84i -22.72-53.90i -70.22+21.57i 28.24-38.60i -20.73-01.23i -34.56+16.73i 26.01+31.97i .  
An estimate of the condition number of A and an approximate error bound for the computed solutions are also printed.

10.1  Program Text

Program Text (f04cbfe.f90)

10.2  Program Data

Program Data (f04cbfe.d)

10.3  Program Results

Program Results (f04cbfe.r)


F04CBF (PDF version)
F04 Chapter Contents
F04 Chapter Introduction
NAG Library Manual

© The Numerical Algorithms Group Ltd, Oxford, UK. 2015