f01kg: FL CL CPP AD

NAG FL Interface
f01kgf (complex_gen_matrix_cond_exp)

Keyword Search:

NAG Library Manual, Mark 27.2

Interfaces: FL CL CPP AD

NAG FL Interface Introduction

F01 (Matop) Chapter Contents

F01 (Matop) Chapter Introduction

f01kg: FL CL CPP AD

▸▿ Contents

1 Purpose

2 Specification

3 Description

4 References

5 Arguments

6 Error Indicators and Warnings

7 Accuracy

8 Parallelism and Performance

9 Further Comments

▸▿ 10 Example

10.1 Program Text

10.2 Program Data

10.3 Program Results

1 Purpose

f01kgf computes an estimate of the relative condition number

κ_{\exp} (A)

of the exponential of a complex

n \times n

matrix

A

, in the

1

-norm. The matrix exponential

e^{A}

is also returned.

2 Specification

Fortran Interface

Subroutine f01kgf (

n, a, lda, condea, ifail)

Integer, Intent (In)	::	n, lda
Integer, Intent (Inout)	::	ifail
Real (Kind=nag_wp), Intent (Out)	::	condea
Complex (Kind=nag_wp), Intent (Inout)	::	a(lda,*)

C Header Interface

#include <nag.h>

void	f01kgf_ (const Integer n, Complex a[], const Integer lda, double condea, Integer ifail)

The routine may be called by the names f01kgf or nagf_matop_complex_gen_matrix_cond_exp.

3 Description

The Fréchet derivative of the matrix exponential of

A

is the unique linear mapping

E ⟼ L (A, E)

such that for any matrix

E

e^{A + E} - e^{A} - L (A, E) = o (‖ E ‖) .

The derivative describes the first-order effect of perturbations in

A

on the exponential

e^{A}

The relative condition number of the matrix exponential can be defined by

κ_{\exp} (A) = \frac{‖ L (A) ‖ ‖ A ‖}{‖ \exp (A) ‖},

where

‖ L (A) ‖

is the norm of the Fréchet derivative of the matrix exponential at

A

To obtain the estimate of

κ_{\exp} (A)

, f01kgf first estimates

‖ L (A) ‖

by computing an estimate

γ

of a quantity

K \in [n^{−1} {‖ L (A) ‖}_{1}, n {‖ L (A) ‖}_{1}]

, such that

γ \leq K

The algorithms used to compute

κ_{\exp} (A)

are detailed in the Al–Mohy and Higham (2009a) and Al–Mohy and Higham (2009b).

The matrix exponential

e^{A}

is computed using a Padé approximant and the scaling and squaring method. The Padé approximant is differentiated to obtain the Fréchet derivatives

L (A, E)

which are used to estimate the condition number.

4 References

Al–Mohy A H and Higham N J (2009a) A new scaling and squaring algorithm for the matrix exponential SIAM J. Matrix Anal. 31(3) 970–989

Al–Mohy A H and Higham N J (2009b) Computing the Fréchet derivative of the matrix exponential, with an application to condition number estimation SIAM J. Matrix Anal. Appl. 30(4) 1639–1657

Higham N J (2008) Functions of Matrices: Theory and Computation SIAM, Philadelphia, PA, USA

Moler C B and Van Loan C F (2003) Nineteen dubious ways to compute the exponential of a matrix, twenty-five years later SIAM Rev. 45 3–49

5 Arguments

1: $n$ – Integer Input: On entry: $n$ , the order of the matrix $A$ .

Constraint: $n \geq 0$ .
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 \times n$ matrix $A$ .

On exit: the $n \times n$ matrix exponential $e^{A}$ .
3: $lda$ – Integer Input: On entry: the first dimension of the array a as declared in the (sub)program from which f01kgf is called.

Constraint: $lda \geq n$ .
4: $condea$ – Real (Kind=nag_wp) Output: On exit: an estimate of the relative condition number of the matrix exponential $κ_{\exp} (A)$ .
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

−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$: The linear equations to be solved for the Padé approximant are singular; it is likely that this routine has been called incorrectly.

$ifail = 2$: $e^{A}$ has been computed using an IEEE double precision Padé approximant, although the arithmetic precision is higher than IEEE double precision.

$ifail = 3$: An unexpected internal error has occurred. Please contact NAG.

$ifail = - 1$: On entry, $n = ⟨ value ⟩$ .
Constraint: $n \geq 0$ .

$ifail = - 3$: On entry, $lda = ⟨ value ⟩$ and $n = ⟨ value ⟩$ .
Constraint: $lda \geq n$ .

$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

f01kgf uses the norm estimation routine f04zdf to produce an estimate

γ

of a quantity

K \in [n^{−1} {‖ L (A) ‖}_{1}, n {‖ L (A) ‖}_{1}]

, such that

γ \leq K

. For further details on the accuracy of norm estimation, see the documentation for f04zdf.

For a normal matrix

A

(for which

A^{H} A = A A^{H}

) the computed matrix,

e^{A}

, is guaranteed to be close to the exact matrix, that is, the method is forward stable. No such guarantee can be given for non-normal matrices. See Section 10.3 of Higham (2008) for details and further discussion.

For further discussion of the condition of the matrix exponential see Section 10.2 of Higham (2008).

8 Parallelism and Performance

f01kgf is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.

f01kgf 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

f01kaf uses a similar algorithm to f01kgf to compute an estimate of the absolute condition number (which is related to the relative condition number by a factor of

‖ A ‖ / ‖ \exp (A) ‖

). However, the required Fréchet derivatives are computed in a more efficient and stable manner by f01kgf and so its use is recommended over f01kaf.

The cost of the algorithm is

O (n^{3})

and the complex allocatable memory required is approximately

15 n^{2}

; see Al–Mohy and Higham (2009a) and Al–Mohy and Higham (2009b) for further details.

If the matrix exponential alone is required, without an estimate of the condition number, then f01fcf should be used. If the Fréchet derivative of the matrix exponential is required then f01khf should be used.

As well as the excellent book Higham (2008), the classic reference for the computation of the matrix exponential is Moler and Van Loan (2003).

10 Example

This example estimates the relative condition number of the matrix exponential

e^{A}

, where

A = (\begin{array}{r} 1 + i & 2 + i & 2 + i & 2 + i \\ 3 + 2 i & 1 & 1 & 2 + i \\ 3 + 2 i & 2 + i & 1 & 2 + i \\ 3 + 2 i & 3 + 2 i & 3 + 2 i & 1 + i \end{array}) .

f01kg: FL CL CPP AD

NAG FL Interfacef01kgf (complex_​gen_​matrix_​cond_​exp)

▸▿ Contents

1 Purpose

2 Specification

3 Description

4 References

5 Arguments

6 Error Indicators and Warnings

7 Accuracy

8 Parallelism and Performance

9 Further Comments

10 Example

10.1 Program Text

10.2 Program Data

10.3 Program Results

NAG FL Interface
f01kgf (complex_gen_matrix_cond_exp)