xref: /aosp_15_r20/external/ComputeLibrary/arm_compute/runtime/NEON/functions/NEMaxUnpoolingLayer.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
1 /*
2  * Copyright (c) 2020-2022 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_NEMAXUNPOOLINGLAYER_H
25 #define ARM_COMPUTE_NEMAXUNPOOLINGLAYER_H
26 
27 #include "arm_compute/core/Types.h"
28 #include "arm_compute/runtime/IFunction.h"
29 #include <memory>
30 
31 namespace arm_compute
32 {
33 class ITensor;
34 class ITensorInfo;
35 class NEFill;
36 
37 /** Function to perform MaxUnpooling. This function calls the following kernels:
38  *
39  * -# @ref NEFill
40  */
41 class NEMaxUnpoolingLayer : public IFunction
42 {
43 public:
44     /** Constructor */
45     NEMaxUnpoolingLayer();
46     /** Prevent instances of this class from being copied (As this class contains pointers) */
47     NEMaxUnpoolingLayer(const NEMaxUnpoolingLayer &) = delete;
48     /** Prevent instances of this class from being copied (As this class contains pointers) */
49     NEMaxUnpoolingLayer &operator=(const NEMaxUnpoolingLayer &) = delete;
50     /** Prevent instances of this class from being moved (As this class contains non movable objects) */
51     NEMaxUnpoolingLayer(NEMaxUnpoolingLayer &&) = delete;
52     /** Prevent instances of this class from being moved (As this class contains non movable objects) */
53     NEMaxUnpoolingLayer &operator=(NEMaxUnpoolingLayer &&) = delete;
54     /** Default destructor */
55     ~NEMaxUnpoolingLayer();
56     /** Set the input and output tensors.
57      *
58      * Valid data layouts:
59      * - NHWC
60      * - NCHW
61      *
62      * Valid data type configurations:
63      * |src            |dst            |
64      * |:--------------|:--------------|
65      * |QASYMM8        |QASYMM8        |
66      * |QASYMM8_SIGNED |QASYMM8_SIGNED |
67      * |F16            |F16            |
68      * |F32            |F32            |
69      *
70      * @note Only supported pool size 2
71      *
72      * @param[in, out] input     Source tensor. (Written to only when padding != 0) Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32.
73      * @param[out]     output    Destination tensor. Data types supported: Same as @p input.
74      * @param[out]     indices   The indices of the maximal values. Data type supported: U32.
75      * @param[in]      pool_info Contains pooling operation information described in @ref PoolingLayerInfo.
76      */
77     void configure(ITensor *input, ITensor *indices, ITensor *output, const PoolingLayerInfo &pool_info);
78     /** Static function to check if given info will lead to a valid configuration of @ref NEMaxUnpoolingLayer
79      *
80      * @note Only supported pool size 2
81      *
82      * @param[in] input     Source tensor. (Written to only when padding != 0) Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32.
83      * @param[in] indices   The indices of the maximal values. Data type supported: U32.
84      * @param[in] output    Destination tensor. Data types supported: Same as @p input.
85      * @param[in] pool_info Contains pooling operation information described in @ref PoolingLayerInfo.
86      *
87      * @return a status
88      */
89     static Status validate(const ITensorInfo *input, const ITensorInfo *indices, const ITensorInfo *output, const PoolingLayerInfo &pool_info);
90 
91     // Inherited methods overridden:
92     void run() override;
93 
94 private:
95     std::unique_ptr<NEFill> _fill_func;
96     struct Impl;
97     std::unique_ptr<Impl> _impl;
98 };
99 }
100 #endif /* ARM_COMPUTE_NEMAXUNPOOLINGLAYER_H */
101