Compute Library
 21.11
CLSpaceToBatchLayerKernel.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_CLSPACETOBATCHLAYERKERNEL_H
25 #define ARM_COMPUTE_CLSPACETOBATCHLAYERKERNEL_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 space to batch 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  ~CLSpaceToBatchLayerKernel() = 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]. Supported M: 2. Data types supported: S32
54  * @param[in] paddings 2-D tensor with shape [2, M] (First dimension is the fastest-changing dimension). Supported M: 2. Data types supported: S32
55  * @param[out] output Tensor output. Data types supported: same as @p input
56  */
57  void configure(const ICLTensor *input, const ICLTensor *block_shape, const ICLTensor *paddings, ICLTensor *output);
58  /** Initialise the kernel's inputs and output.
59  *
60  * @param[in] compile_context The compile context to be used.
61  * @param[in] input Tensor input. Supported tensor rank: 4. Data types supported: All.
62  * @param[in] block_shape 1-D tensor with shape [M]. Supported M: 2. Data types supported: S32
63  * @param[in] paddings 2-D tensor with shape [2, M] (First dimension is the fastest-changing dimension). Supported M: 2. Data types supported: S32
64  * @param[out] output Tensor output. Data types supported: same as @p input
65  */
66  void configure(const CLCompileContext &compile_context, const ICLTensor *input, const ICLTensor *block_shape, const ICLTensor *paddings, ICLTensor *output);
67  /** Initialise the kernel's input and output. (Static block shape and paddings)
68  *
69  * @param[in] input Tensor input. Supported tensor rank: 4. Data types supported: All.
70  * @param[in] block_shape_x Block shape x value.
71  * @param[in] block_shape_y Block shape y value.
72  * @param[in] padding_left The padding at the beginning of every dimension of the output tensor.
73  * @param[in] padding_right The padding at the end of every dimension of the output tensor.
74  * @param[out] output Tensor output. Data types supported: same as @p input
75  */
76  void configure(const ICLTensor *input, const int block_shape_x, const int block_shape_y, const Size2D &padding_left, const Size2D &padding_right, ICLTensor *output);
77  /** Initialise the kernel's input and output. (Static block shape and paddings)
78  *
79  * @param[in] compile_context The compile context to be used.
80  * @param[in] input Tensor input. Supported tensor rank: 4. Data types supported: All.
81  * @param[in] block_shape_x Block shape x value.
82  * @param[in] block_shape_y Block shape y value.
83  * @param[in] padding_left The padding at the beginning of every dimension of the output tensor.
84  * @param[in] padding_right The padding at the end of every dimension of the output tensor.
85  * @param[out] output Tensor output. Data types supported: same as @p input
86  */
87  void configure(const CLCompileContext &compile_context, const ICLTensor *input, const int block_shape_x, const int block_shape_y, const Size2D &padding_left, const Size2D &padding_right,
88  ICLTensor *output);
89  /** Static function to check if given info will lead to a valid configuration of @ref CLSpaceToBatchLayerKernel
90  *
91  * @param[in] input Tensor input. Supported tensor rank: 4. Data types supported: All.
92  * @param[in] block_shape 1-D tensor with shape [M]. Supported M: 2. Data types supported: S32
93  * @param[in] paddings 2-D tensor with shape [2, M] (First dimension is the fastest-changing dimension). Supported M: 2. Data types supported: S32
94  * @param[in] output Tensor output. Data types supported: same as @p input
95  *
96  * @return a status
97  */
98  static Status validate(const ITensorInfo *input, const ITensorInfo *block_shape, const ITensorInfo *paddings, const ITensorInfo *output);
99  /** Static function to check if given info will lead to a valid configuration of @ref CLSpaceToBatchLayerKernel (Static block shape and paddings)
100  *
101  * @param[in] input Tensor input. Supported tensor rank: 4. Data types supported: All.
102  * @param[in] block_shape_x Block shape x value.
103  * @param[in] block_shape_y Block shape y value.
104  * @param[in] padding_left The padding at the beginning of every dimension of the output tensor.
105  * @param[in] padding_right The padding at the end of every dimension of the output tensor.
106  * @param[in] output Tensor output. Data types supported: same as @p input
107  *
108  * @return a status
109  */
110  static Status validate(const ITensorInfo *input, const int block_shape_x, const int block_shape_y, const Size2D &padding_left, const Size2D &padding_right, const ITensorInfo *output);
111 
112  // Inherited methods overridden:
113  void run(const Window &window, cl::CommandQueue &queue) override;
114 
115 private:
116  const ICLTensor *_input; /**< Source tensor */
117  const ICLTensor *_block_shape; /**< Block shape tensor for dynamic evaluation */
118  const ICLTensor *_paddings; /**< Paddings tensor for dynamic evaluation */
119  ICLTensor *_output; /**< Destination tensor */
120 };
121 } // namespace arm_compute
122 #endif /* ARM_COMPUTE_CLSPACETOBATCHLAYERKERNEL_H */
const Window & window() const
The maximum window the kernel can be executed on.
Definition: IKernel.cpp:28
Store the tensor&#39;s metadata.
Definition: ITensorInfo.h:40
void run(const Window &window, cl::CommandQueue &queue) override
Enqueue the OpenCL kernel to process the given window on the passed OpenCL command queue...
Status class.
Definition: Error.h:52
Common interface for all the OpenCL kernels.
Definition: ICLKernel.h:68
Copyright (c) 2017-2021 Arm Limited.
Interface for the space to batch kernel.
~CLSpaceToBatchLayerKernel()=default
Default destructor.
CLSpaceToBatchLayerKernel & operator=(const CLSpaceToBatchLayerKernel &)=delete
Prevent instances of this class from being copied (As this class contains pointers) ...
CLCompileContext class.
Interface for OpenCL tensor.
Definition: ICLTensor.h:42
Class for specifying the size of an image or rectangle.
Definition: Size2D.h:34
void configure(const ICLTensor *input, const ICLTensor *block_shape, const ICLTensor *paddings, ICLTensor *output)
Initialise the kernel&#39;s inputs and output.
Describe a multidimensional execution window.
Definition: Window.h:39
static Status validate(const ITensorInfo *input, const ITensorInfo *block_shape, const ITensorInfo *paddings, const ITensorInfo *output)
Static function to check if given info will lead to a valid configuration of CLSpaceToBatchLayerKerne...