f16yac (dgemm) : NAG Library CL Interface, Mark 27

2 Specification

#include <nag.h>

void	f16yac (Nag_OrderType order, Nag_TransType transa, Nag_TransType transb, Integer m, Integer n, Integer k, double alpha, const double a[], Integer pda, const double b[], Integer pdb, double beta, double c[], Integer pdc, NagError *fail)

The function may be called by the names: f16yac, nag_blast_dgemm or nag_dgemm.

5 Arguments

order

– Nag_OrderType Input

On entry: the order argument specifies the two-dimensional storage scheme being used, i.e., row-major ordering or column-major ordering. C language defined storage is specified by

order = Nag_RowMajor

. See Section 3.1.3 in the Introduction to the NAG Library CL Interface for a more detailed explanation of the use of this argument.

Constraint:

order = Nag_RowMajor

Nag_ColMajor

transa

– Nag_TransType Input

On entry: specifies whether the operation involves

A

A^{T}

$transa = Nag_NoTrans$: It involves $A$ .
$transa = Nag_Trans$ or $Nag_ConjTrans$: It involves $A^{T}$ .

Constraint:

transa = Nag_NoTrans

Nag_Trans

Nag_ConjTrans

transb

– Nag_TransType Input

On entry: specifies whether the operation involves

B

B^{T}

$transb = Nag_NoTrans$: It involves $B$ .
$transb = Nag_Trans$ or $Nag_ConjTrans$: It involves $B^{T}$ .

Constraint:

transb = Nag_NoTrans

Nag_Trans

Nag_ConjTrans

m

– Integer Input

On entry:

m

, the number of rows of the matrix

C

; the number of rows of

A

transa = Nag_NoTrans

, or the number of columns of

A

transa = Nag_Trans

Nag_ConjTrans

Constraint:

m \geq 0

n

– Integer Input

On entry:

n

, the number of columns of the matrix

C

; the number of columns of

B

transb = Nag_NoTrans

, or the number of rows of

B

transb = Nag_Trans

Nag_ConjTrans

Constraint:

n \geq 0

k

– Integer Input

On entry:

k

, the number of columns of

A

transa = Nag_NoTrans

, or the number of rows of

A

transa = Nag_Trans

Nag_ConjTrans

; the number of rows of

B

transb = Nag_NoTrans

, or the number of columns of

B

transb = Nag_Trans

Nag_ConjTrans

Constraint:

k \geq 0

alpha

– double Input

On entry: the scalar

α

a [\dim]

– const double Input

Note: the dimension, dim, of the array a must be at least

$\max (1, pda \times k)$ when $transa = Nag_NoTrans$ and $order = Nag_ColMajor$ ;
$\max (1, m \times pda)$ when $transa = Nag_NoTrans$ and $order = Nag_RowMajor$ ;
$\max (1, pda \times m)$ when $transa = Nag_Trans$ or $Nag_ConjTrans$ and $order = Nag_ColMajor$ ;
$\max (1, k \times pda)$ when $transa = Nag_Trans$ or $Nag_ConjTrans$ and $order = Nag_RowMajor$ .

order = Nag_ColMajor

A_{i j}

is stored in

a [(j - 1) \times pda + i - 1]

order = Nag_RowMajor

A_{i j}

is stored in

a [(i - 1) \times pda + j - 1]

On entry: the matrix

A

;

A

m \times k

transa = Nag_NoTrans

, or

k \times m

transa = Nag_Trans

Nag_ConjTrans

pda

– Integer Input

On entry: the stride separating row or column elements (depending on the value of order) in the array a.

Constraints:

if $order = Nag_ColMajor$ ,
- if $transa = Nag_NoTrans$ , $pda \geq \max (1, m)$ ;
- if $transa = Nag_Trans$ or $Nag_ConjTrans$ , $pda \geq \max (1, k)$ ;
if $order = Nag_RowMajor$ ,
- if $transa = Nag_NoTrans$ , $pda \geq \max (1, k)$ ;
- if $transa = Nag_Trans$ or $Nag_ConjTrans$ , $pda \geq \max (1, m)$ .

10:

b [\dim]

– const double Input

Note: the dimension, dim, of the array b must be at least

$\max (1, pdb \times n)$ when $transb = Nag_NoTrans$ and $order = Nag_ColMajor$ ;
$\max (1, k \times pdb)$ when $transb = Nag_NoTrans$ and $order = Nag_RowMajor$ ;
$\max (1, pdb \times k)$ when $transb = Nag_Trans$ or $Nag_ConjTrans$ and $order = Nag_ColMajor$ ;
$\max (1, n \times pdb)$ when $transb = Nag_Trans$ or $Nag_ConjTrans$ and $order = Nag_RowMajor$ .

order = Nag_ColMajor

B_{i j}

is stored in

b [(j - 1) \times pdb + i - 1]

order = Nag_RowMajor

B_{i j}

is stored in

b [(i - 1) \times pdb + j - 1]

On entry: the matrix

B

;

B

k \times n

transb = Nag_NoTrans

, or

n \times k

transb = Nag_Trans

Nag_ConjTrans

11:

pdb

– Integer Input

On entry: the stride separating row or column elements (depending on the value of order) in the array b.

Constraints:

if $order = Nag_ColMajor$ ,
- if $transb = Nag_NoTrans$ , $pdb \geq \max (1, k)$ ;
- if $transb = Nag_Trans$ or $Nag_ConjTrans$ , $pdb \geq \max (1, n)$ ;
if $order = Nag_RowMajor$ ,
- if $transb = Nag_NoTrans$ , $pdb \geq \max (1, n)$ ;
- if $transb = Nag_Trans$ or $Nag_ConjTrans$ , $pdb \geq \max (1, k)$ .

12:

beta

– double Input

On entry: the scalar

β

13:

c [\dim]

– double Input/Output

Note: the dimension, dim, of the array c must be at least

$\max (1, pdc \times n)$ when $order = Nag_ColMajor$ ;
$\max (1, m \times pdc)$ when $order = Nag_RowMajor$ .

order = Nag_ColMajor

C_{i j}

is stored in

c [(j - 1) \times pdc + i - 1]

order = Nag_RowMajor

C_{i j}

is stored in

c [(i - 1) \times pdc + j - 1]

On entry: the

m \times n

matrix

C

beta = 0

, c need not be set.

On exit: the updated matrix

C

14:

pdc

– Integer Input

On entry: the stride separating row or column elements (depending on the value of order) in the array c.

Constraints:

if $order = Nag_ColMajor$ , $pdc \geq \max (1, m)$ ;
if $order = Nag_RowMajor$ , $pdc \geq \max (1, n)$ .

15:

fail

– NagError * Input/Output

The NAG error argument (see Section 7 in the Introduction to the NAG Library CL Interface).

6 Error Indicators and Warnings

NE_ALLOC_FAIL

Dynamic memory allocation failed.
See Section 3.1.2 in the Introduction to the NAG Library CL Interface for further information.

NE_BAD_PARAM

On entry, argument

⟨ value ⟩

had an illegal value.

NE_ENUM_INT_2

On entry,

transa = ⟨ value ⟩

k = ⟨ value ⟩

pda = ⟨ value ⟩

.
Constraint: if

transa = Nag_NoTrans

pda \geq \max (1, k)

On entry,

transa = ⟨ value ⟩

m = ⟨ value ⟩

pda = ⟨ value ⟩

.
Constraint: if

transa = Nag_Trans

Nag_ConjTrans

pda \geq \max (1, m)

On entry,

transa = ⟨ value ⟩

pda = ⟨ value ⟩

k = ⟨ value ⟩

.
Constraint: if

transa = Nag_Trans

Nag_ConjTrans

pda \geq \max (1, k)

On entry,

transa = ⟨ value ⟩

pda = ⟨ value ⟩

m = ⟨ value ⟩

.
Constraint: if

transa = Nag_NoTrans

pda \geq \max (1, m)

On entry,

transb = ⟨ value ⟩

k = ⟨ value ⟩

pdb = ⟨ value ⟩

.
Constraint: if

transb = Nag_NoTrans

pdb \geq \max (1, k)

On entry,

transb = ⟨ value ⟩

k = ⟨ value ⟩

pdb = ⟨ value ⟩

.
Constraint: if

transb = Nag_Trans

Nag_ConjTrans

pdb \geq \max (1, k)

On entry,

transb = ⟨ value ⟩

n = ⟨ value ⟩

pdb = ⟨ value ⟩

.
Constraint: if

transb = Nag_NoTrans

pdb \geq \max (1, n)

On entry,

transb = ⟨ value ⟩

n = ⟨ value ⟩

pdb = ⟨ value ⟩

.
Constraint: if

transb = Nag_Trans

Nag_ConjTrans

pdb \geq \max (1, n)

NE_INT

On entry,

k = ⟨ value ⟩

.
Constraint:

k \geq 0

On entry,

m = ⟨ value ⟩

.
Constraint:

m \geq 0

On entry,

n = ⟨ value ⟩

.
Constraint:

n \geq 0

NE_INT_2

On entry,

pdc = ⟨ value ⟩

m = ⟨ value ⟩

.
Constraint:

pdc \geq \max (1, m)

On entry,

pdc = ⟨ value ⟩

and

n = ⟨ value ⟩

.
Constraint:

pdc \geq \max (1, n)

NE_INTERNAL_ERROR

An internal error has occurred in this function. Check the function call and any array sizes. If the call is correct then please contact NAG for assistance.

NE_NO_LICENCE

Your licence key may have expired or may not have been installed correctly.
See Section 8 in the Introduction to the NAG Library CL Interface for further information.

8 Parallelism and Performance

f16yac is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.

Please consult the X06 Chapter Introduction for information on how to control and interrogate the OpenMP environment used within this function. Please also consult the Users' Note for your implementation for any additional implementation-specific information.

10 Example

This example computes the matrix-matrix product

C = α A B + β C

where

A = (\begin{matrix} 1.0 & 2.0 & 3.0 \\ 3.0 & 4.0 & 5.0 \\ 5.0 & 6.0 & - 1.0 \end{matrix}),

B = (\begin{matrix} 1.0 & 2.0 \\ - 2.0 & 1.0 \\ 3.0 & - 1.0 \end{matrix}),

C = (\begin{matrix} - 2.0 & 1.0 \\ 1.0 & 3.0 \\ 2.0 & - 1.0 \end{matrix}),

α = 1.5 and β = 1.0 .

10.1 Program Text

10.2 Program Data

10.3 Program Results

NAG CL Interface
f16yac (dgemm)

▸▿ Contents

1 Purpose

2 Specification

3 Description

4 References

5 Arguments

6 Error Indicators and Warnings

7 Accuracy

8 Parallelism and Performance

9 Further Comments

10 Example

10.1 Program Text

10.2 Program Data

10.3 Program Results

NAG CL Interfacef16yac (dgemm)

▸▿ Contents

1 Purpose

2 Specification

3 Description

4 References

5 Arguments

6 Error Indicators and Warnings

7 Accuracy

8 Parallelism and Performance

9 Further Comments

10 Example

10.1 Program Text

10.2 Program Data

10.3 Program Results

NAG CL Interface
f16yac (dgemm)