NAG Library Routine Document

f01ckf (real_gen_matmul)

1

Purpose

2

Specification

3

Description

4

References

5

Arguments

1:     $\mathbf{a}\left(\mathbf{n},\mathbf{p}\right)$ – Real (Kind=nag_wp) arrayOutput

On exit: if $\mathbf{opt}=1$, a contains the result of the matrix multiplication.

2:     $\mathbf{b}\left(\mathbf{n},\mathbf{m}\right)$ – Real (Kind=nag_wp) arrayInput/Output

On entry: the $n$ by $m$ matrix $B$.

On exit: if $\mathbf{opt}=2$, b contains the result of the multiplication.

3:     $\mathbf{c}\left(\mathbf{m},\mathbf{p}\right)$ – Real (Kind=nag_wp) arrayInput/Output

On entry: the $m$ by $p$ matrix $C$.

On exit: if $\mathbf{opt}=3$, c contains the result of the multiplication.

4:     $\mathbf{n}$ – IntegerInput

On entry: $n$, the number of rows of the array $A$ and of the array $B$.

Constraints:

• if $\mathbf{opt}=3$, $\mathbf{n}=\mathbf{m}$;
• otherwise $\mathbf{n}\ge 1$.

5:     $\mathbf{p}$ – IntegerInput

On entry: $p$, the number of columns of the array $A$ and of the array $C$.

Constraints:

• if $\mathbf{opt}=2$, $\mathbf{p}=\mathbf{m}$;
• otherwise $\mathbf{p}\ge 1$.

6:     $\mathbf{m}$ – IntegerInput

On entry: $m$, the number of columns of the array $B$ and rows of the array $C$.

Constraints:

• if $\mathbf{opt}=2$, $\mathbf{m}=\mathbf{p}$;
• if $\mathbf{opt}=3$, $\mathbf{m}=\mathbf{n}$;
• if $\mathbf{opt}\ne 1$, $\mathbf{m}\le \mathbf{iz}$;
• otherwise $\mathbf{m}\ge 1$.

7:     $\mathbf{z}\left(\mathbf{iz}\right)$ – Real (Kind=nag_wp) arrayWorkspace

8:     $\mathbf{iz}$ – IntegerInput

On entry: the dimension of the array z as declared in the (sub)program from which f01ckf is called.

Constraints:

• if $\mathbf{opt}=1$, $\mathbf{iz}\ge 1$;
• if $\mathbf{opt}\ne 1$, $\mathbf{iz}\ge \mathbf{m}$.

9:     $\mathbf{opt}$ – IntegerInput

On entry: the value of opt determines which array is to contain the final result.

$\mathbf{opt}=1$

a must be distinct from b and c and, on exit, contains the result. b and c need not be distinct in this case.

$\mathbf{opt}=2$

b must be distinct from c and on exit, contains the result. a is not used in this case and need not be distinct from b or c.

$\mathbf{opt}=3$

c must be distinct from b and on exit, contains the result. a is not used in this case and need not be distinct from b or c.

Constraint: $1\le \mathbf{opt}\le 3$.

10:   $\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{m}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{m}\ge 1$.

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

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

$\mathbf{ifail}=2$

On entry, $\mathbf{m}=〈\mathit{\text{value}}〉$ and $\mathbf{p}=〈\mathit{\text{value}}〉$.
Constraint: if $\mathbf{opt}=2$, $\mathbf{m}=\mathbf{p}$.

$\mathbf{ifail}=3$

On entry, $\mathbf{n}=〈\mathit{\text{value}}〉$ and $\mathbf{m}=〈\mathit{\text{value}}〉$.
Constraint: if $\mathbf{opt}=3$, $\mathbf{n}=\mathbf{m}$.

$\mathbf{ifail}=4$

On entry, $\mathbf{opt}=〈\mathit{\text{value}}〉$, $\mathbf{iz}=〈\mathit{\text{value}}〉$ and $\mathbf{m}=〈\mathit{\text{value}}〉$.
Constraint: if $\mathbf{opt}\ne 1$, $\mathbf{iz}\ge \mathbf{m}$.

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

10.2

Program Data

Program Data (f01ckfe.d)

10.3

Program Results

Program Results (f01ckfe.r)