xref: /aosp_15_r20/external/ComputeLibrary/arm_compute/graph/printers/DotGraphPrinter.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
1*c217d954SCole Faust /*
2*c217d954SCole Faust  * Copyright (c) 2018-2019,2021 Arm Limited.
3*c217d954SCole Faust  *
4*c217d954SCole Faust  * SPDX-License-Identifier: MIT
5*c217d954SCole Faust  *
6*c217d954SCole Faust  * Permission is hereby granted, free of charge, to any person obtaining a copy
7*c217d954SCole Faust  * of this software and associated documentation files (the "Software"), to
8*c217d954SCole Faust  * deal in the Software without restriction, including without limitation the
9*c217d954SCole Faust  * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
10*c217d954SCole Faust  * sell copies of the Software, and to permit persons to whom the Software is
11*c217d954SCole Faust  * furnished to do so, subject to the following conditions:
12*c217d954SCole Faust  *
13*c217d954SCole Faust  * The above copyright notice and this permission notice shall be included in all
14*c217d954SCole Faust  * copies or substantial portions of the Software.
15*c217d954SCole Faust  *
16*c217d954SCole Faust  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17*c217d954SCole Faust  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18*c217d954SCole Faust  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19*c217d954SCole Faust  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20*c217d954SCole Faust  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21*c217d954SCole Faust  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22*c217d954SCole Faust  * SOFTWARE.
23*c217d954SCole Faust  */
24*c217d954SCole Faust #ifndef ARM_COMPUTE_GRAPH_DOTGRAPHPRINTER_H
25*c217d954SCole Faust #define ARM_COMPUTE_GRAPH_DOTGRAPHPRINTER_H
26*c217d954SCole Faust 
27*c217d954SCole Faust #include "arm_compute/graph/IGraphPrinter.h"
28*c217d954SCole Faust 
29*c217d954SCole Faust #include "arm_compute/graph/INodeVisitor.h"
30*c217d954SCole Faust 
31*c217d954SCole Faust #include <string>
32*c217d954SCole Faust 
33*c217d954SCole Faust namespace arm_compute
34*c217d954SCole Faust {
35*c217d954SCole Faust namespace graph
36*c217d954SCole Faust {
37*c217d954SCole Faust /** Graph printer visitor. */
38*c217d954SCole Faust class DotGraphVisitor final : public DefaultNodeVisitor
39*c217d954SCole Faust {
40*c217d954SCole Faust public:
41*c217d954SCole Faust     /** Default Constructor **/
42*c217d954SCole Faust     DotGraphVisitor() = default;
43*c217d954SCole Faust     /** Returns the output information of the last visited node
44*c217d954SCole Faust      *
45*c217d954SCole Faust      * @return Information of the last visited node
46*c217d954SCole Faust      */
47*c217d954SCole Faust     const std::string &info() const;
48*c217d954SCole Faust 
49*c217d954SCole Faust     // Reveal parent method
50*c217d954SCole Faust     using DefaultNodeVisitor::visit;
51*c217d954SCole Faust 
52*c217d954SCole Faust     // Inherited methods overridden
53*c217d954SCole Faust     void visit(ActivationLayerNode &n) override;
54*c217d954SCole Faust     void visit(BatchNormalizationLayerNode &n) override;
55*c217d954SCole Faust     void visit(ConcatenateLayerNode &n) override;
56*c217d954SCole Faust     void visit(ConvolutionLayerNode &n) override;
57*c217d954SCole Faust     void visit(DepthwiseConvolutionLayerNode &n) override;
58*c217d954SCole Faust     void visit(EltwiseLayerNode &n) override;
59*c217d954SCole Faust     void visit(FusedConvolutionBatchNormalizationNode &n) override;
60*c217d954SCole Faust     void visit(FusedConvolutionBatchNormalizationWithPostOpsNode &n) override;
61*c217d954SCole Faust     void visit(FusedConvolutionWithPostOpNode &n) override;
62*c217d954SCole Faust     void visit(FusedDepthwiseConvolutionBatchNormalizationNode &n) override;
63*c217d954SCole Faust     void visit(NormalizationLayerNode &n) override;
64*c217d954SCole Faust     void visit(PoolingLayerNode &n) override;
65*c217d954SCole Faust     void default_visit(INode &n) override;
66*c217d954SCole Faust 
67*c217d954SCole Faust private:
68*c217d954SCole Faust     std::string _info{};
69*c217d954SCole Faust };
70*c217d954SCole Faust 
71*c217d954SCole Faust /** Graph printer interface */
72*c217d954SCole Faust class DotGraphPrinter final : public IGraphPrinter
73*c217d954SCole Faust {
74*c217d954SCole Faust public:
75*c217d954SCole Faust     // Inherited methods overridden
76*c217d954SCole Faust     void print(const Graph &g, std::ostream &os) override;
77*c217d954SCole Faust 
78*c217d954SCole Faust private:
79*c217d954SCole Faust     /** Print dot graph header
80*c217d954SCole Faust      *
81*c217d954SCole Faust      * @param[in]  g  Graph
82*c217d954SCole Faust      * @param[out] os Output stream to use
83*c217d954SCole Faust      */
84*c217d954SCole Faust     void print_header(const Graph &g, std::ostream &os);
85*c217d954SCole Faust     /** Print dot graph footer
86*c217d954SCole Faust      *
87*c217d954SCole Faust      * @param[in]  g  Graph
88*c217d954SCole Faust      * @param[out] os Output stream to use
89*c217d954SCole Faust      */
90*c217d954SCole Faust     void print_footer(const Graph &g, std::ostream &os);
91*c217d954SCole Faust     /** Prints nodes in dot format
92*c217d954SCole Faust      *
93*c217d954SCole Faust      * @param[in]  g  Graph
94*c217d954SCole Faust      * @param[out] os Output stream to use
95*c217d954SCole Faust      */
96*c217d954SCole Faust     void print_nodes(const Graph &g, std::ostream &os);
97*c217d954SCole Faust     /** Prints edges in dot format
98*c217d954SCole Faust      *
99*c217d954SCole Faust      * @param[in]  g  Graph
100*c217d954SCole Faust      * @param[out] os Output stream to use
101*c217d954SCole Faust      */
102*c217d954SCole Faust     void print_edges(const Graph &g, std::ostream &os);
103*c217d954SCole Faust 
104*c217d954SCole Faust private:
105*c217d954SCole Faust     DotGraphVisitor _dot_node_visitor = {};
106*c217d954SCole Faust };
107*c217d954SCole Faust } // namespace graph
108*c217d954SCole Faust } // namespace arm_compute
109*c217d954SCole Faust #endif /* ARM_COMPUTE_GRAPH_DOTGRAPHPRINTER_H */
110