• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (c) 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_NEMAXUNPOOLINGLAYERKERNEL_H
25 #define ARM_COMPUTE_NEMAXUNPOOLINGLAYERKERNEL_H
26 
27 #include "src/core/NEON/INEKernel.h"
28 
29 namespace arm_compute
30 {
31 class ITensor;
32 
33 /** Interface for the pooling layer kernel */
34 class NEMaxUnpoolingLayerKernel : public INEKernel
35 {
36 public:
name()37     const char *name() const override
38     {
39         return "NEMaxUnpoolingLayerKernel";
40     }
41     /** Default constructor */
42     NEMaxUnpoolingLayerKernel();
43     /** Prevent instances of this class from being copied (As this class contains pointers) */
44     NEMaxUnpoolingLayerKernel(const NEMaxUnpoolingLayerKernel &) = delete;
45     /** Prevent instances of this class from being copied (As this class contains pointers) */
46     NEMaxUnpoolingLayerKernel &operator=(const NEMaxUnpoolingLayerKernel &) = delete;
47     /** Allow instances of this class to be moved */
48     NEMaxUnpoolingLayerKernel(NEMaxUnpoolingLayerKernel &&) = default;
49     /** Allow instances of this class to be moved */
50     NEMaxUnpoolingLayerKernel &operator=(NEMaxUnpoolingLayerKernel &&) = default;
51     /** Default destructor */
52     ~NEMaxUnpoolingLayerKernel() = default;
53     /** Set the input and output tensors.
54      *
55      * @note Output shape must be equal to the shape of the original input to pool.
56      *
57      * @param[in]  input     Source tensor. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32.
58      * @param[in]  indices   Tensor containing the offset to store the input elements in the output tensor.
59      *                       @ref NEPoolingLayerKernel with indices should precede this function in order to
60      *                       properly reconstruct the output tensor.
61      *                       The tensor shape of this tensor has to be equal to the input tensor shape. Data type supported: U32.
62      * @param[out] output    Destination tensor. Data types supported: Same as @p input.
63      * @param[in]  pool_info Contains pooling operation information described in @ref PoolingLayerInfo.
64      */
65     void configure(const ITensor *input, const ITensor *indices, ITensor *output, const PoolingLayerInfo &pool_info);
66     /** Static function to check if given info will lead to a valid configuration of @ref NEMaxUnpoolingLayerKernel
67      *
68      * @param[in] input     Source tensor info. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32.
69      * @param[in] output    Destination tensor info. Data types supported: Same as @p input.
70      * @param[in] indices   Tensor info of the indices of the maximal values. Data type supported: U32.
71      * @param[in] pool_info Contains pooling operation information described in @ref PoolingLayerInfo.
72      *
73      * @return a status
74      */
75     static Status validate(const ITensorInfo *input, const ITensorInfo *indices, const ITensorInfo *output, const PoolingLayerInfo &pool_info);
76 
77     // Inherited methods overridden:
78     void run(const Window &window, const ThreadInfo &info) override;
79 
80 private:
81     /** Function to perform 2x2 pooling and compute the pooling indices. The indices can be used for max unpool.
82      *
83      * @param[in] window_input Input region on which to execute the kernel.
84      */
85     template <typename T>
86     void unpooling2(const Window &window_input);
87 
88     using UnpoolingFunction = void (NEMaxUnpoolingLayerKernel::*)(const Window &window);
89 
90 private:
91     UnpoolingFunction _func;
92     const ITensor    *_input;
93     ITensor          *_output;
94     const ITensor    *_indices;
95 };
96 } // namespace arm_compute
97 #endif /*ARM_COMPUTE_NEMAXUNPOOLINGLAYERKERNEL_H */
98