hide long namesshow long names
hide short namesshow short names
Integer type:  int32  int64  nag_int  show int32  show int32  show int64  show int64  show nag_int  show nag_int

PDF version (NAG web site, 64-bit version, 64-bit version)
Chapter Contents
Chapter Introduction
NAG Toolbox

NAG Toolbox: nag_lapack_zgbsvx (f07bp)

 Contents

    1  Purpose
    2  Syntax
    7  Accuracy
    9  Example

Purpose

nag_lapack_zgbsvx (f07bp) uses the LU factorization to compute the solution to a complex system of linear equations
AX=B ,  ATX=B   or   AHX=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. Error bounds on the solution and a condition estimate are also provided.

Syntax

[ab, afb, ipiv, equed, r, c, b, x, rcond, ferr, berr, rwork, info] = f07bp(fact, trans, kl, ku, ab, afb, ipiv, equed, r, c, b, 'n', n, 'nrhs_p', nrhs_p)
[ab, afb, ipiv, equed, r, c, b, x, rcond, ferr, berr, rwork, info] = nag_lapack_zgbsvx(fact, trans, kl, ku, ab, afb, ipiv, equed, r, c, b, 'n', n, 'nrhs_p', nrhs_p)

Description

nag_lapack_zgbsvx (f07bp) performs the following steps:
1. 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 AX=B , ATX=B  and AHX=B  are
DR A DC DC-1X = DR B ,  
DR A DC T DR-1 X = DC B ,  
and
DR A DC H DR-1 X = DC B ,  
respectively, where DR  and DC  are diagonal matrices, with positive diagonal elements, formed from the computed scaling factors.
When equilibration is used, A will be overwritten by DR A DC  and B will be overwritten by DR B  (or DC B  when the solution of ATX=B  or AHX=B  is sought).
2. Factorization
The matrix A, or its scaled form, is copied and factored using the LU decomposition
A=PLU ,  
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 nag_lapack_zgbsvx (f07bp) with the same matrix A.
3. Condition Number Estimation
The LU 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 function 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.
4. Solution
The (equilibrated) system is solved for X ( DC-1X  or DR-1X ) using the factored form of A ( DRADC ).
5. 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.
6. Construct Solution Matrix X
If equilibration was used, the matrix X is premultiplied by DC  (if trans='N') or DR  (if trans='T' or 'C') so that it solves the original system before equilibration.

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

Parameters

Compulsory Input Parameters

1:     fact – string (length ≥ 1)
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'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' or 'E'.
2:     trans – string (length ≥ 1)
Specifies the form of the system of equations.
trans='N'
AX=B (No transpose).
trans='T'
ATX=B (Transpose).
trans='C'
AHX=B (Conjugate transpose).
Constraint: trans='N', 'T' or 'C'.
3:     kl int64int32nag_int scalar
kl, the number of subdiagonals within the band of the matrix A.
Constraint: kl0.
4:     ku int64int32nag_int scalar
ku, the number of superdiagonals within the band of the matrix A.
Constraint: ku0.
5:     abldab: – complex array
The first dimension of the array ab must be at least kl+ku+1.
The second dimension of the array ab must be at least max1,n.
The n by n coefficient matrix A.
The matrix is stored in rows 1 to kl+ku+1, more precisely, the element Aij must be stored in
abku+1+i-jj  for ​max1,j-kuiminn,j+kl. 
See Further Comments for further details.
If fact='F' and equed'N', A must have been equilibrated by the scaling factors in r and/or c.
6:     afbldafb: – complex array
The first dimension of the array afb must be at least 2×kl+ku+1.
The second dimension of the array afb must be at least max1,n.
If fact='N' or 'E', afb need not be set.
If fact='F', details of the LU factorization of the n by n band matrix A, as computed by nag_lapack_zgbtrf (f07br).
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.
If equed'N', afb is the factorized form of the equilibrated matrix A.
7:     ipiv: int64int32nag_int array
The dimension of the array ipiv must be at least max1,n
If fact='N' or 'E', ipiv need not be set.
If fact='F', ipiv contains the pivot indices from the factorization A=LU, as computed by nag_lapack_dgbtrf (f07bd); row i of the matrix was interchanged with row ipivi.
8:     equed – string (length ≥ 1)
If fact='N' or 'E', equed need not be set.
If 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 DR;
  • if equed='C', column equilibration, i.e., A has been postmultiplied by DC;
  • if equed='B', both row and column equilibration, i.e., A has been replaced by DRADC.
Constraint: if fact='F', equed='N', 'R', 'C' or 'B'.
9:     r: – double array
The dimension of the array r must be at least max1,n
If fact='N' or 'E', r need not be set.
If fact='F' and equed='R' or 'B', r must contain the row scale factors for A, DR; each element of r must be positive.
10:   c: – double array
The dimension of the array c must be at least max1,n
If fact='N' or 'E', c need not be set.
If fact='F' or equed='C' or 'B', c must contain the column scale factors for A, DC; each element of c must be positive.
11:   bldb: – complex array
The first dimension of the array b must be at least max1,n.
The second dimension of the array b must be at least max1,nrhs_p.
The n by r right-hand side matrix B.

Optional Input Parameters

1:     n int64int32nag_int scalar
Default: the first dimension of the array b and the second dimension of the arrays ab, afb, ipiv, r, c.
n, the number of linear equations, i.e., the order of the matrix A.
Constraint: n0.
2:     nrhs_p int64int32nag_int scalar
Default: the second dimension of the array b.
r, the number of right-hand sides, i.e., the number of columns of the matrix B.
Constraint: nrhs_p0.

Output Parameters

1:     abldab: – complex array
The first dimension of the array ab will be kl+ku+1.
The second dimension of the array ab will be max1,n.
If fact='F' or 'N', or if fact='E' and equed='N', ab is not modified.
If equed'N' then, if no constraints are violated, A is scaled as follows:
  • if equed='R', A=DrA;
  • if equed='C', A=ADc;
  • if equed='B', A=DrADc.
2:     afbldafb: – complex array
The first dimension of the array afb will be 2×kl+ku+1.
The second dimension of the array afb will be max1,n.
If fact='F', afb is unchanged from entry.
Otherwise, if no constraints are violated, then if fact='N', afb returns details of the LU factorization of the band matrix A, and if fact='E', afb returns details of the LU factorization of the equilibrated band matrix A (see the description of ab for the form of the equilibrated matrix).
3:     ipiv: int64int32nag_int array
The dimension of the array ipiv will be max1,n
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 ith step row i of the matrix was interchanged with row ipivi. ipivi=i indicates a row interchange was not required.
If fact='N', the pivot indices are those corresponding to the factorization A=LU of the original matrix A.
If fact='E', the pivot indices are those corresponding to the factorization of A=LU of the equilibrated matrix A.
4:     equed – string (length ≥ 1)
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.
5:     r: – double array
The dimension of the array r will be max1,n
If fact='F', r is unchanged from entry.
Otherwise, if no constraints are violated and equed='R' or 'B', r contains the row scale factors for A, DR, such that A is multiplied on the left by DR; each element of r is positive.
6:     c: – double array
The dimension of the array c will be max1,n
If fact='F', c is unchanged from entry.
Otherwise, if no constraints are violated and equed='C' or 'B', c contains the row scale factors for A, DC; each element of c is positive.
7:     bldb: – complex array
The first dimension of the array b will be max1,n.
The second dimension of the array b will be max1,nrhs_p.
If equed='N', b is not modified.
If trans='N' and equed='R' or 'B', b stores DRB.
If trans='T' or 'C' and equed='C' or 'B', b stores DCB.
8:     xldx: – complex array
The first dimension of the array x will be max1,n.
The second dimension of the array x will be max1,nrhs_p.
If info=0 or n+1, the n by r solution matrix X to the original system of equations. Note that the arrays A and B are modified on exit if equed'N', and the solution to the equilibrated system is DC-1X if trans='N' and equed='C' or 'B', or DR-1X if trans='T' or 'C' and equed='R' or 'B'.
9:     rcond – double scalar
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/A1 A-11 .
10:   ferrnrhs_p – double array
If info=0 or n+1, an estimate of the forward error bound for each computed solution vector, such that x^j-xj/xjferrj where x^j is the jth column of the computed solution returned in the array x and xj 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.
11:   berrnrhs_p – double array
If info=0 or n+1, an estimate of the component-wise relative backward error of each computed solution vector x^j (i.e., the smallest relative change in any element of A or B that makes x^j an exact solution).
12:   rworkmax1,n – double array
If info=0, rwork1 contains the reciprocal pivot growth factor maxaij/maxuij. If rwork1 is much less than 1, then the stability of the LU 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>0andinfon, rwork1 contains the reciprocal pivot growth factor for the leading info columns of A.
13:   info int64int32nag_int scalar
info=0 unless the function detects an error (see Error Indicators and Warnings).

Error Indicators and Warnings

Cases prefixed with W are classified as warnings and do not generate an error of type NAG:error_n. See nag_issue_warnings.

   info<0
If info=-i, argument i had an illegal value. An explanatory message is output, and execution of the program is terminated.
W  info>0andinfon
Element _ 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.
W  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.

Accuracy

For each right-hand side vector b, the computed solution x^ is the exact solution of a perturbed system of equations A+Ex^=b, where
EcnεPLU ,  
cn is a modest linear function of n, and ε is the machine precision. See Section 9.3 of Higham (2002) for further details.
If x is the true solution, then the computed solution x^ satisfies a forward error bound of the form
x-x^ x^ wc condA,x^,b  
where condA,x^,b = A-1 A x^ + b / x^ condA = A-1 A κ A. If x^  is the j th column of X , then wc  is returned in berrj  and a bound on x - x^ / x^  is returned in ferrj . See Section 4.4 of Anderson et al. (1999) for further details.

Further Comments

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 *  
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. The solution is then refined, and the errors estimated, using iterative refinement; see nag_lapack_zgbrfs (f07bv) 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 function is nag_lapack_dgbsvx (f07bb).

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 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 .  
Estimates for the backward errors, forward errors, condition number and pivot growth are also output, together with information on the equilibration of A .
function f07bp_example


fprintf('f07bp example results\n\n');

% Banded matrix A and rhs B
m  = int64(4);
kl = int64(1);
ku = int64(2);
ab = [ 0    + 0i,      0    +  0i,     0.97 - 2.84i,  0.59 - 0.48i;
       0    + 0i,     -2.05 -  0.85i, -3.99 + 4.01i,  3.33 - 1.04i;
      -1.65 + 2.26i,  -1.48 -  1.75i, -1.06 + 1.94i, -0.46 - 1.72i;
       0    + 6.3i,   -0.77 +  2.83i,  4.48 - 1.09i,  0    + 0i];
b = [ -1.06 + 21.5i,  12.85 +  2.84i;
     -22.72 - 53.9i, -70.22 + 21.57i;
      28.24 - 38.6i, -20.73 -  1.23i;
     -34.56 + 16.73i  26.01 + 31.97i];

% Initialize input parameters
afb  = complex(zeros(2*kl+ku+1, m));
ipiv = zeros(m,1,'int64');
r    = zeros(m,1);
c    = r;

% Solve AX = B after equilibrating
fact  = 'Equilibration';
trans = 'No transpose';
equed = ' ';
[ab, afb, ipiv, equed, r, c, b, x, rcond, ferr, berr, rwork, info] = ...
  f07bp( ...
         fact, trans, kl, ku, ab, afb, ipiv, equed, r, c, b);

fprintf('Solution(s):\n');
disp(x);
fprintf('\nApproximate condition number = %9.3f\n',1/rcond);
fprintf('Approximate forward  errors  :\n');
fprintf('                               %11.1e\n',ferr);
fprintf('Approximate backward errors  :\n')
fprintf('                               %11.1e\n',berr);


f07bp example results

Solution(s):
  -3.0000 + 2.0000i   1.0000 + 6.0000i
   1.0000 - 7.0000i  -7.0000 - 4.0000i
  -5.0000 + 4.0000i   3.0000 + 5.0000i
   6.0000 - 8.0000i  -8.0000 + 2.0000i


Approximate condition number =   104.227
Approximate forward  errors  :
                                   3.6e-14
                                   4.4e-14
Approximate backward errors  :
                                   6.0e-17
                                   1.0e-16

PDF version (NAG web site, 64-bit version, 64-bit version)
Chapter Contents
Chapter Introduction
NAG Toolbox

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