f07 Chapter Contents
f07 Chapter Introduction
NAG C Library Manual

# NAG Library Function Documentnag_zsptri (f07qwc)

## 1  Purpose

nag_zsptri (f07qwc) computes the inverse of a complex symmetric matrix $A$, where $A$ has been factorized by nag_zsptrf (f07qrc), using packed storage.

## 2  Specification

 #include #include
 void nag_zsptri (Nag_OrderType order, Nag_UploType uplo, Integer n, Complex ap[], const Integer ipiv[], NagError *fail)

## 3  Description

nag_zsptri (f07qwc) is used to compute the inverse of a complex symmetric matrix $A$, the function must be preceded by a call to nag_zsptrf (f07qrc), which computes the Bunch–Kaufman factorization of $A$, using packed storage.
If ${\mathbf{uplo}}=\mathrm{Nag_Upper}$, $A=PUD{U}^{\mathrm{T}}{P}^{\mathrm{T}}$ and ${A}^{-1}$ is computed by solving ${U}^{\mathrm{T}}{P}^{\mathrm{T}}XPU={D}^{-1}$.
If ${\mathbf{uplo}}=\mathrm{Nag_Lower}$, $A=PLD{L}^{\mathrm{T}}{P}^{\mathrm{T}}$ and ${A}^{-1}$ is computed by solving ${L}^{\mathrm{T}}{P}^{\mathrm{T}}XPL={D}^{-1}$.

## 4  References

Du Croz J J and Higham N J (1992) Stability of methods for matrix inversion IMA J. Numer. Anal. 12 1–19

## 5  Arguments

1:     orderNag_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 ${\mathbf{order}}=\mathrm{Nag_RowMajor}$. See Section 3.2.1.3 in the Essential Introduction for a more detailed explanation of the use of this argument.
Constraint: ${\mathbf{order}}=\mathrm{Nag_RowMajor}$ or Nag_ColMajor.
2:     uploNag_UploTypeInput
On entry: specifies how $A$ has been factorized.
${\mathbf{uplo}}=\mathrm{Nag_Upper}$
$A=PUD{U}^{\mathrm{T}}{P}^{\mathrm{T}}$, where $U$ is upper triangular.
${\mathbf{uplo}}=\mathrm{Nag_Lower}$
$A=PLD{L}^{\mathrm{T}}{P}^{\mathrm{T}}$, where $L$ is lower triangular.
Constraint: ${\mathbf{uplo}}=\mathrm{Nag_Upper}$ or $\mathrm{Nag_Lower}$.
3:     nIntegerInput
On entry: $n$, the order of the matrix $A$.
Constraint: ${\mathbf{n}}\ge 0$.
4:     ap[$\mathit{dim}$]ComplexInput/Output
Note: the dimension, dim, 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)$.
On entry: the factorization of $A$ stored in packed form, as returned by nag_zsptrf (f07qrc).
On exit: the factorization is overwritten by the $n$ by $n$ matrix ${A}^{-1}$.
The storage of elements ${A}_{ij}$ depends on the order and uplo arguments as follows:
• if ${\mathbf{order}}=\mathrm{Nag_ColMajor}$ and ${\mathbf{uplo}}=\mathrm{Nag_Upper}$,
${A}_{ij}$ is stored in ${\mathbf{ap}}\left[\left(j-1\right)×j/2+i-1\right]$, for $i\le j$;
• if ${\mathbf{order}}=\mathrm{Nag_ColMajor}$ and ${\mathbf{uplo}}=\mathrm{Nag_Lower}$,
${A}_{ij}$ is stored in ${\mathbf{ap}}\left[\left(2n-j\right)×\left(j-1\right)/2+i-1\right]$, for $i\ge j$;
• if ${\mathbf{order}}=\mathrm{Nag_RowMajor}$ and ${\mathbf{uplo}}=\mathrm{Nag_Upper}$,
${A}_{ij}$ is stored in ${\mathbf{ap}}\left[\left(2n-i\right)×\left(i-1\right)/2+j-1\right]$, for $i\le j$;
• if ${\mathbf{order}}=\mathrm{Nag_RowMajor}$ and ${\mathbf{uplo}}=\mathrm{Nag_Lower}$,
${A}_{ij}$ is stored in ${\mathbf{ap}}\left[\left(i-1\right)×i/2+j-1\right]$, for $i\ge j$.
5:     ipiv[$\mathit{dim}$]const IntegerInput
Note: the dimension, dim, of the array ipiv must be at least $\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{n}}\right)$.
On entry: details of the interchanges and the block structure of $D$, as returned by nag_zsptrf (f07qrc).
6:     failNagError *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.
On entry, argument $〈\mathit{\text{value}}〉$ had an illegal value.
NE_INT
On entry, ${\mathbf{n}}=〈\mathit{\text{value}}〉$.
Constraint: ${\mathbf{n}}\ge 0$.
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.
NE_SINGULAR
$d\left(〈\mathit{\text{value}}〉,〈\mathit{\text{value}}〉\right)$ is exactly zero. $D$ is singular and the inverse of $A$ cannot be computed.

## 7  Accuracy

The computed inverse $X$ satisfies a bound of the form
• if ${\mathbf{uplo}}=\mathrm{Nag_Upper}$, $\left|D{U}^{\mathrm{T}}{P}^{\mathrm{T}}XPU-I\right|\le c\left(n\right)\epsilon \left(\left|D\right|\left|{U}^{\mathrm{T}}\right|{P}^{\mathrm{T}}\left|X\right|P\left|U\right|+\left|D\right|\left|{D}^{-1}\right|\right)$;
• if ${\mathbf{uplo}}=\mathrm{Nag_Lower}$, $\left|D{L}^{\mathrm{T}}{P}^{\mathrm{T}}XPL-I\right|\le c\left(n\right)\epsilon \left(\left|D\right|\left|{L}^{\mathrm{T}}\right|{P}^{\mathrm{T}}\left|X\right|P\left|L\right|+\left|D\right|\left|{D}^{-1}\right|\right)$,
$c\left(n\right)$ is a modest linear function of $n$, and $\epsilon$ is the machine precision.

The total number of real floating point operations is approximately $\frac{8}{3}{n}^{3}$.
The real analogue of this function is nag_dsptri (f07pjc).

## 9  Example

This example computes the inverse of the matrix $A$, where
 $A= -0.39-0.71i 5.14-0.64i -7.86-2.96i 3.80+0.92i 5.14-0.64i 8.86+1.81i -3.52+0.58i 5.32-1.59i -7.86-2.96i -3.52+0.58i -2.83-0.03i -1.54-2.86i 3.80+0.92i 5.32-1.59i -1.54-2.86i -0.56+0.12i .$
Here $A$ is symmetric, stored in packed form, and must first be factorized by nag_zsptrf (f07qrc).

### 9.1  Program Text

Program Text (f07qwce.c)

### 9.2  Program Data

Program Data (f07qwce.d)

### 9.3  Program Results

Program Results (f07qwce.r)