NAG FL Interface
f01ejf (real_​gen_​matrix_​log)

Settings help

FL Name Style:

FL Specification Language:

1 Purpose

f01ejf computes the principal matrix logarithm, log(A), of a real n×n matrix A, with no eigenvalues on the closed negative real line.

2 Specification

Fortran Interface
Subroutine f01ejf ( n, a, lda, imnorm, ifail)
Integer, Intent (In) :: n, lda
Integer, Intent (Inout) :: ifail
Real (Kind=nag_wp), Intent (Inout) :: a(lda,*)
Real (Kind=nag_wp), Intent (Out) :: imnorm
C Header Interface
#include <nag.h>
void  f01ejf_ (const Integer *n, double a[], const Integer *lda, double *imnorm, Integer *ifail)
The routine may be called by the names f01ejf or nagf_matop_real_gen_matrix_log.

3 Description

Any nonsingular matrix A has infinitely many logarithms. For a matrix with no eigenvalues on the closed negative real line, the principal logarithm is the unique logarithm whose spectrum lies in the strip {z:-π<Im(z)<π}.
log(A) is computed using the inverse scaling and squaring algorithm for the matrix logarithm described in Al–Mohy and Higham (2011), adapted to real matrices by Al–Mohy et al. (2012).

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: n Integer Input
On entry: n, the order of the matrix A.
Constraint: n0.
2: a(lda,*) Real (Kind=nag_wp) array Input/Output
Note: the second dimension of the array a must be at least n.
On entry: the n×n matrix A.
On exit: the n×n principal matrix logarithm, log(A).
3: lda Integer Input
On entry: the first dimension of the array a as declared in the (sub)program from which f01ejf is called.
Constraint: ldan.
4: imnorm Real (Kind=nag_wp) Output
On exit: if the routine has given a reliable answer then imnorm=0.0. If imnorm differs from 0.0 by more than unit roundoff (as returned by x02ajf) then the computed matrix logarithm is unreliable.
5: ifail Integer Input/Output
On entry: ifail must be set to 0, −1 or 1 to set behaviour on detection of an error; these values have no effect when no error is detected.
A value of 0 causes the printing of an error message and program execution will be halted; otherwise program execution continues. A value of −1 means that an error message is printed while a value of 1 means that it is not.
If halting is not appropriate, the value −1 or 1 is recommended. If message printing is undesirable, then the value 1 is recommended. Otherwise, the value 0 is recommended. When the value -1 or 1 is used it is essential to test the value of ifail on exit.
On exit: ifail=0 unless the routine detects an error or a warning has been flagged (see Section 6).

6 Error Indicators and Warnings

If on entry 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:
A is singular so the logarithm cannot be computed.
A was found to have eigenvalues on the negative real line. The principal logarithm is not defined in this case. f01fjf can be used to find a complex non-principal logarithm.
log(A) has been computed using an IEEE double precision Padé approximant, although the arithmetic precision is higher than IEEE double precision.
An unexpected internal error occurred. Please contact NAG.
On entry, n=value.
Constraint: n0.
On entry, lda=value and n=value.
Constraint: ldan.
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.
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.
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 ATA=AAT), the Schur decomposition is diagonal and the algorithm reduces to evaluating the logarithm of the eigenvalues of A and then constructing log(A) using the Schur vectors. This should give a very accurate result. In general, however, no error bounds are available for the algorithm. See Al–Mohy and Higham (2011) and Section 9.4 of Higham (2008) for details and further discussion.
The sensitivity of the computation of log(A) 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.
If estimates of the condition number of the matrix logarithm are required then f01jjf should be used.

8 Parallelism and Performance

Background information to multithreading can be found in the Multithreading documentation.
f01ejf is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.
f01ejf 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 implementation-specific information.

9 Further Comments

The cost of the algorithm is O(n3) floating-point operations (see Al–Mohy and Higham (2011)). The real allocatable memory required is approximately 3×n2.
If the Fréchet derivative of the matrix logarithm is required then f01jkf should be used.
f01fjf can be used to find the principal logarithm of a complex matrix. It can also be used to return a complex, non-principal logarithm if a real matrix has no principal logarithm due to the presence of negative eigenvalues.

10 Example

This example finds the principal matrix logarithm of the matrix
A = ( 3 −3 1 1 2 1 −2 1 1 1 3 −1 2 0 2 0 ) .  

10.1 Program Text

Program Text (f01ejfe.f90)

10.2 Program Data

Program Data (f01ejfe.d)

10.3 Program Results

Program Results (f01ejfe.r)