xref: /aosp_15_r20/external/ComputeLibrary/src/core/CL/kernels/CLFillBorderKernel.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
1 /*
2  * Copyright (c) 2016-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_CLFILLBORDERKERNEL_H
25 #define ARM_COMPUTE_CLFILLBORDERKERNEL_H
26 
27 #include "arm_compute/core/PixelValue.h"
28 #include "arm_compute/core/Types.h"
29 #include "src/core/CL/ICLKernel.h"
30 
31 namespace arm_compute
32 {
33 class ICLTensor;
34 
35 /** Interface for filling the border of a kernel */
36 class CLFillBorderKernel : public ICLKernel
37 {
38 public:
39     /** Default constructor */
40     CLFillBorderKernel();
41     /** Prevent instances of this class from being copied (As this class contains pointers) */
42     CLFillBorderKernel(const CLFillBorderKernel &) = delete;
43     /** Prevent instances of this class from being copied (As this class contains pointers) */
44     CLFillBorderKernel &operator=(const CLFillBorderKernel &) = delete;
45     /** Allow instances of this class to be moved */
46     CLFillBorderKernel(CLFillBorderKernel &&) = default;
47     /** Allow instances of this class to be moved */
48     CLFillBorderKernel &operator=(CLFillBorderKernel &&) = default;
49     /** Default destructor */
50     ~CLFillBorderKernel() = default;
51 
52     /** Initialise the kernel's input, output and border mode.
53      *
54      * @param[in]     compile_context       The compile context to be used.
55      * @param[in,out] tensor                Tensor to process Data types supported: U8/QASYMM8/S8/QASYMM8_SIGNED/U16/S16/U32/S32/F16/F32.
56      * @param[in]     border_size           Size of the border to fill in elements.
57      * @param[in]     border_mode           Border mode to use for the convolution.
58      * @param[in]     constant_border_value (Optional) Constant value to use for borders if border_mode is set to CONSTANT.
59      */
60     void configure(const CLCompileContext &compile_context, ICLTensor *tensor, BorderSize border_size, BorderMode border_mode, const PixelValue &constant_border_value = PixelValue());
61     /** Initialise the kernel's input, output and border mode.
62      *
63      * @param[in,out] tensor                Tensor to process Data types supported: U8/QASYMM8/S8/QASYMM8_SIGNED/U16/S16/U32/S32/F16/F32.
64      * @param[in]     border_size           Size of the border to fill in elements.
65      * @param[in]     border_mode           Border mode to use for the convolution.
66      * @param[in]     constant_border_value (Optional) Constant value to use for borders if border_mode is set to CONSTANT.
67      */
68     void configure(ICLTensor *tensor, BorderSize border_size, BorderMode border_mode, const PixelValue &constant_border_value = PixelValue());
69     /** Initialise the kernel's input, output and border mode.
70      *
71      * @param[in]     compile_context       The compile context to be used.
72      * @param[in,out] tensor                Tensor to process Data types supported: U8/QASYMM8/S8/QASYMM8_SIGNED/U16/S16/U32/S32/F16/F32.
73      * @param[in]     border_size           Size of the border to fill in elements.
74      * @param[in]     border_mode           Border mode to use for the convolution.
75      * @param[in]     constant_border_value (Optional) Constant value to use for borders if border_mode is set to CONSTANT.
76      */
77     void configure(const CLCompileContext &compile_context, ITensorInfo *tensor, BorderSize border_size, BorderMode border_mode, const PixelValue &constant_border_value = PixelValue());
78 
79     /** Function to set the constant value on fill border kernel depending on type.
80      *
81      * @param[in] idx                   Index of the kernel argument to set.
82      * @param[in] constant_border_value Constant value to use for borders if border_mode is set to CONSTANT.
83      */
84     template <class T>
85     void set_constant_border(unsigned int idx, const PixelValue &constant_border_value);
86 
87     // Inherited methods overridden:
88     void run_op(ITensorPack &tensors, const Window &window, cl::CommandQueue &queue) override;
89     void run(const Window &window, cl::CommandQueue &queue) override;
90     bool is_parallelisable() const override;
91 
92 private:
93     ICLTensor *_tensor;
94 };
95 } // namespace arm_compute
96 #endif /*ARM_COMPUTE_CLFILLBORDERKERNEL_H */
97