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_CLPOOLINGLAYER_H 25 #define ARM_COMPUTE_CLPOOLINGLAYER_H 26 27 #include "arm_compute/runtime/CL/ICLSimpleFunction.h" 28 29 #include "arm_compute/core/Error.h" 30 #include "arm_compute/core/Types.h" 31 32 namespace arm_compute 33 { 34 class CLCompileContext; 35 class ICLTensor; 36 class ITensorInfo; 37 38 /** Basic function to simulate a pooling layer with the specified pooling operation. This function calls the following OpenCL kernels: 39 * 40 * -# @ref CLFillBorderKernel (executed if padding size is different from zero) 41 * -# @ref CLPoolingLayerKernel 42 */ 43 class CLPoolingLayer : public ICLSimpleFunction 44 { 45 public: 46 /** Set the input and output tensors. 47 * 48 * @param[in,out] input Source tensor. (Written to only when padding != 0) Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32. 49 * @param[out] output Destination tensor. Data types supported: Same as @p input. 50 * @param[in] pool_info Contains pooling operation information described in @ref PoolingLayerInfo. 51 * @param[out] indices (optional) The indices of the maximal values. Data type supported: U32. 52 */ 53 void configure(ICLTensor *input, ICLTensor *output, const PoolingLayerInfo &pool_info, ICLTensor *indices = nullptr); 54 /** Set the input and output tensors. 55 * 56 * @param[in] compile_context The compile context to be used. 57 * @param[in,out] input Source tensor. (Written to only when padding != 0) Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32. 58 * @param[out] output Destination tensor. Data types supported: Same as @p input. 59 * @param[in] pool_info Contains pooling operation information described in @ref PoolingLayerInfo. 60 * @param[out] indices (optional) The indices of the maximal values. Data type supported: U32. 61 */ 62 void configure(const CLCompileContext &compile_context, ICLTensor *input, ICLTensor *output, const PoolingLayerInfo &pool_info, ICLTensor *indices = nullptr); 63 /** Static function to check if given info will lead to a valid configuration of @ref CLPoolingLayer 64 * 65 * @param[in] input Source tensor info. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32. 66 * @param[in] output Destination tensor info. Data types supported: Same as @p input. 67 * @param[in] pool_info Contains pooling operation information described in @ref PoolingLayerInfo. 68 * @param[in] indices (optional) The indices of the maximal values. Data type supported: U32. 69 * 70 * @return a status 71 */ 72 static Status validate(const ITensorInfo *input, const ITensorInfo *output, const PoolingLayerInfo &pool_info, const ITensorInfo *indices = nullptr); 73 }; 74 } // namespace arm_compute 75 #endif /* ARM_COMPUTE_CLPOOLINGLAYER_H */ 76