Compute Library
 22.02
ICLSimpleFunction.h
Go to the documentation of this file.
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_ICLSIMPLEFUNCTION_H
25 #define ARM_COMPUTE_ICLSIMPLEFUNCTION_H
26 
28 
29 #include <memory>
30 
31 namespace arm_compute
32 {
33 // Forward declarations
34 class CLRuntimeContext;
35 class CLFillBorderKernel;
36 class ICLKernel;
37 
38 /** Basic interface for functions which have a single OpenCL kernel */
40 {
41 public:
42  /** Constructor
43  *
44  * @param[in] ctx Runtime context to be used by the function
45  */
46  ICLSimpleFunction(CLRuntimeContext *ctx = nullptr);
47 
48  /** Prevent instances of this class from being copied (As this class contains pointers) */
49  ICLSimpleFunction(const ICLSimpleFunction &) = delete;
50  /** Default move constructor */
52  /** Prevent instances of this class from being copied (As this class contains pointers) */
54  /** Default move assignment operator */
56  /** Default destructor */
58 
59  // Inherited methods overridden:
60  void run() override final;
61 
62 protected:
63  std::unique_ptr<ICLKernel> _kernel; /**< Kernel to run */
64  std::unique_ptr<CLFillBorderKernel> _border_handler; /**< Kernel to handle borders */
65  CLRuntimeContext *_ctx; /**< Context to use */
66 };
67 } // namespace arm_compute
68 #endif /*ARM_COMPUTE_ICLSIMPLEFUNCTION_H */
Base class for all functions.
Definition: IFunction.h:30
Copyright (c) 2017-2021 Arm Limited.
void run() override final
Run the kernels contained in the function.
Basic interface for functions which have a single OpenCL kernel.
ICLSimpleFunction(CLRuntimeContext *ctx=nullptr)
Constructor.
ICLSimpleFunction & operator=(const ICLSimpleFunction &)=delete
Prevent instances of this class from being copied (As this class contains pointers) ...
~ICLSimpleFunction()
Default destructor.