xref: /aosp_15_r20/external/ComputeLibrary/arm_compute/runtime/NEON/functions/NEFillBorder.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
1 /*
2  * Copyright (c) 2016-2021 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_NEFILLBORDER_H
25 #define ARM_COMPUTE_NEFILLBORDER_H
26 
27 #include "arm_compute/core/PixelValue.h"
28 #include "arm_compute/core/Types.h"
29 #include "arm_compute/runtime/IFunction.h"
30 #include <memory>
31 
32 namespace arm_compute
33 {
34 // Forward declaration
35 class ITensor;
36 class NEFillBorderKernel;
37 
38 /** Basic function to run @ref NEFillBorderKernel */
39 class NEFillBorder : public IFunction
40 {
41 public:
42     NEFillBorder();
43     /** Initialize the function's source, destination and border_mode.
44      *
45      * Valid data layouts:
46      * - All
47      *
48      * Valid data type configurations:
49      * |src            |dst            |
50      * |:--------------|:--------------|
51      * |All            |All            |
52      *
53      * @note This function fills the borders within the XY-planes.
54      *
55      * @param[in, out] input                 Source tensor. Data type supported: All
56      * @param[in]      border_width          Width of the tensor border in pixels.
57      * @param[in]      border_mode           Strategy to use for borders.
58      * @param[in]      constant_border_value (Optional) Constant value to use for borders if border_mode is set to CONSTANT.
59      */
60     void configure(ITensor *input, unsigned int border_width, BorderMode border_mode, const PixelValue &constant_border_value = PixelValue());
61 
62     // Inherited methods overridden:
63     void run() override;
64 
65 private:
66     std::unique_ptr<NEFillBorderKernel> _border_handler; /**< Kernel to handle image borders */
67 };
68 } // namespace arm_compute
69 #endif /*ARM_COMPUTE_NEFILLBORDER_H */
70