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