Integer, Intent (In)	::	n, kd, nrhs, ldab, ldb
Integer, Intent (Out)	::	info
Complex (Kind=nag_wp), Intent (Inout)	::	ab(ldab,), b(ldb,)
Character (1), Intent (In)	::	uplo

C Header Interface

#include <nag.h>

void	f07hnf_ (const char uplo, const Integer n, const Integer kd, const Integer nrhs, Complex ab[], const Integer ldab, Complex b[], const Integer ldb, Integer *info, const Charlen length_uplo)

The routine may be called by the names f07hnf, nagf_lapacklin_zpbsv or its LAPACK name zpbsv.

3 Description

f07hnf uses the Cholesky decomposition to factor

A

A = U^{H} U

uplo ='U'

A = L L^{H}

uplo ='L'

, where

U

is an upper triangular band matrix, and

L

is a lower triangular band matrix, with the same number of superdiagonals or subdiagonals as

A

. The factored form of

A

is then used to solve the system of equations

A X = B

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: $uplo$ – Character(1) Input

On entry: if

uplo ='U'

, the upper triangle of

A

is stored.

uplo ='L'

, the lower triangle of

A

is stored.

Constraint:

uplo ='U'

'L'

2: $n$ – Integer Input

On entry:

n

, the number of linear equations, i.e., the order of the matrix

A

Constraint:

n \geq 0

3: $kd$ – Integer Input

On entry:

k_{d}

, the number of superdiagonals of the matrix

A

uplo ='U'

, or the number of subdiagonals if

uplo ='L'

Constraint:

kd \geq 0

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

5: $ab (ldab, *)$ – Complex (Kind=nag_wp) array Input/Output

Note: the second dimension of the array ab must be at least

\max (1, n)

On entry: the upper or lower triangle of the Hermitian band matrix

A

The matrix is stored in rows

1

k_{d} + 1

, more precisely,

if $uplo ='U'$ , the elements of the upper triangle of $A$ within the band must be stored with element $A_{i j}$ in $ab (k_{d} + 1 + i - j, j) for \max (1, j - k_{d}) \leq i \leq j$ ;
if $uplo ='L'$ , the elements of the lower triangle of $A$ within the band must be stored with element $A_{i j}$ in $ab (1 + i - j, j) for j \leq i \leq \min (n, j + k_{d}) .$

On exit: if

info = 0

, the triangular factor

U

L

from the Cholesky factorization

A = U^{H} U

A = L L^{H}

of the band matrix

A

, in the same storage format as

A

6: $ldab$ – Integer Input

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

Constraint:

ldab \geq kd + 1

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

right-hand side matrix

B

On exit: if

info = 0

, the

n \times r

solution matrix

X

8: $ldb$ – Integer Input

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

Constraint:

ldb \geq \max (1, n)

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

$info > 0$: The leading minor of order $⟨ value ⟩$ of $A$ is not positive definite, so the factorization could not be completed, and the solution has not been computed.

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.

f07hpf is a comprehensive LAPACK driver that returns forward and backward error bounds and an estimate of the condition number. Alternatively, f04cff solves

A x = b

and returns a forward error bound and condition estimate. f04cff calls f07hnf to solve the equations.

8 Parallelism and Performance

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

f07hnf is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.

f07hnf 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

When

n ≫ k

, the total number of floating-point operations is approximately

4 n {(k + 1)}^{2} + 16 n k r

, where

k

is the number of superdiagonals and

r

is the number of right-hand sides.

The real analogue of this routine is f07haf.

10 Example

This example solves the equations

A x = b,

where

A

is the Hermitian positive definite band matrix

A = (\begin{array}{r} 9.39 & 1.08 - 1.73 i & 0 & 0 \\ 1.08 + 1.73 i & 1.69 & - 0.04 + 0.29 i & 0 \\ 0 & - 0.04 - 0.29 i & 2.65 & - 0.33 + 2.24 i \\ 0 & 0 & - 0.33 - 2.24 i & 2.17 \end{array})

and

b = (\begin{array}{r} - 12.42 + 68.42 i \\ - 9.93 + 0.88 i \\ - 27.30 - 0.01 i \\ 5.31 + 23.63 i \end{array}) .

Details of the Cholesky factorization of

A

are also output.

f07hn: FL CL CPP AD PY MB

NAG FL Interfacef07hnf (zpbsv)

▸▿ 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
f07hnf (zpbsv)