Compute Library
 21.02
ClPoolingKernel.h
Go to the documentation of this file.
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_POOLING_KERNEL_H
25 #define ARM_COMPUTE_CL_POOLING_KERNEL_H
26 
27 #include "src/core/common/Macros.h"
30 
31 namespace arm_compute
32 {
33 namespace opencl
34 {
35 namespace kernels
36 {
37 /** Interface for the pooling layer kernel */
38 class ClPoolingKernel : public IClKernel
39 {
40 public:
41  /** Default constructor */
44 
45  /** Configure kernel for a given list of arguments
46  *
47  *
48  * @param[in] compile_context The compile context to be used.
49  * @param[in] src Source tensor info. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32.
50  * @param[out] dst Destination tensor info. Data types supported: same as @p src.
51  * @param[in] pool_info Contains pooling operation information described in @ref PoolingLayerInfo.
52  * @param[out] indices (optional) The indices of the maximal values. Data type supported: U32.
53  */
54  void configure(const ClCompileContext &compile_context, ITensorInfo *src, ITensorInfo *dst, const PoolingLayerInfo &pool_info, ITensorInfo *indices = nullptr);
55  /** Static function to check if given info will lead to a valid configuration of @ref ClPoolingKernel
56  *
57  * @param[in] src Source tensor info. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32.
58  * @param[in] dst Destination tensor info. Data types supported: same as @p src.
59  * @param[in] pool_info Contains pooling operation information described in @ref PoolingLayerInfo.
60  * @param[in] indices (optional) The indices of the maximal values. Data type supported: U32.
61  *
62  * @return a status
63  */
64  static Status validate(const ITensorInfo *src, const ITensorInfo *dst, const PoolingLayerInfo &pool_info, const ITensorInfo *indices = nullptr);
65 
66  // Inherited methods overridden:
67  void run_op(ITensorPack &tensors, const Window &window, cl::CommandQueue &queue) override;
68  BorderSize border_size() const override;
69 
70 public:
75 };
76 } // namespace kernels
77 } // namespace opencl
78 } // namespace arm_compute
79 #endif /*ARM_COMPUTE_CL_POOLING_KERNEL_H */
const Window & window() const
The maximum window the kernel can be executed on.
Definition: IKernel.cpp:28
Container for 2D border size.
Definition: Types.h:273
Store the tensor's metadata.
Definition: ITensorInfo.h:40
Status class.
Definition: Error.h:52
Common interface for all the OpenCL kernels.
Definition: ICLKernel.h:46
SimpleTensor< float > src
Definition: DFT.cpp:155
Copyright (c) 2017-2021 Arm Limited.
void configure(const ClCompileContext &compile_context, ITensorInfo *src, ITensorInfo *dst, const PoolingLayerInfo &pool_info, ITensorInfo *indices=nullptr)
Configure kernel for a given list of arguments.
Pooling Layer Information struct.
Definition: Types.h:1214
CLCompileContext class.
BorderSize border_size() const override
The size of the border for that kernel.
void run_op(ITensorPack &tensors, const Window &window, cl::CommandQueue &queue) override
Enqueue the OpenCL kernel to process the given window on the passed OpenCL command queue...
Interface for the pooling layer kernel.
Tensor packing service.
Definition: ITensorPack.h:37
static Status validate(const ITensorInfo *src, const ITensorInfo *dst, const PoolingLayerInfo &pool_info, const ITensorInfo *indices=nullptr)
Static function to check if given info will lead to a valid configuration of ClPoolingKernel.
DataLayout
[DataLayout enum definition]
Definition: Types.h:120
Describe a multidimensional execution window.
Definition: Window.h:39