# NAG FL Interfacef07cef (dgttrs)

## ▸▿ Contents

Settings help

FL Name Style:

FL Specification Language:

## 1Purpose

f07cef computes the solution to a real system of linear equations $AX=B$ or ${A}^{\mathrm{T}}X=B$, where $A$ is an $n×n$ tridiagonal matrix and $X$ and $B$ are $n×r$ matrices, using the $LU$ factorization returned by f07cdf.

## 2Specification

Fortran Interface
 Subroutine f07cef ( n, nrhs, dl, d, du, du2, ipiv, b, ldb, info)
 Integer, Intent (In) :: n, nrhs, ipiv(*), ldb Integer, Intent (Out) :: info Real (Kind=nag_wp), Intent (In) :: dl(*), d(*), du(*), du2(*) Real (Kind=nag_wp), Intent (Inout) :: b(ldb,*) Character (1), Intent (In) :: trans
#include <nag.h>
 void f07cef_ (const char *trans, const Integer *n, const Integer *nrhs, const double dl[], const double d[], const double du[], const double du2[], const Integer ipiv[], double b[], const Integer *ldb, Integer *info, const Charlen length_trans)
The routine may be called by the names f07cef, nagf_lapacklin_dgttrs or its LAPACK name dgttrs.

## 3Description

f07cef should be preceded by a call to f07cdf, which uses Gaussian elimination with partial pivoting and row interchanges to factorize the matrix $A$ as
 $A=PLU ,$
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. f07cef then utilizes the factorization to solve the required equations.

## 4References

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

## 5Arguments

1: $\mathbf{trans}$Character(1) Input
On entry: specifies the equations to be solved as follows:
${\mathbf{trans}}=\text{'N'}$
Solve $AX=B$ for $X$.
${\mathbf{trans}}=\text{'T'}$ or $\text{'C'}$
Solve ${A}^{\mathrm{T}}X=B$ for $X$.
Constraint: ${\mathbf{trans}}=\text{'N'}$, $\text{'T'}$ or $\text{'C'}$.
2: $\mathbf{n}$Integer Input
On entry: $n$, the order of the matrix $A$.
Constraint: ${\mathbf{n}}\ge 0$.
3: $\mathbf{nrhs}$Integer Input
On entry: $r$, the number of right-hand sides, i.e., the number of columns of the matrix $B$.
Constraint: ${\mathbf{nrhs}}\ge 0$.
4: $\mathbf{dl}\left(*\right)$Real (Kind=nag_wp) array Input
Note: the dimension of the array dl must be at least $\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{n}}-1\right)$.
On entry: must contain the $\left(n-1\right)$ multipliers that define the matrix $L$ of the $LU$ factorization of $A$.
5: $\mathbf{d}\left(*\right)$Real (Kind=nag_wp) array Input
Note: the dimension of the array d must be at least $\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{n}}\right)$.
On entry: must contain the $n$ diagonal elements of the upper triangular matrix $U$ from the $LU$ factorization of $A$.
6: $\mathbf{du}\left(*\right)$Real (Kind=nag_wp) array Input
Note: the dimension of the array du must be at least $\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{n}}-1\right)$.
On entry: must contain the $\left(n-1\right)$ elements of the first superdiagonal of $U$.
7: $\mathbf{du2}\left(*\right)$Real (Kind=nag_wp) array Input
Note: the dimension of the array du2 must be at least $\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{n}}-2\right)$.
On entry: must contain the $\left(n-2\right)$ elements of the second superdiagonal of $U$.
8: $\mathbf{ipiv}\left(*\right)$Integer array Input
Note: the dimension of the array ipiv must be at least $\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{n}}\right)$.
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 ${\mathbf{ipiv}}\left(i\right)$, and ${\mathbf{ipiv}}\left(i\right)$ must always be either $i$ or $\left(i+1\right)$, ${\mathbf{ipiv}}\left(i\right)=i$ indicating that a row interchange was not performed.
9: $\mathbf{b}\left({\mathbf{ldb}},*\right)$Real (Kind=nag_wp) array Input/Output
Note: the second dimension of the array b must be at least $\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{nrhs}}\right)$.
On entry: the $n×r$ matrix of right-hand sides $B$.
On exit: the $n×r$ solution matrix $X$.
10: $\mathbf{ldb}$Integer Input
On entry: the first dimension of the array b as declared in the (sub)program from which f07cef is called.
Constraint: ${\mathbf{ldb}}\ge \mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{n}}\right)$.
11: $\mathbf{info}$Integer Output
On exit: ${\mathbf{info}}=0$ unless the routine detects an error (see Section 6).

## 6Error Indicators and Warnings

${\mathbf{info}}<0$
If ${\mathbf{info}}=-i$, argument $i$ had an illegal value. An explanatory message is output, and execution of the program is terminated.

## 7Accuracy

The computed solution for a single right-hand side, $\stackrel{^}{x}$, satisfies an equation of the form
 $(A+E) x^=b ,$
where
 $‖E‖1 =O(ε)‖A‖1$
and $\epsilon$ is the machine precision. An approximate error bound for the computed solution is given by
 $‖x^-x‖1 ‖x‖1 ≤ κ(A) ‖E‖1 ‖A‖1 ,$
where $\kappa \left(A\right)={‖{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 f07cgf can be used to estimate the condition number of $A$ and f07chf can be used to obtain approximate error bounds.

## 8Parallelism and Performance

f07cef is not threaded in any implementation.

The total number of floating-point operations required to solve the equations $AX=B$ or ${A}^{\mathrm{T}}X=B$ is proportional to $nr$.
The complex analogue of this routine is f07csf.

## 10Example

This example solves the equations
 $AX=B ,$
where $A$ is the tridiagonal matrix
 $A = ( 3.0 2.1 0.0 0.0 0.0 3.4 2.3 -1.0 0.0 0.0 0.0 3.6 -5.0 1.9 0.0 0.0 0.0 7.0 -0.9 8.0 0.0 0.0 0.0 -6.0 7.1 ) and B = ( 2.7 6.6 -0.5 10.8 2.6 -3.2 0.6 -11.2 2.7 19.1 ) .$

### 10.1Program Text

Program Text (f07cefe.f90)

### 10.2Program Data

Program Data (f07cefe.d)

### 10.3Program Results

Program Results (f07cefe.r)