NAG FL Interface
f01kkf (complex_gen_matrix_frcht_log)
1
Purpose
f01kkf computes the Fréchet derivative $L\left(A,E\right)$ of the matrix logarithm of the complex $n$ by $n$ matrix $A$ applied to the complex $n$ by $n$ matrix $E$. The principal matrix logarithm $\mathrm{log}\left(A\right)$ is also returned.
2
Specification
Fortran Interface
Integer, Intent (In) 
:: 
n, lda, lde 
Integer, Intent (Inout) 
:: 
ifail 
Complex (Kind=nag_wp), Intent (Inout) 
:: 
a(lda,*), e(lde,*) 

C Header Interface
#include <nag.h>
void 
f01kkf_ (const Integer *n, Complex a[], const Integer *lda, Complex e[], const Integer *lde, Integer *ifail) 

C++ Header Interface
#include <nag.h> extern "C" {
void 
f01kkf_ (const Integer &n, Complex a[], const Integer &lda, Complex e[], const Integer &lde, Integer &ifail) 
}

The routine may be called by the names f01kkf or nagf_matop_complex_gen_matrix_frcht_log.
3
Description
For a matrix with no eigenvalues on the closed negative real line, the principal matrix logarithm $\mathrm{log}\left(A\right)$ is the unique logarithm whose spectrum lies in the strip $\left\{z:\pi <\mathrm{Im}\left(z\right)<\pi \right\}$.
The Fréchet derivative of the matrix logarithm of
$A$ is the unique linear mapping
$E\u27fcL\left(A,E\right)$ such that for any matrix
$E$
The derivative describes the first order effect of perturbations in $A$ on the logarithm $\mathrm{log}\left(A\right)$.
f01kkf uses the algorithm of
Al–Mohy et al. (2012) to compute
$\mathrm{log}\left(A\right)$ and
$L\left(A,E\right)$. The principal matrix logarithm
$\mathrm{log}\left(A\right)$ is computed using a Schur decomposition, a Padé approximant and the inverse scaling and squaring method. The Padé approximant is then differentiated in order to obtain the Fréchet derivative
$L\left(A,E\right)$. If
$A$ is nonsingular but has negative real eigenvalues, the principal logarithm is not defined, but
f01kkf will return a nonprincipal logarithm and Fréchet derivative.
4
References
Al–Mohy A H and Higham N J (2011) Improved inverse scaling and squaring algorithms for the matrix logarithm SIAM J. Sci. Comput. 34(4) C152–C169
Al–Mohy A H, Higham N J and Relton S D (2012) Computing the Fréchet derivative of the matrix logarithm and estimating the condition number SIAM J. Sci. Comput. 35(4) C394–C410
Higham N J (2008) Functions of Matrices: Theory and Computation SIAM, Philadelphia, PA, USA
5
Arguments

1:
$\mathbf{n}$ – Integer
Input

On entry: $n$, the order of the matrix $A$.
Constraint:
${\mathbf{n}}\ge 0$.

2:
$\mathbf{a}\left({\mathbf{lda}},*\right)$ – Complex (Kind=nag_wp) array
Input/Output

Note: the second dimension of the array
a
must be at least
${\mathbf{n}}$.
On entry: the $n$ by $n$ matrix $A$.
On exit: the $n$ by $n$ principal matrix logarithm, $\mathrm{log}\left(A\right)$. Alterntively, if ${\mathbf{ifail}}={\mathbf{2}}$, a nonprincipal logarithm is returned.

3:
$\mathbf{lda}$ – Integer
Input

On entry: the first dimension of the array
a as declared in the (sub)program from which
f01kkf is called.
Constraint:
${\mathbf{lda}}\ge {\mathbf{n}}$.

4:
$\mathbf{e}\left({\mathbf{lde}},*\right)$ – Complex (Kind=nag_wp) array
Input/Output

Note: the second dimension of the array
e
must be at least
${\mathbf{n}}$.
On entry: the $n$ by $n$ matrix $E$
On exit: with ${\mathbf{ifail}}={\mathbf{0}}$, ${\mathbf{2}}$ or ${\mathbf{3}}$, the Fréchet derivative $L\left(A,E\right)$

5:
$\mathbf{lde}$ – Integer
Input

On entry: the first dimension of the array
e as declared in the (sub)program from which
f01kkf is called.
Constraint:
${\mathbf{lde}}\ge {\mathbf{n}}$.

6:
$\mathbf{ifail}$ – Integer
Input/Output

On entry:
ifail must be set to
$0$,
$1\text{or}1$. If you are unfamiliar with this argument you should refer to
Section 4 in the Introduction to the NAG Library FL Interface for details.
For environments where it might be inappropriate to halt program execution when an error is detected, the value
$1\text{or}1$ is recommended. If the output of error messages is undesirable, then the value
$1$ is recommended. Otherwise, if you are not familiar with this argument, the recommended value is
$0$.
When the value $\mathbf{1}\text{or}\mathbf{1}$ is used it is essential to test the value of ifail on exit.
On exit:
${\mathbf{ifail}}={\mathbf{0}}$ unless the routine detects an error or a warning has been flagged (see
Section 6).
6
Error Indicators and Warnings
If on entry
${\mathbf{ifail}}=0$ or
$1$, explanatory error messages are output on the current error message unit (as defined by
x04aaf).
Errors or warnings detected by the routine:
 ${\mathbf{ifail}}=1$

$A$ is singular so the logarithm cannot be computed.
 ${\mathbf{ifail}}=2$

$A$ has eigenvalues on the negative real line. The principal logarithm is not defined in this case, so a nonprincipal logarithm was returned.
 ${\mathbf{ifail}}=3$

$\mathrm{log}\left(A\right)$ has been computed using an IEEE double precision Padé approximant, although the arithmetic precision is higher than IEEE double precision.
 ${\mathbf{ifail}}=4$

An unexpected internal error occurred. This failure should not occur and suggests that the routine has been called incorrectly.
 ${\mathbf{ifail}}=1$

On entry, ${\mathbf{n}}=\u2329\mathit{\text{value}}\u232a$.
Constraint: ${\mathbf{n}}\ge 0$.
 ${\mathbf{ifail}}=3$

On entry, ${\mathbf{lda}}=\u2329\mathit{\text{value}}\u232a$ and ${\mathbf{n}}=\u2329\mathit{\text{value}}\u232a$.
Constraint: ${\mathbf{lda}}\ge {\mathbf{n}}$.
 ${\mathbf{ifail}}=5$

On entry, ${\mathbf{lde}}=\u2329\mathit{\text{value}}\u232a$ and ${\mathbf{n}}=\u2329\mathit{\text{value}}\u232a$.
Constraint: ${\mathbf{lde}}\ge {\mathbf{n}}$.
 ${\mathbf{ifail}}=99$
An unexpected error has been triggered by this routine. Please
contact
NAG.
See
Section 7 in the Introduction to the NAG Library FL Interface for further information.
 ${\mathbf{ifail}}=399$
Your licence key may have expired or may not have been installed correctly.
See
Section 8 in the Introduction to the NAG Library FL Interface for further information.
 ${\mathbf{ifail}}=999$
Dynamic memory allocation failed.
See
Section 9 in the Introduction to the NAG Library FL Interface for further information.
7
Accuracy
For a normal matrix
$A$ (for which
${A}^{\mathrm{H}}A=A{A}^{\mathrm{H}}$), the Schur decomposition is diagonal and the computation of the matrix logarithm reduces to evaluating the logarithm of the eigenvalues of
$A$ and then constructing
$\mathrm{log}\left(A\right)$ using the Schur vectors. This should give a very accurate result. In general, however, no error bounds are available for the algorithm. The sensitivity of the computation of
$\mathrm{log}\left(A\right)$ and
$L\left(A,E\right)$ is worst when
$A$ has an eigenvalue of very small modulus or has a complex conjugate pair of eigenvalues lying close to the negative real axis. See
Al–Mohy and Higham (2011),
Al–Mohy et al. (2012) and Section 11.2 of
Higham (2008) for details and further discussion.
8
Parallelism and Performance
f01kkf is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.
f01kkf 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 routine. Please also consult the
Users' Note for your implementation for any additional implementationspecific information.
The cost of the algorithm is
$O\left({n}^{3}\right)$ floatingpoint operations. The complex allocatable memory required is approximately
$5{n}^{2}$; see
Al–Mohy et al. (2012) for further details.
If the matrix logarithm alone is required, without the Fréchet derivative, then
f01fjf should be used. If the condition number of the matrix logarithm is required then
f01kjf should be used. The real analogue of this routine is
f01jkf.
10
Example
This example finds the principal matrix logarithm
$\mathrm{log}\left(A\right)$ and the Fréchet derivative
$L\left(A,E\right)$, where
10.1
Program Text
10.2
Program Data
10.3
Program Results