Compute Library
 21.02
NEROIPoolingLayer.h
Go to the documentation of this file.
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_NEROIPOOLINGLAYER_H
25 #define ARM_COMPUTE_NEROIPOOLINGLAYER_H
26 
28 
30 #include <memory>
31 
32 namespace arm_compute
33 {
34 class ITensor;
35 class NEROIPoolingLayerKernel;
36 class ROIPoolingLayerInfo;
37 
38 /** Basic function to run @ref NEROIPoolingLayerKernel.
39  *
40  * This function calls the following Neon kernels:
41  * -# @ref NEROIPoolingLayerKernel
42  *
43  */
45 {
46 public:
47  /** Constructor */
49  /** Prevent instances of this class from being copied (As this class contains pointers) */
50  NEROIPoolingLayer(const NEROIPoolingLayer &) = delete;
51  /** Prevent instances of this class from being copied (As this class contains pointers) */
53  /** Prevent instances of this class from being moved (As this class contains non movable objects) */
55  /** Prevent instances of this class from being moved (As this class contains non movable objects) */
57  /** Default destructor */
59  /** Set the input and output tensors.
60  *
61  * @param[in] input Source tensor. Data types supported: F32.
62  * @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
63  * as coordinate of an image and batch_id of ROI [ batch_id, x1, y1, x2, y2 ]. Data types supported: U16
64  * @param[out] output Destination tensor. Data types supported: Same as @p input.
65  * @param[in] pool_info Contains pooling operation information described in @ref ROIPoolingLayerInfo.
66  *
67  * @note The x and y dimensions of @p output tensor must be the same as that specified by @p pool_info 's pooled
68  * width and pooled height.
69  * @note The z dimensions of @p output tensor and @p input tensor must be the same.
70  * @note The fourth dimension of @p output tensor must be the same as the number of elements in @p rois array.
71  */
72  void configure(const ITensor *input, const ITensor *rois, ITensor *output, const ROIPoolingLayerInfo &pool_info);
73 
74  // Inherited methods overridden:
75  void run() override;
76 
77 private:
78  std::unique_ptr<NEROIPoolingLayerKernel> _roi_kernel;
79 };
80 } // namespace arm_compute
81 #endif /* ARM_COMPUTE_NEROIPOOLINGLAYER_H */
Base class for all functions.
Definition: IFunction.h:30
~NEROIPoolingLayer()
Default destructor.
void run() override
Run the kernels contained in the function.
Interface for Neon tensor.
Definition: ITensor.h:36
Copyright (c) 2017-2021 Arm Limited.
Basic function to run NEROIPoolingLayerKernel.
void configure(const ITensor *input, const ITensor *rois, ITensor *output, const ROIPoolingLayerInfo &pool_info)
Set the input and output tensors.
NEROIPoolingLayer & operator=(const NEROIPoolingLayer &)=delete
Prevent instances of this class from being copied (As this class contains pointers) ...
ROI Pooling Layer Information class.
Definition: Types.h:1309