xref: /aosp_15_r20/external/ComputeLibrary/arm_compute/runtime/NEON/functions/NEBatchToSpaceLayer.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
1 /*
2  * Copyright (c) 2019-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_NEBATCHTOSPACELAYER_H
25 #define ARM_COMPUTE_NEBATCHTOSPACELAYER_H
26 
27 #include "arm_compute/runtime/IFunction.h"
28 
29 #include "arm_compute/core/Types.h"
30 #include "arm_compute/runtime/NEON/INESimpleFunctionNoBorder.h"
31 
32 namespace arm_compute
33 {
34 class ITensor;
35 class ITensorInfo;
36 
37 /** Basic function to run @ref NEBatchToSpaceLayerKernel. */
38 class NEBatchToSpaceLayer : public INESimpleFunctionNoBorder
39 {
40 public:
41     /** Constructor */
42     NEBatchToSpaceLayer() = default;
43     /** Prevent instances of this class from being copied (As this class contains pointers) */
44     NEBatchToSpaceLayer(const NEBatchToSpaceLayer &) = delete;
45     /** Prevent instances of this class from being copied (As this class contains pointers) */
46     NEBatchToSpaceLayer &operator=(const NEBatchToSpaceLayer &) = delete;
47     /** Prevent instances of this class from being moved (As this class contains non movable objects) */
48     NEBatchToSpaceLayer(NEBatchToSpaceLayer &&) = delete;
49     /** Prevent instances of this class from being moved (As this class contains non movable objects) */
50     NEBatchToSpaceLayer &operator=(NEBatchToSpaceLayer &&) = delete;
51     /** Default destructor */
52     ~NEBatchToSpaceLayer() = default;
53     /** Set the input and output tensors.
54      *
55      * Valid data layouts:
56      * - NHWC
57      * - NCHW
58      *
59      * Valid data type configurations:
60      * |src0      |src1      |dst        |
61      * |:---------|:---------|:----------|
62      * |All       |s32       |All        |
63      *
64      * @param[in]  input       Tensor input. Supported tensor rank: 4. Data types supported: All.
65      * @param[in]  block_shape 1-D tensor with shape [M]. Data types supported: S32
66      * @param[out] output      Tensor output. Data types supported: same as @p input
67      */
68     void configure(const ITensor *input, const ITensor *block_shape, ITensor *output);
69     /** Set the input and output tensors. (Static block shape).
70      *
71      * @param[in]  input         Tensor input. Supported tensor rank: 4. Data types supported: All.
72      * @param[in]  block_shape_x Block shape x value.
73      * @param[in]  block_shape_y Block shape y value.
74      * @param[out] output        Tensor output. Data types supported: same as @p input
75      */
76     void configure(const ITensor *input, int32_t block_shape_x, int32_t block_shape_y, ITensor *output);
77     /** Static function to check if given info will lead to a valid configuration of @ref CLBatchToSpaceLayer
78      *
79      * @param[in]  input       Tensor input info. Supported tensor rank: 4. Data types supported: All.
80      * @param[in]  block_shape block shape tensor info with shape [M]. Data types supported: S32
81      * @param[out] output      Tensor output info. Data types supported: same as @p input
82      *
83      * @return a status
84      */
85     static Status validate(const ITensorInfo *input, const ITensorInfo *block_shape, const ITensorInfo *output);
86     /** Static function to check if given info will lead to a valid configuration of @ref CLBatchToSpaceLayer (Static block shape).
87      *
88      * @param[in]  input         Tensor input info. Supported tensor rank: 4. Data types supported: All.
89      * @param[in]  block_shape_x Block shape x value.
90      * @param[in]  block_shape_y Block shape y value.
91      * @param[out] output        Tensor output info. Data types supported: same as @p input
92      *
93      * @return a status
94      */
95     static Status validate(const ITensorInfo *input, int32_t block_shape_x, int32_t block_shape_y, const ITensorInfo *output);
96 };
97 } // namespace arm_compute
98 #endif /* ARM_COMPUTE_NEBATCHTOSPACELAYER_H */
99