Compute Library
 21.05
ClFill.h
Go to the documentation of this file.
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 
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  /** Constructor */
40  ClFill() = default;
41  /** Initialise the kernel's tensor and filling value
42  *
43  * @param[in] compile_context The compile context to be used.
44  * @param[in,out] tensor Source tensor info. Supported data types: All.
45  * @param[in] constant_value The value used to fill the planes of the tensor
46  * @param[in] window Window to be used in case setting only part of a tensor. Default is nullptr.
47  */
48  void configure(const CLCompileContext &compile_context, ITensorInfo *tensor, const PixelValue &constant_value, Window *window = nullptr);
49  /** Static function to check if given info will lead to a valid configuration of @ref kernels::ClFillKernel
50  *
51  * @param[in] tensor Source tensor info. Data types supported: All.
52  * @param[in] constant_value The value used to fill the planes of the tensor.
53  * @param[in] window Window to be used in case setting only part of a tensor. Default is nullptr.
54  *
55  * @return a status
56  */
57  static Status validate(const ITensorInfo *tensor, const PixelValue &constant_value, Window *window = nullptr);
58 };
59 } // namespace opencl
60 } // namespace arm_compute
61 #endif /* ARM_COMPUTE_CL_FILL_H */
Class describing the value of a pixel for any image format.
Definition: PixelValue.h:34
Basic function to run kernels::ClFillKernel.
Definition: ClFill.h:36
void configure(const CLCompileContext &compile_context, ITensorInfo *tensor, const PixelValue &constant_value, Window *window=nullptr)
Initialise the kernel's tensor and filling value.
Definition: ClFill.cpp:33
Store the tensor's metadata.
Definition: ITensorInfo.h:40
Status class.
Definition: Error.h:52
Copyright (c) 2017-2021 Arm Limited.
CLCompileContext class.
ClFill()=default
Constructor.
Basic interface for functions which have a single async CL kernel.
Definition: ICLOperator.h:41
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 kernels::ClFillKernel.
Definition: ClFill.cpp:40
Describe a multidimensional execution window.
Definition: Window.h:39