Gitiles
Code Review Sign In
review.mlplatform.org / ml / armnn / c1f6b09cc22b6e2de3d9eb88aec1778d0308a2b3 / . / Documentation / classarmnn_1_1_optimize_for_connection_impl.xhtml
blob: 9989c91613cdc32af132b9e9233522cb98d6fac0 [file] [log] [blame]
Ryan OSheade36e4a2020-03-13 16:26:19 +0000[diff] [blame]1<!-- Copyright (c) 2020 ARM Limited. -->
2<!-- -->
3<!-- SPDX-License-Identifier: MIT -->
4<!-- -->
5<!-- HTML header for doxygen 1.8.13-->
6<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
7<html xmlns="http://www.w3.org/1999/xhtml">
8<head>
9<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
10<meta http-equiv="X-UA-Compatible" content="IE=9"/>
11<meta name="generator" content="Doxygen 1.8.13"/>
12<meta name="robots" content="NOINDEX, NOFOLLOW" />
13<meta name="viewport" content="width=device-width, initial-scale=1"/>
14<title>ArmNN: OptimizeForConnectionImpl&lt; BaseType, ChildType, Wrapped &gt; Class Template Reference</title>
15<link href="tabs.css" rel="stylesheet" type="text/css"/>
16<script type="text/javascript" src="jquery.js"></script>
17<script type="text/javascript" src="dynsections.js"></script>
18<link href="navtree.css" rel="stylesheet" type="text/css"/>
19<script type="text/javascript" src="resize.js"></script>
20<script type="text/javascript" src="navtreedata.js"></script>
21<script type="text/javascript" src="navtree.js"></script>
22<script type="text/javascript">
23 $(document).ready(initResizable);
24</script>
25<link href="search/search.css" rel="stylesheet" type="text/css"/>
26<script type="text/javascript" src="search/searchdata.js"></script>
27<script type="text/javascript" src="search/search.js"></script>
28<script type="text/x-mathjax-config">
29 MathJax.Hub.Config({
30 extensions: ["tex2jax.js"],
31 jax: ["input/TeX","output/HTML-CSS"],
32});
33</script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
34<link href="doxygen.css" rel="stylesheet" type="text/css" />
35<link href="stylesheet.css" rel="stylesheet" type="text/css"/>
36</head>
37<body>
38<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
39<div id="titlearea">
40<table cellspacing="0" cellpadding="0">
41 <tbody>
42 <tr style="height: 56px;">
43 <img alt="ArmNN" src="Arm_NN_horizontal_blue.png" style="max-width: 10rem; margin-top: .5rem; margin-left 10px"/>
44 <td style="padding-left: 0.5em;">
45 <div id="projectname">
46 &#160;<span id="projectnumber">20.02</span>
47 </div>
48 </td>
49 </tr>
50 </tbody>
51</table>
52</div>
53<!-- end header part -->
54<!-- Generated by Doxygen 1.8.13 -->
55<script type="text/javascript">
56var searchBox = new SearchBox("searchBox", "search",false,'Search');
57</script>
58<script type="text/javascript" src="menudata.js"></script>
59<script type="text/javascript" src="menu.js"></script>
60<script type="text/javascript">
61$(function() {
62 initMenu('',true,false,'search.php','Search');
63 $(document).ready(function() { init_search(); });
64});
65</script>
66<div id="main-nav"></div>
67</div><!-- top -->
68<div id="side-nav" class="ui-resizable side-nav-resizable">
69 <div id="nav-tree">
70 <div id="nav-tree-contents">
71 <div id="nav-sync" class="sync"></div>
72 </div>
73 </div>
74 <div id="splitbar" style="-moz-user-select:none;"
75 class="ui-resizable-handle">
76 </div>
77</div>
78<script type="text/javascript">
79$(document).ready(function(){initNavTree('classarmnn_1_1_optimize_for_connection_impl.xhtml','');});
80</script>
81<div id="doc-content">
82<!-- window showing the filter options -->
83<div id="MSearchSelectWindow"
84 onmouseover="return searchBox.OnSearchSelectShow()"
85 onmouseout="return searchBox.OnSearchSelectHide()"
86 onkeydown="return searchBox.OnSearchSelectKey(event)">
87</div>
88
89<!-- iframe showing the search results (closed by default) -->
90<div id="MSearchResultsWindow">
91<iframe src="javascript:void(0)" frameborder="0"
92 name="MSearchResults" id="MSearchResults">
93</iframe>
94</div>
95
96<div class="header">
97 <div class="summary">
98<a href="#pub-methods">Public Member Functions</a> &#124;
99<a href="#pro-methods">Protected Member Functions</a> &#124;
100<a href="classarmnn_1_1_optimize_for_connection_impl-members.xhtml">List of all members</a> </div>
101 <div class="headertitle">
102<div class="title">OptimizeForConnectionImpl&lt; BaseType, ChildType, Wrapped &gt; Class Template Reference</div> </div>
103</div><!--header-->
104<div class="contents">
105
106<p>Wrapper <a class="el" href="classarmnn_1_1_optimization.xhtml">Optimization</a> class that calls Wrapped::Run for every connection BaseType -&gt; ChildType.
107 <a href="classarmnn_1_1_optimize_for_connection_impl.xhtml#details">More...</a></p>
108
109<p><code>#include &lt;<a class="el" href="_optimization_8hpp_source.xhtml">Optimization.hpp</a>&gt;</code></p>
110<div class="dynheader">
111Inheritance diagram for OptimizeForConnectionImpl&lt; BaseType, ChildType, Wrapped &gt;:</div>
112<div class="dyncontent">
113 <div class="center">
114 <img src="classarmnn_1_1_optimize_for_connection_impl.png" usemap="#OptimizeForConnectionImpl_3C_20BaseType_2C_20ChildType_2C_20Wrapped_20_3E_map" alt=""/>
115 <map id="OptimizeForConnectionImpl_3C_20BaseType_2C_20ChildType_2C_20Wrapped_20_3E_map" name="OptimizeForConnectionImpl_3C_20BaseType_2C_20ChildType_2C_20Wrapped_20_3E_map">
116<area href="classarmnn_1_1_optimize_for_type_impl.xhtml" alt="OptimizeForTypeImpl&lt; BaseType, OptimizeForConnectionImpl&lt; BaseType, ChildType, Wrapped &gt; &gt;" shape="rect" coords="0,112,579,136"/>
117<area href="classarmnn_1_1_optimize_for_connection.xhtml" alt="OptimizeForConnection&lt; BaseType, ChildType, Wrapped &gt;" shape="rect" coords="0,168,579,192"/>
118</map>
119 </div></div>
120<table class="memberdecls">
121<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
122Public Member Functions</h2></td></tr>
123<tr class="memitem:aabfa350bfc87763fdcda1fdc0ce207dd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_optimize_for_connection_impl.xhtml#aabfa350bfc87763fdcda1fdc0ce207dd">Run</a> (<a class="el" href="classarmnn_1_1_graph.xhtml">Graph</a> &amp;graph, BaseType &amp;base) const</td></tr>
124<tr class="separator:aabfa350bfc87763fdcda1fdc0ce207dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
125</table><table class="memberdecls">
126<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
127Protected Member Functions</h2></td></tr>
128<tr class="memitem:ab974ba2e7b8454f2afc9f69a89c457bd"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_optimize_for_connection_impl.xhtml#ab974ba2e7b8454f2afc9f69a89c457bd">~OptimizeForConnectionImpl</a> ()=default</td></tr>
129<tr class="separator:ab974ba2e7b8454f2afc9f69a89c457bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
130</table>
131<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
132<div class="textblock"><h3>template&lt;typename BaseType, typename ChildType, typename Wrapped&gt;<br />
133class armnn::OptimizeForConnectionImpl&lt; BaseType, ChildType, Wrapped &gt;</h3>
134
135<p>Wrapper <a class="el" href="classarmnn_1_1_optimization.xhtml">Optimization</a> class that calls Wrapped::Run for every connection BaseType -&gt; ChildType. </p>
136<ul>
137<li>Wrapped class mustn't remove the base layer. The optimizer will remove it if left unconnected after applying each optimization.</li>
138<li>Wrapped class mustn't affect existing connections in the same output. It might add new ones.</li>
139<li>Children layers are removed if left unconnected after applying the wrapped optimization. </li>
140</ul>
141
142<p class="definition">Definition at line <a class="el" href="_optimization_8hpp_source.xhtml#l00077">77</a> of file <a class="el" href="_optimization_8hpp_source.xhtml">Optimization.hpp</a>.</p>
143</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
144<a id="ab974ba2e7b8454f2afc9f69a89c457bd"></a>
145<h2 class="memtitle"><span class="permalink"><a href="#ab974ba2e7b8454f2afc9f69a89c457bd">&#9670;&nbsp;</a></span>~OptimizeForConnectionImpl()</h2>
146
147<div class="memitem">
148<div class="memproto">
149<table class="mlabels">
150 <tr>
151 <td class="mlabels-left">
152 <table class="memname">
153 <tr>
154 <td class="memname">~<a class="el" href="classarmnn_1_1_optimize_for_connection_impl.xhtml">OptimizeForConnectionImpl</a> </td>
155 <td>(</td>
156 <td class="paramname"></td><td>)</td>
157 <td></td>
158 </tr>
159 </table>
160 </td>
161 <td class="mlabels-right">
162<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">default</span></span> </td>
163 </tr>
164</table>
165</div><div class="memdoc">
166
167</div>
168</div>
169<h2 class="groupheader">Member Function Documentation</h2>
170<a id="aabfa350bfc87763fdcda1fdc0ce207dd"></a>
171<h2 class="memtitle"><span class="permalink"><a href="#aabfa350bfc87763fdcda1fdc0ce207dd">&#9670;&nbsp;</a></span>Run()</h2>
172
173<div class="memitem">
174<div class="memproto">
175<table class="mlabels">
176 <tr>
177 <td class="mlabels-left">
178 <table class="memname">
179 <tr>
180 <td class="memname">void Run </td>
181 <td>(</td>
182 <td class="paramtype"><a class="el" href="classarmnn_1_1_graph.xhtml">Graph</a> &amp;&#160;</td>
183 <td class="paramname"><em>graph</em>, </td>
184 </tr>
185 <tr>
186 <td class="paramkey"></td>
187 <td></td>
188 <td class="paramtype">BaseType &amp;&#160;</td>
189 <td class="paramname"><em>base</em>&#160;</td>
190 </tr>
191 <tr>
192 <td></td>
193 <td>)</td>
194 <td></td><td> const</td>
195 </tr>
196 </table>
197 </td>
198 <td class="mlabels-right">
199<span class="mlabels"><span class="mlabel">inline</span></span> </td>
200 </tr>
201</table>
202</div><div class="memdoc">
203
204<p class="definition">Definition at line <a class="el" href="_optimization_8hpp_source.xhtml#l00082">82</a> of file <a class="el" href="_optimization_8hpp_source.xhtml">Optimization.hpp</a>.</p>
205
206<p class="reference">References <a class="el" href="_graph_8hpp_source.xhtml#l00442">Graph::EraseLayer()</a>, and <a class="el" href="_layer_8hpp_source.xhtml#l00243">Layer::IsOutputUnconnected()</a>.</p>
207<div class="fragment"><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; {</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; <span class="keywordflow">for</span> (<span class="keyword">auto</span> output = base.BeginOutputSlots(); output != base.EndOutputSlots(); ++output)</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; {</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; <span class="keywordflow">for</span> (<span class="keyword">auto</span>&amp;&amp; childInput : output-&gt;GetConnections())</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; {</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; <span class="keywordflow">if</span> (childInput-&gt;GetOwningLayer().GetType() == LayerEnumOf&lt;ChildType&gt;())</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; {</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; Wrapped::Run(graph, *childInput);</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; }</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; }</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160;</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; <span class="comment">// Removes unconnected children.</span></div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; <span class="keywordflow">for</span> (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i = 0; i &lt; output-&gt;GetNumConnections();)</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; {</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; Layer* child = &amp;output-&gt;GetConnection(i)-&gt;GetOwningLayer();</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160;</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; <span class="keywordflow">if</span> (child-&gt;IsOutputUnconnected())</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; {</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; graph.EraseLayer(child);</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; }</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; <span class="keywordflow">else</span></div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; {</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; ++i;</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; }</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; }</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; }</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; }</div></div><!-- fragment -->
208</div>
209</div>
210<hr/>The documentation for this class was generated from the following file:<ul>
211<li>src/armnn/optimizations/<a class="el" href="_optimization_8hpp_source.xhtml">Optimization.hpp</a></li>
212</ul>
213</div><!-- contents -->
214</div><!-- doc-content -->
215<!-- start footer part -->
216<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
217 <ul>
218 <li class="navelem"><a class="el" href="namespacearmnn.xhtml">armnn</a></li><li class="navelem"><a class="el" href="classarmnn_1_1_optimize_for_connection_impl.xhtml">OptimizeForConnectionImpl</a></li>
219 <li class="footer">Generated on Fri Mar 13 2020 16:09:19 for ArmNN by
220 <a href="http://www.doxygen.org/index.html">
221 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
222 </ul>
223</div>
224</body>
225</html>