xref: /aosp_15_r20/external/ComputeLibrary/src/gpu/cl/operators/ClPool2d.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
1 /*
2  * Copyright (c) 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_H
25 #define ARM_COMPUTE_CL_POOL2D_H
26 
27 #include "src/gpu/cl/ClCompileContext.h"
28 #include "src/gpu/cl/IClOperator.h"
29 
30 #include <memory>
31 
32 namespace arm_compute
33 {
34 namespace opencl
35 {
36 /** Basic function to simulate a pooling layer with the specified pooling operation. This function calls the following OpenCL kernels:
37  *
38  * -# @ref opencl::ClPool2d
39  */
40 class ClPool2d : public IClOperator
41 {
42 public:
43     /** Constructor */
44     ClPool2d() = default;
45     /** Configure operator for a given list of arguments
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 type supported: same as @p src
50      * @param[in]  info            Pooling layer parameters.
51      * @param[out] indices         (optional) The indices info of the maximal values. Data type supported: U32.
52      */
53     void configure(const ClCompileContext &compile_context, ITensorInfo *src, ITensorInfo *dst, const PoolingLayerInfo &info, ITensorInfo *indices = nullptr);
54     /** Static function to check if given info will lead to a valid configuration
55      *
56      * Similar to ClPool2d::configure()
57      *
58      * @return a status
59      */
60     static Status validate(const ITensorInfo *src, const ITensorInfo *dst, const PoolingLayerInfo &info, const ITensorInfo *indices = nullptr);
61 };
62 } // namespace opencl
63 } // namespace arm_compute
64 #endif /* ARM_COMPUTE_CL_POOL2D_H */
65