xref: /aosp_15_r20/external/ComputeLibrary/src/core/NEON/kernels/NEROIPoolingLayerKernel.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
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_NEROIPOOLINGLAYERKERNEL_H
25 #define ARM_COMPUTE_NEROIPOOLINGLAYERKERNEL_H
26 
27 #include "src/core/NEON/INEKernel.h"
28 namespace arm_compute
29 {
30 class ITensor;
31 
32 /** Interface for the ROI pooling layer kernel */
33 class NEROIPoolingLayerKernel : public INEKernel
34 {
35 public:
name()36     const char *name() const override
37     {
38         return "NEROIPoolingLayerKernel";
39     }
40     /** Default constructor */
41     NEROIPoolingLayerKernel();
42     /** Prevent instances of this class from being copied (As this class contains pointers) */
43     NEROIPoolingLayerKernel(const NEROIPoolingLayerKernel &) = delete;
44     /** Prevent instances of this class from being copied (As this class contains pointers) */
45     NEROIPoolingLayerKernel &operator=(const NEROIPoolingLayerKernel &) = delete;
46     /** Allow instances of this class to be moved */
47     NEROIPoolingLayerKernel(NEROIPoolingLayerKernel &&) = default;
48     /** Allow instances of this class to be moved */
49     NEROIPoolingLayerKernel &operator=(NEROIPoolingLayerKernel &&) = default;
50     /** Default destructor */
51     ~NEROIPoolingLayerKernel() = default;
52 
53     /** Set the input and output tensors.
54      *
55      * @param[in]  input     Source tensor. Data types supported: QASYMM8/F32
56      * @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
57      *                       as coordinate of an image and batch_id of ROI [ batch_id, x1, y1, x2, y2 ]. Data types supported: U16
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 ROIPoolingLayerInfo.
60      *
61      * @note The x and y dimensions of @p output tensor must be the same as that specified by @p pool_info 's pooled
62      * width and pooled height.
63      * @note The z dimensions of @p output tensor and @p input tensor must be the same.
64      * @note The fourth dimension of @p output tensor must be the same as the number of elements in @p rois tensor.
65      */
66     void configure(const ITensor *input, const ITensor *rois, const ITensor *output, const ROIPoolingLayerInfo &pool_info);
67 
68     // Inherited methods overridden:
69     void run(const Window &window, const ThreadInfo &info) override;
70 
71     /** Static function to check if given info will lead to a valid configuration of @ref NEROIPoolingLayerKernel
72      *
73      * @param[in] input     Source tensor info. Data types supported: QASYMM8/F32.
74      * @param[in] rois      ROIs tensor info. Data types supported: U16
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 ROIPoolingLayerInfo.
77      *
78      * @note The x and y dimensions of @p output tensor must be the same as @p pool_info 's pooled
79      * width and pooled height.
80      * @note The datatype of @p output should be the same as the datatype of @p input
81      * @note The fourth dimension of @p output tensor must be the same as the number of elements in @p rois array.
82      *
83      * @return a Status
84      */
85     static Status validate(const ITensorInfo *input, const ITensorInfo *rois, const ITensorInfo *output, const ROIPoolingLayerInfo &pool_info);
86 
87 private:
88     const ITensor      *_input;
89     const ITensor      *_rois;
90     const ITensor      *_output;
91     ROIPoolingLayerInfo _pool_info;
92 };
93 } // namespace arm_compute
94 #endif /*ARM_COMPUTE_NEROIPOOLINGLAYERKERNEL_H */
95