Compute Library
 21.05
ClPooling.h
Go to the documentation of this file.
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_POOLING_H
25 #define ARM_COMPUTE_CL_POOLING_H
26 
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 CLFillBorderKernel (executed if padding size is different from zero)
39  * -# @ref opencl::ClPooling
40  */
41 class ClPooling : public IClOperator
42 {
43 public:
44  /** Constructor */
45  ClPooling() = default;
46  /** Configure operator for a given list of arguments
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 type supported: same as @p src
51  * @param[in] info Pooling layer parameters.
52  * @param[out] indices (optional) The indices info of the maximal values. Data type supported: U32.
53  */
54  void configure(const ClCompileContext &compile_context, ITensorInfo *src, ITensorInfo *dst, const PoolingLayerInfo &info, ITensorInfo *indices = nullptr);
55  /** Static function to check if given info will lead to a valid configuration of @ref ClPooling
56  *
57  * @param[in] src Source tensor info. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32.
58  * @param[out] dst Destination tensor info. Data type supported: same as @p src
59  * @param[in] info Pooling layer parameters.
60  * @param[out] indices (optional) The indices info 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 &info, const ITensorInfo *indices = nullptr);
65 
66  // Inherited method overridden
67  void run(ITensorPack &tensors) override;
68 
69 private:
70  std::unique_ptr<ICLKernel> _pooling{ nullptr };
71  std::unique_ptr<ICLKernel> _border_handler{ nullptr };
72 };
73 } // namespace opencl
74 } // namespace arm_compute
75 #endif /* ARM_COMPUTE_CL_POOLING_H */
static Status validate(const ITensorInfo *src, const ITensorInfo *dst, const PoolingLayerInfo &info, const ITensorInfo *indices=nullptr)
Static function to check if given info will lead to a valid configuration of ClPooling.
Definition: ClPooling.cpp:88
void run(ITensorPack &tensors) override
Run the kernels contained in the function.
Definition: ClPooling.cpp:93
Store the tensor's metadata.
Definition: ITensorInfo.h:40
Status class.
Definition: Error.h:52
SimpleTensor< float > src
Definition: DFT.cpp:155
Copyright (c) 2017-2021 Arm Limited.
ClPooling()=default
Constructor.
Pooling Layer Information struct.
Definition: Types.h:1142
Basic function to simulate a pooling layer with the specified pooling operation.
Definition: ClPooling.h:41
CLCompileContext class.
ScaleKernelInfo info(interpolation_policy, default_border_mode, PixelValue(), sampling_policy, false)
void configure(const ClCompileContext &compile_context, ITensorInfo *src, ITensorInfo *dst, const PoolingLayerInfo &info, ITensorInfo *indices=nullptr)
Configure operator for a given list of arguments.
Definition: ClPooling.cpp:36
Tensor packing service.
Definition: ITensorPack.h:37
Basic interface for functions which have a single async CL kernel.
Definition: ICLOperator.h:41