NAG FL Interface
f01ekf (real_​gen_​matrix_​fun_​std)

Settings help

FL Name Style:

FL Specification Language:

1 Purpose

f01ekf computes the matrix exponential, sine, cosine, sinh or cosh, of a real n×n matrix A using the Schur–Parlett algorithm.

2 Specification

Fortran Interface
Subroutine f01ekf ( fun, 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
Character (*), Intent (In) :: fun
C Header Interface
#include <nag.h>
void  f01ekf_ (const char *fun, const Integer *n, double a[], const Integer *lda, double *imnorm, Integer *ifail, const Charlen length_fun)
The routine may be called by the names f01ekf or nagf_matop_real_gen_matrix_fun_std.

3 Description

f(A), where f is either the exponential, sine, cosine, sinh or cosh, is computed using the Schur–Parlett algorithm described in Higham (2008) and Davies and Higham (2003).

4 References

Davies P I and Higham N J (2003) A Schur–Parlett algorithm for computing matrix functions SIAM J. Matrix Anal. Appl. 25(2) 464–485
Higham N J (2008) Functions of Matrices: Theory and Computation SIAM, Philadelphia, PA, USA

5 Arguments

1: fun Character(*) Input
On entry: indicates which matrix function will be computed.
The matrix exponential, eA, will be computed.
The matrix sine, sin(A), will be computed.
The matrix cosine, cos(A), will be computed.
The hyperbolic matrix sine, sinh(A), will be computed.
The hyperbolic matrix cosine, cosh(A), will be computed.
Constraint: fun='EXP', 'SIN', 'COS', 'SINH' or 'COSH'.
2: n Integer Input
On entry: n, the order of the matrix A.
Constraint: n0.
3: 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 matrix, f(A).
4: lda Integer Input
On entry: the first dimension of the array a as declared in the (sub)program from which f01ekf is called.
Constraint: ldan.
5: imnorm Real (Kind=nag_wp) Output
On exit: if A has complex eigenvalues, f01ekf will use complex arithmetic to compute the matrix function. The imaginary part is discarded at the end of the computation, because it will theoretically vanish. imnorm contains the 1-norm of the imaginary part, which should be used to check that the routine has given a reliable answer.
If A has real eigenvalues, f01ekf uses real arithmetic and imnorm=0.
6: 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 Taylor series failed to converge.
An unexpected internal error occurred when evaluating the function at a point. Please contact NAG.
There was an error whilst reordering the Schur form of A.
Note:  this failure should not occur and suggests that the routine has been called incorrectly.
The routine was unable to compute the Schur decomposition of A.
Note:  this failure should not occur and suggests that the routine has been called incorrectly.
An unexpected internal error occurred. Please contact NAG.
The linear equations to be solved are nearly singular and the Padé approximant used to compute the exponential may have no correct figures.
Note:  this failure should not occur and suggests that the routine has been called incorrectly.
On entry, fun=value was an illegal value.
On entry, n=value.
Constraint: n0.
On entry, argument lda is invalid.
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 f at the eigenvalues of A and then constructing f(A) using the Schur vectors. This should give a very accurate result. In general, however, no error bounds are available for the algorithm.
For further discussion of the Schur–Parlett algorithm see Section 9.4 of Higham (2008).

8 Parallelism and Performance

Background information to multithreading can be found in the Multithreading documentation.
f01ekf is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.
f01ekf 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 integer allocatable memory required is n. If A has real eigenvalues then up to 9n2 of real allocatable memory may be required. If A has complex eigenvalues then up to 9n2 of complex allocatable memory may be required.
The cost of the Schur–Parlett algorithm depends on the spectrum of A, but is roughly between 28n3 and n4/3 floating-point operations; see Algorithm 9.6 of Higham (2008).
If the matrix exponential is required then it is recommended that f01ecf be used. f01ecf uses an algorithm which is, in general, more accurate than the Schur–Parlett algorithm used by f01ekf.
If estimates of the condition number of the matrix function are required then f01jaf should be used.
f01fkf can be used to find the matrix exponential, sin, cos, sinh or cosh of a complex matrix.

10 Example

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

10.1 Program Text

Program Text (f01ekfe.f90)

10.2 Program Data

Program Data (f01ekfe.d)

10.3 Program Results

Program Results (f01ekfe.r)