xref: /aosp_15_r20/external/ComputeLibrary/src/core/NEON/kernels/NEBatchToSpaceLayerKernel.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
1 /*
2  * Copyright (c) 2019-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_NEBATCHTOSPACELAYERKERNEL_H
25 #define ARM_COMPUTE_NEBATCHTOSPACELAYERKERNEL_H
26 
27 #include "src/core/NEON/INEKernel.h"
28 
29 namespace arm_compute
30 {
31 class ITensor;
32 
33 /** Interface for the batch to space kernel */
34 class NEBatchToSpaceLayerKernel : public INEKernel
35 {
36 public:
name()37     const char *name() const override
38     {
39         return "NEBatchToSpaceLayerKernel";
40     }
41     /** Default constructor */
42     NEBatchToSpaceLayerKernel();
43     /** Prevent instances of this class from being copied (As this class contains pointers) */
44     NEBatchToSpaceLayerKernel(const NEBatchToSpaceLayerKernel &) = delete;
45     /** Prevent instances of this class from being copied (As this class contains pointers) */
46     NEBatchToSpaceLayerKernel &operator=(const NEBatchToSpaceLayerKernel &) = delete;
47     /** Allow instances of this class to be moved */
48     NEBatchToSpaceLayerKernel(NEBatchToSpaceLayerKernel &&) = default;
49     /** Allow instances of this class to be moved */
50     NEBatchToSpaceLayerKernel &operator=(NEBatchToSpaceLayerKernel &&) = default;
51     /** Default destructor */
52     ~NEBatchToSpaceLayerKernel() = default;
53     /** Initialise the kernel's inputs and output.
54      *
55      * @param[in]  input       Tensor input. Supported tensor rank: 4. Data types supported: All.
56      * @param[in]  block_shape 1-D tensor with shape [M]. Data types supported: S32
57      * @param[out] output      Tensor output. Data types supported: same as @p input
58      */
59     void configure(const ITensor *input, const ITensor *block_shape, ITensor *output);
60     /** Initialise the kernel's inputs and output (Static block shape).
61      *
62      * @param[in]  input         Tensor input. Supported tensor rank: 4. Data types supported: All.
63      * @param[in]  block_shape_x Block shape x value.
64      * @param[in]  block_shape_y Block shape y value.
65      * @param[out] output        Tensor output. Data types supported: same as @p input
66      */
67     void configure(const ITensor *input, const int32_t block_shape_x, const int32_t block_shape_y, ITensor *output);
68     /** Static function to check if given info will lead to a valid configuration of @ref NEBatchToSpaceLayerKernel
69      *
70      * @param[in] input       Tensor input. Supported tensor rank: 4. Data types supported: All.
71      * @param[in] block_shape 1-D tensor with shape [M]. Data types supported: S32
72      * @param[in] output      Tensor output. Data types supported: same as @p input
73      *
74      * @return a status
75      */
76     static Status validate(const ITensorInfo *input, const ITensorInfo *block_shape, const ITensorInfo *output);
77     /** Static function to check if given info will lead to a valid configuration of @ref NEBatchToSpaceLayerKernel (Static block shape).
78      *
79      * @param[in] input         Tensor input. Supported tensor rank: 4. Data types supported: All.
80      * @param[in] block_shape_x Block shape x value.
81      * @param[in] block_shape_y Block shape y value.
82      * @param[in] output        Tensor output. Data types supported: same as @p input
83      *
84      * @return a status
85      */
86     static Status validate(const ITensorInfo *input, const int32_t block_shape_x, const int32_t block_shape_y, const ITensorInfo *output);
87 
88     // Inherited methods overridden:
89     void run(const Window &window, const ThreadInfo &info) override;
90 
91 private:
92     const ITensor *_input;       /**< Source tensor */
93     const ITensor *_block_shape; /**< Block shape tensor */
94     ITensor       *_output;      /**< Destination tensor */
95     DataLayout     _data_layout; /**< Data layout to  be used at run-time */
96 
97     int32_t _block_shape_x;
98     int32_t _block_shape_y;
99 };
100 } // namespace arm_compute
101 #endif /* ARM_COMPUTE_NEBATCHTOSPACELAYERKERNEL_H */
102