arm_compute v18.05
[platform/upstream/armcl.git] / arm_compute / graph / backends / CL / CLFunctionFactory.h
1 /*
2  * Copyright (c) 2018 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_GRAPH_CLFUNCTIONFACTORY_H__
25 #define __ARM_COMPUTE_GRAPH_CLFUNCTIONFACTORY_H__
26
27 #include "arm_compute/runtime/IFunction.h"
28
29 #include <memory>
30
31 namespace arm_compute
32 {
33 namespace graph
34 {
35 // Forward declarations
36 class INode;
37 class GraphContext;
38
39 namespace backends
40 {
41 /** Factory for generating OpenCL backend functions **/
42 class CLFunctionFactory final
43 {
44 public:
45     /** Create a backend execution function depending on the node type
46      *
47      * @param[in] node Node to create the backend function for
48      * @param[in] ctx  Context to use
49      *
50      * @return Backend function
51      */
52     static std::unique_ptr<arm_compute::IFunction> create(INode *node, GraphContext &ctx);
53 };
54 } // namespace backends
55 } // namespace graph
56 } // namespace arm_compute
57 #endif //__ARM_COMPUTE_GRAPH_CLFUNCTIONFACTORY_H__