Compute Library
 22.05
CLReorgLayerKernel.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_CLREORGLAYERKERNEL_H
25 #define ARM_COMPUTE_CLREORGLAYERKERNEL_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 /** OpenCL kernel to perform a reorg layer */
36 {
37 public:
38  /** Default constructor */
40  /** Prevent instances of this class from being copied (As this class contains pointers). */
41  CLReorgLayerKernel(const CLReorgLayerKernel &) = delete;
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  /** Initialize the kernel's input, output.
49  *
50  * @param[in] input Source tensor. Data types supported: All.
51  * @param[out] output Destination tensor with tensor shape:
52  * [width_input / stride, height_input / stride, channels_input * stride * stride, batch_size]. This means the output has
53  * the same number of input elements. Data types supported: same as @p input.
54  * @param[in] stride Stride value to use for reorganizing the values in the output tensor.
55  * It defines the spatial distance between 2 consecutive pixels in the x and y direction
56  */
57  void configure(const ICLTensor *input, ICLTensor *output, int32_t stride);
58  /** Initialize the kernel's input, output.
59  *
60  * @param[in] compile_context The compile context to be used.
61  * @param[in] input Source tensor. Data types supported: All.
62  * @param[out] output Destination tensor with tensor shape:
63  * [width_input / stride, height_input / stride, channels_input * stride * stride, batch_size]. This means the output has
64  * the same number of input elements. Data types supported: same as @p input.
65  * @param[in] stride Stride value to use for reorganizing the values in the output tensor.
66  * It defines the spatial distance between 2 consecutive pixels in the x and y direction
67  */
68  void configure(const CLCompileContext &compile_context, const ICLTensor *input, ICLTensor *output, int32_t stride);
69  /** Static function to check if given info will lead to a valid configuration of @ref CLReorgLayerKernel
70  *
71  * @param[in] input Source tensor. Data types supported: All.
72  * @param[in] output Destination tensor with tensor shape:
73  * [width_input / stride, height_input / stride, channels_input * stride * stride, batch_size]. This means the output has
74  * the same number of input elements. Data types supported: same as @p input. Data types supported: same as @p input.
75  * @param[in] stride Stride value to use for reorganizing the values in the output tensor
76  * It defines the spatial distance between 2 consecutive pixels in the x and y direction
77  *
78  * @return a status
79  */
80  static Status validate(const ITensorInfo *input, const ITensorInfo *output, int32_t stride);
81 
82  // Inherited methods overridden:
83  void run(const Window &window, cl::CommandQueue &queue) override;
84 
85 private:
86  const ICLTensor *_input;
87  ICLTensor *_output;
88 };
89 } // namespace arm_compute
90 #endif /*ARM_COMPUTE_CLREORGLAYERKERNEL_H */
const Window & window() const
The maximum window the kernel can be executed on.
Definition: IKernel.cpp:28
Store the tensor's metadata.
Definition: ITensorInfo.h:40
Status class.
Definition: Error.h:52
Common interface for all the OpenCL kernels.
Definition: ICLKernel.h:81
Copyright (c) 2017-2022 Arm Limited.
static Status validate(const ITensorInfo *input, const ITensorInfo *output, int32_t stride)
Static function to check if given info will lead to a valid configuration of CLReorgLayerKernel.
CLReorgLayerKernel & operator=(const CLReorgLayerKernel &)=delete
Prevent instances of this class from being copied (As this class contains pointers).
OpenCL kernel to perform a reorg layer.
CLCompileContext class.
void configure(const ICLTensor *input, ICLTensor *output, int32_t stride)
Initialize the kernel's input, output.
Interface for OpenCL tensor.
Definition: ICLTensor.h:42
void run(const Window &window, cl::CommandQueue &queue) override
Enqueue the OpenCL kernel to process the given window on the passed OpenCL command queue...
CLReorgLayerKernel()
Default constructor.
Describe a multidimensional execution window.
Definition: Window.h:39