Compute Library
 22.05
CLPoolingLayer.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_CLPOOLINGLAYER_H
25 #define ARM_COMPUTE_CLPOOLINGLAYER_H
26 
28 
29 #include "arm_compute/core/Types.h"
30 
31 #include <memory>
32 
33 namespace arm_compute
34 {
35 class CLCompileContext;
36 class ICLTensor;
37 class ITensorInfo;
38 
39 /** Basic function to run @ref opencl::ClPool2d */
40 class CLPoolingLayer : public IFunction
41 {
42 public:
43  /** Default Constructor */
45  /** Default Destructor */
47  /** Prevent instances of this class from being copied (As this class contains pointers) */
48  CLPoolingLayer(const CLPoolingLayer &) = delete;
49  /** Default move constructor */
50  CLPoolingLayer(CLPoolingLayer &&) = default;
51  /** Prevent instances of this class from being copied (As this class contains pointers) */
52  CLPoolingLayer &operator=(const CLPoolingLayer &) = delete;
53  /** Default move assignment operator */
55  /** Set the input and output tensors.
56  *
57  * Valid data layouts:
58  * - NHWC
59  * - NCHW
60  *
61  * Valid data type configurations:
62  * |src |dst |
63  * |:--------------|:--------------|
64  * |QASYMM8 |QASYMM8 |
65  * |QASYMM8_SIGNED |QASYMM8_SIGNED |
66  * |F16 |F16 |
67  * |F32 |F32 |
68  *
69  * @note Source tensor is padded with -inf for MAX pooling and 0 otherwise
70  * Cases where pooling region is completely outside input tensor are not supported
71  *
72  * @param[in,out] input Source tensor. (Written to only when padding != 0) Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32.
73  * @param[out] output Destination tensor. Data types supported: Same as @p input.
74  * @param[in] pool_info Contains pooling operation information described in @ref PoolingLayerInfo.
75  * @param[out] indices (optional) The indices of the maximal values. Data type supported: U32.
76  */
77  void configure(ICLTensor *input, ICLTensor *output, const PoolingLayerInfo &pool_info, ICLTensor *indices = nullptr);
78  /** Set the input and output tensors.
79  *
80  * @param[in] compile_context The compile context to be used.
81  * @param[in,out] input Source tensor. (Written to only when padding != 0) Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32.
82  * @param[out] output Destination tensor. Data types supported: Same as @p input.
83  * @param[in] pool_info Contains pooling operation information described in @ref PoolingLayerInfo.
84  * @param[out] indices (optional) The indices of the maximal values. Data type supported: U32.
85  */
86  void configure(const CLCompileContext &compile_context, ICLTensor *input, ICLTensor *output, const PoolingLayerInfo &pool_info, ICLTensor *indices = nullptr);
87  /** Static function to check if given info will lead to a valid configuration of @ref CLPoolingLayer
88  *
89  * @param[in] input Source tensor info. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32.
90  * @param[in] output Destination tensor info. Data types supported: Same as @p input.
91  * @param[in] pool_info Contains pooling operation information described in @ref PoolingLayerInfo.
92  * @param[in] indices (optional) The indices of the maximal values. Data type supported: U32.
93  *
94  * @return a status
95  */
96  static Status validate(const ITensorInfo *input, const ITensorInfo *output, const PoolingLayerInfo &pool_info, const ITensorInfo *indices = nullptr);
97 
98  // Inherited methods overridden:
99  void run() override;
100 
101 private:
102  struct Impl;
103  std::unique_ptr<Impl> _impl;
104 };
105 } // namespace arm_compute
106 #endif /* ARM_COMPUTE_CLPOOLINGLAYER_H */
void configure(ICLTensor *input, ICLTensor *output, const PoolingLayerInfo &pool_info, ICLTensor *indices=nullptr)
Set the input and output tensors.
Base class for all functions.
Definition: IFunction.h:30
CLPoolingLayer()
Default Constructor.
Store the tensor&#39;s metadata.
Definition: ITensorInfo.h:40
Status class.
Definition: Error.h:52
Copyright (c) 2017-2022 Arm Limited.
Pooling Layer Information struct.
Definition: Types.h:1186
static Status validate(const ITensorInfo *input, const ITensorInfo *output, const PoolingLayerInfo &pool_info, const ITensorInfo *indices=nullptr)
Static function to check if given info will lead to a valid configuration of CLPoolingLayer.
CLCompileContext class.
void run() override
Run the kernels contained in the function.
Interface for OpenCL tensor.
Definition: ICLTensor.h:42
~CLPoolingLayer()
Default Destructor.
Basic function to run opencl::ClPool2d.
CLPoolingLayer & operator=(const CLPoolingLayer &)=delete
Prevent instances of this class from being copied (As this class contains pointers) ...