Compute Library
 21.02
CLUnstack.cpp
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  */
25 
27 #include "arm_compute/core/Error.h"
29 #include "arm_compute/core/Types.h"
31 
32 namespace arm_compute
33 {
34 namespace
35 {
36 inline unsigned int wrap_axis(int axis, const ITensorInfo *const tensor)
37 {
38  return wrap_around(axis, static_cast<int>(tensor->num_dimensions()));
39 }
40 
41 inline void setup_slice_coordinates_and_mask(Coordinates &slice_start, int32_t &slice_end_mask, const unsigned int input_num_dimensions)
42 {
43  // Setups up coordinates to slice the input tensor: start coordinates to all 0s and the unstacking axis of both Start/End to slice just one 2d tensor at a time.
44  Coordinates slice_end;
45  slice_start.set_num_dimensions(input_num_dimensions);
46  slice_end.set_num_dimensions(input_num_dimensions);
47  for(size_t k = 0; k < input_num_dimensions; ++k)
48  {
49  slice_start.set(k, 0);
50  slice_end.set(k, -1);
51  }
53 }
54 } // namespace
55 
57  : _num_slices(0),
58  _strided_slice_vector()
59 {
60 }
61 
62 void CLUnstack::configure(const ICLTensor *input, const std::vector<ICLTensor *> &output_vector, int axis)
63 {
64  configure(CLKernelLibrary::get().get_compile_context(), input, output_vector, axis);
65 }
66 
67 void CLUnstack::configure(const CLCompileContext &compile_context, const ICLTensor *input, const std::vector<ICLTensor *> &output_vector, int axis)
68 {
69  std::vector<ITensorInfo *> outputs_vector_info(output_vector.size());
70  std::transform(output_vector.begin(), output_vector.end(), outputs_vector_info.begin(), [](ICLTensor * t)
71  {
73  return t->info();
74  });
75 
77  ARM_COMPUTE_ERROR_THROW_ON(CLUnstack::validate(input->info(), outputs_vector_info, axis));
78 
79  // Wrap around negative values
80  const unsigned int axis_u = wrap_axis(axis, input->info());
81  _num_slices = std::min(outputs_vector_info.size(), input->info()->dimension(axis_u));
82  _strided_slice_vector.resize(_num_slices);
83 
84  Coordinates slice_start;
85  int32_t slice_end_mask;
86  setup_slice_coordinates_and_mask(slice_start, slice_end_mask, input->info()->tensor_shape().num_dimensions());
87  for(unsigned int slice = 0; slice < _num_slices; ++slice)
88  {
89  // Adjusts start and end coordinates to take a 2D slice at a time
90  slice_start.set(axis_u, slice);
91  _strided_slice_vector[slice].configure(compile_context, input, output_vector[slice], slice_start, Coordinates(), BiStrides(), 0, slice_end_mask, (1 << axis_u));
92  }
93 }
94 
95 Status CLUnstack::validate(const ITensorInfo *input, const std::vector<ITensorInfo *> &output_vector, int axis)
96 {
98  ARM_COMPUTE_RETURN_ERROR_ON(output_vector.empty());
99  ARM_COMPUTE_RETURN_ERROR_ON(axis < (-static_cast<int>(input->tensor_shape().num_dimensions())));
100  ARM_COMPUTE_RETURN_ERROR_ON(axis >= static_cast<int>(input->tensor_shape().num_dimensions()));
101  const unsigned int num_slices = std::min(output_vector.size(), input->dimension(wrap_axis(axis, input)));
102  ARM_COMPUTE_RETURN_ERROR_ON(num_slices > input->dimension(wrap_axis(axis, input)));
103  ARM_COMPUTE_RETURN_ERROR_ON(num_slices > output_vector.size());
104  Coordinates slice_start;
105  int32_t slice_end_mask;
106  for(size_t k = 0; k < num_slices; ++k)
107  {
108  slice_start.set(wrap_axis(axis, input), k);
109  setup_slice_coordinates_and_mask(slice_start, slice_end_mask, input->tensor_shape().num_dimensions());
110  ARM_COMPUTE_RETURN_ON_ERROR(CLStridedSlice::validate(input, output_vector[k], slice_start, Coordinates(), BiStrides(), 0, slice_end_mask, (1 << wrap_axis(axis, input))));
111  }
112  return Status{};
113 }
114 
116 {
117  for(unsigned i = 0; i < _num_slices; ++i)
118  {
119  _strided_slice_vector[i].run();
120  }
121 }
122 
123 } // namespace arm_compute
void set(size_t dimension, T value, bool increase_dim_unit=true)
Accessor to set the value of one of the dimensions.
Definition: Dimensions.h:76
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
Coordinates BiStrides
Bidirectional strides.
Definition: Types.h:51
static CLKernelLibrary & get()
Access the KernelLibrary singleton.
Store the tensor&#39;s metadata.
Definition: ITensorInfo.h:40
#define ARM_COMPUTE_ERROR_THROW_ON(status)
Definition: Error.h:455
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
static Status validate(const ITensorInfo *input, const std::vector< ITensorInfo *> &output_vector, int axis)
Static function to check if given info will lead to a valid configuration of CLUnstack.
Definition: CLUnstack.cpp:95
Copyright (c) 2017-2021 Arm Limited.
int32_t construct_slice_end_mask(Coordinates ends)
Constructs end mask in case we want to perform a slice operation using the strided slice interface...
#define ARM_COMPUTE_RETURN_ERROR_ON_NULLPTR(...)
Definition: Validate.h:163
void configure(const ICLTensor *input, const std::vector< ICLTensor *> &output_vector, int axis)
Set the input, output and unstacking axis.
Definition: CLUnstack.cpp:62
T wrap_around(T x, T m)
Wrap-around a number within the range 0 <= x < m.
Definition: Helpers.h:231
virtual const TensorShape & tensor_shape() const =0
Size for each dimension of the tensor.
static Status validate(const ITensorInfo *input, const ITensorInfo *output, const Coordinates &starts, const Coordinates &ends, const BiStrides &strides, int32_t begin_mask=0, int32_t end_mask=0, int32_t shrink_axis_mask=0)
Static function to check if given info will lead to a valid configuration of CLStridedSlice.
CLUnstack()
Default constructor.
Definition: CLUnstack.cpp:56
Coordinates of an item.
Definition: Coordinates.h:37
virtual ITensorInfo * info() const =0
Interface to be implemented by the child class to return the tensor&#39;s metadata.
CLCompileContext class.
Interface for OpenCL tensor.
Definition: ICLTensor.h:42
void run() override
Run the kernels contained in the function.
Definition: CLUnstack.cpp:115
unsigned int num_dimensions() const
Returns the effective dimensionality of the tensor.
Definition: Dimensions.h:143
#define ARM_COMPUTE_ERROR_ON_NULLPTR(...)
Definition: Validate.h:161
SimpleTensor< T > slice(const SimpleTensor< T > &src, Coordinates starts, Coordinates ends)