xref: /aosp_15_r20/external/ComputeLibrary/src/core/NEON/kernels/NEReorgLayerKernel.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
1 /*
2  * Copyright (c) 2018-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_NEREORGLAYERKERNEL_H
25 #define ARM_COMPUTE_NEREORGLAYERKERNEL_H
26 
27 #include "src/core/NEON/INEKernel.h"
28 
29 namespace arm_compute
30 {
31 // Forward declarations
32 class ITensor;
33 
34 /** Interface for the kernel to perform tensor re-organization */
35 class NEReorgLayerKernel : public INEKernel
36 {
37 public:
name()38     const char *name() const override
39     {
40         return "NEReorgLayerKernel";
41     }
42     /** Default constructor */
43     NEReorgLayerKernel();
44     /** Prevent instances of this class from being copied (As this class contains pointers) */
45     NEReorgLayerKernel(const NEReorgLayerKernel &) = delete;
46     /** Prevent instances of this class from being copied (As this class contains pointers) */
47     NEReorgLayerKernel &operator=(const NEReorgLayerKernel &) = delete;
48     /** Default Move Constructor. */
49     NEReorgLayerKernel(NEReorgLayerKernel &&) = default;
50     /** Default move assignment operator */
51     NEReorgLayerKernel &operator=(NEReorgLayerKernel &&) = default;
52     /** Default destructor */
53     ~NEReorgLayerKernel() = default;
54     /** Set the input and output of the kernel
55      *
56      * @param[in]  input  Source tensor. Data type supported: All
57      * @param[out] output Destination tensor. Data type supported: Same as @p input
58      * @param[in]  stride Stride to be used during data re-organization.
59      *                    It defines the spatial distance between 2 consecutive pixels in the x and y direction
60      */
61     void configure(const ITensor *input, ITensor *output, int32_t stride);
62 
63     /** Static function to check if given info will lead to a valid configuration of @ref cpu::kernels::CpuReshapeKernel
64      *
65      * @param[in] input  Source tensor info. Data type supported: All
66      * @param[in] output Destination tensor info. Data type supported: Same as @p input
67      * @param[in] stride Stride to be used during data re-organization
68      *                   It defines the spatial distance between 2 consecutive pixels in the x and y direction
69      *
70      * @return a status
71      */
72     static Status validate(const ITensorInfo *input, const ITensorInfo *output, int32_t stride);
73 
74     // Inherited methods overridden:
75     void run(const Window &window, const ThreadInfo &info) override;
76 
77 private:
78     const ITensor *_input;
79     ITensor       *_output;
80     int32_t        _stride;
81 };
82 } // namespace arm_compute
83 #endif /*ARM_COMPUTE_NEREORGLAYERKERNEL_H */
84