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_CLROIPOOLINGLAYERKERNEL_H 25 #define ARM_COMPUTE_CLROIPOOLINGLAYERKERNEL_H 26 27 #include "src/core/CL/ICLKernel.h" 28 29 #include "arm_compute/core/CL/ICLArray.h" 30 31 namespace arm_compute 32 { 33 class ICLTensor; 34 35 /** Interface for the ROI pooling layer kernel */ 36 class CLROIPoolingLayerKernel : public ICLKernel 37 { 38 public: 39 /** Default constructor */ 40 CLROIPoolingLayerKernel(); 41 /** Prevent instances of this class from being copied (As this class contains pointers) */ 42 CLROIPoolingLayerKernel(const CLROIPoolingLayerKernel &) = delete; 43 /** Prevent instances of this class from being copied (As this class contains pointers) */ 44 CLROIPoolingLayerKernel &operator=(const CLROIPoolingLayerKernel &) = delete; 45 /** Allow instances of this class to be moved */ 46 CLROIPoolingLayerKernel(CLROIPoolingLayerKernel &&) = default; 47 /** Allow instances of this class to be moved */ 48 CLROIPoolingLayerKernel &operator=(CLROIPoolingLayerKernel &&) = default; 49 /** Default destructor */ 50 ~CLROIPoolingLayerKernel() = default; 51 52 /** Set the input and output tensors. 53 * 54 * @param[in] input Source tensor. Data types supported: F16/F32. 55 * @param[in] rois ROIs tensor, it is a 2D tensor of size [5, N] (where N is the number of ROIs) containing top left and bottom right corner 56 * as coordinate of an image and batch_id of ROI [ batch_id, x1, y1, x2, y2 ]. Data types supported: U16 57 * @param[out] output Destination tensor. Data types supported: Same as @p input. 58 * @param[in] pool_info Contains pooling operation information described in @ref ROIPoolingLayerInfo. 59 * 60 * @note The x and y dimensions of @p output tensor must be the same as @p pool_info 's pooled 61 * width and pooled height. 62 * @note The z dimensions of @p output tensor and @p input tensor must be the same. 63 * @note The fourth dimension of @p output tensor must be the same as the number of elements in @p rois array. 64 */ 65 void configure(const ICLTensor *input, const ICLTensor *rois, ICLTensor *output, const ROIPoolingLayerInfo &pool_info); 66 /** Set the input and output tensors. 67 * 68 * @param[in] compile_context The compile context to be used. 69 * @param[in] input Source tensor. Data types supported: F16/F32. 70 * @param[in] rois ROIs tensor, it is a 2D tensor of size [5, N] (where N is the number of ROIs) containing top left and bottom right corner 71 * as coordinate of an image and batch_id of ROI [ batch_id, x1, y1, x2, y2 ]. Data types supported: U16 72 * @param[out] output Destination tensor. Data types supported: Same as @p input. 73 * @param[in] pool_info Contains pooling operation information described in @ref ROIPoolingLayerInfo. 74 * 75 * @note The x and y dimensions of @p output tensor must be the same as @p pool_info 's pooled 76 * width and pooled height. 77 * @note The z dimensions of @p output tensor and @p input tensor must be the same. 78 * @note The fourth dimension of @p output tensor must be the same as the number of elements in @p rois array. 79 */ 80 void configure(const CLCompileContext &compile_context, const ICLTensor *input, const ICLTensor *rois, ICLTensor *output, const ROIPoolingLayerInfo &pool_info); 81 82 // Inherited methods overridden: 83 void run(const Window &window, cl::CommandQueue &queue) override; 84 85 private: 86 const ICLTensor *_input; 87 const ICLTensor *_rois; 88 ICLTensor *_output; 89 ROIPoolingLayerInfo _pool_info; 90 }; 91 } // namespace arm_compute 92 #endif /*ARM_COMPUTE_CLROIPOOLINGLAYERKERNEL_H */ 93