NAG FL Interface
f01kff (complex_​gen_​matrix_​frcht_​pow)

Settings help

FL Name Style:


FL Specification Language:


1 Purpose

f01kff computes the Fréchet derivative L(A,E) of the pth power (where p is real) of the complex n×n matrix A applied to the complex n×n matrix E. The principal matrix power Ap is also returned.

2 Specification

Fortran Interface
Subroutine f01kff ( n, a, lda, e, lde, p, ifail)
Integer, Intent (In) :: n, lda, lde
Integer, Intent (Inout) :: ifail
Real (Kind=nag_wp), Intent (In) :: p
Complex (Kind=nag_wp), Intent (Inout) :: a(lda,*), e(lde,*)
C Header Interface
#include <nag.h>
void  f01kff_ (const Integer *n, Complex a[], const Integer *lda, Complex e[], const Integer *lde, const double *p, Integer *ifail)
The routine may be called by the names f01kff or nagf_matop_complex_gen_matrix_frcht_pow.

3 Description

For a matrix A with no eigenvalues on the closed negative real line, Ap (p) can be defined as
Ap= exp(plog(A))  
where log(A) is the principal logarithm of A (the unique logarithm whose spectrum lies in the strip {z:-π<Im(z)<π}). If A is nonsingular but has negative real eigenvalues, the principal logarithm is not defined, but a non-principal pth power can be defined by using a non-principal logarithm.
The Fréchet derivative of the matrix pth power of A is the unique linear mapping EL(A,E) such that for any matrix E
(A+E)p - Ap - L(A,E) = o(E) .  
The derivative describes the first-order effect of perturbations in A on the matrix power Ap.
f01kff uses the algorithms of Higham and Lin (2011) and Higham and Lin (2013) to compute Ap and L(A,E). The real number p is expressed as p=q+r where q(−1,1) and r. Then Ap=AqAr. The integer power Ar is found using a combination of binary powering and, if necessary, matrix inversion. The fractional power Aq is computed using a Schur decomposition, a Padé approximant and the scaling and squaring method. The Padé approximant is differentiated in order to obtain the Fréchet derivative of Aq and L(A,E) is then computed using a combination of the chain rule and the product rule for Fréchet derivatives.

4 References

Higham N J (2008) Functions of Matrices: Theory and Computation SIAM, Philadelphia, PA, USA
Higham N J and Lin L (2011) A Schur–Padé algorithm for fractional powers of a matrix SIAM J. Matrix Anal. Appl. 32(3) 1056–1078
Higham N J and Lin L (2013) An improved Schur–Padé algorithm for fractional powers of a matrix and their Fréchet derivatives SIAM J. Matrix Anal. Appl. 34(3) 1341–1360

5 Arguments

1: n Integer Input
On entry: n, the order of the matrix A.
Constraint: n0.
2: a(lda,*) Complex (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 pth power, Ap. Alternatively if ifail=1, a non-principal pth power is returned.
3: lda Integer Input
On entry: the first dimension of the array a as declared in the (sub)program from which f01kff is called.
Constraint: ldan.
4: e(lde,*) Complex (Kind=nag_wp) array Input/Output
Note: the second dimension of the array e must be at least n.
On entry: the n×n matrix E.
On exit: the Fréchet derivative L(A,E).
5: lde Integer Input
On entry: the first dimension of the array e as declared in the (sub)program from which f01kff is called.
Constraint: lden.
6: p Real (Kind=nag_wp) Input
On entry: the required power of A.
7: 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:
ifail=1
A has eigenvalues on the negative real line. The principal pth power is not defined in this case, so a non-principal power was returned.
ifail=2
A is singular so the pth power cannot be computed.
ifail=3
Ap has been computed using an IEEE double precision Padé approximant, although the arithmetic precision is higher than IEEE double precision.
ifail=4
An unexpected internal error occurred. This failure should not occur and suggests that the routine has been called incorrectly.
ifail=-1
On entry, n=value.
Constraint: n0.
ifail=-3
On entry, lda=value and n=value.
Constraint: ldan.
ifail=-5
On entry, lde=value and n=value.
Constraint: lden.
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.
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.
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 AHA=AAH), the Schur decomposition is diagonal and the computation of the fractional part of the matrix power reduces to evaluating powers of the eigenvalues of A and then constructing Ap using the Schur vectors. This should give a very accurate result. In general, however, no error bounds are available for the algorithm. See Higham and Lin (2011) and Higham and Lin (2013) for details and further discussion.
If the condition number of the matrix power is required then f01kef should be used.

8 Parallelism and Performance

Background information to multithreading can be found in the Multithreading documentation.
f01kff is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.
f01kff 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 complex allocatable memory required by the algorithm is approximately 6×n2.
The cost of the algorithm is O(n3) floating-point operations; see Higham and Lin (2011) and Higham and Lin (2013).
If the matrix pth power alone is required, without the Fréchet derivative, then f01fqf should be used. If the condition number of the matrix power is required then f01kef should be used. The real analogue of this routine is f01jff.

10 Example

This example finds Ap and the Fréchet derivative of the matrix power L(A,E), where p=0.2,
A = ( 2i+ 3i+0 2i+0 1+3i 2+i 1i+0 1i+0 2+0i 0+i 2+2i 0+2i 0+4i 3i+ 0+0i 3i+0 1i+0 )   and   E = ( 0+i 3i+0 2i+0 1+3i 0+i 1i+0 3+3i 0+0i 0+i 2+2i 0+2i 0i+0 2i+ 0+0i 1i+0 1i+0 ) .  

10.1 Program Text

Program Text (f01kffe.f90)

10.2 Program Data

Program Data (f01kffe.d)

10.3 Program Results

Program Results (f01kffe.r)