NAG Library Function Document

nag_zpotrs (f07fsc)

void	nag_zpotrs (Nag_OrderType order, Nag_UploType uplo, Integer n, Integer nrhs, const Complex a[], Integer pda, Complex b[], Integer pdb, NagError *fail)

3 Description

nag_zpotrs (f07fsc) is used to solve a complex Hermitian positive definite system of linear equations

A X = B

, this function must be preceded by a call to nag_zpotrf (f07frc) which computes the Cholesky factorization of

A

. The solution

X

is computed by forward and backward substitution.

uplo = Nag_Upper

A = U^{H} U

, where

U

is upper triangular; the solution

X

is computed by solving

U^{H} Y = B

and then

U X = Y

uplo = Nag_Lower

A = L L^{H}

, where

L

is lower triangular; the solution

X

is computed by solving

L Y = B

and then

L^{H} X = Y

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 how

A

has been factorized.

$uplo = Nag_Upper$: $A = U^{H} U$ , where $U$ is upper triangular.
$uplo = Nag_Lower$: $A = L L^{H}$ , 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: a[ $\dim$ ] – const ComplexInput

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

\max (1, pda \times n)

On entry: the Cholesky factor of

A

, as returned by nag_zpotrf (f07frc).

6: pda – IntegerInput

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

Constraint:

pda \geq \max (1, n)

7: b[ $\dim$ ] – ComplexInput/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

right-hand side matrix

B

On exit: 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: 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)$ .
On entry, $pdb = ⟨value⟩$ and $nrhs = ⟨value⟩$ .
Constraint: $pdb \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

For each right-hand side vector

b

, the computed solution

x

is the exact solution of a perturbed system of equations

(A + E) x = b

, where

if $uplo = Nag_Upper$ , $|E| \leq c (n) ε |U^{H}| |U|$ ;
if $uplo = Nag_Lower$ , $|E| \leq c (n) ε |L| |L^{H}|$ ,

c (n)

is a modest linear function of

n

, and

ε

is the machine precision.

\hat{x}

is the true solution, then the computed solution

x

satisfies a forward error bound of the form

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

where

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

Note that

cond (A, x)

can be much smaller than

cond (A)

Forward and backward error bounds can be computed by calling nag_zporfs (f07fvc), and an estimate for

κ_{\infty} (A)

(

= κ_{1} (A)

) can be obtained by calling nag_zpocon (f07fuc).

8 Parallelism and Performance

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

nag_zpotrs (f07fsc) 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 real floating-point operations is approximately

8 n^{2} r

This function may be followed by a call to nag_zporfs (f07fvc) to refine the solution and return an error estimate.

The real analogue of this function is nag_dpotrs (f07fec).

10 Example

This example solves the system of equations

A X = B

, where

A = (\begin{array}{r} 3.23 + 0.00 i & 1.51 - 1.92 i & 1.90 + 0.84 i & 0.42 + 2.50 i \\ 1.51 + 1.92 i & 3.58 + 0.00 i & - 0.23 + 1.11 i & - 1.18 + 1.37 i \\ 1.90 - 0.84 i & - 0.23 - 1.11 i & 4.09 + 0.00 i & 2.33 - 0.14 i \\ 0.42 - 2.50 i & - 1.18 - 1.37 i & 2.33 + 0.14 i & 4.29 + 0.00 i \end{array})

and

B = (\begin{array}{r} 3.93 - 6.14 i & 1.48 + 6.58 i \\ 6.17 + 9.42 i & 4.65 - 4.75 i \\ - 7.17 - 21.83 i & - 4.91 + 2.29 i \\ 1.99 - 14.38 i & 7.64 - 10.79 i \end{array}) .

Here

A

is Hermitian positive definite and must first be factorized by nag_zpotrf (f07frc).

NAG Library Function Documentnag_zpotrs (f07fsc)

+− 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_zpotrs (f07fsc)