• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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_NEPOOLINGLAYER_H
25 #define ARM_COMPUTE_NEPOOLINGLAYER_H
26 
27 #include "arm_compute/runtime/IFunction.h"
28 
29 #include "arm_compute/core/Types.h"
30 #include <memory>
31 
32 namespace arm_compute
33 {
34 class ITensor;
35 class ITensorInfo;
36 class NEPoolingLayerKernel;
37 class NEFillBorderKernel;
38 
39 /** Basic function to simulate a pooling layer with the specified pooling operation. This function calls the following NEON kernels:
40  *
41  * -# @ref NEFillBorderKernel (executed if padding size is different from zero)
42  * -# @ref NEPoolingLayerKernel
43  */
44 class NEPoolingLayer : public IFunction
45 {
46 public:
47     /** Constructor */
48     NEPoolingLayer();
49     /** Prevent instances of this class from being copied (As this class contains pointers) */
50     NEPoolingLayer(const NEPoolingLayer &) = delete;
51     /** Prevent instances of this class from being copied (As this class contains pointers) */
52     NEPoolingLayer &operator=(const NEPoolingLayer &) = delete;
53     /** Prevent instances of this class from being moved (As this class contains non movable objects) */
54     NEPoolingLayer(NEPoolingLayer &&) = delete;
55     /** Prevent instances of this class from being moved (As this class contains non movable objects) */
56     NEPoolingLayer &operator=(NEPoolingLayer &&) = delete;
57     /** Default destructor */
58     ~NEPoolingLayer();
59     /** Set the input and output tensors.
60      *
61      * @note F16 is supported for pool sizes 2 and 3 only
62      *
63      * @param[in, out] input     Source tensor. (Written to only when padding != 0) Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32.
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 PoolingLayerInfo.
66      * @param[out]     indices   (optional) The indices of the maximal values. Data type supported: U32.
67      */
68     void configure(ITensor *input, ITensor *output, const PoolingLayerInfo &pool_info, ITensor *indices = nullptr);
69     /** Static function to check if given info will lead to a valid configuration of @ref NEPoolingLayer
70      *
71      * @note F16 is supported for pool sizes 2 and 3 only
72      *
73      * @param[in] input     Source tensor info. (Written to only when padding != 0) 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) Tensor info of 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() override;
84 
85 private:
86     std::unique_ptr<NEPoolingLayerKernel> _pooling_layer_kernel;
87     std::unique_ptr<NEFillBorderKernel>   _border_handler;
88     bool                                  _is_global_pooling_layer;
89     DataLayout                            _data_layout;
90 };
91 }
92 #endif /* ARM_COMPUTE_NEPOOLINGLAYER_H */
93