Compute Library
 22.05
CLReorgLayer.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_CLREORGLAYER_H
25 #define ARM_COMPUTE_CLREORGLAYER_H
26 
27 #include "arm_compute/core/Types.h"
29 
30 namespace arm_compute
31 {
32 class CLCompileContext;
33 class ICLTensor;
34 class ITensorInfo;
35 
37 {
38 public:
39  /** Initialise the function's source and destination.
40  *
41  * Valid data layouts:
42  * - NHWC
43  * - NCHW
44  *
45  * Valid data type configurations:
46  * |src |dst |
47  * |:--------------|:--------------|
48  * |All |All |
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  */
58  void configure(ICLTensor *input, ICLTensor *output, int32_t stride);
59  /** Initialise the function's source and destination.
60  *
61  * @param[in] compile_context The compile context to be used.
62  * @param[in] input Source tensor. Data types supported: All.
63  * @param[out] output Destination tensor with tensor shape:
64  * [width_input / stride, height_input / stride, channels_input * stride * stride, batch_size]. This means the output has
65  * the same number of input elements. Data types supported: same as @p input.
66  * @param[in] stride Stride value to use for reorganizing the values in the output tensor.
67  * It defines the spatial distance between 2 consecutive pixels in the x and y direction
68  *
69  */
70  void configure(const CLCompileContext &compile_context, ICLTensor *input, ICLTensor *output, int32_t stride);
71  /** Static function to check if given info will lead to a valid configuration of @ref CLReorgLayer
72  *
73  * @param[in] input Source tensor. Data types supported: All.
74  * @param[in] output Destination tensor with tensor shape:
75  * [width_input / stride, height_input / stride, channels_input * stride * stride, batch_size]. This means the output has
76  * the same number of input elements. Data types supported: same as @p input. Data types supported: same as @p input.
77  * @param[in] stride Stride value to use for reorganizing the values in the output tensor
78  * It defines the spatial distance between 2 consecutive pixels in the x and y direction
79  *
80  * @return a status
81  */
82  static Status validate(const ITensorInfo *input, const ITensorInfo *output, int32_t stride);
83 };
84 } // namespace arm_compute
85 #endif /*ARM_COMPUTE_CLREORGLAYER_H */
Store the tensor's metadata.
Definition: ITensorInfo.h:40
Status class.
Definition: Error.h:52
void configure(ICLTensor *input, ICLTensor *output, int32_t stride)
Initialise the function's source and destination.
Copyright (c) 2017-2022 Arm Limited.
Basic interface for functions which have a single OpenCL kernel.
CLCompileContext class.
Interface for OpenCL tensor.
Definition: ICLTensor.h:42
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 CLReorgLayer.