f07 Chapter Contents
f07 Chapter Introduction
NAG Library Manual

# NAG Library Function Documentnag_zspcon (f07quc)

## 1  Purpose

nag_zspcon (f07quc) estimates the condition number of a complex symmetric matrix $A$, where $A$ has been factorized by nag_zsptrf (f07qrc), using packed storage.

## 2  Specification

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

## 3  Description

nag_zspcon (f07quc) estimates the condition number (in the $1$-norm) of a complex symmetric matrix $A$:
 $κ1A=A1A-11 .$
Since $A$ is symmetric, ${\kappa }_{1}\left(A\right)={\kappa }_{\infty }\left(A\right)={‖A‖}_{\infty }{‖{A}^{-1}‖}_{\infty }$.
Because ${\kappa }_{1}\left(A\right)$ is infinite if $A$ is singular, the function actually returns an estimate of the reciprocal of ${\kappa }_{1}\left(A\right)$.
The function should be preceded by a call to nag_zsp_norm (f16ugc) to compute ${‖A‖}_{1}$ and a call to nag_zsptrf (f07qrc) to compute the Bunch–Kaufman factorization of $A$. The function then uses Higham's implementation of Hager's method (see Higham (1988)) to estimate ${‖{A}^{-1}‖}_{1}$.

## 4  References

Higham N J (1988) FORTRAN codes for estimating the one-norm of a real or complex matrix, with applications to condition estimation ACM Trans. Math. Software 14 381–396

## 5  Arguments

1:    $\mathbf{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 ${\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 $\mathrm{Nag_ColMajor}$.
2:    $\mathbf{uplo}$Nag_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:    $\mathbf{n}$IntegerInput
On entry: $n$, the order of the matrix $A$.
Constraint: ${\mathbf{n}}\ge 0$.
4:    $\mathbf{ap}\left[\mathit{dim}\right]$const ComplexInput
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).
5:    $\mathbf{ipiv}\left[\mathit{dim}\right]$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:    $\mathbf{anorm}$doubleInput
On entry: the $1$-norm of the original matrix $A$, which may be computed by calling nag_zsp_norm (f16ugc) with its argument ${\mathbf{norm}}=\mathrm{Nag_OneNorm}$. anorm must be computed either before calling nag_zsptrf (f07qrc) or else from a copy of the original matrix $A$.
Constraint: ${\mathbf{anorm}}\ge 0.0$.
7:    $\mathbf{rcond}$double *Output
On exit: an estimate of the reciprocal of the condition number of $A$. rcond is set to zero if exact singularity is detected or the estimate underflows. If rcond is less than machine precision, $A$ is singular to working precision.
8:    $\mathbf{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.
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.
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_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_REAL
On entry, ${\mathbf{anorm}}=〈\mathit{\text{value}}〉$.
Constraint: ${\mathbf{anorm}}\ge 0.0$.

## 7  Accuracy

The computed estimate rcond is never less than the true value $\rho$, and in practice is nearly always less than $10\rho$, although examples can be constructed where rcond is much larger.

## 8  Parallelism and Performance

nag_zspcon (f07quc) is not threaded by NAG in any implementation.
nag_zspcon (f07quc) 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

A call to nag_zspcon (f07quc) involves solving a number of systems of linear equations of the form $Ax=b$; the number is usually $5$ and never more than $11$. Each solution involves approximately $8{n}^{2}$ real floating-point operations but takes considerably longer than a call to nag_zsptrs (f07qsc) with one right-hand side, because extra care is taken to avoid overflow when $A$ is approximately singular.
The real analogue of this function is nag_dspcon (f07pgc).

## 10  Example

This example estimates the condition number in the $1$-norm (or $\infty$-norm) 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). The true condition number in the $1$-norm is $32.92$.

### 10.1  Program Text

Program Text (f07quce.c)

### 10.2  Program Data

Program Data (f07quce.d)

### 10.3  Program Results

Program Results (f07quce.r)