Compute Library
 21.05
ClFillKernel.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2018-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_KERNEL_H
25 #define ARM_COMPUTE_CL_FILL_KERNEL_H
26 
27 #include "src/core/common/Macros.h"
30 
31 namespace arm_compute
32 {
33 namespace opencl
34 {
35 namespace kernels
36 {
37 /** Interface for filling the planes of a tensor */
38 class ClFillKernel : public IClKernel
39 {
40 public:
41  ClFillKernel() = default;
43  /** Initialise the kernel's tensor and filling value
44  *
45  * @param[in,out] tensor Input tensor info. Supported data types: All.
46  * @param[in] constant_value The value used to fill the planes of the tensor
47  * @param[in] window Window to be used in case setting only part of a tensor. Default is nullptr.
48  */
49  void configure(ITensorInfo *tensor, const PixelValue &constant_value, Window *window = nullptr);
50  /** Initialise the kernel's tensor and filling value
51  *
52  * @param[in] compile_context The compile context to be used.
53  * @param[in,out] tensor Input tensor info. Supported data types: All.
54  * @param[in] constant_value The value used to fill the planes of the tensor
55  * @param[in] window Window to be used in case setting only part of a tensor. Default is nullptr.
56  */
57  void configure(const CLCompileContext &compile_context, ITensorInfo *tensor, const PixelValue &constant_value, Window *window = nullptr);
58  /** Static function to check if given info will lead to a valid configuration of @ref ClFillKernel
59  *
60  * @param[in] tensor Source tensor info. Data types supported: All.
61  * @param[in] constant_value The value used to fill the planes of the tensor
62  * @param[in] window Window to be used in case setting only part of a tensor. Default is nullptr.
63  *
64  * @return a status
65  */
66  static Status validate(const ITensorInfo *tensor, const PixelValue &constant_value, Window *window = nullptr);
67 
68  // Inherited methods overridden:
69  void run_op(ITensorPack &tensors, const Window &window, cl::CommandQueue &queue) override;
70 
71 private:
72  Window _full_window{};
73 };
74 } // namespace kernels
75 } // namespace opencl
76 } // namespace arm_compute
77 #endif /*ARM_COMPUTE_CLMEMSETRKERNEL_H */
Class describing the value of a pixel for any image format.
Definition: PixelValue.h:34
const Window & window() const
The maximum window the kernel can be executed on.
Definition: IKernel.cpp:28
Store the tensor's metadata.
Definition: ITensorInfo.h:40
Status class.
Definition: Error.h:52
Common interface for all the OpenCL kernels.
Definition: ICLKernel.h:46
Copyright (c) 2017-2021 Arm Limited.
static Status validate(const ITensorInfo *tensor, const PixelValue &constant_value, Window *window=nullptr)
Static function to check if given info will lead to a valid configuration of ClFillKernel.
void run_op(ITensorPack &tensors, const Window &window, cl::CommandQueue &queue) override
Enqueue the OpenCL kernel to process the given window on the passed OpenCL command queue.
CLCompileContext class.
void configure(ITensorInfo *tensor, const PixelValue &constant_value, Window *window=nullptr)
Initialise the kernel's tensor and filling value.
Tensor packing service.
Definition: ITensorPack.h:37
Interface for filling the planes of a tensor.
Definition: ClFillKernel.h:38
Describe a multidimensional execution window.
Definition: Window.h:39