xref: /aosp_15_r20/external/ComputeLibrary/src/core/CL/kernels/CLPadLayerKernel.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
1 /*
2  * Copyright (c) 2019-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_CLPADLAYERKERNEL_H
25 #define ARM_COMPUTE_CLPADLAYERKERNEL_H
26 
27 #include "src/core/CL/ICLKernel.h"
28 
29 namespace arm_compute
30 {
31 class ICLTensor;
32 
33 /** Interface for the PadLayer function. */
34 class CLPadLayerKernel : public ICLKernel
35 {
36 public:
37     /** Default constructor */
38     CLPadLayerKernel();
39     /** Prevent instances of this class from being copied (As this class contains pointers) */
40     CLPadLayerKernel(const CLPadLayerKernel &) = delete;
41     /** Prevent instances of this class from being copied (As this class contains pointers) */
42     CLPadLayerKernel &operator=(const CLPadLayerKernel &) = delete;
43     /** Allow instances of this class to be moved */
44     CLPadLayerKernel(CLPadLayerKernel &&) = default;
45     /** Allow instances of this class to be moved */
46     CLPadLayerKernel &operator=(CLPadLayerKernel &&) = default;
47     /** Default destructor */
48     ~CLPadLayerKernel() = default;
49     /** Set the input and output tensor.
50      *
51      * @param[in]  input          Source tensor. Data types supported: All.
52      * @param[out] output         Output tensor. Data type supported: same as @p input
53      * @param[in]  padding        The padding for each spatial dimension of the input tensor. The pair padding[i]
54      *                            specifies the front and the end padding in the i-th dimension.
55      * @param[in]  constant_value (Optional) Constant value to be used for the padding.
56      * @param[in]  mode           (Optional) Controls whether the padding should be filled with @p constant_value using CONSTANT,
57      *                            or reflect the input, either including the border values (SYMMETRIC) or not (REFLECT).
58      */
59     void configure(const ICLTensor *input, ICLTensor *output, const PaddingList &padding, PixelValue constant_value = PixelValue(), PaddingMode mode = PaddingMode::CONSTANT);
60     /** Set the input and output tensor.
61      *
62      * @param[in]  compile_context The compile context to be used.
63      * @param[in]  input           Source tensor. Data types supported: All.
64      * @param[out] output          Output tensor. Data type supported: same as @p input
65      * @param[in]  padding         The padding for each spatial dimension of the input tensor. The pair padding[i]
66      *                             specifies the front and the end padding in the i-th dimension.
67      * @param[in]  constant_value  (Optional) Constant value to be used for the padding.
68      * @param[in]  mode            (Optional) Controls whether the padding should be filled with @p constant_value using CONSTANT,
69      *                             or reflect the input, either including the border values (SYMMETRIC) or not (REFLECT).
70      */
71     void configure(const CLCompileContext &compile_context, const ICLTensor *input, ICLTensor *output, const PaddingList &padding, PixelValue constant_value = PixelValue(),
72                    PaddingMode mode = PaddingMode::CONSTANT);
73     /** Static function to check if given info will lead to a valid configuration of @ref CLPadLayerKernel
74      *
75      * @param[in] input          Source tensor info. Data types supported: All.
76      * @param[in] output         Output tensor info. Data type supported: same as @p input
77      * @param[in] padding        The padding for each spatial dimension of the input tensor. The pair padding[i]
78      *                           specifies the front and the end padding in the i-th dimension.
79      * @param[in] constant_value (Optional) Constant value to be used for the padding.
80      * @param[in] mode           (Optional) Controls whether the padding should be filled with @p constant_value using CONSTANT,
81      *                            or reflect the input, either including the border values (SYMMETRIC) or not (REFLECT).
82      */
83     static Status validate(const ITensorInfo *input, const ITensorInfo *output, const PaddingList &padding, PixelValue constant_value = PixelValue(), PaddingMode mode = PaddingMode::CONSTANT);
84 
85     // Inherited methods overridden:
86     void run(const Window &window, cl::CommandQueue &queue) override;
87 
88 private:
89     const ICLTensor *_input;
90     ICLTensor       *_output;
91     bool             _4d_enabled;
92 };
93 } // namespace arm_compute
94 #endif /*ARM_COMPUTE_CLPADLAYERKERNEL_H */
95