NAG Library Routine Document
f01fqf
(complex_gen_matrix_pow)
1
Purpose
f01fqf computes an abitrary real power of a complex by matrix .
2
Specification
Fortran Interface
Integer, Intent (In) | :: |
n,
lda | Integer, Intent (Inout) | :: |
ifail | Real (Kind=nag_wp), Intent (In) | :: |
p | Complex (Kind=nag_wp), Intent (Inout) | :: |
a(lda,*) |
|
C Header Interface
#include nagmk26.h
void |
f01fqf_ (
const Integer *n,
Complex a[],
const Integer *lda,
const double *p,
Integer *ifail) |
|
3
Description
For a matrix
with no eigenvalues on the closed negative real line,
(
) can be defined as
where
is the principal logarithm of
(the unique logarithm whose spectrum lies in the strip
).
is computed using the Schur–Padé algorithm described in
Higham and Lin (2011) and
Higham and Lin (2013).
The real number is expressed as where and . Then . The integer power is found using a combination of binary powering and, if necessary, matrix inversion. The fractional power is computed using a Schur decomposition and a Padé approximant.
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: – IntegerInput
-
On entry: , the order of the matrix .
Constraint:
.
- 2: – Complex (Kind=nag_wp) arrayInput/Output
-
Note: the second dimension of the array
a
must be at least
.
On entry: the by matrix .
On exit: if , the by matrix th power, . Alternatively, if , contains an by non-principal power of .
- 3: – IntegerInput
-
On entry: the first dimension of the array
a as declared in the (sub)program from which
f01fqf is called.
Constraint:
.
- 4: – Real (Kind=nag_wp)Input
-
On entry: the required power of .
- 5: – IntegerInput/Output
-
On entry:
ifail must be set to
,
. If you are unfamiliar with this argument you should refer to
Section 3.4 in How to Use the NAG Library and its Documentation for details.
For environments where it might be inappropriate to halt program execution when an error is detected, the value
is recommended. If the output of error messages is undesirable, then the value
is recommended. Otherwise, if you are not familiar with this argument, the recommended value is
.
When the value is used it is essential to test the value of ifail on exit.
On exit:
unless the routine detects an error or a warning has been flagged (see
Section 6).
6
Error Indicators and Warnings
If on entry
or
, explanatory error messages are output on the current error message unit (as defined by
x04aaf).
Errors or warnings detected by the routine:
-
has eigenvalues on the negative real line. The principal th power is not defined so a non-principal power is returned.
-
is singular so the th power cannot be computed.
-
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. This failure should not occur and suggests that the routine has been called incorrectly.
-
On entry, .
Constraint: .
-
On entry, and .
Constraint: .
An unexpected error has been triggered by this routine. Please
contact
NAG.
See
Section 3.9 in How to Use the NAG Library and its Documentation for further information.
Your licence key may have expired or may not have been installed correctly.
See
Section 3.8 in How to Use the NAG Library and its Documentation for further information.
Dynamic memory allocation failed.
See
Section 3.7 in How to Use the NAG Library and its Documentation for further information.
7
Accuracy
For positive integer , the algorithm reduces to a sequence of matrix multiplications. For negative integer , the algorithm consists of a combination of matrix inversion and matrix multiplications.
For a normal matrix (for which ) and non-integer , the Schur decomposition is diagonal and the algorithm reduces to evaluating powers of the eigenvalues of and then constructing using the Schur vectors. This should give a very accurate result. In general however, no error bounds are available for the algorithm.
8
Parallelism and Performance
f01fqf is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.
f01fqf 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.
The cost of the algorithm is . The exact cost depends on the matrix but if then the cost is independent of .
complex allocatable memory is required by the routine.
If estimates of the condition number of
are required then
f01kef should be used.
10
Example
This example finds
where
and
10.1
Program Text
Program Text (f01fqfe.f90)
10.2
Program Data
Program Data (f01fqfe.d)
10.3
Program Results
Program Results (f01fqfe.r)