NAG Library Routine Document

f04aef  (withdraw_real_square_solve_ref)

1

Purpose

2

Specification

3

Description

4

References

5

Arguments

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

Note: the second dimension of the array a must be at least $\max \left(1,\mathbf{n}\right)$.

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

2:     $\mathbf{lda}$ – IntegerInput

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

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

3:     $\mathbf{b}\left(\mathbf{ldb},*\right)$ – Real (Kind=nag_wp) arrayInput

Note: the second dimension of the array b must be at least $\max \left(1,\mathbf{m}\right)$.

On entry: the $n$ by $m$ right-hand side matrix $B$.

4:     $\mathbf{ldb}$ – IntegerInput

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

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

5:     $\mathbf{n}$ – IntegerInput

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

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

6:     $\mathbf{m}$ – IntegerInput

On entry: $m$, the number of right-hand sides.

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

7:     $\mathbf{c}\left(\mathbf{ldc},*\right)$ – Real (Kind=nag_wp) arrayOutput

Note: the second dimension of the array c must be at least $\max \left(1,\mathbf{m}\right)$.

On exit: the $n$ by $m$ solution matrix $X$.

8:     $\mathbf{ldc}$ – IntegerInput

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

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

9:     $\mathbf{wkspce}\left(\max \left(1,\mathbf{n}\right)\right)$ – Real (Kind=nag_wp) arrayWorkspace

10:   $\mathbf{aa}\left(\mathbf{ldaa},*\right)$ – Real (Kind=nag_wp) arrayOutput

Note: the second dimension of the array aa must be at least $\max \left(1,\mathbf{n}\right)$.

On exit: the triangular factors $L$ and $U$, except that the unit diagonal elements of $U$ are not stored.

11:   $\mathbf{ldaa}$ – IntegerInput

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

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

12:   $\mathbf{bb}\left(\mathbf{ldbb},*\right)$ – Real (Kind=nag_wp) arrayOutput

Note: the second dimension of the array bb must be at least $\max \left(1,\mathbf{m}\right)$.

On exit: the final $n$ by $m$ residual matrix $R=B-AX$.

13:   $\mathbf{ldbb}$ – IntegerInput

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

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

14:   $\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$

The matrix $A$ is singular, possibly due to rounding errors.

$\mathbf{ifail}=2$

Iterative refinement fails to improve the solution, i.e., the matrix $A$ is too ill-conditioned.

$\mathbf{ifail}=3$

On entry,	$\mathbf{n}<0$,
or	$\mathbf{m}<0$,
or	$\mathbf{lda}<\max \left(1,\mathbf{n}\right)$,
or	$\mathbf{ldb}<\max \left(1,\mathbf{n}\right)$,
or	$\mathbf{ldc}<\max \left(1,\mathbf{n}\right)$,
or	$\mathbf{ldaa}<\max \left(1,\mathbf{n}\right)$,
or	$\mathbf{ldbb}<\max \left(1,\mathbf{n}\right)$.

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

10.2

Program Data

Program Data (f04aefe.d)

10.3

Program Results

Program Results (f04aefe.r)