Compute Library
 21.02
AccessWindowStatic.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2017-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_IACCESS_WINDOW_STATIC_H
25 #define ARM_COMPUTE_IACCESS_WINDOW_STATIC_H
26 
30 #include "arm_compute/core/Types.h"
31 
32 #include <array>
33 
34 namespace arm_compute
35 {
36 class Window;
37 class ITensorInfo;
38 
39 /** Implementation of a static rectangular access pattern.
40  *
41  * In this implementation the access offsets and sizes are not relative to the
42  * current element. Instead they are considered to be absolute coordinates
43  * within the accessed tensor's shape.
44  *
45  * */
47 {
48 public:
49  /** Constructor for a static access pattern.
50  *
51  * @param[in,out] info Tensor info of the accessed kernel.
52  * @param[in] start_x Start of the access in X direction.
53  * @param[in] start_y Start of the access in Y direction.
54  * @param[in] end_x End of the access in X direction.
55  * @param[in] end_y End of the access in Y direction.
56  */
57  AccessWindowStatic(ITensorInfo *info, int start_x, int start_y, int end_x, int end_y);
58 
59  /** Prevent instances of this class from being copied (As this class contains pointers) */
60  AccessWindowStatic(const AccessWindowStatic &) = delete;
61  /** Prevent instances of this class from being copied (As this class contains pointers) */
63  /** Allow instances of this class to be move constructed */
65  /** Allow instances of this class to be moved */
67  /** Default destructor */
68  ~AccessWindowStatic() = default;
69 
70  /** Set the valid region based on the static access pattern and valid
71  * region of the inputs.
72  *
73  * @param[in] window Execution window of the kernel.
74  * @param[in] input_valid_region Combined valid region of all inputs.
75  */
76  void set_valid_region(const Window &window, const ValidRegion &input_valid_region);
77 
78  /** Compute the valid region based on the static access pattern and valid region of the inputs.
79  *
80  * @param[in] window Execution window of the kernel.
81  * @param[in] input_valid_region Combined valid region of all inputs.
82  *
83  * @return a valid region.
84  *
85  */
86  ValidRegion compute_valid_region(const Window &window, ValidRegion input_valid_region) const;
87 
88  // Inherited methods overriden:
89  bool update_window_if_needed(Window &window) const override;
90  bool update_padding_if_needed(const Window &window) override;
91  ValidRegion compute_valid_region(const Window &window, ValidRegion input_valid_region, bool border_undefined, BorderSize border_size) const override;
92 
93 private:
94  ITensorInfo *_info;
95  int _start_x;
96  int _start_y;
97  int _end_x;
98  int _end_y;
99 };
100 } // namespace arm_compute
101 #endif /*ARM_COMPUTE_IACCESS_WINDOW_STATIC_H*/
ValidRegion compute_valid_region(const Window &window, ValidRegion input_valid_region) const
Compute the valid region based on the static access pattern and valid region of the inputs...
Container for 2D border size.
Definition: Types.h:273
AccessWindowStatic & operator=(const AccessWindowStatic &)=delete
Prevent instances of this class from being copied (As this class contains pointers) ...
Store the tensor&#39;s metadata.
Definition: ITensorInfo.h:40
Copyright (c) 2017-2021 Arm Limited.
Implementation of a static rectangular access pattern.
bool update_padding_if_needed(const Window &window) override
Increase the padding to be large enough for the window.
bool update_window_if_needed(Window &window) const override
Shrink the window if padding is not large enough.
Interface describing methods to update access window and padding based on kernel parameters.
Definition: IAccessWindow.h:71
ScaleKernelInfo info(interpolation_policy, default_border_mode, PixelValue(), sampling_policy, false)
~AccessWindowStatic()=default
Default destructor.
AccessWindowStatic(ITensorInfo *info, int start_x, int start_y, int end_x, int end_y)
Constructor for a static access pattern.
Container for valid region of a window.
Definition: Types.h:188
Describe a multidimensional execution window.
Definition: Window.h:39
void set_valid_region(const Window &window, const ValidRegion &input_valid_region)
Set the valid region based on the static access pattern and valid region of the inputs.