Compute Library
 21.02
NEPoolingLayer.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_NEPOOLINGLAYER_H
25 #define ARM_COMPUTE_NEPOOLINGLAYER_H
26 
27 #include "arm_compute/core/Types.h"
30 
31 #include <memory>
32 
33 namespace arm_compute
34 {
35 // Forward declarations
36 class ITensor;
37 class ITensorInfo;
38 
39 /** Basic function to simulate a pooling layer with the specified pooling operation. This function calls the following Neon kernels:
40  *
41  * -# @ref NEFillBorderKernel (executed if padding size is different from zero)
42  * -# @ref cpu::kernels::CpuPoolingKernel
43  * -# @ref cpu::CpuPoolingAssemblyDispatch
44  */
45 class NEPoolingLayer : public IFunction
46 {
47 public:
48  /** Constructor */
49  NEPoolingLayer(std::shared_ptr<IMemoryManager> memory_manager = nullptr);
50  /** Prevent instances of this class from being copied (As this class contains pointers) */
51  NEPoolingLayer(const NEPoolingLayer &) = delete;
52  /** Prevent instances of this class from being copied (As this class contains pointers) */
53  NEPoolingLayer &operator=(const NEPoolingLayer &) = delete;
54  /** Prevent instances of this class from being moved (As this class contains non movable objects) */
55  NEPoolingLayer(NEPoolingLayer &&) = delete;
56  /** Prevent instances of this class from being moved (As this class contains non movable objects) */
58  /** Default destructor */
60  /** Set the input and output tensors.
61  *
62  * @note F16 is supported for pool sizes 2 and 3 only
63  *
64  * @param[in, out] input Source tensor. (Written to only when padding != 0) Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32.
65  * @param[out] output Destination tensor. Data types supported: Same as @p input.
66  * @param[in] pool_info Contains pooling operation information described in @ref PoolingLayerInfo.
67  * @param[out] indices (optional) The indices of the maximal values. Data type supported: U32.
68  */
69  void configure(ITensor *input, ITensor *output, const PoolingLayerInfo &pool_info, ITensor *indices = nullptr);
70  /** Static function to check if given info will lead to a valid configuration of @ref NEPoolingLayer
71  *
72  * @note F16 is supported for pool sizes 2 and 3 only
73  *
74  * @param[in] input Source tensor info. (Written to only when padding != 0) Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32.
75  * @param[in] output Destination tensor info. Data types supported: Same as @p input.
76  * @param[in] pool_info Contains pooling operation information described in @ref PoolingLayerInfo.
77  * @param[in] indices (optional) Tensor info of the indices of the maximal values. Data type supported: U32.
78  *
79  * @return a status
80  */
81  static Status validate(const ITensorInfo *input, const ITensorInfo *output, const PoolingLayerInfo &pool_info, const ITensorInfo *indices = nullptr);
82 
83  // Inherited methods overridden:
84  void run() override;
85 
86 private:
87  struct Impl;
88  std::unique_ptr<Impl> _impl;
89 };
90 }
91 #endif /* ARM_COMPUTE_NEPOOLINGLAYER_H */
Base class for all functions.
Definition: IFunction.h:30
NEPoolingLayer(std::shared_ptr< IMemoryManager > memory_manager=nullptr)
Constructor.
Store the tensor&#39;s metadata.
Definition: ITensorInfo.h:40
Status class.
Definition: Error.h:52
Interface for Neon tensor.
Definition: ITensor.h:36
Copyright (c) 2017-2021 Arm Limited.
~NEPoolingLayer()
Default destructor.
void run() override
Run the kernels contained in the function.
Pooling Layer Information struct.
Definition: Types.h:1214
NEPoolingLayer & operator=(const NEPoolingLayer &)=delete
Prevent instances of this class from being copied (As this class contains pointers) ...
void configure(ITensor *input, ITensor *output, const PoolingLayerInfo &pool_info, ITensor *indices=nullptr)
Set the input and output tensors.
Basic function to simulate a pooling layer with the specified pooling operation.
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 NEPoolingLayer.