xref: /aosp_15_r20/external/ComputeLibrary/src/gpu/cl/operators/ClFill.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
1 /*
2  * Copyright (c) 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_CL_FILL_H
25 #define ARM_COMPUTE_CL_FILL_H
26 
27 #include "arm_compute/core/Window.h"
28 #include "src/gpu/cl/ClCompileContext.h"
29 #include "src/gpu/cl/IClOperator.h"
30 
31 namespace arm_compute
32 {
33 namespace opencl
34 {
35 /** Basic function to run @ref kernels::ClFillKernel */
36 class ClFill : public IClOperator
37 {
38 public:
39     /** Initialise the kernel's tensor and filling value
40      *
41      * @param[in]     compile_context The compile context to be used.
42      * @param[in,out] tensor          Source tensor info. Supported data types: All.
43      * @param[in]     constant_value  The value used to fill the planes of the tensor
44      * @param[in]     window          Window to be used in case setting only part of a tensor. Default is nullptr.
45      */
46     void configure(const CLCompileContext &compile_context, ITensorInfo *tensor, const PixelValue &constant_value, Window *window = nullptr);
47     /** Static function to check if given info will lead to a valid configuration
48      *
49      * Similar to ClFill::configure()
50      *
51      * @return a status
52      */
53     static Status validate(const ITensorInfo *tensor, const PixelValue &constant_value, Window *window = nullptr);
54 };
55 } // namespace opencl
56 } // namespace arm_compute
57 #endif /* ARM_COMPUTE_CL_FILL_H */
58