Compute Library
 22.11
IOperator.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_IOPERATOR_H
25 #define ARM_COMPUTE_IOPERATOR_H
26 
30 
31 namespace arm_compute
32 {
33 class ITensorPack;
34 namespace experimental
35 {
36 /** Base class for all async functions */
37 class IOperator
38 {
39 public:
40  /** Destructor */
41  virtual ~IOperator() = default;
42  /** Run the kernels contained in the function
43  *
44  * @param[in] tensors Vector that contains the tensors to operate on.
45  *
46  */
47  virtual void run(ITensorPack &tensors) = 0;
48  /** Prepare the function for executing
49  *
50  * Any one off pre-processing step required by the function is handled here
51  *
52  * @param[in] constants Vector that contains the constants tensors.
53  *
54  * @note Prepare stage might not need all the function's buffers' backing memory to be available in order to execute
55  */
56  virtual void prepare(ITensorPack &constants) = 0;
57 
58  /** Return the memory requirements required by the workspace
59  */
60  virtual MemoryRequirements workspace() const = 0;
61 };
62 } // namespace experimental
63 } // namespace arm_compute
64 #endif /*ARM_COMPUTE_IOPERATOR_H */
virtual MemoryRequirements workspace() const =0
Return the memory requirements required by the workspace.
virtual void prepare(ITensorPack &constants)=0
Prepare the function for executing.
virtual void run(ITensorPack &tensors)=0
Run the kernels contained in the function.
Base class for all async functions.
Definition: IOperator.h:37
Copyright (c) 2017-2022 Arm Limited.
std::vector< MemoryInfo > MemoryRequirements
Definition: Types.h:134
virtual ~IOperator()=default
Destructor.
Tensor packing service.
Definition: ITensorPack.h:39