NAG Library Routine Document

f04ccf  (complex_tridiag_solve)

 Contents

    1  Purpose
    7  Accuracy

1
Purpose

f04ccf computes the solution to a complex system of linear equations AX=B, where A is an n by n tridiagonal matrix 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

Fortran Interface
Subroutine f04ccf ( n, nrhs, dl, d, du, du2, ipiv, b, ldb, rcond, errbnd, ifail)
Integer, Intent (In):: n, nrhs, ldb
Integer, Intent (Inout):: ifail
Integer, Intent (Out):: ipiv(n)
Real (Kind=nag_wp), Intent (Out):: rcond, errbnd
Complex (Kind=nag_wp), Intent (Inout):: dl(*), d(*), du(*), b(ldb,*)
Complex (Kind=nag_wp), Intent (Out):: du2(n-2)
C Header Interface
#include nagmk26.h
void  f04ccf_ ( const Integer *n, const Integer *nrhs, Complex dl[], Complex d[], Complex du[], Complex du2[], Integer ipiv[], Complex b[], const Integer *ldb, double *rcond, double *errbnd, Integer *ifail)

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 unit lower triangular with at most one nonzero subdiagonal element, and U is an upper triangular band matrix with two superdiagonals. The factored form of A is then used to solve the system of equations AX=B.
Note that the equations ATX=B may be solved by interchanging the order of the arguments du and dl.

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
Arguments

1:     n – IntegerInput
On entry: the number of linear equations n, i.e., the order of the matrix A.
Constraint: n0.
2:     nrhs – IntegerInput
On entry: the number of right-hand sides r, i.e., the number of columns of the matrix B.
Constraint: nrhs0.
3:     dl* – Complex (Kind=nag_wp) arrayInput/Output
Note: the dimension of the array dl must be at least max1,n-1.
On entry: must contain the n-1 subdiagonal elements of the matrix A.
On exit: if ifail0, dl is overwritten by the n-1 multipliers that define the matrix L from the LU factorization of A.
4:     d* – Complex (Kind=nag_wp) arrayInput/Output
Note: the dimension of the array d must be at least max1,n.
On entry: must contain the n diagonal elements of the matrix A.
On exit: if ifail0, d is overwritten by the n diagonal elements of the upper triangular matrix U from the LU factorization of A.
5:     du* – Complex (Kind=nag_wp) arrayInput/Output
Note: the dimension of the array du must be at least max1,n-1.
On entry: must contain the n-1 superdiagonal elements of the matrix A
On exit: if ifail0, du is overwritten by the n-1 elements of the first superdiagonal of U.
6:     du2n-2 – Complex (Kind=nag_wp) arrayOutput
On exit: if ifail0, du2 returns the n-2 elements of the second superdiagonal of U.
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 will always be either i or i+1; 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 f04ccf is called.
Constraint: ldbmax1,n.
10:   rcond – Real (Kind=nag_wp)Output
On exit: if no constraints are violated, an estimate of the reciprocal of the condition number of the matrix A, computed as rcond=1/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, 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 argument you should refer to Section 3.4 in How to Use the NAG Library and its Documentation 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 argument, 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>0andifailn
Diagonal element value of the upper triangular factor is zero. The factorization has been completed, but the solution could not be computed.
ifail=n+1
A solution has been computed, but rcond is less than machine precision so that the matrix A is numerically singular.
ifail=-1
On entry, n=value.
Constraint: n0.
ifail=-2
On entry, nrhs=value.
Constraint: nrhs0.
ifail=-9
On entry, ldb=value and n=value.
Constraint: ldbmax1,n.
ifail=-99
An unexpected error has been triggered by this routine. Please contact NAG.
See Section 3.9 in How to Use the NAG Library and its Documentation for further information.
ifail=-399
Your licence key may have expired or may not have been installed correctly.
See Section 3.8 in How to Use the NAG Library and its Documentation for further information.
ifail=-999
Dynamic memory allocation failed.
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.
See Section 3.7 in How to Use the NAG Library and its Documentation 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-11 A1 , the condition number of A with respect to the solution of the linear equations. f04ccf uses the approximation E1=εA1 to estimate errbnd. See Section 4.4 of Anderson et al. (1999) for further details.

8
Parallelism and Performance

f04ccf 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 total number of floating-point operations required to solve the equations AX=B is proportional to nr. 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 f04ccf is f04bcf.

10
Example

This example solves the equations
AX=B,  
where A is the tridiagonal matrix
A= -1.3+1.3i 2.0-1.0i 0.0i+0.0 0.0i+0.0 0.0i+0.0 1.0-2.0i -1.3+1.3i 2.0+1.0i 0.0i+0.0 0.0i+0.0 0.0i+0.0 1.0+1.0i -1.3+3.3i -1.0+1.0i 0.0i+0.0 0.0i+0.0 0.0i+0.0 2.0-3.0i -0.3+4.3i 1.0-1.0i 0.0i+0.0 0.0i+0.0 0.0i+0.0 1.0+1.0i -3.3+1.3i  
and
B = 2.4-05.0i 2.7+06.9i 3.4+18.2i -6.9-05.3i -14.7+09.7i -6.0-00.6i 31.9-07.7i -3.9+09.3i -1.0+01.6i -3.0+12.2i .  
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 (f04ccfe.f90)

10.2
Program Data

Program Data (f04ccfe.d)

10.3
Program Results

Program Results (f04ccfe.r)

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