Compute Library
 21.08
IGraphMutator.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2018-2019 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_IGRAPHMUTATOR_H
25 #define ARM_COMPUTE_GRAPH_IGRAPHMUTATOR_H
26 
27 namespace arm_compute
28 {
29 namespace graph
30 {
31 // Forward declarations
32 class Graph;
33 
34 /** Graph mutator interface */
36 {
37 public:
38  /** Mutation type */
39  enum class MutationType
40  {
41  IR, /** IR specific mutation */
42  Backend /** Backend specific mutation */
43  };
44 
45 public:
46  /** Virtual Destructor */
47  virtual ~IGraphMutator() = default;
48  /** Walk the graph and perform a specific mutation
49  *
50  * @param[in, out] g Graph to walk and mutate
51  */
52  virtual void mutate(Graph &g) = 0;
53  /** Returns mutation type
54  *
55  * @return Mutation type enumeration
56  */
57  virtual MutationType type() const = 0;
58  /** Returns mutator name
59  *
60  * @return Mutator name
61  */
62  virtual const char *name() = 0;
63 };
64 } // namespace graph
65 } // namespace arm_compute
66 #endif /* ARM_COMPUTE_GRAPH_IGRAPHMUTATOR_H */
Copyright (c) 2017-2021 Arm Limited.
virtual void mutate(Graph &g)=0
Walk the graph and perform a specific mutation.
virtual const char * name()=0
Returns mutator name.
virtual ~IGraphMutator()=default
Virtual Destructor.
Graph class.
Definition: Graph.h:53
virtual MutationType type() const =0
Returns mutation type.
Graph mutator interface.
Definition: IGraphMutator.h:35