NAG C Library Function Document

nag_matop_complex_gen_matrix_cond_log (f01kjc)


nag_matop_complex_gen_matrix_cond_log (f01kjc) computes an estimate of the relative condition number κlogA of the logarithm of a complex n by n matrix A, in the 1-norm. The principal matrix logarithm logA is also returned.


#include <nag.h>
#include <nagf01.h>
void  nag_matop_complex_gen_matrix_cond_log (Integer n, Complex a[], Integer pda, double *condla, NagError *fail)


For a matrix with no eigenvalues on the closed negative real line, the principal matrix logarithm logA is the unique logarithm whose spectrum lies in the strip z:-π<Imz<π.
The Fréchet derivative of the matrix logarithm of A is the unique linear mapping ELA,E such that for any matrix E 
logA+E - logA - LA,E = oE .  
The derivative describes the first order effect of perturbations in A on the logarithm logA.
The relative condition number of the matrix logarithm can be defined by
κlogA = LA A logA ,  
where LA is the norm of the Fréchet derivative of the matrix logarithm at A.
To obtain the estimate of κlogA, nag_matop_complex_gen_matrix_cond_log (f01kjc) first estimates LA by computing an estimate γ of a quantity Kn-1LA1,nLA1, such that γK.
The algorithms used to compute κlogA and logA are based on a Schur decomposition, the inverse scaling and squaring method and Padé approximants. Further details can be found in Al–Mohy and Higham (2011) and Al–Mohy et al. (2012).
If A is nonsingular but has negative real eigenvalues, the principal logarithm is not defined, but nag_matop_complex_gen_matrix_cond_log (f01kjc) will return a non-principal logarithm and its condition number.


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


1:     n IntegerInput
On entry: n, the order of the matrix A.
Constraint: n0.
2:     a[dim] ComplexInput/Output
Note: the dimension, dim, of the array a must be at least pda×n.
The i,jth element of the matrix A is stored in a[j-1×pda+i-1].
On entry: the n by n matrix A.
On exit: the n by n principal matrix logarithm, logA. Alternatively, if fail.code= NE_NEGATIVE_EIGVAL, a non-principal logarithm is returned.
3:     pda IntegerInput
On entry: the stride separating matrix row elements in the array a.
Constraint: pdan.
4:     condla double *Output
On exit: with fail.code= NE_NOERROR, NE_NEGATIVE_EIGVAL or NW_SOME_PRECISION_LOSS, an estimate of the relative condition number of the matrix logarithm, κlogA. Alternatively, if fail.code= NE_RCOND, contains the absolute condition number of the matrix logarithm.
5:     fail NagError *Input/Output
The NAG error argument (see Section 3.7 in How to Use the NAG Library and its Documentation).

Error Indicators and Warnings

Dynamic memory allocation failed.
See Section in How to Use the NAG Library and its Documentation for further information.
On entry, argument value had an illegal value.
On entry, n=value.
Constraint: n0.
On entry, pda=value and n=value.
Constraint: pdan.
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.
See Section 2.7.6 in How to Use the NAG Library and its Documentation for further information.
A has eigenvalues on the negative real line. The principal logarithm is not defined in this case, so a non-principal logarithm was returned.
Your licence key may have expired or may not have been installed correctly.
See Section 2.7.5 in How to Use the NAG Library and its Documentation for further information.
The relative condition number is infinite. The absolute condition number was returned instead.
A is singular so the logarithm cannot be computed.
logA has been computed using an IEEE double precision Padé approximant, although the arithmetic precision is higher than IEEE double precision.


nag_matop_complex_gen_matrix_cond_log (f01kjc) uses the norm estimation function nag_linsys_complex_gen_norm_rcomm (f04zdc) to produce an estimate γ of a quantity Kn-1LA1,nLA1, such that γK. For further details on the accuracy of norm estimation, see the documentation for nag_linsys_complex_gen_norm_rcomm (f04zdc).
For a normal matrix A (for which AHA=AAH), 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 logA 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 logA 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) and Section 11.2 of Higham (2008) for details and further discussion.

Parallelism and Performance

nag_matop_complex_gen_matrix_cond_log (f01kjc) is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.
nag_matop_complex_gen_matrix_cond_log (f01kjc) 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.

Further Comments

nag_matop_complex_gen_matrix_cond_std (f01kac) uses a similar algorithm to nag_matop_complex_gen_matrix_cond_log (f01kjc) to compute an estimate of the absolute condition number (which is related to the relative condition number by a factor of A/logA). However, the required Fréchet derivatives are computed in a more efficient and stable manner by nag_matop_complex_gen_matrix_cond_log (f01kjc) and so its use is recommended over nag_matop_complex_gen_matrix_cond_std (f01kac).
The amount of complex allocatable memory required by the algorithm is typically of the order 10n2.
The cost of the algorithm is On3 floating-point operations; see Al–Mohy et al. (2012).
If the matrix logarithm alone is required, without an estimate of the condition number, then nag_matop_complex_gen_matrix_log (f01fjc) should be used. If the Fréchet derivative of the matrix logarithm is required then nag_matop_complex_gen_matrix_frcht_log (f01kkc) should be used. The real analogue of this function is nag_matop_real_gen_matrix_cond_log (f01jjc).


This example estimates the relative condition number of the matrix logarithm logA, where
A = 3+2i 1 1 1+2i 0+2i -4 0 0 1 -2 3+2i 0+i 1 i 1 2+3i .  

Program Text

Program Text (f01kjce.c)

Program Data

Program Data (f01kjce.d)

Program Results

Program Results (f01kjce.r)