Integer type:  int32  int64  nag_int  show int32  show int32  show int64  show int64  show nag_int  show nag_int

Chapter Contents
Chapter Introduction
NAG Toolbox

# NAG Toolbox: nag_linsys_complex_symm_packed_solve (f04dj)

## Purpose

nag_linsys_complex_symm_packed_solve (f04dj) computes the solution to a complex system of linear equations $AX=B$, where $A$ is an $n$ by $n$ complex symmetric matrix, stored in packed format and $X$ and $B$ are $n$ by $r$ matrices. An estimate of the condition number of $A$ and an error bound for the computed solution are also returned.

## Syntax

[ap, ipiv, b, rcond, errbnd, ifail] = f04dj(uplo, ap, b, 'n', n, 'nrhs_p', nrhs_p)
[ap, ipiv, b, rcond, errbnd, ifail] = nag_linsys_complex_symm_packed_solve(uplo, ap, b, 'n', n, 'nrhs_p', nrhs_p)

## Description

The diagonal pivoting method is used to factor $A$ as $A=UD{U}^{\mathrm{T}}$, if ${\mathbf{uplo}}=\text{'U'}$, or $A=LD{L}^{\mathrm{T}}$, if ${\mathbf{uplo}}=\text{'L'}$, where $U$ (or $L$) is a product of permutation and unit upper (lower) triangular matrices, and $D$ is symmetric and block diagonal with $1$ by $1$ and $2$ by $2$ diagonal blocks. The factored form of $A$ is then used to solve the system of equations $AX=B$.

## 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

## Parameters

### Compulsory Input Parameters

1:     $\mathrm{uplo}$ – string (length ≥ 1)
If ${\mathbf{uplo}}=\text{'U'}$, the upper triangle of the matrix $A$ is stored.
If ${\mathbf{uplo}}=\text{'L'}$, the lower triangle of the matrix $A$ is stored.
Constraint: ${\mathbf{uplo}}=\text{'U'}$ or $\text{'L'}$.
2:     $\mathrm{ap}\left(:\right)$ – complex array
The dimension of the array ap must be at least $\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{n}}×\left({\mathbf{n}}+1\right)/2\right)$
The $n$ by $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 ${\mathbf{uplo}}=\text{'U'}$, the upper triangle of $A$ must be stored with element ${A}_{ij}$ in ${\mathbf{ap}}\left(i+j\left(j-1\right)/2\right)$ for $i\le j$;
• if ${\mathbf{uplo}}=\text{'L'}$, the lower triangle of $A$ must be stored with element ${A}_{ij}$ in ${\mathbf{ap}}\left(i+\left(2n-j\right)\left(j-1\right)/2\right)$ for $i\ge j$.
3:     $\mathrm{b}\left(\mathit{ldb},:\right)$ – complex array
The first dimension of the array b must be at least $\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{n}}\right)$.
The second dimension of the array b must be at least $\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{nrhs_p}}\right)$.
The $n$ by $r$ matrix of right-hand sides $B$.

### Optional Input Parameters

1:     $\mathrm{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: ${\mathbf{n}}\ge 0$.
2:     $\mathrm{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: ${\mathbf{nrhs_p}}\ge 0$.

### Output Parameters

1:     $\mathrm{ap}\left(:\right)$ – complex array
The dimension of the array ap will be $\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{n}}×\left({\mathbf{n}}+1\right)/2\right)$
If ${\mathbf{ifail}}\ge {\mathbf{0}}$, the block diagonal matrix $D$ and the multipliers used to obtain the factor $U$ or $L$ from the factorization $A=UD{U}^{\mathrm{T}}$ or $A=LD{L}^{\mathrm{T}}$ as computed by nag_lapack_zsptrf (f07qr), stored as a packed triangular matrix in the same storage format as $A$.
2:     $\mathrm{ipiv}\left({\mathbf{n}}\right)$int64int32nag_int array
If no constraints are violated, details of the interchanges and the block structure of $D$, as determined by nag_lapack_zsptrf (f07qr).
• If ${\mathbf{ipiv}}\left(k\right)>0$, then rows and columns $k$ and ${\mathbf{ipiv}}\left(k\right)$ were interchanged, and ${d}_{kk}$ is a $1$ by $1$ diagonal block;
• if ${\mathbf{uplo}}=\text{'U'}$ and ${\mathbf{ipiv}}\left(k\right)={\mathbf{ipiv}}\left(k-1\right)<0$, then rows and columns $k-1$ and $-{\mathbf{ipiv}}\left(k\right)$ were interchanged and ${d}_{k-1:k,k-1:k}$ is a $2$ by $2$ diagonal block;
• if ${\mathbf{uplo}}=\text{'L'}$ and ${\mathbf{ipiv}}\left(k\right)={\mathbf{ipiv}}\left(k+1\right)<0$, then rows and columns $k+1$ and $-{\mathbf{ipiv}}\left(k\right)$ were interchanged and ${d}_{k:k+1,k:k+1}$ is a $2$ by $2$ diagonal block.
3:     $\mathrm{b}\left(\mathit{ldb},:\right)$ – complex array
The first dimension of the array b will be $\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{n}}\right)$.
The second dimension of the array b will be $\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{nrhs_p}}\right)$.
If ${\mathbf{ifail}}={\mathbf{0}}$ or $\mathbf{n}+{\mathbf{1}}$, the $n$ by $r$ solution matrix $X$.
4:     $\mathrm{rcond}$ – double scalar
If no constraints are violated, an estimate of the reciprocal of the condition number of the matrix $A$, computed as ${\mathbf{rcond}}=1/\left({‖A‖}_{1}{‖{A}^{-1}‖}_{1}\right)$.
5:     $\mathrm{errbnd}$ – double scalar
If ${\mathbf{ifail}}={\mathbf{0}}$ or $\mathbf{n}+{\mathbf{1}}$, an estimate of the forward error bound for a computed solution $\stackrel{^}{x}$, such that ${‖\stackrel{^}{x}-x‖}_{1}/{‖x‖}_{1}\le {\mathbf{errbnd}}$, where $\stackrel{^}{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:     $\mathrm{ifail}$int64int32nag_int scalar
${\mathbf{ifail}}={\mathbf{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.

${\mathbf{ifail}}>0 \text{and} {\mathbf{ifail}}\le {\mathbf{n}}$
Diagonal block $_$ of the block diagonal matrix is zero. The factorization has been completed, but the solution could not be computed.
W  ${\mathbf{ifail}}={\mathbf{n}}+1$
A solution has been computed, but rcond is less than machine precision so that the matrix $A$ is numerically singular.
${\mathbf{ifail}}=-1$
On entry, ${\mathbf{uplo}}\ne \text{'U'}$ or $\text{'L'}$.
${\mathbf{ifail}}=-2$
Constraint: ${\mathbf{n}}\ge 0$.
${\mathbf{ifail}}=-3$
Constraint: ${\mathbf{nrhs_p}}\ge 0$.
${\mathbf{ifail}}=-7$
Constraint: $\mathit{ldb}\ge \mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{n}}\right)$.
${\mathbf{ifail}}=-99$
${\mathbf{ifail}}=-399$
Your licence key may have expired or may not have been installed correctly.
${\mathbf{ifail}}=-999$
Dynamic memory allocation failed.
The double allocatable memory required is n, and the complex allocatable memory required is $2×{\mathbf{n}}$. Allocation failed before the solution could be computed.

## Accuracy

The computed solution for a single right-hand side, $\stackrel{^}{x}$, satisfies an equation of the form
 $A+E x^=b,$
where
 $E1 = Oε A1$
and $\epsilon$ is the machine precision. An approximate error bound for the computed solution is given by
 $x^-x1 x1 ≤ κA E1 A1 ,$
where $\kappa \left(A\right)={‖{A}^{-1}‖}_{1}{‖A‖}_{1}$, the condition number of $A$ with respect to the solution of the linear equations. nag_linsys_complex_symm_packed_solve (f04dj) uses the approximation ${‖E‖}_{1}=\epsilon {‖A‖}_{1}$ to estimate errbnd. See Section 4.4 of Anderson et al. (1999) for further details.

The packed storage scheme is illustrated by the following example when $n=4$ and ${\mathbf{uplo}}=\text{'U'}$. Two-dimensional storage of the symmetric matrix $A$:
 $a11 a12 a13 a14 a22 a23 a24 a33 a34 a44 aij = aji$
Packed storage of the upper triangle of $A$:
 $ap= a11, a12, a22, a13, a23, a33, a14, a24, a34, a44$
The total number of floating-point operations required to solve the equations $AX=B$ is proportional to $\left(\frac{1}{3}{n}^{3}+2{n}^{2}r\right)$. 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.
Function nag_linsys_complex_herm_packed_solve (f04cj) is for complex Hermitian matrices, and the real analogue of nag_linsys_complex_symm_packed_solve (f04dj) is nag_linsys_real_symm_packed_solve (f04bj).

## Example

This example solves the equations
 $AX=B,$
where $A$ is the symmetric indefinite matrix
 $A= -0.56+0.12i -1.54-2.86i 5.32-1.59i 3.80+0.92i -1.54-2.86i -2.83-0.03i -3.52+0.58i -7.86-2.96i 5.32-1.59i -3.52+0.58i 8.86+1.81i 5.14-0.64i 3.80+0.92i -7.86-2.96i 5.14-0.64i -0.39-0.71i$
and
 $B= -6.43+19.24i -4.59-35.53i -0.49-01.47i 6.95+20.49i -48.18+66.00i -12.08-27.02i -55.64+41.22i -19.09-35.97i .$
An estimate of the condition number of $A$ and an approximate error bound for the computed solutions are also printed.
```function f04dj_example

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

% Solve complex Ax = b for symmetric packed A
% with error bound and condition number
uplo = 'U';
ap = [ -0.56 +  0.12i                                    ...
-1.54 -  2.86i     -2.83 - 0.03i                  ...
5.32 -  1.59i     -3.52 + 0.58i    8.86 + 1.81i  ...
3.8  +  0.92i     -7.86 - 2.96i    5.14 - 0.64i  -0.39 - 0.71i];
b = [  -6.43 + 19.24i,   -4.59 - 35.53i;
-0.49 -  1.47i,    6.95 + 20.49i;
-48.18 + 66.00i,  -12.08 - 27.02i;
-55.64 + 41.22i,  -19.09 - 35.97i];

[ap, ipiv, x, rcond, errbnd, ifail] = ...
f04dj(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);

```
```f04dj example results

Solution
-4.0000 + 3.0000i  -1.0000 + 1.0000i
3.0000 - 2.0000i   3.0000 + 2.0000i
-2.0000 + 5.0000i   1.0000 - 3.0000i
1.0000 - 1.0000i  -2.0000 - 1.0000i

Estimate of condition number
20.6

Estimate of error bound for computed solutions
2.3e-15

```