Compute Library
 21.05
CLTypes.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2020-2021 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 fixed block size.
34  * @note Temporary variant to keep compatibility with the old implementation.
35  * @note This variant will be deprecated in favor of a new and configurable NATIVE variant
36  */
37  NATIVE_V1,
38  /** Native GEMM kernel with configurable block size.*/
39  NATIVE,
40  /** Reshaped GEMM kernel where both lhs and rhs matrices are reshaped. Fixed block size fixed.
41  * @note Temporary variant to keep compatibility with the old implementation.
42  * @note This variant will be deprecated in favor of RESHAPED
43  */
45  /** Reshaped GEMM kernel where both lhs and rhs matrices are reshaped. Configurable reshape and block size */
46  RESHAPED,
47  /** Reshaped GEMM kernel where only the rhs matrix is reshaped. Configurable reshape and block size */
49 };
50 
51 /** OpenCL GEMM kernel selection parameters. These information are retrieved to select the GEMM kernel on OpenCL */
53 {
54  unsigned int m{ 0 }; /**< Number of rows for the lhs matrix. Lhs matrix NOT transposed */
55  unsigned int n{ 0 }; /**< Number of columns for the rhs matrix. Rhs matrix NOT transposed */
56  unsigned int k{ 0 }; /**< Number of rows for the rhs matrix. Rhs matrix NOT transposed */
57  unsigned int b{ 0 }; /**< Batch size */
58  bool is_rhs_constant{ false }; /**< True if the content of the rhs matrix is constant */
59  DataType data_type{ DataType::UNKNOWN }; /**< Data type */
60 };
61 
62 /** List the possible OpenCL backends */
63 enum class CLBackendType
64 {
65  Native, /**< OpenCL native backend */
66  Clvk, /**< CLVK backend */
67 };
68 } // namespace arm_compute
69 #endif /* ARM_COMPUTE_RUNTIME_CLTYPES_H */
unsigned int m
Number of rows for the lhs matrix.
Definition: CLTypes.h:54
OpenCL GEMM kernel selection parameters.
Definition: CLTypes.h:52
Reshaped GEMM kernel where only the rhs matrix is reshaped.
CLGEMMKernelType
OpenCL GEMM kernel types.
Definition: CLTypes.h:31
Reshaped GEMM kernel where both lhs and rhs matrices are reshaped.
Copyright (c) 2017-2021 Arm Limited.
Native GEMM kernel with fixed block size.
bool is_rhs_constant
True if the content of the rhs matrix is constant.
Definition: CLTypes.h:58
CLBackendType
List the possible OpenCL backends.
Definition: CLTypes.h:63
unsigned int b
Batch size.
Definition: CLTypes.h:57
Native GEMM kernel with configurable block size.
unsigned int n
Number of columns for the rhs matrix.
Definition: CLTypes.h:55
DataType
Available data types.
Definition: Types.h:77
Reshaped GEMM kernel where both lhs and rhs matrices are reshaped.
unsigned int k
Number of rows for the rhs matrix.
Definition: CLTypes.h:56