f01 Chapter Contents
f01 Chapter Introduction
NAG Library Manual

# NAG Library Function Documentnag_matop_real_gen_matrix_cond_usd (f01jcc)

## 1  Purpose

nag_matop_real_gen_matrix_cond_usd (f01jcc) computes an estimate of the absolute condition number of a matrix function $f$ at a real $n$ by $n$ matrix $A$ in the $1$-norm, using analytical derivatives of $f$ you have supplied.

## 2  Specification

 #include #include
void  nag_matop_real_gen_matrix_cond_usd (Integer n, double a[], Integer pda,
 void (*f)(Integer m, Integer *iflag, Integer nz, const Complex z[], Complex fz[], Nag_Comm *comm),
Nag_Comm *comm, Integer *iflag, double *conda, double *norma, double *normfa, NagError *fail)

## 3  Description

The absolute condition number of $f$ at $A$, ${\mathrm{cond}}_{\mathrm{abs}}\left(f,A\right)$ is given by the norm of the Fréchet derivative of $f$, $L\left(A\right)$, which is defined by
 $LX := maxE≠0 LX,E E ,$
where $L\left(X,E\right)$ is the Fréchet derivative in the direction $E$. $L\left(X,E\right)$ is linear in $E$ and can therefore be written as
 $vec LX,E = KX vecE ,$
where the $\mathrm{vec}$ operator stacks the columns of a matrix into one vector, so that $K\left(X\right)$ is ${n}^{2}×{n}^{2}$. nag_matop_real_gen_matrix_cond_usd (f01jcc) computes an estimate $\gamma$ such that $\gamma \le {‖K\left(X\right)‖}_{1}$, where ${‖K\left(X\right)‖}_{1}\in \left[{n}^{-1}{‖L\left(X\right)‖}_{1},n{‖L\left(X\right)‖}_{1}\right]$. The relative condition number can then be computed via
 $cond rel f,A = cond abs f,A A1 fA 1 .$
The algorithm used to find $\gamma$ is detailed in Section 3.4 of Higham (2008).
The function $f$, and the derivatives of $f$, are returned by function f which, given an integer $m$, evaluates ${f}^{\left(m\right)}\left({z}_{\mathit{i}}\right)$ at a number of (generally complex) points ${z}_{\mathit{i}}$, for $\mathit{i}=1,2,\dots ,{n}_{z}$. For any $z$ on the real line, $f\left(z\right)$ must also be real. nag_matop_real_gen_matrix_cond_usd (f01jcc) is therefore appropriate for functions that can be evaluated on the complex plane and whose derivatives, of arbitrary order, can also be evaluated on the complex plane.

## 4  References

Higham N J (2008) Functions of Matrices: Theory and Computation SIAM, Philadelphia, PA, USA

## 5  Arguments

1:     nIntegerInput
On entry: $n$, the order of the matrix $A$.
Constraint: ${\mathbf{n}}\ge 0$.
2:     a[$\mathit{dim}$]doubleInput/Output
Note: the dimension, dim, of the array a must be at least ${\mathbf{pda}}×{\mathbf{n}}$.
The $\left(i,j\right)$th element of the matrix $A$ is stored in ${\mathbf{a}}\left[\left(j-1\right)×{\mathbf{pda}}+i-1\right]$.
On entry: the $n$ by $n$ matrix $A$.
On exit: the $n$ by $n$ matrix, $f\left(A\right)$.
3:     pdaIntegerInput
On entry: the stride separating matrix row elements in the array a.
Constraint: ${\mathbf{pda}}\ge {\mathbf{n}}$.
4:     ffunction, supplied by the userExternal Function
Given an integer $m$, the function f evaluates ${f}^{\left(m\right)}\left({z}_{i}\right)$ at a number of points ${z}_{i}$.
The specification of f is:
 void f (Integer m, Integer *iflag, Integer nz, const Complex z[], Complex fz[], Nag_Comm *comm)
1:     mIntegerInput
On entry: the order, $m$, of the derivative required.
If ${\mathbf{m}}=0$, $f\left({z}_{i}\right)$ should be returned. For ${\mathbf{m}}>0$, ${f}^{\left(m\right)}\left({z}_{i}\right)$ should be returned.
2:     iflagInteger *Input/Output
On entry: iflag will be zero.
On exit: iflag should either be unchanged from its entry value of zero, or may be set nonzero to indicate that there is a problem in evaluating the function $f\left(z\right)$; for instance $f\left(z\right)$ may not be defined. If iflag is returned as nonzero then nag_matop_real_gen_matrix_cond_usd (f01jcc) will terminate the computation, with ${\mathbf{fail}}\mathbf{.}\mathbf{code}=$ NE_USER_STOP.
3:     nzIntegerInput
On entry: ${n}_{z}$, the number of function or derivative values required.
4:     z[nz]const ComplexInput
On entry: the ${n}_{z}$ points ${z}_{1},{z}_{2},\dots ,{z}_{{n}_{z}}$ at which the function $f$ is to be evaluated.
5:     fz[nz]ComplexOutput
On exit: the ${n}_{z}$ function or derivative values. ${\mathbf{fz}}\left[\mathit{i}-1\right]$ should return the value ${f}^{\left(m\right)}\left({z}_{\mathit{i}}\right)$, for $\mathit{i}=1,2,\dots ,{n}_{z}$. If ${z}_{i}$ lies on the real line, then so must ${f}^{\left(m\right)}\left({z}_{i}\right)$.
6:     commNag_Comm *
Pointer to structure of type Nag_Comm; the following members are relevant to f.
userdouble *
iuserInteger *
pPointer
The type Pointer will be void *. Before calling nag_matop_real_gen_matrix_cond_usd (f01jcc) you may allocate memory and initialize these pointers with various quantities for use by f when called from nag_matop_real_gen_matrix_cond_usd (f01jcc) (see Section 3.2.1.1 in the Essential Introduction).
5:     commNag_Comm *Communication Structure
The NAG communication argument (see Section 3.2.1.1 in the Essential Introduction).
6:     iflagInteger *Output
On exit: ${\mathbf{iflag}}=0$, unless iflag has been set nonzero inside f, in which case iflag will be the value set and fail will be set to ${\mathbf{fail}}\mathbf{.}\mathbf{code}=$ NE_USER_STOP.
On exit: an estimate of the absolute condition number of $f$ at $A$.
On exit: the $1$-norm of $A$.
On exit: the $1$-norm of $f\left(A\right)$.
10:   failNagError *Input/Output
The NAG error argument (see Section 3.6 in the Essential Introduction).

## 6  Error Indicators and Warnings

NE_ALLOC_FAIL
Allocation of memory 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_INT_2
On entry, ${\mathbf{pda}}=⟨\mathit{\text{value}}⟩$ and ${\mathbf{n}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{pda}}\ge {\mathbf{n}}$.
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 internal error occurred when estimating the norm of the Fréchet derivative of $f$ at $A$. Please contact NAG.
An internal error occurred when evaluating the matrix function $f\left(A\right)$. You can investigate further by calling nag_matop_real_gen_matrix_fun_usd (f01emc) with the matrix $A$ and the function $f$.
NE_USER_STOP
iflag has been set nonzero by the user-supplied function.

## 7  Accuracy

nag_matop_real_gen_matrix_cond_usd (f01jcc) uses the norm estimation routine nag_linsys_real_gen_norm_rcomm (f04ydc) to estimate a quantity $\gamma$, where $\gamma \le {‖K\left(X\right)‖}_{1}$ and ${‖K\left(X\right)‖}_{1}\in \left[{n}^{-1}{‖L\left(X\right)‖}_{1},n{‖L\left(X\right)‖}_{1}\right]$. For further details on the accuracy of norm estimation, see the documentation for nag_linsys_real_gen_norm_rcomm (f04ydc).

## 8  Parallelism and Performance

nag_matop_real_gen_matrix_cond_usd (f01jcc) is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.
nag_matop_real_gen_matrix_cond_usd (f01jcc) 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.
In these implementations, this may make calls to the user supplied functions from within an OpenMP parallel region. Thus OpenMP directives within the user functions should be avoided, unless you are using the same OpenMP runtime library (which normally means using the same compiler) as that used to build your NAG Library implementation, as listed in the Installers' Note. You must also ensure that you use the NAG communication argument comm in a thread safe manner, which is best achieved by only using it to supply read-only data to the user functions.

The matrix function is computed using the underlying matrix function routine nag_matop_real_gen_matrix_fun_usd (f01emc). Approximately $6{n}^{2}$ of real allocatable memory is required by the routine, in addition to the memory used by the underlying matrix function routine.
If only $f\left(A\right)$ is required, without an estimate of the condition number, then it is far more efficient to use the underlying matrix function routine directly.
The complex analogue of this function is nag_matop_complex_gen_matrix_cond_usd (f01kcc).

## 10  Example

This example estimates the absolute and relative condition numbers of the matrix function ${e}^{2A}$ where
 $A= 0 -1 -1 1 -2 0 1 -1 2 -1 2 -2 -1 -2 0 -1 .$

### 10.1  Program Text

Program Text (f01jcce.c)

### 10.2  Program Data

Program Data (f01jcce.d)

### 10.3  Program Results

Program Results (f01jcce.r)