NAG Library Routine Document

f03bnf (complex_gen)

1

Purpose

2

Specification

3

Description

4

References

5

Arguments

1:     $\mathbf{n}$ – IntegerInput

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

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

2:     $\mathbf{a}\left(\mathbf{lda},*\right)$ – Complex (Kind=nag_wp) arrayInput

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

On entry: the $n$ by $n$ matrix $A$ in factorized form as returned by f07arf (zgetrf).

3:     $\mathbf{lda}$ – IntegerInput

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

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

4:     $\mathbf{ipiv}\left(\mathbf{n}\right)$ – Integer arrayInput

On entry: the row interchanges used to factorize matrix $A$ as returned by f07arf (zgetrf).

5:     $\mathbf{d}$ – Complex (Kind=nag_wp)Output

On exit: the mantissa of the real and imaginary parts of the determinant.

6:     $\mathbf{id}\left(2\right)$ – Integer arrayOutput

On exit: the exponents for the real and imaginary parts of the determinant. The determinant, $d=\left(d_r,d_i\right)$, is returned as $d_r=D_r\times 2^j$ and $d_i=D_i\times 2^k$, where $\mathbf{d}=\left(D_r,D_i\right)$ and $j$ and $k$ are stored in the first and second elements respectively of the array id on successful exit.

7:     $\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}=1$

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

$\mathbf{ifail}=3$

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

$\mathbf{ifail}=4$

The matrix $A$ is approximately singular.

$\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 (f03bnfe.f90)

10.2

Program Data

Program Data (f03bnfe.d)

10.3

Program Results

Program Results (f03bnfe.r)