NAG Library Function Document

nag_zsprfs (f07qvc)

void	nag_zsprfs (Nag_OrderType order, Nag_UploType uplo, Integer n, Integer nrhs, const Complex ap[], const Complex afp[], const Integer ipiv[], const Complex b[], Integer pdb, Complex x[], Integer pdx, double ferr[], double berr[], NagError *fail)

3 Description

nag_zsprfs (f07qvc) returns the backward errors and estimated bounds on the forward errors for the solution of a complex symmetric system of linear equations with multiple right-hand sides

A X = B

, using packed storage. The function handles each right-hand side vector (stored as a column of the matrix

B

) independently, so we describe the function of nag_zsprfs (f07qvc) in terms of a single right-hand side

b

and solution

x

Given a computed solution

x

, the function computes the component-wise backward error

β

. This is the size of the smallest relative perturbation in each element of

A

and

b

such that

x

is the exact solution of a perturbed system

\begin{matrix} (A + δ A) x = b + δ b \\ |δ a_{i j}| \leq β |a_{i j}| and |δ b_{i}| \leq β |b_{i}| . \end{matrix}

Then the function estimates a bound for the component-wise forward error in the computed solution, defined by:

\max_{i} |x_{i} - {\hat{x}}_{i}| / \max_{i} |x_{i}|

where

\hat{x}

is the true solution.

For details of the method, see the f07 Chapter Introduction.

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_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: uplo – Nag_UploTypeInput

On entry: specifies whether the upper or lower triangular part of

A

is stored and how

A

is to be factorized.

$uplo = Nag_Upper$: The upper triangular part of $A$ is stored and $A$ is factorized as $P U D U^{T} P^{T}$ , where $U$ is upper triangular.
$uplo = Nag_Lower$: The lower triangular part of $A$ is stored and $A$ is factorized as $P L D L^{T} P^{T}$ , where $L$ is lower triangular.

Constraint:

uplo = Nag_Upper

Nag_Lower

3: n – IntegerInput

On entry:

n

, the order of the matrix

A

Constraint:

n \geq 0

4: nrhs – IntegerInput

On entry:

r

, the number of right-hand sides.

Constraint:

nrhs \geq 0

5: ap[ $\dim$ ] – const ComplexInput

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

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

On entry: the

n

n

original symmetric matrix

A

as supplied to nag_zsptrf (f07qrc).

6: afp[ $\dim$ ] – const ComplexInput

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

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

On entry: the factorization of

A

stored in packed form, as returned by nag_zsptrf (f07qrc).

7: ipiv[ $\dim$ ] – const IntegerInput

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

\max (1, n)

On entry: details of the interchanges and the block structure of

D

, as returned by nag_zsptrf (f07qrc).

8: b[ $\dim$ ] – const ComplexInput

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

right-hand side matrix

B

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

10: x[ $\dim$ ] – ComplexInput/Output

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

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

The

(i, j)

th element of the matrix

X

is stored in

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

On entry: the

n

r

solution matrix

X

, as returned by nag_zsptrs (f07qsc).

On exit: the improved solution matrix

X

11: pdx – IntegerInput

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

Constraints:

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

12: ferr[nrhs] – doubleOutput

On exit:

ferr [j - 1]

contains an estimated error bound for the

j

th solution vector, that is, the

j

th column of

X

, for

j = 1, 2, \dots, r

13: berr[nrhs] – doubleOutput

On exit:

berr [j - 1]

contains the component-wise backward error bound

β

for the

j

th solution vector, that is, the

j

th column of

X

, for

j = 1, 2, \dots, r

14: 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, $pdb = ⟨value⟩$ .
Constraint: $pdb > 0$ .
On entry, $pdx = ⟨value⟩$ .
Constraint: $pdx > 0$ .
NE_INT_2: On entry, $pdb = ⟨value⟩$ and $n = ⟨value⟩$ .
Constraint: $pdb \geq \max (1, n)$ .
On entry, $pdb = ⟨value⟩$ and $nrhs = ⟨value⟩$ .
Constraint: $pdb \geq \max (1, nrhs)$ .
On entry, $pdx = ⟨value⟩$ and $n = ⟨value⟩$ .
Constraint: $pdx \geq \max (1, n)$ .
On entry, $pdx = ⟨value⟩$ and $nrhs = ⟨value⟩$ .
Constraint: $pdx \geq \max (1, nrhs)$ .
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.

7 Accuracy

The bounds returned in ferr are not rigorous, because they are estimated, not computed exactly; but in practice they almost always overestimate the actual error.

8 Parallelism and Performance

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

nag_zsprfs (f07qvc) 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

For each right-hand side, computation of the backward error involves a minimum of

16 n^{2}

real floating-point operations. Each step of iterative refinement involves an additional

24 n^{2}

real operations. At most five steps of iterative refinement are performed, but usually only one or two steps are required.

Estimating the forward error involves solving a number of systems of linear equations of the form

A x = b

; the number is usually

5

and never more than

11

. Each solution involves approximately

8 n^{2}

real operations.

The real analogue of this function is nag_dsprfs (f07phc).

10 Example

This example solves the system of equations

A X = B

using iterative refinement and to compute the forward and backward error bounds, where

A = (\begin{array}{r} - 0.39 - 0.71 i & 5.14 - 0.64 i & - 7.86 - 2.96 i & 3.80 + 0.92 i \\ 5.14 - 0.64 i & 8.86 + 1.81 i & - 3.52 + 0.58 i & 5.32 - 1.59 i \\ - 7.86 - 2.96 i & - 3.52 + 0.58 i & - 2.83 - 0.03 i & - 1.54 - 2.86 i \\ 3.80 + 0.92 i & 5.32 - 1.59 i & - 1.54 - 2.86 i & - 0.56 + 0.12 i \end{array})

and

B = (\begin{array}{r} - 55.64 + 41.22 i & - 19.09 - 35.97 i \\ - 48.18 + 66.00 i & - 12.08 - 27.02 i \\ - 0.49 - 1.47 i & 6.95 + 20.49 i \\ - 6.43 + 19.24 i & - 4.59 - 35.53 i \end{array}) .

Here

A

is symmetric, stored in packed form, and must first be factorized by nag_zsptrf (f07qrc).

NAG Library Function Documentnag_zsprfs (f07qvc)

+− 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_zsprfs (f07qvc)