xref: /aosp_15_r20/external/ComputeLibrary/src/core/NEON/kernels/NESpaceToDepthLayerKernel.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_NESPACETODEPTHLAYERKERNEL_H
25 #define ARM_COMPUTE_NESPACETODEPTHLAYERKERNEL_H
26 
27 #include "arm_compute/core/Types.h"
28 #include "src/core/NEON/INEKernel.h"
29 
30 namespace arm_compute
31 {
32 class ITensor;
33 
34 /** Interface for the space to depth kernel */
35 class NESpaceToDepthLayerKernel : public INEKernel
36 {
37 public:
name()38     const char *name() const override
39     {
40         return "NESpaceToDepthLayerKernel";
41     }
42     /** Default constructor */
43     NESpaceToDepthLayerKernel();
44     /** Prevent instances of this class from being copied (As this class contains pointers) */
45     NESpaceToDepthLayerKernel(const NESpaceToDepthLayerKernel &) = delete;
46     /** Prevent instances of this class from being copied (As this class contains pointers) */
47     NESpaceToDepthLayerKernel &operator=(const NESpaceToDepthLayerKernel &) = delete;
48     /** Allow instances of this class to be moved */
49     NESpaceToDepthLayerKernel(NESpaceToDepthLayerKernel &&) = default;
50     /** Allow instances of this class to be moved */
51     NESpaceToDepthLayerKernel &operator=(NESpaceToDepthLayerKernel &&) = default;
52     /** Default destructor */
53     ~NESpaceToDepthLayerKernel() = default;
54     /** Initialise the kernel's inputs and output.
55      *
56      * @param[in]  input       Tensor input. Supported tensor rank: 4. Data types supported: All.
57      * @param[out] output      Tensor output. Data types supported: same as @p input
58      * @param[in]  block_shape Block shape value
59      */
60     void configure(const ITensor *input, ITensor *output, int32_t block_shape);
61     /** Static function to check if given info will lead to a valid configuration of @ref NESpaceToDepthLayerKernel
62      *
63      * @param[in] input       Tensor input info. Supported tensor rank: 4. Data types supported: All.
64      * @param[in] output      Tensor output info. Data types supported: same as @p input
65      * @param[in] block_shape Block shape value
66      *
67      * @return a status
68      */
69     static Status validate(const ITensorInfo *input, const ITensorInfo *output, int32_t block_shape);
70 
71     // Inherited methods overridden:
72     void run(const Window &window, const ThreadInfo &info) override;
73 
74 private:
75     const ITensor *_input;       /**< Source tensor */
76     ITensor       *_output;      /**< Destination tensor */
77     int32_t        _block_shape; /**< Block shape */
78     DataLayout     _data_layout; /**< Data layout  of the operation */
79 };
80 } // namespace arm_compute
81 #endif /* ARM_COMPUTE_NESPACETODEPTHLAYERKERNEL_H */
82