NAG Library Routine Document

f11mkf (direct_real_gen_matmul)

1

Purpose

2

Specification

3

Description

4

References

5

Arguments

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

On entry: specifies whether or not the matrix $A$ is transposed.

$\mathbf{trans}=\text{'N'}$

$\alpha AB+\beta C$ is computed.

$\mathbf{trans}=\text{'T'}$

$\alpha A^{\mathrm{T}}B+\beta C$ is computed.

Constraint: $\mathbf{trans}=\text{'N'}$ or $\text{'T'}$.

2:     $\mathbf{n}$ – IntegerInput

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

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

3:     $\mathbf{m}$ – IntegerInput

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

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

4:     $\mathbf{alpha}$ – Real (Kind=nag_wp)Input

On entry: $\alpha$, the scalar factor in the matrix multiplication.

5:     $\mathbf{icolzp}\left(*\right)$ – Integer arrayInput

Note: the dimension of the array icolzp must be at least $\mathbf{n}+1$.

On entry: $\mathbf{icolzp}\left(i\right)$ contains the index in $A$ of the start of a new column. See Section 2.1.3 in the F11 Chapter Introduction.

6:     $\mathbf{irowix}\left(*\right)$ – Integer arrayInput

Note: the dimension of the array irowix must be at least $\mathbf{icolzp}\left(\mathbf{n}+1\right)-1$, the number of nonzeros of the sparse matrix $A$.

On entry: the row index array of sparse matrix $A$.

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

Note: the dimension of the array a must be at least $\mathbf{icolzp}\left(\mathbf{n}+1\right)-1$, the number of nonzeros of the sparse matrix $A$.

On entry: the array of nonzero values in the sparse matrix $A$.

8:     $\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$ matrix $B$.

9:     $\mathbf{ldb}$ – IntegerInput

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

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

10:   $\mathbf{beta}$ – Real (Kind=nag_wp)Input

On entry: the scalar factor $\beta$.

11:   $\mathbf{c}\left(\mathbf{ldc},*\right)$ – Real (Kind=nag_wp) arrayInput/Output

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

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

On exit: $C$ is overwritten by $\alpha AB+\beta C$ or $\alpha A^{\mathrm{T}}B+\beta C$ depending on the value of trans.

12:   $\mathbf{ldc}$ – IntegerInput

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

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

13:   $\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{ldb}=〈\mathit{\text{value}}〉$ and $\mathbf{n}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{ldb}\ge \max \left(1,\mathbf{n}\right)$.

On entry, $\mathbf{ldc}=〈\mathit{\text{value}}〉$ and $\mathbf{n}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{ldc}\ge \max \left(1,\mathbf{n}\right)$.

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

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

On entry, $\mathbf{trans}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{trans}=\text{'N'}$ or $\text{'T'}$.

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

10.2

Program Data

Program Data (f11mkfe.d)

10.3

Program Results

Program Results (f11mkfe.r)