xref: /aosp_15_r20/external/ComputeLibrary/arm_compute/runtime/CL/functions/CLSpaceToDepthLayer.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_CLSPACETODEPTHLAYER_H
25 #define ARM_COMPUTE_CLSPACETODEPTHLAYER_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 CLCompileContext;
35 class CLSpaceToDepthLayerKernel;
36 class ICLTensor;
37 class ITensorInfo;
38 
39 /** Basic function to run @ref CLSpaceToDepthLayerKernel. */
40 class CLSpaceToDepthLayer : public IFunction
41 {
42 public:
43     /** Default constructor */
44     CLSpaceToDepthLayer();
45     /** Prevent instances of this class from being copied */
46     CLSpaceToDepthLayer(const CLSpaceToDepthLayer &) = delete;
47     /** Prevent instances of this class from being copied */
48     CLSpaceToDepthLayer &operator=(const CLSpaceToDepthLayer &) = delete;
49     /** Prevent instances of this class to be moved */
50     CLSpaceToDepthLayer(CLSpaceToDepthLayer &&) = delete;
51     /** Prevent instances of this class to be moved */
52     CLSpaceToDepthLayer &operator=(CLSpaceToDepthLayer &&) = delete;
53     /** Default destructor */
54     ~CLSpaceToDepthLayer();
55     /** Set the input and output tensors.
56      *
57      * Valid data layouts:
58      * - NHWC
59      * - NCHW
60      *
61      * Valid data type configurations:
62      * |src            |dst            |
63      * |:--------------|:--------------|
64      * |All            |All            |
65      *
66      * @param[in]  input       Tensor input. Supported tensor rank: 4. Data types supported: All.
67      * @param[out] output      Tensor output. Data types supported: same as @p input
68      * @param[in]  block_shape Block shape value.
69      */
70     void configure(const ICLTensor *input, ICLTensor *output, int32_t block_shape);
71     /** Set the input and output tensors.
72      *
73      * @param[in]  compile_context The compile context to be used.
74      * @param[in]  input           Tensor input. Supported tensor rank: 4. Data types supported: All.
75      * @param[out] output          Tensor output. Data types supported: same as @p input
76      * @param[in]  block_shape     Block shape value.
77      */
78     void configure(const CLCompileContext &compile_context, const ICLTensor *input, ICLTensor *output, int32_t block_shape);
79     /** Static function to check if given info will lead to a valid configuration of @ref CLSpaceToDepthLayer.
80      *
81      * @param[in] input       Tensor input info. Supported tensor rank: 4. Data types supported: All.
82      * @param[in] output      Tensor output info. Data types supported: same as @p input
83      * @param[in] block_shape Block shape value.
84      *
85      * @return a status
86      */
87     static Status validate(const ITensorInfo *input, const ITensorInfo *output, int32_t block_shape);
88 
89     // Inherited methods overridden:
90     void run() override;
91 
92 private:
93     std::unique_ptr<CLSpaceToDepthLayerKernel> _space_to_depth_kernel; /**< CLSpaceToDepthLayerKernel to run */
94 };
95 } // namespace arm_compute
96 #endif /* ARM_COMPUTE_CLSPACETODEPTHLAYER_H */
97