xref: /aosp_15_r20/external/ComputeLibrary/src/gpu/cl/kernels/ClPool2dKernel.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
1 /*
2  * Copyright (c) 2017-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_CL_POOL2D_KERNEL_H
25 #define ARM_COMPUTE_CL_POOL2D_KERNEL_H
26 
27 #include "src/core/common/Macros.h"
28 #include "src/gpu/cl/ClCompileContext.h"
29 #include "src/gpu/cl/IClKernel.h"
30 
31 namespace arm_compute
32 {
33 namespace opencl
34 {
35 namespace kernels
36 {
37 /** Interface for the pooling layer kernel */
38 class ClPool2dKernel : public IClKernel
39 {
40 public:
41     ClPool2dKernel();
42     ARM_COMPUTE_DISALLOW_COPY_ALLOW_MOVE(ClPool2dKernel);
43 
44     /** Configure kernel for a given list of arguments
45      *
46      *
47      * @param[in]  compile_context The compile context to be used.
48      * @param[in]  src             Source tensor info. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32.
49      * @param[out] dst             Destination tensor info. Data types supported: same as @p src.
50      * @param[in]  pool_info       Contains pooling operation information described in @ref PoolingLayerInfo.
51      * @param[out] indices         (optional) The indices of the maximal values. Data type supported: U32.
52      */
53     void configure(const ClCompileContext &compile_context, ITensorInfo *src, ITensorInfo *dst, const PoolingLayerInfo &pool_info, ITensorInfo *indices = nullptr);
54     /** Static function to check if given info will lead to a valid configuration
55      *
56      * Similar to ClPool2dKernel::configure()
57      *
58      * @return a status
59      */
60     static Status validate(const ITensorInfo *src, const ITensorInfo *dst, const PoolingLayerInfo &pool_info, const ITensorInfo *indices = nullptr);
61 
62     // Inherited methods overridden:
63     void run_op(ITensorPack &tensors, const Window &window, cl::CommandQueue &queue) override;
64 
65 public:
66     PoolingLayerInfo _pool_info{};
67     DataLayout       _data_layout{ DataLayout::UNKNOWN };
68     unsigned int     _num_elems_processed_per_iteration{ 1 };
69 };
70 } // namespace kernels
71 } // namespace opencl
72 } // namespace arm_compute
73 #endif /* ARM_COMPUTE_CL_POOL2D_KERNEL_H */
74