# NAG FL Interfacef01fqf (complex_​gen_​matrix_​pow)

## ▸▿ Contents

Settings help

FL Name Style:

FL Specification Language:

## 1Purpose

f01fqf computes an abitrary real power ${A}^{p}$ of a complex $n×n$ matrix $A$.

## 2Specification

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

## 3Description

For a matrix $A$ with no eigenvalues on the closed negative real line, ${A}^{p}$ ($p\in ℝ$) can be defined as
 $Ap= exp(plog(A))$
where $\mathrm{log}\left(A\right)$ is the principal logarithm of $A$ (the unique logarithm whose spectrum lies in the strip $\left\{z:-\pi <\mathrm{Im}\left(z\right)<\pi \right\}$).
${A}^{p}$ is computed using the Schur–Padé algorithm described in Higham and Lin (2011) and Higham and Lin (2013).
The real number $p$ is expressed as $p=q+r$ where $q\in \left(-1,1\right)$ and $r\in ℤ$. Then ${A}^{p}={A}^{q}{A}^{r}$. The integer power ${A}^{r}$ is found using a combination of binary powering and, if necessary, matrix inversion. The fractional power ${A}^{q}$ is computed using a Schur decomposition and a Padé approximant.

## 4References

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

## 5Arguments

1: $\mathbf{n}$Integer Input
On entry: $n$, the order of the matrix $A$.
Constraint: ${\mathbf{n}}\ge 0$.
2: $\mathbf{a}\left({\mathbf{lda}},*\right)$Complex (Kind=nag_wp) array Input/Output
Note: the second dimension of the array a must be at least ${\mathbf{n}}$.
On entry: the $n×n$ matrix $A$.
On exit: if ${\mathbf{ifail}}={\mathbf{0}}$, the $n×n$ matrix $p$th power, ${A}^{p}$. Alternatively, if ${\mathbf{ifail}}={\mathbf{1}}$, contains an $n×n$ non-principal power of $A$.
3: $\mathbf{lda}$Integer Input
On entry: the first dimension of the array a as declared in the (sub)program from which f01fqf is called.
Constraint: ${\mathbf{lda}}\ge {\mathbf{n}}$.
4: $\mathbf{p}$Real (Kind=nag_wp) Input
On entry: the required power of $A$.
5: $\mathbf{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 $-\mathbf{1}$ or $\mathbf{1}$ is used it is essential to test the value of ifail on exit.
On exit: ${\mathbf{ifail}}={\mathbf{0}}$ unless the routine detects an error or a warning has been flagged (see Section 6).

## 6Error Indicators and Warnings

If on entry ${\mathbf{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:
${\mathbf{ifail}}=1$
$A$ has eigenvalues on the negative real line. The principal $p$th power is not defined so a non-principal power is returned.
${\mathbf{ifail}}=2$
$A$ is singular so the $p$th power cannot be computed.
${\mathbf{ifail}}=3$
${A}^{p}$ has been computed using an IEEE double precision Padé approximant, although the arithmetic precision is higher than IEEE double precision.
${\mathbf{ifail}}=4$
An unexpected internal error occurred. This failure should not occur and suggests that the routine has been called incorrectly.
${\mathbf{ifail}}=-1$
On entry, ${\mathbf{n}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{n}}\ge 0$.
${\mathbf{ifail}}=-3$
On entry, ${\mathbf{lda}}=⟨\mathit{\text{value}}⟩$ and ${\mathbf{n}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{lda}}\ge {\mathbf{n}}$.
${\mathbf{ifail}}=-99$
See Section 7 in the Introduction to the NAG Library FL Interface for further information.
${\mathbf{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.
${\mathbf{ifail}}=-999$
Dynamic memory allocation failed.
See Section 9 in the Introduction to the NAG Library FL Interface for further information.

## 7Accuracy

For positive integer $p$, the algorithm reduces to a sequence of matrix multiplications. For negative integer $p$, the algorithm consists of a combination of matrix inversion and matrix multiplications.
For a normal matrix $A$ (for which ${A}^{\mathrm{H}}A=A{A}^{\mathrm{H}}$) and non-integer $p$, the Schur decomposition is diagonal and the algorithm reduces to evaluating powers of the eigenvalues of $A$ and then constructing ${A}^{p}$ using the Schur vectors. This should give a very accurate result. In general however, no error bounds are available for the algorithm.

## 8Parallelism 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 $O\left({n}^{3}\right)$. The exact cost depends on the matrix $A$ but if $p\in \left(-1,1\right)$ then the cost is independent of $p$. $O\left(4×{n}^{2}\right)$ complex allocatable memory is required by the routine.
If estimates of the condition number of ${A}^{p}$ are required then f01kef should be used.

## 10Example

This example finds ${A}^{p}$ where $p=0.2$ and
 $A = ( 2i+ 3i+0 2i+0 1+3i 2+i 1i+0 1i+0 2+2i 2+i 2+2i 2i 2+4i 3i+ 2+2i 3i+0 1i+0 ) .$

### 10.1Program Text

Program Text (f01fqfe.f90)

### 10.2Program Data

Program Data (f01fqfe.d)

### 10.3Program Results

Program Results (f01fqfe.r)