Compute Library
 22.05
CLSpaceToBatchLayer.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2018-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_CLSPACETOBATCHLAYER_H
25 #define ARM_COMPUTE_CLSPACETOBATCHLAYER_H
26 
27 #include "arm_compute/core/Types.h"
31 
32 #include <memory>
33 
34 namespace arm_compute
35 {
36 class CLCompileContext;
37 class CLSpaceToBatchLayerKernel;
38 class ICLTensor;
39 class ITensorInfo;
40 
41 /** Basic function to spatial divide a tensor. This function calls the following OpenCL kernels/functions:
42  *
43  * -# @ref CLFill
44  * -# @ref CLSpaceToBatchLayerKernel
45  */
47 {
48 public:
49  /** Default constructor */
51  /** Prevent instances of this class from being copied (As this class contains pointers) */
52  CLSpaceToBatchLayer(const CLSpaceToBatchLayer &) = delete;
53  /** Prevent instances of this class from being copied (As this class contains pointers) */
55  /** Allow instances of this class to be moved */
57  /** Allow instances of this class to be moved */
59  /** Default destructor */
61  /** Set the input and output tensors.
62  *
63  * Valid data layouts:
64  * - NHWC
65  * - NCHW
66  *
67  * Valid data type configurations:
68  * |src0 |src1 |src2 |dst |
69  * |:---------|:---------|:---------|:---------|
70  * |All |S32 |S32 |All |
71  *
72  * @param[in] input Tensor input. Supported tensor rank: 4. Data types supported: All.
73  * @param[in] block_shape 1-D tensor with shape [M]. Supported M: 2. Data types supported: S32
74  * @param[in] paddings 2-D tensor with shape [2, M] (First dimension is the fastest-changing dimension). Supported M: 2. Data types supported: S32
75  * @param[out] output Tensor output. Data types supported: same as @p input
76  */
77  void configure(const ICLTensor *input, const ICLTensor *block_shape, const ICLTensor *paddings, ICLTensor *output);
78  /** Set the input and output tensors.
79  *
80  * @param[in] compile_context The compile context to be used.
81  * @param[in] input Tensor input. Supported tensor rank: 4. Data types supported: All.
82  * @param[in] block_shape 1-D tensor with shape [M]. Supported M: 2. Data types supported: S32
83  * @param[in] paddings 2-D tensor with shape [2, M] (First dimension is the fastest-changing dimension). Supported M: 2. Data types supported: S32
84  * @param[out] output Tensor output. Data types supported: same as @p input
85  */
86  void configure(const CLCompileContext &compile_context, const ICLTensor *input, const ICLTensor *block_shape, const ICLTensor *paddings, ICLTensor *output);
87  /** Set the input and output tensors. (Static block shape and paddings)
88  *
89  * @param[in] input Tensor input. Supported tensor rank: 4. Data types supported: All.
90  * @param[in] block_shape_x Block shape x value.
91  * @param[in] block_shape_y Block shape y value.
92  * @param[in] padding_left The padding at the beginning of every dimension of the output tensor.
93  * @param[in] padding_right The padding at the end of every dimension of the output tensor.
94  * @param[out] output Tensor output. Data types supported: same as @p input
95  */
96  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);
97  /** Set the input and output tensors. (Static block shape and paddings)
98  *
99  * @param[in] compile_context The compile context to be used.
100  * @param[in] input Tensor input. Supported tensor rank: 4. Data types supported: All.
101  * @param[in] block_shape_x Block shape x value.
102  * @param[in] block_shape_y Block shape y value.
103  * @param[in] padding_left The padding at the beginning of every dimension of the output tensor.
104  * @param[in] padding_right The padding at the end of every dimension of the output tensor.
105  * @param[out] output Tensor output. Data types supported: same as @p input
106  */
107  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,
108  ICLTensor *output);
109  /** Static function to check if given info will lead to a valid configuration of @ref CLSpaceToBatchLayer
110  *
111  * @param[in] input Tensor input info. Supported tensor rank: 4. Data types supported: All.
112  * @param[in] block_shape block shape tensor info with shape [M]. Supported M: 2. Data types supported: S32
113  * @param[in] paddings paddings tensor info with shape [2, M] (First dimension is the fastest-changing dimension). Supported M: 2. Data types supported: S32
114  * @param[out] output Tensor output info. Data types supported: same as @p input
115  *
116  * @return a status
117  */
118  static Status validate(const ITensorInfo *input, const ITensorInfo *block_shape, const ITensorInfo *paddings, const ITensorInfo *output);
119  /** Static function to check if given info will lead to a valid configuration of @ref CLSpaceToBatchLayer (Static block shape and paddings)
120  *
121  * @param[in] input Tensor input info. Supported tensor rank: 4. Data types supported: All.
122  * @param[in] block_shape_x Block shape x value.
123  * @param[in] block_shape_y Block shape y value.
124  * @param[in] padding_left The padding at the beginning of every dimension of the output tensor.
125  * @param[in] padding_right The padding at the end of every dimension of the output tensor.
126  * @param[out] output Tensor output info. Data types supported: same as @p input
127  *
128  * @return a status
129  */
130  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);
131 
132  // Inherited methods overridden:
133  void run() override;
134 
135 private:
136  std::unique_ptr<CLSpaceToBatchLayerKernel> _space_to_batch_kernel; /**< SpaceToBatch kernel to run */
137  CLFill _fill; /**< Fill function to run */
138  bool _has_padding; /**< Flag to check if the output has padding */
139 };
140 } // namespace arm_compute
141 #endif /* ARM_COMPUTE_CLSPACETOBATCHLAYER_H */
void configure(const ICLTensor *input, const ICLTensor *block_shape, const ICLTensor *paddings, ICLTensor *output)
Set the input and output tensors.
Base class for all functions.
Definition: IFunction.h:30
Store the tensor&#39;s metadata.
Definition: ITensorInfo.h:40
Status class.
Definition: Error.h:52
Copyright (c) 2017-2022 Arm Limited.
CLSpaceToBatchLayer & operator=(const CLSpaceToBatchLayer &)=delete
Prevent instances of this class from being copied (As this class contains pointers) ...
~CLSpaceToBatchLayer()
Default destructor.
CLSpaceToBatchLayer()
Default constructor.
CLCompileContext class.
Interface for OpenCL tensor.
Definition: ICLTensor.h:42
Basic function to spatial divide a tensor.
Class for specifying the size of an image or rectangle.
Definition: Size2D.h:34
void run() override
Run the kernels contained in the function.
Basic function to run opencl::kernels::ClFillKernel.
Definition: CLFill.h:38
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 CLSpaceToBatchLayer.