f07br: FL CL CPP AD

NAG CL Interface
f07brc (zgbtrf)

Keyword Search:

NAG Library Manual, Mark 27.3

Interfaces: FL CL CPP AD

NAG CL Interface Introduction

F07 (Lapacklin) Chapter Contents

F07 (Lapacklin) Chapter Introduction

f07br: FL CL CPP AD

▸▿ 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

Settings help

CL Name Style:
Short (a00aac)
Long (impl_details)
Full (nag_info_impl_details)

1 Purpose

f07brc computes the

L U

factorization of a complex

m \times n

band matrix.

2 Specification

#include <nag.h>

void	f07brc (Nag_OrderType order, Integer m, Integer n, Integer kl, Integer ku, Complex ab[], Integer pdab, Integer ipiv[], NagError *fail)

The function may be called by the names: f07brc, nag_lapacklin_zgbtrf or nag_zgbtrf.

3 Description

f07brc forms the

L U

factorization of a complex

m \times n

band matrix

A

using partial pivoting, with row interchanges. Usually

m = n

, and then, if

A

has

k_{l}

nonzero subdiagonals and

k_{u}

nonzero superdiagonals, the factorization has the form

A = P L U

, where

P

is a permutation matrix,

L

is a lower triangular matrix with unit diagonal elements and at most

k_{l}

nonzero elements in each column, and

U

is an upper triangular band matrix with

k_{l} + k_{u}

superdiagonals.

Note that

L

is not a band matrix, but the nonzero elements of

L

can be stored in the same space as the subdiagonal elements of

A

U

is a band matrix but with

k_{l}

additional superdiagonals compared with

A

. These additional superdiagonals are created by the row interchanges.

4 References

Golub G H and Van Loan C F (1996) Matrix Computations (3rd Edition) Johns Hopkins University Press, Baltimore

5 Arguments

1: $order$ – Nag_OrderType Input

On entry: the order argument specifies the two-dimensional storage scheme being used, i.e., row-major ordering or column-major ordering. C language defined storage is specified by

order = Nag_RowMajor

. See Section 3.1.3 in the Introduction to the NAG Library CL Interface for a more detailed explanation of the use of this argument.

Constraint:

order = Nag_RowMajor

Nag_ColMajor

2: $m$ – Integer Input

On entry:

m

, the number of rows of the matrix

A

Constraint:

m \geq 0

3: $n$ – Integer Input

On entry:

n

, the number of columns of the matrix

A

Constraint:

n \geq 0

4: $kl$ – Integer Input

On entry:

k_{l}

, the number of subdiagonals within the band of the matrix

A

Constraint:

kl \geq 0

5: $ku$ – Integer Input

On entry:

k_{u}

, the number of superdiagonals within the band of the matrix

A

Constraint:

ku \geq 0

6: $ab [\dim]$ – Complex Input/Output

Note: the dimension, dim, of the array ab must be at least

$\max (1, pdab \times n)$ when $order = Nag_ColMajor$ ;
$\max (1, m \times pdab)$ when $order = Nag_RowMajor$ .

On entry: the

m \times n

matrix

A

This is stored as a notional two-dimensional array with row elements or column elements stored contiguously. The storage of elements

A_{i j}

, for row

i = 1, \dots, m

and column

j = \max (1, i - k_{l}), \dots, \min (n, i + k_{u})

, depends on the order argument as follows:

if $order = Nag_ColMajor$ , $A_{i j}$ is stored as $ab [(j - 1) \times pdab + kl + ku + i - j]$ ;
if $order = Nag_RowMajor$ , $A_{i j}$ is stored as $ab [(i - 1) \times pdab + kl + j - i]$ .

See Section 9 in f07bnc for further details.

On exit: ab is overwritten by details of the factorization.

The elements,

u_{i j}

, of the upper triangular band factor

U

with

k_{l} + k_{u}

super-diagonals, and the multipliers,

l_{i j}

, used to form the lower triangular factor

L

are stored. The elements

u_{i j}

, for

i = 1, \dots, m

and

j = i, \dots, \min (n, i + k_{l} + k_{u})

, and

l_{i j}

, for

i = 1, \dots, m

and

j = \max (1, i - k_{l}), \dots, i

, are stored where

A_{i j}

is stored on entry.

7: $pdab$ – Integer Input

On entry: the stride separating row or column elements (depending on the value of order) of the matrix

A

in the array ab.

Constraint:

pdab \geq 2 \times kl + ku + 1

8: $ipiv [\min (m, n)]$ – Integer Output

On exit: the pivot indices that define the permutation matrix. At the

i

th step, if

ipiv [i - 1] > i

then row

i

of the matrix

A

was interchanged with row

ipiv [i - 1]

, for

i = 1, 2, \dots, \min (m, n)

ipiv [i - 1] \leq i

indicates that, at the

i

th step, a row interchange was not required.

9: $fail$ – NagError * Input/Output

The NAG error argument (see Section 7 in the Introduction to the NAG Library CL Interface).

6 Error Indicators and Warnings

NE_ALLOC_FAIL: Dynamic memory allocation failed.
See Section 3.1.2 in the Introduction to the NAG Library CL Interface for further information.
NE_BAD_PARAM: On entry, argument $⟨ value ⟩$ had an illegal value.
NE_INT: On entry, $kl = ⟨ value ⟩$ .
Constraint: $kl \geq 0$ .

On entry, $ku = ⟨ value ⟩$ .
Constraint: $ku \geq 0$ .

On entry, $m = ⟨ value ⟩$ .
Constraint: $m \geq 0$ .

On entry, $n = ⟨ value ⟩$ .
Constraint: $n \geq 0$ .

On entry, $pdab = ⟨ value ⟩$ .
Constraint: $pdab > 0$ .
NE_INT_3: On entry, $pdab = ⟨ value ⟩$ , $kl = ⟨ value ⟩$ and $ku = ⟨ value ⟩$ .
Constraint: $pdab \geq 2 \times kl + ku + 1$ .
NE_INTERNAL_ERROR: An internal error has occurred in this function. Check the function call and any array sizes. If the call is correct then please contact NAG for assistance.
See Section 7.5 in the Introduction to the NAG Library CL Interface for further information.
NE_NO_LICENCE: Your licence key may have expired or may not have been installed correctly.
See Section 8 in the Introduction to the NAG Library CL Interface for further information.
NE_SINGULAR: Element $⟨ value ⟩$ of the diagonal is exactly zero. The factorization has been completed, but the factor $U$ is exactly singular, and division by zero will occur if it is used to solve a system of equations.

7 Accuracy

The computed factors

L

and

U

are the exact factors of a perturbed matrix

A + E

, where

| E | \leq c (k) ε P | L | | U |,

c (k)

is a modest linear function of

k = k_{l} + k_{u} + 1

, and

ε

is the machine precision. This assumes

k ≪ \min (m, n)

8 Parallelism and Performance

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

f07brc 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 function. Please also consult the Users' Note for your implementation for any additional implementation-specific information.

9 Further Comments

The total number of real floating-point operations varies between approximately

8 n k_{l} (k_{u} + 1)

and

8 n k_{l} (k_{l} + k_{u} + 1)

, depending on the interchanges, assuming

m = n ≫ k_{l}

and

n ≫ k_{u}

A call to f07brc may be followed by calls to the functions:

f07bsc to solve $A X = B$ , $A^{T} X = B$ or $A^{H} X = B$ ;
f07buc to estimate the condition number of $A$ .

The real analogue of this function is f07bdc.

10 Example

This example computes the

L U

factorization of the matrix

A

, where

A = (\begin{array}{r} - 1.65 + 2.26 i & - 2.05 - 0.85 i & 0.97 - 2.84 i & 0.00 + 0.00 i \\ 0.00 + 6.30 i & - 1.48 - 1.75 i & - 3.99 + 4.01 i & 0.59 - 0.48 i \\ 0.00 + 0.00 i & - 0.77 + 2.83 i & - 1.06 + 1.94 i & 3.33 - 1.04 i \\ 0.00 + 0.00 i & 0.00 + 0.00 i & 4.48 - 1.09 i & - 0.46 - 1.72 i \end{array}) .

Here

A

is treated as a band matrix with one subdiagonal and two superdiagonals.

f07br: FL CL CPP AD

NAG CL Interfacef07brc (zgbtrf)

▸▿ 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 CL Interface
f07brc (zgbtrf)