NAG Library Routine Document

f04cbf  (complex_band_solve)

1

Purpose

2

Specification

3

Description

4

References

5

Arguments

1:     $\mathbf{n}$ – IntegerInput

On entry: the number of linear equations $n$, i.e., the order of the matrix $A$.

Constraint: $\mathbf{n}\ge 0$.

2:     $\mathbf{kl}$ – IntegerInput

On entry: the number of subdiagonals $k_l$, within the band of $A$.

Constraint: $\mathbf{kl}\ge 0$.

3:     $\mathbf{ku}$ – IntegerInput

On entry: the number of superdiagonals $k_u$, within the band of $A$.

Constraint: $\mathbf{ku}\ge 0$.

4:     $\mathbf{nrhs}$ – IntegerInput

On entry: the number of right-hand sides $r$, i.e., the number of columns of the matrix $B$.

Constraint: $\mathbf{nrhs}\ge 0$.

5:     $\mathbf{ab}\left(\mathbf{ldab},*\right)$ – Complex (Kind=nag_wp) arrayInput/Output

Note: the second dimension of the array ab must be at least $\max \left(1,\mathbf{n}\right)$.

On entry: the $n$ by $n$ matrix $A$.

The matrix is stored in rows $k_l+1$ to $2k_l+k_u+1$; the first $k_l$ rows need not be set, more precisely, the element $A_{ij}$ must be stored in

$$\mathbf{ab}\left(k_l+k_u+1+i-j,j\right)=A_{ij}\text{\hspace{1em} for }\max \left(1,j-k_u\right)\le i\le \min \left(n,j+k_l\right)\text{.}$$

See Section 9 for further details.

On exit: if $\mathbf{ifail}\ge \mathbf{0}$, ab is overwritten by details of the factorization.

The upper triangular band matrix $U$, with $k_l+k_u$ superdiagonals, is stored in rows $1$ to $k_l+k_u+1$ of the array, and the multipliers used to form the matrix $L$ are stored in rows $k_l+k_u+2$ to $2k_l+k_u+1$.

6:     $\mathbf{ldab}$ – IntegerInput

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

Constraint: $\mathbf{ldab}\ge 2\times \mathbf{kl}+\mathbf{ku}+1$.

7:     $\mathbf{ipiv}\left(\mathbf{n}\right)$ – Integer arrayOutput

On exit: if $\mathbf{ifail}\ge \mathbf{0}$, the 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)$. $\mathbf{ipiv}\left(i\right)=i$ indicates a row interchange was not required.

8:     $\mathbf{b}\left(\mathbf{ldb},*\right)$ – Complex (Kind=nag_wp) arrayInput/Output

Note: the second dimension of the array b must be at least $\max \left(1,\mathbf{nrhs}\right)$.

On entry: the $n$ by $r$ matrix of right-hand sides $B$.

On exit: if $\mathbf{ifail}=\mathbf{0}$ or $\mathbf{n}+\mathbf{1}$, the $n$ by $r$ solution matrix $X$.

9:     $\mathbf{ldb}$ – IntegerInput

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

Constraint: $\mathbf{ldb}\ge \max \left(1,\mathbf{n}\right)$.

10:   $\mathbf{rcond}$ – Real (Kind=nag_wp)Output

On exit: if $\mathbf{ifail}\ge \mathbf{0}$, an estimate of the reciprocal of the condition number of the matrix $A$, computed as $\mathbf{rcond}=\left({‖A‖}_1{‖A^{-1}‖}_1\right)$.

11:   $\mathbf{errbnd}$ – Real (Kind=nag_wp)Output

On exit: if $\mathbf{ifail}=\mathbf{0}$ or $\mathbf{n}+\mathbf{1}$, an estimate of the forward error bound for a computed solution $\hat{x}$, such that ${‖\hat{x}-x‖}_1/{‖x‖}_1\le \mathbf{errbnd}$, where $\hat{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:   $\mathbf{ifail}$ – IntegerInput/Output

On entry: ifail must be set to $0$, $-1\text{ 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\text{ 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 $-\mathbf{1}\text{ or }\mathbf{1}$ is used it is essential to test the value of ifail on exit.

On exit: $\mathbf{ifail}=\mathbf{0}$ unless the routine detects an error or a warning has been flagged (see Section 6).

6

Error Indicators and Warnings

$\mathbf{ifail}>0\hspace{0.17em}\text{and}\hspace{0.17em}\mathbf{ifail}\le \mathbf{n}$

Diagonal element $〈\mathit{\text{value}}〉$ of the upper triangular factor is zero. The factorization has been completed, but the solution could not be computed.

$\mathbf{ifail}=\mathbf{n}+1$

A solution has been computed, but rcond is less than machine precision so that the matrix $A$ is numerically singular.

$\mathbf{ifail}=-1$

On entry, $\mathbf{n}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{n}\ge 0$.

$\mathbf{ifail}=-2$

On entry, $\mathbf{kl}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{kl}\ge 0$.

$\mathbf{ifail}=-3$

On entry, $\mathbf{ku}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{ku}\ge 0$.

$\mathbf{ifail}=-4$

On entry, $\mathbf{nrhs}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{nrhs}\ge 0$.

$\mathbf{ifail}=-6$

On entry, $\mathbf{ldab}=〈\mathit{\text{value}}〉$, $\mathbf{kl}=〈\mathit{\text{value}}〉$ and $\mathbf{ku}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{ldab}\ge 2\times \mathbf{kl}+\mathbf{ku}+1$.

$\mathbf{ifail}=-9$

On entry, $\mathbf{ldb}=〈\mathit{\text{value}}〉$ and $\mathbf{n}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{ldb}\ge \max \left(1,\mathbf{n}\right)$.

$\mathbf{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.

$\mathbf{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.

$\mathbf{ifail}=-999$

Dynamic memory allocation failed.

The real allocatable memory required is n, and the complex allocatable memory required is $2\times \mathbf{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

8

Parallelism and Performance

9

Further Comments

10

Example

10.1

Program Text

Program Text (f04cbfe.f90)

10.2

Program Data

Program Data (f04cbfe.d)

10.3

Program Results

Program Results (f04cbfe.r)