Compute Library
 21.05
ICLOperator.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 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_ICLOPERATOR_H
25 #define ARM_COMPUTE_ICLOPERATOR_H
26 
27 #include "arm_compute/core/Types.h"
28 
32 
33 #include <memory>
34 
35 namespace arm_compute
36 {
37 class ICLKernel;
38 namespace experimental
39 {
40 /** Basic interface for functions which have a single async CL kernel */
41 class ICLOperator : public IOperator
42 {
43 public:
44  /** Constructor
45  *
46  * @param[in] ctx Runtime context to be used by the function
47  */
48  ICLOperator(IRuntimeContext *ctx = nullptr);
49  /** Prevent instances of this class from being copied (As this class contains pointers) */
50  ICLOperator(const ICLOperator &) = delete;
51  /** Default move constructor */
52  ICLOperator(ICLOperator &&) = default;
53  /** Prevent instances of this class from being copied (As this class contains pointers) */
54  ICLOperator &operator=(const ICLOperator &) = delete;
55  /** Default move assignment operator */
56  ICLOperator &operator=(ICLOperator &&) = default;
57 
58  // Inherited methods overridden:
59  void run(ITensorPack &tensors) override;
60  void prepare(ITensorPack &constants) override;
61  MemoryRequirements workspace() const override;
62 
63 protected:
64  std::unique_ptr<ICLKernel> _kernel;
65  IRuntimeContext *_ctx;
66  MemoryRequirements _workspace;
67 };
68 } // namespace experimental
69 } // namespace arm_compute
70 #endif /*ARM_COMPUTE_ICLOPERATOR_H */
ICLOperator & operator=(const ICLOperator &)=delete
Prevent instances of this class from being copied (As this class contains pointers)
ICLOperator(IRuntimeContext *ctx=nullptr)
Constructor.
Definition: CLOperator.cpp:33
Base class for all async functions.
Definition: IOperator.h:37
MemoryRequirements workspace() const override
Return the memory requirements required by the workspace.
Definition: CLOperator.cpp:53
Copyright (c) 2017-2021 Arm Limited.
std::vector< MemoryInfo > MemoryRequirements
Definition: Types.h:74
void prepare(ITensorPack &constants) override
Prepare the function for executing.
Definition: CLOperator.cpp:48
Tensor packing service.
Definition: ITensorPack.h:37
void run(ITensorPack &tensors) override
Run the kernels contained in the function.
Definition: CLOperator.cpp:38
Basic interface for functions which have a single async CL kernel.
Definition: ICLOperator.h:41