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" 28 #include "arm_compute/runtime/IFunction.h" 29 #include "arm_compute/runtime/IMemoryManager.h" 30 #include "arm_compute/runtime/MemoryGroup.h" 31 32 #include <memory> 33 34 namespace arm_compute 35 { 36 // Forward declarations 37 class ITensor; 38 class ITensorInfo; 39 40 /** Basic function to simulate a pooling layer with the specified pooling operation. This function calls the following kernels: 41 * 42 * -# @ref cpu::CpuPool2d 43 */ 44 class NEPoolingLayer : public IFunction 45 { 46 public: 47 /** Constructor */ 48 NEPoolingLayer(std::shared_ptr<IMemoryManager> memory_manager = nullptr); 49 /** Prevent instances of this class from being copied (As this class contains pointers) */ 50 NEPoolingLayer(const NEPoolingLayer &) = delete; 51 /** Prevent instances of this class from being copied (As this class contains pointers) */ 52 NEPoolingLayer &operator=(const NEPoolingLayer &) = delete; 53 /** Prevent instances of this class from being moved (As this class contains non movable objects) */ 54 NEPoolingLayer(NEPoolingLayer &&) = delete; 55 /** Prevent instances of this class from being moved (As this class contains non movable objects) */ 56 NEPoolingLayer &operator=(NEPoolingLayer &&) = delete; 57 /** Default destructor */ 58 ~NEPoolingLayer(); 59 /** Set the input and output tensors. 60 * 61 * Valid data layouts: 62 * - NHWC 63 * - NCHW 64 * 65 * Valid data type configurations: 66 * |src |dst | 67 * |:--------------|:--------------| 68 * |QASYMM8 |QASYMM8 | 69 * |QASYMM8_SIGNED |QASYMM8_SIGNED | 70 * |F16 |F16 | 71 * |F32 |F32 | 72 * 73 * @note F16 is supported for pool sizes 2 and 3 only 74 * @note Source tensor is padded with -inf for MAX pooling and 0 otherwise 75 * Cases where pooling region is completely outside input tensor are only supported for floating point data type 76 * 77 * @param[in, out] input Source tensor. (Written to only when padding != 0) Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32. 78 * @param[out] output Destination tensor. Data types supported: Same as @p input. 79 * @param[in] pool_info Contains pooling operation information described in @ref PoolingLayerInfo. 80 * @param[out] indices (optional) The indices of the maximal values. Data type supported: U32. 81 */ 82 void configure(ITensor *input, ITensor *output, const PoolingLayerInfo &pool_info, ITensor *indices = nullptr); 83 /** Static function to check if given info will lead to a valid configuration of @ref NEPoolingLayer 84 * 85 * @note F16 is supported for pool sizes 2 and 3 only 86 * 87 * @param[in] input Source tensor info. (Written to only when padding != 0) Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32. 88 * @param[in] output Destination tensor info. Data types supported: Same as @p input. 89 * @param[in] pool_info Contains pooling operation information described in @ref PoolingLayerInfo. 90 * @param[in] indices (optional) Tensor info of the indices of the maximal values. Data type supported: U32. 91 * 92 * @return a status 93 */ 94 static Status validate(const ITensorInfo *input, const ITensorInfo *output, const PoolingLayerInfo &pool_info, const ITensorInfo *indices = nullptr); 95 96 // Inherited methods overridden: 97 void run() override; 98 99 private: 100 struct Impl; 101 std::unique_ptr<Impl> _impl; 102 }; 103 } 104 #endif /* ARM_COMPUTE_NEPOOLINGLAYER_H */ 105