NAG Library Routine Document

f01edf (real_symm_matrix_exp)

1

Purpose

2

Specification

3

Description

4

References

5

Arguments

1:     $\mathbf{uplo}$ – Character(1)Input

On entry: indicates whether the upper or lower triangular part of $A$ is stored.

$\mathbf{uplo}=\text{'U'}$

The upper triangular part of $A$ is stored.

$\mathbf{uplo}=\text{'L'}$

The lower triangular part of $A$ is stored.

Constraint: $\mathbf{uplo}=\text{'U'}$ or $\text{'L'}$.

2:     $\mathbf{n}$ – IntegerInput

On entry: $n$, the order of the matrix $A$.

Constraint: $\mathbf{n}\ge 0$.

3:     $\mathbf{a}\left(\mathbf{lda},*\right)$ – Real (Kind=nag_wp) arrayInput/Output

Note: the second dimension of the array a must be at least $\mathbf{n}$.

On entry: the $n$ by $n$ symmetric matrix $A$.

• If $\mathbf{uplo}=\text{'U'}$, the upper triangular part of $A$ must be stored and the elements of the array below the diagonal are not referenced.
• If $\mathbf{uplo}=\text{'L'}$, the lower triangular part of $A$ must be stored and the elements of the array above the diagonal are not referenced.

On exit: if $\mathbf{ifail}=\mathbf{0}$, the upper or lower triangular part of the $n$ by $n$ matrix exponential, $e^A$.

4:     $\mathbf{lda}$ – IntegerInput

On entry: the first dimension of the array a as declared in the (sub)program from which f01edf is called.

Constraint: $\mathbf{lda}\ge \max \left(1,\mathbf{n}\right)$.

5:     $\mathbf{ifail}$ – IntegerInput/Output

On entry: ifail must be set to $0$, $-1\text{ or }1$. 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 $-1\text{ or }1$ is recommended. If the output of error messages is undesirable, then the value $1$ is recommended. Otherwise, if you are not familiar with this argument, the recommended value is $0$. When the value $-\mathbf{1}\text{ 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).

6

Error Indicators and Warnings

$\mathbf{ifail}>0$

The computation of the spectral factorization failed to converge.

$\mathbf{ifail}=-1$

On entry, $\mathbf{uplo}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{uplo}=\text{'L'}$ or $\text{'U'}$.

$\mathbf{ifail}=-2$

On entry, $\mathbf{n}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{n}\ge 0$.

$\mathbf{ifail}=-3$

An internal error occurred when computing the spectral factorization. Please contact NAG.

$\mathbf{ifail}=-4$

On entry, $\mathbf{lda}=〈\mathit{\text{value}}〉$ and $\mathbf{n}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{lda}\ge \mathbf{n}$.

$\mathbf{ifail}=-99$

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.

$\mathbf{ifail}=-399$

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.

$\mathbf{ifail}=-999$

Dynamic memory allocation failed.

See Section 3.7 in How to Use the NAG Library and its Documentation for further information.

7

Accuracy

8

Parallelism and Performance

9

Further Comments

10

Example

10.1

Program Text

Program Text (f01edfe.f90)

10.2

Program Data

Program Data (f01edfe.d)

10.3

Program Results

Program Results (f01edfe.r)