xref: /aosp_15_r20/external/ComputeLibrary/src/core/AccessWindowAutoPadding.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
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_ACCESS_WINDOW_AUTO_PADDING_H
25 #define ARM_COMPUTE_ACCESS_WINDOW_AUTO_PADDING_H
26 
27 #include "arm_compute/core/Coordinates.h"
28 #include "arm_compute/core/IAccessWindow.h"
29 #include "arm_compute/core/TensorShape.h"
30 #include "arm_compute/core/Types.h"
31 
32 namespace arm_compute
33 {
34 class Window;
35 class ITensorInfo;
36 
37 /** Dummy access window.
38  *
39  * This implementation always uses the auto padding of the tensor info and
40  * never updates the window. The valid region is always set to cover the entire
41  * tensor.
42  *
43  * @note This access window is only used during the migration to the new
44  *       padding system. It will be removed once all kernels have been ported.
45  *
46  * */
47 class AccessWindowAutoPadding : public IAccessWindow
48 {
49 public:
50     /** Default constructor.
51      *
52      * @param[in,out] info Tensor info of the accessed kernel.
53      */
54     AccessWindowAutoPadding(ITensorInfo *info);
55     /** Prevent instances of this class from being copied (As this class contains pointers) */
56     AccessWindowAutoPadding(const AccessWindowAutoPadding &) = delete;
57     /** Prevent instances of this class from being copied (As this class contains pointers) */
58     AccessWindowAutoPadding &operator=(const AccessWindowAutoPadding &) = delete;
59     /** Allow instances of this class to be move constructed */
60     AccessWindowAutoPadding(AccessWindowAutoPadding &&) = default;
61     /** Allow instances of this class to be moved */
62     AccessWindowAutoPadding &operator=(AccessWindowAutoPadding &&) = default;
63     /** Default destructor */
64     ~AccessWindowAutoPadding() = default;
65 
66     /** Set the valid region to match the entire tensor. */
67     void set_valid_region();
68 
69     /** Return a valid region that spans across the entire tensor.
70      *
71      * @return a valid region.
72      *
73      */
74     ValidRegion compute_valid_region() const;
75 
76     // Inherited methods overridden:
77     bool update_window_if_needed(Window &window) const override;
78     bool update_padding_if_needed(const Window &window) override;
79     ValidRegion compute_valid_region(const Window &window, ValidRegion input_valid_region, bool border_undefined, BorderSize border_size) const override;
80 
81 private:
82     ITensorInfo *_info;
83 };
84 } // namespace arm_compute
85 #endif /*ARM_COMPUTE_ACCESS_WINDOW_AUTO_PADDING_H*/
86