NAG Library Function Document

nag_real_gen_lin_solve (f04bac)

void	nag_real_gen_lin_solve (Nag_OrderType order, Integer n, Integer nrhs, double a[], Integer pda, Integer ipiv[], double b[], Integer pdb, double rcond, double errbnd, NagError *fail)

3 Description

The

L U

decomposition with partial pivoting and row interchanges is used to factor

A

A = P L U

, where

P

is a permutation matrix,

L

is unit lower triangular, and

U

is upper triangular. 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 http://www.netlib.org/lapack/lug

Higham N J (2002) Accuracy and Stability of Numerical Algorithms (2nd Edition) SIAM, Philadelphia

5 Arguments

1: order – Nag_OrderTypeInput

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.2.1.3 in the Essential Introduction for a more detailed explanation of the use of this argument.

Constraint:

order = Nag_RowMajor

Nag_ColMajor

2: n – IntegerInput

On entry: the number of linear equations

n

, i.e., the order of the matrix

A

Constraint:

n \geq 0

3: nrhs – IntegerInput

On entry: the number of right-hand sides

r

, i.e., the number of columns of the matrix

B

Constraint:

nrhs \geq 0

4: a[ $\dim$ ] – doubleInput/Output

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

\max (1, pda \times n)

The

(i, j)

th element of the matrix

A

is stored in

$a [(j - 1) \times pda + i - 1]$ when $order = Nag_ColMajor$ ;
$a [(i - 1) \times pda + j - 1]$ when $order = Nag_RowMajor$ .

On entry: the

n

n

coefficient matrix

A

On exit: if

fail . code =

NE_NOERROR, the factors

L

and

U

from the factorization

A = P L U

. The unit diagonal elements of

L

are not stored.

5: pda – IntegerInput

On entry: the stride separating row or column elements (depending on the value of order) in the array a.

Constraint:

pda \geq \max (1, n)

6: ipiv[n] – IntegerOutput

On exit: if

fail . code =

NE_NOERROR, the pivot indices that define the permutation matrix

P

; at the

i

th step row

i

of the matrix was interchanged with row

ipiv [i - 1]

ipiv [i - 1] = i

indicates a row interchange was not required.

7: b[ $\dim$ ] – doubleInput/Output

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

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

The

(i, j)

th element of the matrix

B

is stored in

$b [(j - 1) \times pdb + i - 1]$ when $order = Nag_ColMajor$ ;
$b [(i - 1) \times pdb + j - 1]$ when $order = Nag_RowMajor$ .

On entry: the

n

r

matrix of right-hand sides

B

On exit: if

fail . code =

NE_NOERROR or NE_RCOND, the

n

r

solution matrix

X

8: pdb – IntegerInput

On entry: the stride separating row or column elements (depending on the value of order) in the array b.

Constraints:

if $order = Nag_ColMajor$ , $pdb \geq \max (1, n)$ ;
if $order = Nag_RowMajor$ , $pdb \geq \max (1, nrhs)$ .

9: rcond – double *Output

On exit: if no constraints are violated, an estimate of the reciprocal of the condition number of the matrix

A

, computed as

rcond = 1 / ({‖A‖}_{1} {‖A^{- 1}‖}_{1})

10: errbnd – double *Output

On exit: if

fail . code =

NE_NOERROR or NE_RCOND, an estimate of the forward error bound for a computed solution

\hat{x}

, such that

{‖\hat{x} - x‖}_{1} / {‖x‖}_{1} \leq 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, then errbnd is returned as unity.

11: fail – NagError *Input/Output

The NAG error argument (see Section 3.6 in the Essential Introduction).

6 Error Indicators and Warnings

NE_ALLOC_FAIL: Dynamic memory allocation failed.
NE_BAD_PARAM: On entry, argument $⟨value⟩$ had an illegal value.
NE_INT: On entry, $n = ⟨value⟩$ .
Constraint: $n \geq 0$ .
On entry, $nrhs = ⟨value⟩$ .
Constraint: $nrhs \geq 0$ .
On entry, $pda = ⟨value⟩$ .
Constraint: $pda > 0$ .
On entry, $pdb = ⟨value⟩$ .
Constraint: $pdb > 0$ .
NE_INT_2: On entry, $pda = ⟨value⟩$ and $n = ⟨value⟩$ .
Constraint: $pda \geq \max (1, n)$ .
On entry, $pdb = ⟨value⟩$ and $n = ⟨value⟩$ .
Constraint: $pdb \geq \max (1, n)$ .
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.
NE_RCOND: A solution has been computed, but rcond is less than machine precision so that the matrix $A$ is numerically singular.
NE_SINGULAR: Diagonal element $⟨value⟩$ of the upper triangular factor is zero. The factorization has been completed, but the solution could not be 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. nag_real_gen_lin_solve (f04bac) uses the approximation

{‖E‖}_{1} = ε {‖A‖}_{1}

to estimate errbnd. See Section 4.4 of Anderson et al. (1999) for further details.

8 Parallelism and Performance

nag_real_gen_lin_solve (f04bac) is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.

nag_real_gen_lin_solve (f04bac) 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 Users' Note for your implementation for any additional implementation-specific information.

9 Further Comments

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

A X = B

is proportional to

(\frac{2}{3} n^{3} + n^{2} r)

. The condition number estimation typically requires between four and five solves and never more than eleven solves, following the factorization.

In practice the condition number estimator is very reliable, but it can underestimate the true condition number; see Section 15.3 of Higham (2002) for further details.

The complex analogue of nag_real_gen_lin_solve (f04bac) is nag_complex_gen_lin_solve (f04cac).

10 Example

This example solves the equations

A X = B,

where

A = (\begin{matrix} 1.80 & 2.88 & 2.05 & - 0.89 \\ 5.25 & - 2.95 & - 0.95 & - 3.80 \\ 1.58 & - 2.69 & - 2.90 & - 1.04 \\ - 1.11 & - 0.66 & - 0.59 & 0.80 \end{matrix}) and B = (\begin{matrix} 9.52 & 18.47 \\ 24.35 & 2.25 \\ 0.77 & - 13.28 \\ - 6.22 & - 6.21 \end{matrix}) .

An estimate of the condition number of

A

and an approximate error bound for the computed solutions are also printed.

NAG Library Function Documentnag_real_gen_lin_solve (f04bac)

+− 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 Library Function Document

nag_real_gen_lin_solve (f04bac)