Compute Library
 20.02.1
Window.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2016-2019 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_WINDOW_H
25 #define ARM_COMPUTE_WINDOW_H
26 
27 #include <algorithm>
28 #include <array>
29 #include <cstddef>
30 
32 #include "arm_compute/core/Error.h"
34 #include "arm_compute/core/Utils.h"
35 
36 namespace arm_compute
37 {
38 /** Describe a multidimensional execution window. */
39 class Window
40 {
41 public:
42  /** Alias for dimension 0 also known as X dimension */
43  static constexpr size_t DimX = 0;
44  /** Alias for dimension 1 also known as Y dimension */
45  static constexpr size_t DimY = 1;
46  /** Alias for dimension 2 also known as Z dimension */
47  static constexpr size_t DimZ = 2;
48 
49  /** Default constructor: create a window containing a single element. */
50  constexpr Window()
51  : _dims(), _is_broadcasted(utility::generate_array<bool, Coordinates::num_max_dimensions, false>::value)
52  {
53  }
54  /** Copy constructor
55  *
56  * @param[in] src Copy the values from src to a new object
57  */
58  Window(const Window &src);
59  /** Copy assignment operator
60  *
61  * @param[in] rhs Copy the values from rhs to the current object
62  *
63  * @return Reference to the updated object
64  */
65  Window &operator=(const Window &rhs);
66 
67  /** Describe one of the image's dimensions with a start, end and step.
68  *
69  * Iteration through the elements of the dimension is done like this:
70  * for(int v = start(); v < end(); v += step())
71  * {
72  * ...
73  * }
74  */
75  class Dimension
76  {
77  public:
78  /** Constructor, by default creates a dimension of 1.
79  *
80  * @param[in] start Start of the dimension
81  * @param[in] end End of the dimension
82  * @param[in] step Step between two elements of the dimension when iterating.
83  *
84  */
85  constexpr Dimension(int start = 0, int end = 1, int step = 1)
86  : _start(start), _end(end), _step(step)
87  {
88  }
89  /** Default assignment operator to allow dimensions to be copied */
90  Dimension &operator=(const Dimension &d) = default;
91  /** Return the start of the dimension */
92  constexpr int start() const
93  {
94  return _start;
95  }
96  /** Return the end of the dimension */
97  constexpr int end() const
98  {
99  return _end;
100  }
101  /** Return the step of the dimension */
102  constexpr int step() const
103  {
104  return _step;
105  }
106  /** Set the dimension's step
107  *
108  * @param[in] step The new step
109  */
110  void set_step(int step)
111  {
112  _step = step;
113  }
114  /** Set the dimension's end
115  *
116  * @param[in] end The new end
117  */
118  void set_end(int end)
119  {
120  _end = end;
121  }
122 
123  private:
124  int _start; /**< Start of the dimension */
125  int _end; /**< End of the dimension */
126  int _step;
127  };
128 
129  /** Read only access to a given dimension of the window
130  *
131  * @note Precondition: dimension < Coordinates::num_max_dimensions
132  *
133  * @param[in] dimension The dimension to access
134  *
135  * @return The requested dimension
136  */
137  constexpr const Dimension &operator[](size_t dimension) const;
138 
139  /** Alias to access the first dimension of the window
140  *
141  * @return First dimension of the window
142  */
143  constexpr const Dimension &x() const
144  {
145  return _dims.at(Window::DimX);
146  }
147 
148  /** Alias to access the second dimension of the window
149  *
150  * @return Second dimension of the window
151  */
152  constexpr const Dimension &y() const
153  {
154  return _dims.at(Window::DimY);
155  }
156 
157  /** Alias to access the third dimension of the window
158  *
159  * @return Third dimension of the window
160  */
161  constexpr const Dimension &z() const
162  {
163  return _dims.at(Window::DimZ);
164  }
165 
166  /** Set the values of a given dimension
167  *
168  * @param[in] dimension The dimension to set
169  * @param[in] dim The values to set the dimension to
170  */
171  void set(size_t dimension, const Dimension &dim);
172 
173  /** Set the dimension as broadcasted dimension
174  *
175  * @param[in] dimension The dimension to set
176  */
177  void set_broadcasted(size_t dimension);
178 
179  /** Return whether a dimension has been broadcasted
180  *
181  * @param[in] dimension The requested dimension
182  *
183  * @return true if the dimension has been broadcasted
184  */
185  bool is_broadcasted(size_t dimension) const;
186 
187  /** Use the tensor's dimensions to fill the window dimensions.
188  *
189  * @param[in] shape @ref TensorShape to copy the dimensions from.
190  * @param[in] first_dimension Only copy dimensions which are greater or equal to this value.
191  */
192  void use_tensor_dimensions(const TensorShape &shape, size_t first_dimension = Window::DimX);
193 
194  /** Shift the values of a given dimension by the given shift_value
195  *
196  * @param[in] dimension The dimension to shift
197  * @param[in] shift_value Value to shift the start and end values of.
198  */
199  void shift(size_t dimension, int shift_value);
200 
201  /** Shift down all the dimensions of a window
202  *
203  * i.e new_dims[n] = old_dims[n+shift_value].
204  *
205  * @param[in] shift_value Number of dimensions to shift the window by.
206  *
207  * @return The window with the shifted dimensions.
208  */
209  Window shift_dimensions(unsigned int shift_value) const;
210 
211  /** Adjust the start or end of a given dimension by the given value
212  *
213  * @param[in] dimension The dimension to adjust
214  * @param[in] adjust_value The adjusted value.
215  * @param[in] is_at_start The flag to indicate whether adjust the start or end of the dimension.
216  */
217  void adjust(size_t dimension, int adjust_value, bool is_at_start);
218 
219  /** Scale the values of a given dimension by the given scale_value
220  *
221  * @note The end of the window is rounded up to be a multiple of step after the scaling.
222  *
223  * @param[in] dimension The dimension to scale
224  * @param[in] scale_value Value to scale the start, end and step values of.
225  */
226  void scale(size_t dimension, float scale_value);
227 
228  /** Set the step of a given dimension.
229  *
230  * @param[in] dimension Dimension to update
231  * @param[in] step The new dimension's step value
232  */
233  void set_dimension_step(size_t dimension, int step);
234 
235  /** Will validate all the window's dimensions' values when asserts are enabled
236  *
237  * No-op when asserts are disabled
238  */
239  void validate() const;
240 
241  /** Return the number of iterations needed to iterate through a given dimension
242  *
243  * @param[in] dimension The requested dimension
244  *
245  * @return The number of iterations
246  */
247  constexpr size_t num_iterations(size_t dimension) const;
248  /** Return the total number of iterations needed to iterate through the entire window
249  *
250  * @return Number of total iterations
251  */
252  size_t num_iterations_total() const;
253  /** Return the shape of the window in number of steps */
254  TensorShape shape() const;
255  /** Split a window into a set of sub windows along a given dimension
256  *
257  * For example to split a window into 3 sub-windows along the Y axis, you would have to do:<br/>
258  * Window sub0 = window.split_window( 1, 0, 3);<br/>
259  * Window sub1 = window.split_window( 1, 1, 3);<br/>
260  * Window sub2 = window.split_window( 1, 2, 3);<br/>
261  *
262  * @param[in] dimension Dimension along which the split will be performed
263  * @param[in] id Id of the sub-window to return. Must be in the range (0, total-1)
264  * @param[in] total Total number of sub-windows the window will be split into.
265  *
266  * @return The subwindow "id" out of "total"
267  */
268  Window split_window(size_t dimension, size_t id, size_t total) const;
269  /** First 1D slice of the window
270  *
271  * @return The first slice of the window.
272  */
274  {
275  return first_slice_window<1>();
276  };
277  /** First 2D slice of the window
278  *
279  * @return The first slice of the window.
280  */
282  {
283  return first_slice_window<2>();
284  };
285  /** First 3D slice of the window
286  *
287  * @return The first slice of the window.
288  */
290  {
291  return first_slice_window<3>();
292  };
293  /** First 4D slice of the window
294  *
295  * @return The first slice of the window.
296  */
298  {
299  return first_slice_window<4>();
300  };
301  /** Slide the passed 1D window slice.
302  *
303  * If slice contains the last slice then it will remain unchanged and false will be returned.
304  *
305  * @param[in,out] slice Current slice, to be updated to the next slice.
306  *
307  * @return true if slice contains a new slice, false if slice already contained the last slice
308  */
310  {
311  return slide_window_slice<1>(slice);
312  }
313  /** Slide the passed 2D window slice.
314  *
315  * If slice contains the last slice then it will remain unchanged and false will be returned.
316  *
317  * @param[in,out] slice Current slice, to be updated to the next slice.
318  *
319  * @return true if slice contains a new slice, false if slice already contained the last slice
320  */
322  {
323  return slide_window_slice<2>(slice);
324  }
325  /** Slide the passed 3D window slice.
326  *
327  * If slice contains the last slice then it will remain unchanged and false will be returned.
328  *
329  * @param[in,out] slice Current slice, to be updated to the next slice.
330  *
331  * @return true if slice contains a new slice, false if slice already contained the last slice
332  */
334  {
335  return slide_window_slice<3>(slice);
336  }
337  /** Slide the passed 4D window slice.
338  *
339  * If slice contains the last slice then it will remain unchanged and false will be returned.
340  *
341  * @param[in,out] slice Current slice, to be updated to the next slice.
342  *
343  * @return true if slice contains a new slice, false if slice already contained the last slice
344  */
346  {
347  return slide_window_slice<4>(slice);
348  }
349 
350  /** Collapse the dimensions between @p first and @p last if possible.
351  *
352  * A dimension is collapsable if it starts from 0 and matches the corresponding dimension in the full_window
353  *
354  * @param[in] full_window Full window @p window has been created from.
355  * @param[in] first Start dimension into which the following are collapsed.
356  * @param[in] last End (exclusive) dimension to collapse.
357  * @param[out] has_collapsed (Optional) Whether the window was collapsed.
358  *
359  * @return Collapsed window.
360  */
361  Window collapse_if_possible(const Window &full_window, size_t first, size_t last, bool *has_collapsed = nullptr) const;
362 
363  /** Collapse the dimensions higher than @p first if possible.
364  *
365  * A dimension is collapsable if it starts from 0 and matches the corresponding dimension in the full_window
366  *
367  * @param[in] full_window Full window @p window has been created from.
368  * @param[in] first Start dimension into which the following are collapsed.
369  * @param[out] has_collapsed (Optional) Whether the window was collapsed.
370  *
371  * @return Collapsed window.
372  */
373  Window collapse_if_possible(const Window &full_window, size_t first, bool *has_collapsed = nullptr) const
374  {
375  return collapse_if_possible(full_window, first, Coordinates::num_max_dimensions, has_collapsed);
376  }
377 
378  /** Collapse the dimensions between @p first and @p last.
379  *
380  * A dimension is collapsable if it starts from 0 and matches the corresponding dimension in the full_window
381  *
382  * @param[in] full_window Full window @p window has been created from.
383  * @param[in] first Start dimension into which the following are collapsed.
384  * @param[in] last End (exclusive) dimension to collapse.
385  *
386  * @return Collapsed window if successful.
387  */
388  Window collapse(const Window &full_window, size_t first, size_t last = Coordinates::num_max_dimensions) const;
389 
390  /** Don't advance in the dimension where @p shape is less equal to 1.
391  *
392  * @param[in] shape A TensorShape.
393  *
394  * @return Broadcast window.
395  */
397 
398  /** Don't advance in the dimension where shape of @p info is less equal to 1.
399  *
400  * @param[in] info An ITensorInfo.
401  *
402  * @return Broadcast window.
403  */
405  {
406  return broadcast_if_dimension_le_one(info.tensor_shape());
407  }
408  /** Friend function that swaps the contents of two windows
409  *
410  * @param[in] lhs First window to swap.
411  * @param[in] rhs Second window to swap.
412  */
413  friend void swap(Window &lhs, Window &rhs);
414 
415 private:
416  /** First slice of the window
417  *
418  * @return The first slice of the window.
419  */
420  template <unsigned int window_dimension>
421  Window first_slice_window() const;
422 
423  /** Slide the passed window slice.
424  *
425  * If slice contains the last slice then it will remain unchanged and false will be returned.
426  *
427  * @param[in,out] slice Current slice, to be updated to the next slice.
428  *
429  * @return true if slice contains a new slice, false if slice already contained the last slice
430  */
431  template <unsigned int window_dimension>
432  bool slide_window_slice(Window &slice) const;
433 
434 private:
435  std::array<Dimension, Coordinates::num_max_dimensions> _dims;
436  std::array<bool, Coordinates::num_max_dimensions> _is_broadcasted;
437 };
438 } // namespace arm_compute
439 #include "Window.inl"
440 #endif /*ARM_COMPUTE_WINDOW_H */
Window first_slice_window_2D() const
First 2D slice of the window.
Definition: Window.h:281
void scale(size_t dimension, float scale_value)
Scale the values of a given dimension by the given scale_value.
Definition: Window.inl:155
Shape of a tensor.
Definition: TensorShape.h:39
void set_end(int end)
Set the dimension's end.
Definition: Window.h:118
void shift(size_t dimension, int shift_value)
Shift the values of a given dimension by the given shift_value.
Definition: Window.inl:133
constexpr int step() const
Return the step of the dimension.
Definition: Window.h:102
friend void swap(Window &lhs, Window &rhs)
Friend function that swaps the contents of two windows.
Definition: Window.inl:292
Store the tensor's metadata.
Definition: ITensorInfo.h:40
Window split_window(size_t dimension, size_t id, size_t total) const
Split a window into a set of sub windows along a given dimension.
Definition: Window.inl:189
Describe one of the image's dimensions with a start, end and step.
Definition: Window.h:75
void validate() const
Will validate all the window's dimensions' values when asserts are enabled.
Definition: Window.inl:173
constexpr const Dimension & z() const
Alias to access the third dimension of the window.
Definition: Window.h:161
constexpr size_t num_iterations(size_t dimension) const
Return the number of iterations needed to iterate through a given dimension.
Definition: Window.inl:182
void use_tensor_dimensions(const TensorShape &shape, size_t first_dimension=Window::DimX)
Use the tensor's dimensions to fill the window dimensions.
Definition: Window.inl:264
bool slide_window_slice_2D(Window &slice) const
Slide the passed 2D window slice.
Definition: Window.h:321
Copyright (c) 2017-2020 ARM Limited.
Window collapse(const Window &full_window, size_t first, size_t last=Coordinates::num_max_dimensions) const
Collapse the dimensions between first and last.
Definition: Window.inl:111
Dimension & operator=(const Dimension &d)=default
Default assignment operator to allow dimensions to be copied.
static constexpr size_t DimX
Alias for dimension 0 also known as X dimension.
Definition: Window.h:43
Window collapse_if_possible(const Window &full_window, size_t first, size_t last, bool *has_collapsed=nullptr) const
Collapse the dimensions between first and last if possible.
Definition: Window.inl:68
Coordinates of an item.
Definition: Coordinates.h:37
Window & operator=(const Window &rhs)
Copy assignment operator.
Definition: Window.inl:36
constexpr const Dimension & operator[](size_t dimension) const
Read only access to a given dimension of the window.
Definition: Window.inl:43
constexpr Window()
Default constructor: create a window containing a single element.
Definition: Window.h:50
void set_step(int step)
Set the dimension's step.
Definition: Window.h:110
void set(size_t dimension, const Dimension &dim)
Set the values of a given dimension.
Definition: Window.inl:49
Window broadcast_if_dimension_le_one(const TensorShape &shape) const
Don't advance in the dimension where shape is less equal to 1.
Definition: Window.inl:120
bool is_broadcasted(size_t dimension) const
Return whether a dimension has been broadcasted.
Definition: Window.inl:62
bool slide_window_slice_3D(Window &slice) const
Slide the passed 3D window slice.
Definition: Window.h:333
constexpr Dimension(int start=0, int end=1, int step=1)
Constructor, by default creates a dimension of 1.
Definition: Window.h:85
static constexpr size_t DimY
Alias for dimension 1 also known as Y dimension.
Definition: Window.h:45
void set_dimension_step(size_t dimension, int step)
Set the step of a given dimension.
Definition: Window.inl:167
static constexpr size_t DimZ
Alias for dimension 2 also known as Z dimension.
Definition: Window.h:47
Window collapse_if_possible(const Window &full_window, size_t first, bool *has_collapsed=nullptr) const
Collapse the dimensions higher than first if possible.
Definition: Window.h:373
constexpr const Dimension & y() const
Alias to access the second dimension of the window.
Definition: Window.h:152
Window broadcast_if_dimension_le_one(const ITensorInfo &info) const
Don't advance in the dimension where shape of info is less equal to 1.
Definition: Window.h:404
Window first_slice_window_4D() const
First 4D slice of the window.
Definition: Window.h:297
bool slide_window_slice_4D(Window &slice) const
Slide the passed 4D window slice.
Definition: Window.h:345
TensorShape shape() const
Return the shape of the window in number of steps.
Definition: Window.inl:272
constexpr int end() const
Return the end of the dimension.
Definition: Window.h:97
void adjust(size_t dimension, int adjust_value, bool is_at_start)
Adjust the start or end of a given dimension by the given value.
Definition: Window.inl:140
void set_broadcasted(size_t dimension)
Set the dimension as broadcasted dimension.
Definition: Window.inl:55
static constexpr size_t num_max_dimensions
Number of dimensions the tensor has.
Definition: Dimensions.h:45
Window first_slice_window_3D() const
First 3D slice of the window.
Definition: Window.h:289
bool slide_window_slice_1D(Window &slice) const
Slide the passed 1D window slice.
Definition: Window.h:309
constexpr int start() const
Return the start of the dimension.
Definition: Window.h:92
size_t num_iterations_total() const
Return the total number of iterations needed to iterate through the entire window.
Definition: Window.inl:282
Describe a multidimensional execution window.
Definition: Window.h:39
Window shift_dimensions(unsigned int shift_value) const
Shift down all the dimensions of a window.
Definition: Window.inl:101
Window first_slice_window_1D() const
First 1D slice of the window.
Definition: Window.h:273
cast configure & src
Definition: Cast.cpp:169
SimpleTensor< T > slice(const SimpleTensor< T > &src, Coordinates starts, Coordinates ends)
constexpr const Dimension & x() const
Alias to access the first dimension of the window.
Definition: Window.h:143