1 /* 2 * Copyright (c) 2017-2020 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_CLPOOLINGLAYERKERNEL_H 25 #define ARM_COMPUTE_CLPOOLINGLAYERKERNEL_H 26 27 #include "src/core/CL/ICLKernel.h" 28 29 #include "arm_compute/core/Error.h" 30 31 namespace arm_compute 32 { 33 class ICLTensor; 34 35 /** Interface for the pooling layer kernel */ 36 class CLPoolingLayerKernel : public ICLKernel 37 { 38 public: 39 /** Default constructor */ 40 CLPoolingLayerKernel(); 41 /** Prevent instances of this class from being copied (As this class contains pointers) */ 42 CLPoolingLayerKernel(const CLPoolingLayerKernel &) = delete; 43 /** Prevent instances of this class from being copied (As this class contains pointers) */ 44 CLPoolingLayerKernel &operator=(const CLPoolingLayerKernel &) = delete; 45 /** Allow instances of this class to be moved */ 46 CLPoolingLayerKernel(CLPoolingLayerKernel &&) = default; 47 /** Allow instances of this class to be moved */ 48 CLPoolingLayerKernel &operator=(CLPoolingLayerKernel &&) = default; 49 /** Default destructor */ 50 ~CLPoolingLayerKernel() = default; 51 52 /** Set the input and output tensors. 53 * 54 * 55 * @param[in] input Source tensor. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32. 56 * @param[out] output Destination tensor. Data types supported: Same as @p input. 57 * @param[in] pool_info Contains pooling operation information described in @ref PoolingLayerInfo. 58 * @param[out] indices (optional) The indices of the maximal values. Data type supported: U32. 59 */ 60 void configure(const ICLTensor *input, ICLTensor *output, const PoolingLayerInfo &pool_info, ICLTensor *indices = nullptr); 61 /** Set the input and output tensors. 62 * 63 * 64 * @param[in] compile_context The compile context to be used. 65 * @param[in] input Source tensor. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32. 66 * @param[out] output Destination tensor. Data types supported: Same as @p input. 67 * @param[in] pool_info Contains pooling operation information described in @ref PoolingLayerInfo. 68 * @param[out] indices (optional) The indices of the maximal values. Data type supported: U32. 69 */ 70 void configure(const CLCompileContext &compile_context, const ICLTensor *input, ICLTensor *output, const PoolingLayerInfo &pool_info, ICLTensor *indices = nullptr); 71 /** Static function to check if given info will lead to a valid configuration of @ref CLPoolingLayerKernel 72 * 73 * @param[in] input Source tensor info. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32. 74 * @param[in] output Destination tensor info. Data types supported: Same as @p input. 75 * @param[in] pool_info Contains pooling operation information described in @ref PoolingLayerInfo. 76 * @param[in] indices (optional) The indices of the maximal values. Data type supported: U32. 77 * 78 * @return a status 79 */ 80 static Status validate(const ITensorInfo *input, const ITensorInfo *output, const PoolingLayerInfo &pool_info, const ITensorInfo *indices = nullptr); 81 82 // Inherited methods overridden: 83 void run(const Window &window, cl::CommandQueue &queue) override; 84 BorderSize border_size() const override; 85 86 public: 87 const ICLTensor *_input; 88 ICLTensor *_output; 89 ICLTensor *_indices; 90 PoolingLayerInfo _pool_info; 91 DataLayout _data_layout; 92 BorderSize _border_size; 93 unsigned int _num_elems_processed_per_iteration; 94 }; 95 } // namespace arm_compute 96 #endif /*ARM_COMPUTE_CLPOOLINGLAYERKERNEL_H */ 97