Compute Library
 21.02
NEDepthToSpaceLayerKernel.cpp
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2019-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  */
25 
28 #include "arm_compute/core/Types.h"
34 
35 #include <arm_neon.h>
36 #include <cstdint>
37 
39 
40 namespace arm_compute
41 {
42 namespace
43 {
44 Status validate_arguments(const ITensorInfo *input, const ITensorInfo *output, int32_t block_shape)
45 {
47  ARM_COMPUTE_RETURN_ERROR_ON(input->data_type() == DataType::UNKNOWN);
48  ARM_COMPUTE_RETURN_ERROR_ON(input->num_dimensions() > 4);
49  ARM_COMPUTE_RETURN_ERROR_ON(block_shape < 2);
50 
51  const DataLayout data_layout = input->data_layout();
52  const int idx_channel = get_data_layout_dimension_index(data_layout, DataLayoutDimension::CHANNEL);
53  ARM_COMPUTE_RETURN_ERROR_ON(input->tensor_shape()[idx_channel] % (block_shape * block_shape) != 0);
54  // Validate output if initialized
55  if(output->total_size() != 0)
56  {
59  ARM_COMPUTE_RETURN_ERROR_ON(output->tensor_shape()[idx_width] != (block_shape * input->tensor_shape()[idx_width]));
60  ARM_COMPUTE_RETURN_ERROR_ON(output->tensor_shape()[idx_height] != (block_shape * input->tensor_shape()[idx_height]));
61  ARM_COMPUTE_RETURN_ERROR_ON(output->num_dimensions() > 4);
63  }
64 
65  return Status{};
66 }
67 } // namespace
68 
70  : _input(nullptr), _output(nullptr), _block_shape(), _data_layout(DataLayout::UNKNOWN)
71 {
72 }
73 
74 void NEDepthToSpaceLayerKernel::configure(const ITensor *input, ITensor *output, int32_t block_shape)
75 {
76  ARM_COMPUTE_ERROR_ON_NULLPTR(input, output);
78  // Output auto inizialitation if not yet initialized
79  auto_init_if_empty(*output->info(), input->info()->clone()->set_tensor_shape(output_shape));
80 
81  // Perform validation step
82  ARM_COMPUTE_ERROR_THROW_ON(validate_arguments(input->info(), output->info(), block_shape));
83 
84  _input = input;
85  _output = output;
86  _block_shape = block_shape;
87  _data_layout = input->info()->data_layout();
88 
89  // Configure kernel window
90  Window win = calculate_max_window(*input->info(), Steps());
91  ICPPKernel::configure(win);
92 }
93 
94 Status NEDepthToSpaceLayerKernel::validate(const ITensorInfo *input, const ITensorInfo *output, int32_t block_shape)
95 {
97  ARM_COMPUTE_RETURN_ON_ERROR(validate_arguments(input, output, block_shape));
98  return Status{};
99 }
100 
102 {
103  ARM_COMPUTE_UNUSED(info);
106 
107  const int idx_channel = get_data_layout_dimension_index(_data_layout, DataLayoutDimension::CHANNEL);
108  const int depth_size = _input->info()->dimension(idx_channel);
109  const int r = (depth_size / (_block_shape * _block_shape));
110  const int element_size = _input->info()->element_size();
111 
112  Window slice_out = window.first_slice_window_3D();
113 
114  // The slice_out slice does not move
115  slice_out.set(Window::DimX, Window::Dimension(0, 0, 0));
116  slice_out.set(Window::DimY, Window::Dimension(0, 0, 0));
117  slice_out.set(Window::DimZ, Window::Dimension(0, 0, 0));
118 
119  // Main loop for NCHW and NHWC
120  if(_data_layout == DataLayout::NCHW)
121  {
122  Window slice_in = window.first_slice_window_2D();
123  do
124  {
125  Iterator in(_input, slice_in);
126  execute_window_loop(slice_in, [&](const Coordinates & id)
127  {
128  const int x = id.x();
129  const int y = id.y();
130 
131  const int z = id.z() % r;
132  const int out_x = x * _block_shape + (id.z() / r) % _block_shape;
133  const int out_y = y * _block_shape + (id.z() / r) / _block_shape;
134  Coordinates output_coords{ out_x, out_y, z, id[3] };
135  memcpy(_output->ptr_to_element(output_coords), in.ptr(), element_size);
136  },
137  in);
138  }
139  while(window.slide_window_slice_2D(slice_in));
140  }
141  else
142  {
143  Window slice_in = window.first_slice_window_3D();
144  do
145  {
146  Iterator in(_input, slice_in);
147  execute_window_loop(slice_in, [&](const Coordinates & id)
148  {
149  const int x = id.y();
150  const int y = id.z();
151 
152  const int z = id.x() % r;
153  const int out_x = x * _block_shape + (id.x() / r) % _block_shape;
154  const int out_y = y * _block_shape + (id.x() / r) / _block_shape;
155  Coordinates output_coords{ z, out_x, out_y, id[3] };
156  memcpy(_output->ptr_to_element(output_coords), in.ptr(), element_size);
157  },
158  in);
159  }
160  while(window.slide_window_slice_3D(slice_in));
161  }
162 }
163 } // namespace arm_compute
Window first_slice_window_2D() const
First 2D slice of the window.
Definition: Window.h:283
Window calculate_max_window(const ValidRegion &valid_region, const Steps &steps, bool skip_border, BorderSize border_size)
const Window & window() const
The maximum window the kernel can be executed on.
Definition: IKernel.cpp:28
uint8_t * ptr_to_element(const Coordinates &id) const
Return a pointer to the element at the passed coordinates.
Definition: ITensor.h:63
Shape of a tensor.
Definition: TensorShape.h:39
TensorShape compute_depth_to_space_shape(const TensorShape &input_shape, DataLayout data_layout, int block)
Calculate the depth to space output shape of a tensor.
virtual size_t dimension(size_t index) const =0
Return the size of the requested dimension.
#define ARM_COMPUTE_RETURN_ON_ERROR(status)
Checks if a status contains an error and returns it.
Definition: Error.h:204
const DataLayout data_layout
Definition: Im2Col.cpp:151
Store the tensor&#39;s metadata.
Definition: ITensorInfo.h:40
#define ARM_COMPUTE_ERROR_THROW_ON(status)
Definition: Error.h:455
Describe one of the image&#39;s dimensions with a start, end and step.
Definition: Window.h:77
Status class.
Definition: Error.h:52
#define ARM_COMPUTE_RETURN_ERROR_ON(cond)
If the condition is true, an error is returned.
Definition: Error.h:296
Interface for Neon tensor.
Definition: ITensor.h:36
bool slide_window_slice_2D(Window &slice) const
Slide the passed 2D window slice.
Definition: Window.h:323
Copyright (c) 2017-2021 Arm Limited.
#define ARM_COMPUTE_RETURN_ERROR_ON_NULLPTR(...)
Definition: Validate.h:163
void configure(const ITensor *input, ITensor *output, int32_t block_shape)
Initialise the kernel&#39;s inputs and output.
static constexpr size_t DimX
Alias for dimension 0 also known as X dimension.
Definition: Window.h:43
#define ARM_COMPUTE_UNUSED(...)
To avoid unused variables warnings.
Definition: Error.h:152
virtual const TensorShape & tensor_shape() const =0
Size for each dimension of the tensor.
Class to describe a number of elements in each dimension.
Definition: Steps.h:40
Coordinates of an item.
Definition: Coordinates.h:37
bool auto_init_if_empty(ITensorInfo &info, const TensorShape &shape, int num_channels, DataType data_type, QuantizationInfo quantization_info=QuantizationInfo())
Auto initialize the tensor info (shape, number of channels and data type) if the current assignment i...
virtual std::unique_ptr< T > clone() const =0
Provide a clone of the current object of class T.
virtual ITensorInfo * info() const =0
Interface to be implemented by the child class to return the tensor&#39;s metadata.
constexpr uint8_t * ptr() const
Return a pointer to the current pixel.
Definition: Helpers.inl:139
virtual size_t element_size() const =0
Element size in bytes calculated as data_size() * num_channels()
void set(size_t dimension, const Dimension &dim)
Set the values of a given dimension.
Definition: Window.inl:49
void run(const Window &window, const ThreadInfo &info) override
Execute the kernel on the passed window.
bool slide_window_slice_3D(Window &slice) const
Slide the passed 3D window slice.
Definition: Window.h:335
#define ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL(k)
Definition: Validate.h:941
Num samples, channels, height, width.
static constexpr size_t DimY
Alias for dimension 1 also known as Y dimension.
Definition: Window.h:45
ScaleKernelInfo info(interpolation_policy, default_border_mode, PixelValue(), sampling_policy, false)
Information about executing thread and CPU.
Definition: CPPTypes.h:235
static constexpr size_t DimZ
Alias for dimension 2 also known as Z dimension.
Definition: Window.h:47
#define ARM_COMPUTE_RETURN_ERROR_ON_MISMATCHING_DATA_TYPES(...)
Definition: Validate.h:545
constexpr const Dimension & y() const
Alias to access the second dimension of the window.
Definition: Window.h:154
Status validate_arguments(const ITensorInfo *input, const ITensorInfo *bias, const ITensorInfo *output, const GEMMLowpOutputStageInfo *output_stage)
#define ARM_COMPUTE_ERROR_ON_NULLPTR(...)
Definition: Validate.h:161
void execute_window_loop(const Window &w, L &&lambda_function, Ts &&... iterators)
Iterate through the passed window, automatically adjusting the iterators and calling the lambda_funct...
Definition: Helpers.inl:77
Includes all wrapper headers at once.
size_t get_data_layout_dimension_index(const DataLayout data_layout, const DataLayoutDimension data_layout_dimension)
Get the index of the given dimension.
Definition: Helpers.inl:193
static Status validate(const ITensorInfo *input, const ITensorInfo *output, int32_t block_shape)
Static function to check if given info will lead to a valid configuration of NEDepthToSpaceLayerKerne...
Iterator updated by execute_window_loop for each window element.
Definition: Helpers.h:46
Window first_slice_window_3D() const
First 3D slice of the window.
Definition: Window.h:291
DataLayout
[DataLayout enum definition]
Definition: Types.h:120
Describe a multidimensional execution window.
Definition: Window.h:39
#define ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW(f, s)
Definition: Validate.h:205
virtual DataLayout data_layout() const =0
Get the data layout of the tensor.
constexpr const Dimension & x() const
Alias to access the first dimension of the window.
Definition: Window.h:145