xref: /aosp_15_r20/external/ComputeLibrary/arm_compute/runtime/NEON/functions/NESpaceToDepthLayer.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_NESPACETODEPTHLAYER_H
25 #define ARM_COMPUTE_NESPACETODEPTHLAYER_H
26 
27 #include "arm_compute/core/Types.h"
28 #include "arm_compute/runtime/IFunction.h"
29 
30 #include <memory>
31 
32 namespace arm_compute
33 {
34 class ITensor;
35 class ITensorInfo;
36 class NESpaceToDepthLayerKernel;
37 
38 /** Basic function to run @ref NESpaceToDepthLayerKernel. */
39 class NESpaceToDepthLayer : public IFunction
40 {
41 public:
42     /** Default constructor */
43     NESpaceToDepthLayer();
44     /** Prevent instances of this class from being copied (As this class contains pointers) */
45     NESpaceToDepthLayer(const NESpaceToDepthLayer &) = delete;
46     /** Prevent instances of this class from being copied (As this class contains pointers) */
47     NESpaceToDepthLayer &operator=(const NESpaceToDepthLayer &) = delete;
48     /** Allow instances of this class to be moved */
49     NESpaceToDepthLayer(NESpaceToDepthLayer &&) = default;
50     /** Allow instances of this class to be moved */
51     NESpaceToDepthLayer &operator=(NESpaceToDepthLayer &&) = default;
52     /** Default destructor */
53     ~NESpaceToDepthLayer();
54     /** Set the input and output tensors.
55      *
56      * Valid data layouts:
57      * - NHWC
58      * - NCHW
59      *
60      * Valid data type configurations:
61      * |src            |dst            |
62      * |:--------------|:--------------|
63      * |All            |All            |
64      *
65      * @param[in]  input       Tensor input. Supported tensor rank: 4. Data types supported: All.
66      * @param[out] output      Tensor output. Data types supported: same as @p input
67      * @param[in]  block_shape Block shape value
68      */
69     void configure(const ITensor *input, ITensor *output, int32_t block_shape);
70     /** Static function to check if given info will lead to a valid configuration of @ref NESpaceToDepthLayer (Static block shape and paddings)
71      *
72      * @param[in] input       Tensor input info. Supported tensor rank: 4. Data types supported: All.
73      * @param[in] output      Tensor output info. Data types supported: same as @p input
74      * @param[in] block_shape Block shape value
75      *
76      * @return a status
77      */
78     static Status validate(const ITensorInfo *input, const ITensorInfo *output, int32_t block_shape);
79 
80     // Inherited methods overridden:
81     void run() override;
82 
83 private:
84     std::unique_ptr<NESpaceToDepthLayerKernel> _space_to_depth_kernel; /**< SpaceToDepth kernel to run */
85 };
86 } // namespace arm_compute
87 #endif /* ARM_COMPUTE_NESPACETODEPTHLAYER_H */
88