IVGCVSW-3726 Upload ArmNN Doxygen files
* Upload current ArmNN Doxygen files
Signed-off-by: Ryan OShea <Ryan.OShea2@arm.com>
Change-Id: I8989ed16ee40a99a4495b100bd009cf3e24a7285
diff --git a/Documentation/classarmnn_1_1_optimizer.html b/Documentation/classarmnn_1_1_optimizer.html
new file mode 100644
index 0000000..10b11f0
--- /dev/null
+++ b/Documentation/classarmnn_1_1_optimizer.html
@@ -0,0 +1,201 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
+<meta http-equiv="X-UA-Compatible" content="IE=9"/>
+<meta name="generator" content="Doxygen 1.8.13"/>
+<meta name="viewport" content="width=device-width, initial-scale=1"/>
+<title>ArmNN: Optimizer Class Reference</title>
+<link href="tabs.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="jquery.js"></script>
+<script type="text/javascript" src="dynsections.js"></script>
+<link href="navtree.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="resize.js"></script>
+<script type="text/javascript" src="navtreedata.js"></script>
+<script type="text/javascript" src="navtree.js"></script>
+<script type="text/javascript">
+ $(document).ready(initResizable);
+</script>
+<link href="search/search.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="search/searchdata.js"></script>
+<script type="text/javascript" src="search/search.js"></script>
+<link href="doxygen.css" rel="stylesheet" type="text/css" />
+</head>
+<body>
+<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
+<div id="titlearea">
+<table cellspacing="0" cellpadding="0">
+ <tbody>
+ <tr style="height: 56px;">
+ <td id="projectalign" style="padding-left: 0.5em;">
+ <div id="projectname">ArmNN
+  <span id="projectnumber">NotReleased</span>
+ </div>
+ </td>
+ </tr>
+ </tbody>
+</table>
+</div>
+<!-- end header part -->
+<!-- Generated by Doxygen 1.8.13 -->
+<script type="text/javascript">
+var searchBox = new SearchBox("searchBox", "search",false,'Search');
+</script>
+<script type="text/javascript" src="menudata.js"></script>
+<script type="text/javascript" src="menu.js"></script>
+<script type="text/javascript">
+$(function() {
+ initMenu('',true,false,'search.php','Search');
+ $(document).ready(function() { init_search(); });
+});
+</script>
+<div id="main-nav"></div>
+</div><!-- top -->
+<div id="side-nav" class="ui-resizable side-nav-resizable">
+ <div id="nav-tree">
+ <div id="nav-tree-contents">
+ <div id="nav-sync" class="sync"></div>
+ </div>
+ </div>
+ <div id="splitbar" style="-moz-user-select:none;"
+ class="ui-resizable-handle">
+ </div>
+</div>
+<script type="text/javascript">
+$(document).ready(function(){initNavTree('classarmnn_1_1_optimizer.html','');});
+</script>
+<div id="doc-content">
+<!-- window showing the filter options -->
+<div id="MSearchSelectWindow"
+ onmouseover="return searchBox.OnSearchSelectShow()"
+ onmouseout="return searchBox.OnSearchSelectHide()"
+ onkeydown="return searchBox.OnSearchSelectKey(event)">
+</div>
+
+<!-- iframe showing the search results (closed by default) -->
+<div id="MSearchResultsWindow">
+<iframe src="javascript:void(0)" frameborder="0"
+ name="MSearchResults" id="MSearchResults">
+</iframe>
+</div>
+
+<div class="header">
+ <div class="summary">
+<a href="#pub-types">Public Types</a> |
+<a href="#pub-static-methods">Static Public Member Functions</a> |
+<a href="classarmnn_1_1_optimizer-members.html">List of all members</a> </div>
+ <div class="headertitle">
+<div class="title">Optimizer Class Reference</div> </div>
+</div><!--header-->
+<div class="contents">
+
+<p><code>#include <<a class="el" href="_optimizer_8hpp_source.html">Optimizer.hpp</a>></code></p>
+<table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
+Public Types</h2></td></tr>
+<tr class="memitem:a621bdb49c4a2f879b27d27e771693a46"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_optimizer.html#a621bdb49c4a2f879b27d27e771693a46">OptimizationPtr</a> = std::unique_ptr< <a class="el" href="classarmnn_1_1_optimization.html">Optimization</a> ></td></tr>
+<tr class="separator:a621bdb49c4a2f879b27d27e771693a46"><td class="memSeparator" colspan="2"> </td></tr>
+<tr class="memitem:ad1794808004025d6e06c176507197b24"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_optimizer.html#ad1794808004025d6e06c176507197b24">Optimizations</a> = std::vector< <a class="el" href="classarmnn_1_1_optimizer.html#a621bdb49c4a2f879b27d27e771693a46">OptimizationPtr</a> ></td></tr>
+<tr class="separator:ad1794808004025d6e06c176507197b24"><td class="memSeparator" colspan="2"> </td></tr>
+</table><table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
+Static Public Member Functions</h2></td></tr>
+<tr class="memitem:a1f48ba622b76ea04d15c9b62f642bf08"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_optimizer.html#a1f48ba622b76ea04d15c9b62f642bf08">Pass</a> (<a class="el" href="classarmnn_1_1_graph.html">Graph</a> &graph, const <a class="el" href="classarmnn_1_1_optimizer.html#ad1794808004025d6e06c176507197b24">Optimizations</a> &optimizations)</td></tr>
+<tr class="separator:a1f48ba622b76ea04d15c9b62f642bf08"><td class="memSeparator" colspan="2"> </td></tr>
+</table>
+<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
+<div class="textblock">
+<p class="definition">Definition at line <a class="el" href="_optimizer_8hpp_source.html#l00014">14</a> of file <a class="el" href="_optimizer_8hpp_source.html">Optimizer.hpp</a>.</p>
+</div><h2 class="groupheader">Member Typedef Documentation</h2>
+<a id="a621bdb49c4a2f879b27d27e771693a46"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a621bdb49c4a2f879b27d27e771693a46">◆ </a></span>OptimizationPtr</h2>
+
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">using <a class="el" href="classarmnn_1_1_optimizer.html#a621bdb49c4a2f879b27d27e771693a46">OptimizationPtr</a> = std::unique_ptr<<a class="el" href="classarmnn_1_1_optimization.html">Optimization</a>></td>
+ </tr>
+ </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="_optimizer_8hpp_source.html#l00017">17</a> of file <a class="el" href="_optimizer_8hpp_source.html">Optimizer.hpp</a>.</p>
+
+</div>
+</div>
+<a id="ad1794808004025d6e06c176507197b24"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ad1794808004025d6e06c176507197b24">◆ </a></span>Optimizations</h2>
+
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">using <a class="el" href="classarmnn_1_1_optimizer.html#ad1794808004025d6e06c176507197b24">Optimizations</a> = std::vector<<a class="el" href="classarmnn_1_1_optimizer.html#a621bdb49c4a2f879b27d27e771693a46">OptimizationPtr</a>></td>
+ </tr>
+ </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="_optimizer_8hpp_source.html#l00018">18</a> of file <a class="el" href="_optimizer_8hpp_source.html">Optimizer.hpp</a>.</p>
+
+</div>
+</div>
+<h2 class="groupheader">Member Function Documentation</h2>
+<a id="a1f48ba622b76ea04d15c9b62f642bf08"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a1f48ba622b76ea04d15c9b62f642bf08">◆ </a></span>Pass()</h2>
+
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+ <tr>
+ <td class="mlabels-left">
+ <table class="memname">
+ <tr>
+ <td class="memname">void Pass </td>
+ <td>(</td>
+ <td class="paramtype"><a class="el" href="classarmnn_1_1_graph.html">Graph</a> & </td>
+ <td class="paramname"><em>graph</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">const <a class="el" href="classarmnn_1_1_optimizer.html#ad1794808004025d6e06c176507197b24">Optimizations</a> & </td>
+ <td class="paramname"><em>optimizations</em> </td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td>
+ </tr>
+ </table>
+ </td>
+ <td class="mlabels-right">
+<span class="mlabels"><span class="mlabel">static</span></span> </td>
+ </tr>
+</table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="_optimizer_8cpp_source.html#l00016">16</a> of file <a class="el" href="_optimizer_8cpp_source.html">Optimizer.cpp</a>.</p>
+
+<p class="reference">References <a class="el" href="_graph_8hpp_source.html#l00158">Graph::begin()</a>, <a class="el" href="_observable_8hpp_source.html#l00026">GraphObservable< ObservedType >::Clear()</a>, <a class="el" href="_graph_8hpp_source.html#l00160">Graph::end()</a>, <a class="el" href="_graph_8hpp_source.html#l00442">Graph::EraseLayer()</a>, <a class="el" href="_graph_8hpp_source.html#l00389">Graph::GetPosInGraph()</a>, and <a class="el" href="_graph_8hpp_source.html#l00173">Graph::TopologicalSort()</a>.</p>
+
+<p class="reference">Referenced by <a class="el" href="_convert_constants_float_to_half_tests_8cpp_source.html#l00018">BOOST_AUTO_TEST_CASE()</a>, and <a class="el" href="_network_8cpp_source.html#l00807">armnn::Optimize()</a>.</p>
+<div class="fragment"><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> {</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  <span class="comment">// Create observables to observe changes to the graph</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  AddedLayerObservable addedLayerObservable(graph);</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  ErasedLayerNamesObservable erasedLayerNamesObservable(graph);</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  <span class="keywordtype">bool</span> graphNeedsSorting = <span class="keyword">false</span>;</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  <span class="keyword">auto</span> it = graph.TopologicalSort().end();</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  <span class="comment">// Calls TopologicalSort() for every iteration to re-order the list in case layers were added/removed.</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  <span class="keywordflow">while</span> (it != graph.TopologicalSort().begin())</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  {</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  --it;</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <span class="keywordflow">for</span> (<span class="keyword">auto</span>&& optimization : optimizations)</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  {</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  BOOST_ASSERT(*it);</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  optimization->Run(graph, **it);</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="keywordflow">if</span> ((*it)->IsOutputUnconnected())</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  {</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keyword">auto</span> next = std::next(graph.GetPosInGraph(**it));</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  graph.EraseLayer(it);</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  it = next;</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  graphNeedsSorting = <span class="keyword">true</span>;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  }</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="comment">// Add the names of erased layers as related layers to the new added layers</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keywordflow">for</span> (<span class="keyword">auto</span>& erasedLayerName : erasedLayerNamesObservable)</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  {</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keywordflow">for</span> (<span class="keyword">auto</span>& addedLayer : addedLayerObservable)</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  {</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  addedLayer->AddRelatedLayerName(erasedLayerName);</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  }</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  }</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  erasedLayerNamesObservable.Clear();</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  addedLayerObservable.Clear();</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keywordflow">if</span> (graphNeedsSorting)</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  {</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  graphNeedsSorting = <span class="keyword">false</span>;</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  }</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  }</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  }</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> }</div></div><!-- fragment -->
+</div>
+</div>
+<hr/>The documentation for this class was generated from the following files:<ul>
+<li>src/armnn/<a class="el" href="_optimizer_8hpp_source.html">Optimizer.hpp</a></li>
+<li>src/armnn/<a class="el" href="_optimizer_8cpp_source.html">Optimizer.cpp</a></li>
+</ul>
+</div><!-- contents -->
+</div><!-- doc-content -->
+<!-- start footer part -->
+<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
+ <ul>
+ <li class="navelem"><a class="el" href="namespacearmnn.html">armnn</a></li><li class="navelem"><a class="el" href="classarmnn_1_1_optimizer.html">Optimizer</a></li>
+ <li class="footer">Generated on Fri Mar 13 2020 16:07:04 for ArmNN by
+ <a href="http://www.doxygen.org/index.html">
+ <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
+ </ul>
+</div>
+</body>
+</html>