Compute Library
 23.11
CLTypes.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2020-2022 Arm Limited.
3  *
4  * SPDX-License-Identifier: MIT
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
7  * of this software and associated documentation files (the "Software"), to
8  * deal in the Software without restriction, including without limitation the
9  * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
10  * sell copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in all
14  * copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22  * SOFTWARE.
23  */
24 #ifndef ARM_COMPUTE_RUNTIME_CLTYPES_H
25 #define ARM_COMPUTE_RUNTIME_CLTYPES_H
26 #include "arm_compute/core/Types.h"
27 
28 namespace arm_compute
29 {
30 /** OpenCL GEMM kernel types */
31 enum class CLGEMMKernelType
32 {
33  /** Native GEMM kernel with configurable block size.*/
34  NATIVE,
35  /** Reshaped GEMM kernel where both lhs and rhs matrices are reshaped. Configurable reshape and block size */
36  RESHAPED,
37  /** Reshaped GEMM kernel where only the rhs matrix is reshaped. Configurable reshape and block size */
39  /** Reshaped GEMM kernel where only the rhs matrix is reshaped. Using MMUL with configurable block size. */
41 };
42 
43 /** OpenCL GEMM kernel selection parameters. These information are retrieved to select the GEMM kernel on OpenCL */
45 {
46  unsigned int m{0}; /**< Number of rows for the lhs matrix. Lhs matrix NOT transposed */
47  unsigned int n{0}; /**< Number of columns for the rhs matrix. Rhs matrix NOT transposed */
48  unsigned int k{0}; /**< Number of rows for the rhs matrix. Rhs matrix NOT transposed */
49  unsigned int b{0}; /**< Batch size */
50  bool is_rhs_constant{false}; /**< True if the content of the rhs matrix is constant */
51  DataType data_type{DataType::UNKNOWN}; /**< Data type */
52 };
53 
54 /** List the possible OpenCL backends */
55 enum class CLBackendType
56 {
57  Native, /**< OpenCL native backend */
58  Clvk, /**< CLVK backend */
59 };
60 } // namespace arm_compute
61 #endif /* ARM_COMPUTE_RUNTIME_CLTYPES_H */
arm_compute::CLGEMMKernelSelectionParams
OpenCL GEMM kernel selection parameters.
Definition: CLTypes.h:44
arm_compute::CLGEMMKernelSelectionParams::data_type
DataType data_type
Data type.
Definition: CLTypes.h:51
Types.h
arm_compute::CLGEMMKernelSelectionParams::n
unsigned int n
Number of columns for the rhs matrix.
Definition: CLTypes.h:47
arm_compute::CLGEMMKernelType::NATIVE
@ NATIVE
Native GEMM kernel with configurable block size.
arm_compute::CLGEMMKernelSelectionParams::m
unsigned int m
Number of rows for the lhs matrix.
Definition: CLTypes.h:46
arm_compute::CLGEMMKernelSelectionParams::is_rhs_constant
bool is_rhs_constant
True if the content of the rhs matrix is constant.
Definition: CLTypes.h:50
arm_compute::CLGEMMKernelType
CLGEMMKernelType
OpenCL GEMM kernel types.
Definition: CLTypes.h:31
arm_compute::CLBackendType::Clvk
@ Clvk
CLVK backend.
arm_compute::CLGEMMKernelSelectionParams::b
unsigned int b
Batch size.
Definition: CLTypes.h:49
arm_compute::CLBackendType
CLBackendType
List the possible OpenCL backends.
Definition: CLTypes.h:55
arm_compute::CLBackendType::Native
@ Native
OpenCL native backend.
arm_compute::CLGEMMKernelSelectionParams::k
unsigned int k
Number of rows for the rhs matrix.
Definition: CLTypes.h:48
arm_compute
Copyright (c) 2017-2023 Arm Limited.
Definition: introduction.dox:24
arm_compute::CLGEMMKernelType::RESHAPED_ONLY_RHS_MMUL
@ RESHAPED_ONLY_RHS_MMUL
Reshaped GEMM kernel where only the rhs matrix is reshaped.
arm_compute::CLGEMMKernelType::RESHAPED
@ RESHAPED
Reshaped GEMM kernel where both lhs and rhs matrices are reshaped.
arm_compute::CLGEMMKernelType::RESHAPED_ONLY_RHS
@ RESHAPED_ONLY_RHS
Reshaped GEMM kernel where only the rhs matrix is reshaped.
arm_compute::DataType::UNKNOWN
@ UNKNOWN
Unknown data type.
arm_compute::DataType
DataType
Available data types.
Definition: CoreTypes.h:83