NAG Library Function Document

nag_zptsvx (f07jpc)

void	nag_zptsvx (Nag_OrderType order, Nag_FactoredFormType fact, Integer n, Integer nrhs, const double d[], const Complex e[], double df[], Complex ef[], const Complex b[], Integer pdb, Complex x[], Integer pdx, double rcond, double ferr[], double berr[], NagError fail)

3 Description

nag_zptsvx (f07jpc) performs the following steps:

1.	If $fact = Nag_NotFactored$ , the matrix $A$ is factorized as $A = L D L^{H}$ , where $L$ is a unit lower bidiagonal matrix and $D$ is diagonal. The factorization can also be regarded as having the form $A = U^{H} D U$ .
2.	If the leading $i$ by $i$ principal minor is not positive definite, then the function returns with $fail . errnum = i$ and $fail . code =$ NE_MAT_NOT_POS_DEF. Otherwise, the factored form of $A$ is used to estimate the condition number of the matrix $A$ . If the reciprocal of the condition number is less than machine precision, $fail . code =$ NE_SINGULAR_WP is returned as a warning, but the function still goes on to solve for $X$ and compute error bounds as described below.
3.	The system of equations is solved for $X$ using the factored form of $A$ .
4.	Iterative refinement is applied to improve the computed solution matrix and to calculate error bounds and backward error estimates for it.

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

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

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: $fact$ – Nag_FactoredFormTypeInput

On entry: specifies whether or not the factorized form of the matrix

A

has been supplied.

$fact = Nag_Factored$: df and ef contain the factorized form of the matrix $A$ . df and ef will not be modified.
$fact = Nag_NotFactored$: The matrix $A$ will be copied to df and ef and factorized.

Constraint:

fact = Nag_Factored

Nag_NotFactored

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, i.e., the number of columns of the matrix

B

Constraint:

nrhs \geq 0

5: $d [\dim]$ – const doubleInput

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

\max (1, n)

On entry: the

n

diagonal elements of the tridiagonal matrix

A

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

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

\max (1, n - 1)

On entry: the

(n - 1)

subdiagonal elements of the tridiagonal matrix

A

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

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

\max (1, n)

On entry: if

fact = Nag_Factored

, df must contain the

n

diagonal elements of the diagonal matrix

D

from the

L D L^{H}

factorization of

A

On exit: if

fact = Nag_NotFactored

, df contains the

n

diagonal elements of the diagonal matrix

D

from the

L D L^{H}

factorization of

A

8: $ef [\dim]$ – ComplexInput/Output

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

\max (1, n - 1)

On entry: if

fact = Nag_Factored

, ef must contain the

(n - 1)

subdiagonal elements of the unit bidiagonal factor

L

from the

L D L^{H}

factorization of

A

On exit: if

fact = Nag_NotFactored

, ef contains the

(n - 1)

subdiagonal elements of the unit bidiagonal factor

L

from the

L D L^{H}

factorization of

A

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

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

11: $x [\dim]$ – ComplexOutput

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 exit: if

fail . code =

NE_NOERROR or NE_SINGULAR_WP, the

n

r

solution matrix

X

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

13: $rcond$ – double *Output

On exit: the reciprocal condition number of the matrix

A

. If rcond is less than the machine precision (in particular, if

rcond = 0.0

), the matrix is singular to working precision. This condition is indicated by a return code of

fail . code =

NE_SINGULAR_WP.

14: $ferr [nrhs]$ – doubleOutput

On exit: the forward error bound for each solution vector

{\hat{x}}_{j}

(the

j

th column of the solution matrix

X

). If

x_{j}

is the true solution corresponding to

{\hat{x}}_{j}

ferr [j - 1]

is an estimated upper bound for the magnitude of the largest element in (

{\hat{x}}_{j} - x_{j}

) divided by the magnitude of the largest element in

{\hat{x}}_{j}

15: $berr [nrhs]$ – doubleOutput

On exit: the component-wise relative backward error of each solution vector

{\hat{x}}_{j}

(i.e., the smallest relative change in any element of

A

B

that makes

{\hat{x}}_{j}

an exact solution).

16: $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.
See Section 3.2.1.2 in the Essential Introduction for further information.
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.

An unexpected error has been triggered by this function. Please contact NAG.
See Section 3.6.6 in the Essential Introduction for further information.
NE_MAT_NOT_POS_DEF: 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. $rcond = 0.0$ is returned.
NE_NO_LICENCE: Your licence key may have expired or may not have been installed correctly.
See Section 3.6.5 in the Essential Introduction for further information.
NE_SINGULAR_WP: $D$ is nonsingular, but rcond is less than machine precision, meaning that the matrix is singular to working precision. Nevertheless, the solution and error bounds are computed because there are a number of situations where the computed solution can be more accurate than the value of rcond would suggest.

7 Accuracy

For each right-hand side vector

b

, the computed solution

\hat{x}

is the exact solution of a perturbed system of equations

(A + E) \hat{x} = b

, where

|E| \leq c (n) ε |R^{T}| |R|, where ​ R = D^{\frac{1}{2}} U,

c (n)

is a modest linear function of

n

, and

ε

is the machine precision. See Section 10.1 of Higham (2002) for further details.

x

is the true solution, then the computed solution

\hat{x}

satisfies a forward error bound of the form

\frac{{‖x - \hat{x}‖}_{\infty}}{{‖\hat{x}‖}_{\infty}} \leq w_{c} cond (A, \hat{x}, b)

where

cond (A, \hat{x}, b) = {‖|A^{- 1}| (|A| |\hat{x}| + |b|)‖}_{\infty} / {‖\hat{x}‖}_{\infty} \leq cond (A) = {‖|A^{- 1}| |A|‖}_{\infty} \leq κ_{\infty} (A)

. If

\hat{x}

is the

j

th column of

X

, then

w_{c}

is returned in

berr [j - 1]

and a bound on

{‖x - \hat{x}‖}_{\infty} / {‖\hat{x}‖}_{\infty}

is returned in

ferr [j - 1]

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

8 Parallelism and Performance

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

nag_zptsvx (f07jpc) 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 number of floating-point operations required for the factorization, and for the estimation of the condition number of

A

is proportional to

n

. The number of floating-point operations required for the solution of the equations, and for the estimation of the forward and backward error is proportional to

n r

, where

r

is the number of right-hand sides.

The condition estimation is based upon Equation (15.11) of Higham (2002). For further details of the error estimation, see Section 4.4 of Anderson et al. (1999).

The real analogue of this function is nag_dptsvx (f07jbc).

10 Example

This example solves the equations

A X = B,

where

A

is the Hermitian positive definite tridiagonal matrix

A = (\begin{array}{r} 16.0 & 16.0 - 16.0 i & 0 & 0 \\ 16.0 + 16.0 i & 41.0 & 18.0 + 9.0 i & 0 \\ 0 & 18.0 - 9.0 i & 46.0 & 1.0 + 4.0 i \\ 0 & 0 & 1.0 - 4.0 i & 21.0 \end{array})

and

B = (\begin{array}{r} 64.0 + 16.0 i & - 16.0 - 32.0 i \\ 93.0 + 62.0 i & 61.0 - 66.0 i \\ 78.0 - 80.0 i & 71.0 - 74.0 i \\ 14.0 - 27.0 i & 35.0 + 15.0 i \end{array}) .

Error estimates for the solutions and an estimate of the reciprocal of the condition number of

A

are also output.

NAG Library Function Documentnag_zptsvx (f07jpc)

▸▿ 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_zptsvx (f07jpc)