Compute Library
 22.05
CLBatchToSpaceLayerKernel.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2018-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_CLBATCHTOSPACELAYERKERNEL_H
25 #define ARM_COMPUTE_CLBATCHTOSPACELAYERKERNEL_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 batch to space kernel */
36 {
37 public:
38  /** Default constructor */
40  /** Prevent instances of this class from being copied (As this class contains pointers) */
42  /** Prevent instances of this class from being copied (As this class contains pointers) */
44  /** Allow instances of this class to be moved */
46  /** Allow instances of this class to be moved */
48  /** Default destructor */
49  ~CLBatchToSpaceLayerKernel() = 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[in] block_shape 1-D tensor with shape [M]. Data types supported: S32
54  * @param[out] output Tensor output. Data types supported: same as @p input
55  */
56  void configure(const ICLTensor *input, const ICLTensor *block_shape, ICLTensor *output);
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[in] block_shape 1-D tensor with shape [M]. Data types supported: S32
62  * @param[out] output Tensor output. Data types supported: same as @p input
63  */
64  void configure(const CLCompileContext &compile_context, const ICLTensor *input, const ICLTensor *block_shape, ICLTensor *output);
65  /** Initialise the kernel's inputs and output (Static block shape).
66  *
67  * @param[in] input Tensor input. Supported tensor rank: 4. Data types supported: All.
68  * @param[in] block_shape_x Block shape x value.
69  * @param[in] block_shape_y Block shape y value.
70  * @param[out] output Tensor output. Data types supported: same as @p input
71  */
72  void configure(const ICLTensor *input, const int32_t block_shape_x, const int32_t block_shape_y, ICLTensor *output);
73  /** Initialise the kernel's inputs and output (Static block shape).
74  *
75  * @param[in] compile_context The compile context to be used.
76  * @param[in] input Tensor input. Supported tensor rank: 4. Data types supported: All.
77  * @param[in] block_shape_x Block shape x value.
78  * @param[in] block_shape_y Block shape y value.
79  * @param[out] output Tensor output. Data types supported: same as @p input
80  */
81  void configure(const CLCompileContext &compile_context, const ICLTensor *input, const int32_t block_shape_x, const int32_t block_shape_y, ICLTensor *output);
82  /** Static function to check if given info will lead to a valid configuration of @ref CLBatchToSpaceLayerKernel
83  *
84  * @param[in] input Tensor input. Supported tensor rank: 4. Data types supported: All.
85  * @param[in] block_shape 1-D tensor with shape [M]. Data types supported: S32
86  * @param[in] output Tensor output. Data types supported: same as @p input
87  *
88  * @return a status
89  */
90  static Status validate(const ITensorInfo *input, const ITensorInfo *block_shape, const ITensorInfo *output);
91  /** Static function to check if given info will lead to a valid configuration of @ref CLBatchToSpaceLayerKernel (Static block shape).
92  *
93  * @param[in] input Tensor input. Supported tensor rank: 4. Data types supported: All.
94  * @param[in] block_shape_x Block shape x value.
95  * @param[in] block_shape_y Block shape y value.
96  * @param[in] output Tensor output. Data types supported: same as @p input
97  *
98  * @return a status
99  */
100  static Status validate(const ITensorInfo *input, const int32_t block_shape_x, const int32_t block_shape_y, const ITensorInfo *output);
101 
102  // Inherited methods overridden:
103  void run(const Window &window, cl::CommandQueue &queue) override;
104 
105 private:
106  const ICLTensor *_input; /**< Source tensor */
107  const ICLTensor *_block_shape; /**< Block shape tensor */
108  ICLTensor *_output; /**< Destination tensor */
109 };
110 } // namespace arm_compute
111 #endif /* ARM_COMPUTE_CLBATCHTOSPACELAYERKERNEL_H */
Interface for the batch to space kernel.
const Window & window() const
The maximum window the kernel can be executed on.
Definition: IKernel.cpp:28
CLBatchToSpaceLayerKernel & operator=(const CLBatchToSpaceLayerKernel &)=delete
Prevent instances of this class from being copied (As this class contains pointers) ...
void run(const Window &window, cl::CommandQueue &queue) override
Enqueue the OpenCL kernel to process the given window on the passed OpenCL command queue...
Store the tensor&#39;s metadata.
Definition: ITensorInfo.h:40
Status class.
Definition: Error.h:52
static Status validate(const ITensorInfo *input, const ITensorInfo *block_shape, const ITensorInfo *output)
Static function to check if given info will lead to a valid configuration of CLBatchToSpaceLayerKerne...
Common interface for all the OpenCL kernels.
Definition: ICLKernel.h:81
Copyright (c) 2017-2022 Arm Limited.
~CLBatchToSpaceLayerKernel()=default
Default destructor.
CLCompileContext class.
Interface for OpenCL tensor.
Definition: ICLTensor.h:42
Describe a multidimensional execution window.
Definition: Window.h:39
void configure(const ICLTensor *input, const ICLTensor *block_shape, ICLTensor *output)
Initialise the kernel&#39;s inputs and output.