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

Parameters

Compulsory Input Parameters

1: $uplo$ – string (length ≥ 1)

uplo ='U'

, the upper triangle of the matrix

A

is stored.

uplo ='L'

, the lower triangle of the matrix

A

is stored.

Constraint:

uplo ='U'

'L'

2: $ap (:)$ – double array

The dimension of the array ap must be at least

\max (1, n \times (n + 1) / 2)

The

n

n

symmetric matrix

A

, packed column-wise in a linear array. The

j

th column of the matrix

A

is stored in the array ap as follows:

More precisely,

if $uplo ='U'$ , the upper triangle of $A$ must be stored with element $A_{i j}$ in $ap (i + j (j - 1) / 2)$ for $i \leq j$ ;
if $uplo ='L'$ , the lower triangle of $A$ must be stored with element $A_{i j}$ in $ap (i + (2 n - j) (j - 1) / 2)$ for $i \geq j$ .

3: $b (ldb :)$ – double array

The first dimension of the array b must be at least

\max (1, n)

The second dimension of the array b must be at least

\max (1, nrhs_p)

The

n

r

matrix of right-hand sides

B

Optional Input Parameters

1: $n$ – int64int32nag_int scalar: Default: the first dimension of the array b.
The number of linear equations $n$ , i.e., the order of the matrix $A$ .

Constraint: $n \geq 0$ .
2: $nrhs_p$ – int64int32nag_int scalar: Default: the second dimension of the array b.
The number of right-hand sides $r$ , i.e., the number of columns of the matrix $B$ .

Constraint: $nrhs_p \geq 0$ .

Output Parameters

1: $ap (:)$ – double array

The dimension of the array ap will be

\max (1, n \times (n + 1) / 2)

ifail \geq 0

, the block diagonal matrix

D

and the multipliers used to obtain the factor

U

L

from the factorization

A = U D U^{T}

A = L D L^{T}

as computed by nag_lapack_dsptrf (f07pd), stored as a packed triangular matrix in the same storage format as

A

2: $ipiv (n)$ – int64int32nag_int array

ifail \geq 0

, details of the interchanges and the block structure of

D

, as determined by nag_lapack_dsptrf (f07pd).

If $ipiv (k) > 0$ , then rows and columns $k$ and $ipiv (k)$ were interchanged, and $d_{k k}$ is a $1$ by $1$ diagonal block;
if $uplo ='U'$ and $ipiv (k) = ipiv (k - 1) < 0$ , then rows and columns $k - 1$ and $- ipiv (k)$ were interchanged and $d_{k - 1 : k, k - 1 : k}$ is a $2$ by $2$ diagonal block;
if $uplo ='L'$ and $ipiv (k) = ipiv (k + 1) < 0$ , then rows and columns $k + 1$ and $- ipiv (k)$ were interchanged and $d_{k : k + 1, k : k + 1}$ is a $2$ by $2$ diagonal block.

3: $b (ldb :)$ – double array

The first dimension of the array b will be

\max (1, n)

The second dimension of the array b will be

\max (1, nrhs_p)

ifail = 0

n + 1

, the

n

r

solution matrix

X

4: $rcond$ – double scalar

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})

5: $errbnd$ – double scalar

ifail = 0

n + 1

, 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.

6: $ifail$ – int64int32nag_int scalar

ifail = 0

unless the function detects an error (see Error Indicators and Warnings).

Error Indicators and Warnings

Errors or warnings detected by the function:

Cases prefixed with W are classified as warnings and do not generate an error of type NAG:error_n. See nag_issue_warnings.

$ifail > 0 and ifail \leq n$: Diagonal block $_$ of the block diagonal matrix is zero. The factorization has been completed, but the solution could not be computed.

W $ifail = n + 1$: A solution has been computed, but rcond is less than machine precision so that the matrix $A$ is numerically singular.

$ifail = - 1$: On entry, uplo not one of 'U' or 'u' or 'L' or 'l'.

$ifail = - 2$: Constraint: $n \geq 0$ .

$ifail = - 3$: Constraint: $nrhs_p \geq 0$ .

$ifail = - 7$: Constraint: $ldb \geq \max (1, n)$ .

$ifail = - 99$: An unexpected error has been triggered by this routine. Please contact NAG.

$ifail = - 399$: Your licence key may have expired or may not have been installed correctly.

$ifail = - 999$: Dynamic memory allocation failed.
The integer allocatable memory required is n, and the double allocatable memory required is $2 \times n$ . Allocation failed before the solution could be computed.

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_linsys_real_symm_packed_solve (f04bj) uses the approximation

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

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

Further Comments

The packed storage scheme is illustrated by the following example when

n = 4

and

uplo ='U'

. Two-dimensional storage of the symmetric matrix

A

\begin{matrix} a_{11} & a_{12} & a_{13} & a_{14} \\ a_{22} & a_{23} & a_{24} \\ a_{33} & a_{34} \\ a_{44} \end{matrix} (a_{i j} = a_{j i})

Packed storage of the upper triangle of

A

ap = [\begin{matrix} a_{11}, & a_{12}, & a_{22}, & a_{13}, & a_{23}, & a_{33}, & a_{14}, & a_{24}, & a_{34}, & a_{44} \end{matrix}]

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

A X = B

is proportional to

(\frac{1}{3} n^{3} + 2 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 analogues of nag_linsys_real_symm_packed_solve (f04bj) are nag_linsys_complex_herm_packed_solve (f04cj) for complex Hermitian matrices, and nag_linsys_complex_symm_packed_solve (f04dj) for complex symmetric matrices.

Example

This example solves the equations

A X = B,

where

A

is the symmetric indefinite matrix

A = (\begin{matrix} - 1.81 & 2.06 & 0.63 & - 1.15 \\ 2.06 & 1.15 & 1.87 & 4.20 \\ 0.63 & 1.87 & - 0.21 & 3.87 \\ - 1.15 & 4.20 & 3.87 & 2.07 \end{matrix}) and B = (\begin{matrix} 0.96 & 3.93 \\ 6.07 & 19.25 \\ 8.38 & 9.90 \\ 9.50 & 27.85 \end{matrix}) .

An estimate of the condition number of

A

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

Open in the MATLAB editor: f04bj_example

function f04bj_example


fprintf('f04bj example results\n\n');

% Solve Ax = b for symmetric packed A with error bound and condition number
uplo = 'U';
ap = [-1.81              ...
       2.06  1.15        ...
       0.63  1.87 -0.21  ...
      -1.15  4.20  3.87  2.07];
b = [0.96,  3.93;
     6.07, 19.25;
     8.38,  9.90;
     9.50, 27.85];

[ap, ipiv, x, rcond, errbnd, ifail] = ...
  f04bj(uplo, ap, b);

disp('Solution');
disp(x);
disp('Estimate of condition number');
fprintf('%10.1f\n\n',1/rcond);
disp('Estimate of error bound for computed solutions');
fprintf('%10.1e\n\n',errbnd);

f04bj example results

Solution
   -5.0000    2.0000
   -2.0000    3.0000
    1.0000    4.0000
    4.0000    1.0000

Estimate of condition number
      75.7

Estimate of error bound for computed solutions
   8.4e-15

PDF version (NAG web site, 64-bit version, 64-bit version)

Chapter Contents

Chapter Introduction

NAG Toolbox