Integer, Intent (In)	::	n, nrhs, ipiv(*), ldb
Integer, Intent (Out)	::	info
Complex (Kind=nag_wp), Intent (In)	::	dl(), d(), du(), du2()
Complex (Kind=nag_wp), Intent (Inout)	::	b(ldb,*)
Character (1), Intent (In)	::	trans

C Header Interface

#include <nag.h>

void	f07csf_ (const char trans, const Integer n, const Integer nrhs, const Complex dl[], const Complex d[], const Complex du[], const Complex du2[], const Integer ipiv[], Complex b[], const Integer ldb, Integer *info, const Charlen length_trans)

The routine may be called by the names f07csf, nagf_lapacklin_zgttrs or its LAPACK name zgttrs.

3 Description

f07csf should be preceded by a call to f07crf, which uses Gaussian elimination with partial pivoting and row interchanges to factorize the matrix

A

A = P L U,

where

P

is a permutation matrix,

L

is unit lower triangular with at most one nonzero subdiagonal element in each column, and

U

is an upper triangular band matrix, with two superdiagonals. f07csf then utilizes the factorization to solve the required 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 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: $trans$ – Character(1) Input

On entry: specifies the equations to be solved as follows:

$trans ='N'$: Solve $A X = B$ for $X$ .
$trans ='T'$: Solve $A^{T} X = B$ for $X$ .
$trans ='C'$: Solve $A^{H} X = B$ for $X$ .

Constraint:

trans ='N'

'T'

'C'

2: $n$ – Integer Input

On entry:

n

, the order of the matrix

A

Constraint:

n \geq 0

3: $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

4: $dl (*)$ – Complex (Kind=nag_wp) array Input

Note: the dimension of the array dl must be at least

\max (1, n - 1)

On entry: must contain the

(n - 1)

multipliers that define the matrix

L

of the

L U

factorization of

A

5: $d (*)$ – Complex (Kind=nag_wp) array Input

Note: the dimension of the array d must be at least

\max (1, n)

On entry: must contain the

n

diagonal elements of the upper triangular matrix

U

from the

L U

factorization of

A

6: $du (*)$ – Complex (Kind=nag_wp) array Input

Note: the dimension of the array du must be at least

\max (1, n - 1)

On entry: must contain the

(n - 1)

elements of the first superdiagonal of

U

7: $du2 (*)$ – Complex (Kind=nag_wp) array Input

Note: the dimension of the array du2 must be at least

\max (1, n - 2)

On entry: must contain the

(n - 2)

elements of the second superdiagonal of

U

8: $ipiv (*)$ – Integer array Input

Note: the dimension of the array ipiv must be at least

\max (1, n)

On entry: must contain the

n

pivot indices that define the permutation matrix

P

. At the

i

th step, row

i

of the matrix was interchanged with row

ipiv (i)

, and

ipiv (i)

must always be either

i

(i + 1)

ipiv (i) = i

indicating that a row interchange was not performed.

9: $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 \times r

matrix of right-hand sides

B

On exit: the

n \times r

solution matrix

X

10: $ldb$ – Integer Input

On entry: the first dimension of the array b as declared in the (sub)program from which f07csf is called.

Constraint:

ldb \geq \max (1, n)

11: $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.

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 this routine f07cuf can be used to estimate the condition number of

A

and f07cvf can be used to obtain approximate error bounds.

8 Parallelism and Performance

Background information to multithreading can be found in the Multithreading documentation.

f07csf is not threaded in any implementation.

9 Further Comments

The total number of floating-point operations required to solve the equations

A X = B

A^{T} X = B

A^{H} X = B

is proportional to

n r

The real analogue of this routine is f07cef.

10 Example

This example solves the equations

A X = B,

where

A

is the tridiagonal matrix

A = (\begin{array}{r} - 1.3 + 1.3 i & 2.0 - 1.0 i & 0 & 0 & 0 \\ 1.0 - 2.0 i & - 1.3 + 1.3 i & 2.0 + 1.0 i & 0 & 0 \\ 0 & 1.0 + 1.0 i & - 1.3 + 3.3 i & - 1.0 + 1.0 i & 0 \\ 0 & 0 & 2.0 - 3.0 i & - 0.3 + 4.3 i & 1.0 - 1.0 i \\ 0 & 0 & 0 & 1.0 + 1.0 i & - 3.3 + 1.3 i \end{array})

and

B = (\begin{array}{r} 2.4 - 5.0 i & 2.7 + 6.9 i \\ 3.4 + 18.2 i & - 6.9 - 5.3 i \\ - 14.7 + 9.7 i & - 6.0 - 0.6 i \\ 31.9 - 7.7 i & - 3.9 + 9.3 i \\ - 1.0 + 1.6 i & - 3.0 + 12.2 i \end{array}) .

f07cs: FL CL CPP AD PY MB

NAG FL Interfacef07csf (zgttrs)

▸▿ 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
f07csf (zgttrs)