xref: /aosp_15_r20/external/ComputeLibrary/src/cpu/operators/CpuMaxUnpooling.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
1 /*
2  * Copyright (c) 2021-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_CPU_MAXUNPOOLING_H
25 #define ARM_COMPUTE_CPU_MAXUNPOOLING_H
26 
27 #include "src/cpu/ICpuOperator.h"
28 
29 namespace arm_compute
30 {
31 namespace cpu
32 {
33 /** Basic function to run @ref kernels::CpuMaxUnpoolingLayerKernel */
34 class CpuMaxUnpooling : public ICpuOperator
35 {
36 public:
37     /** Configure operator for a given list of arguments
38      *
39      * @param[in]  src       Source tensor to permute. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32.
40      * @param[in]  indices   Tensor containing the offset to store the src elements in the dst tensor.
41      *                       @ref CpuMaxUnpooling with indices should precede this function in order to
42      *                       properly reconstruct the output tensor.
43      *                       The tensor shape of this tensor has to be equal to the src tensor shape. Data type supported: U32.
44      * @param[out] dst       Destination tensor. Data types supported: Same as @p src
45      * @param[in]  pool_info Contains pooling operation information described in @ref PoolingLayerInfo.
46      */
47     void configure(const ITensorInfo *src, const ITensorInfo *indices, ITensorInfo *dst, const PoolingLayerInfo &pool_info);
48     /** Static function to check if given info will lead to a valid configuration
49      *
50      * Similar to @ref CpuMaxUnpooling::configure()
51      *
52      * @return a status
53      */
54     static Status validate(const ITensorInfo *src, const ITensorInfo *indices, const ITensorInfo *dst, const PoolingLayerInfo &pool_info);
55 };
56 } // namespace cpu
57 } // namespace arm_compute
58 #endif /* ARM_COMPUTE_CPU_MAXUNPOOLING_H  */
59