diff options
author | Ryan OShea <Ryan.OShea2@arm.com> | 2020-03-13 16:26:19 +0000 |
---|---|---|
committer | Ryan OShea <Ryan.OShea2@arm.com> | 2020-03-13 16:26:19 +0000 |
commit | de36e4a9c299028e792c3a5bd99ad0816d806077 (patch) | |
tree | 6c71d89db68da1033bb422253cee2970580ed692 /Documentation/classarmnn_1_1_optimized_network.xhtml | |
parent | 78b26f024641e763c7252198339c83bad8c0982f (diff) | |
download | armnn-de36e4a9c299028e792c3a5bd99ad0816d806077.tar.gz |
IVGCVSW-3726 Upload ArmNN Doxygen files
* Upload current ArmNN Doxygen files
Signed-off-by: Ryan OShea <Ryan.OShea2@arm.com>
Change-Id: I8989ed16ee40a99a4495b100bd009cf3e24a7285
Diffstat (limited to 'Documentation/classarmnn_1_1_optimized_network.xhtml')
-rw-r--r-- | Documentation/classarmnn_1_1_optimized_network.xhtml | 321 |
1 files changed, 321 insertions, 0 deletions
diff --git a/Documentation/classarmnn_1_1_optimized_network.xhtml b/Documentation/classarmnn_1_1_optimized_network.xhtml new file mode 100644 index 0000000000..395efb3110 --- /dev/null +++ b/Documentation/classarmnn_1_1_optimized_network.xhtml @@ -0,0 +1,321 @@ +<!-- Copyright (c) 2020 ARM Limited. --> +<!-- --> +<!-- SPDX-License-Identifier: MIT --> +<!-- --> +<!-- HTML header for doxygen 1.8.13--> +<!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="robots" content="NOINDEX, NOFOLLOW" /> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>ArmNN: OptimizedNetwork 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> +<script type="text/x-mathjax-config"> + MathJax.Hub.Config({ + extensions: ["tex2jax.js"], + jax: ["input/TeX","output/HTML-CSS"], +}); +</script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +<link href="stylesheet.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;"> + <img alt="ArmNN" src="Arm_NN_horizontal_blue.png" style="max-width: 10rem; margin-top: .5rem; margin-left 10px"/> + <td style="padding-left: 0.5em;"> + <div id="projectname"> +  <span id="projectnumber">20.02</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_optimized_network.xhtml','');}); +</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-methods">Public Member Functions</a> | +<a href="classarmnn_1_1_optimized_network-members.xhtml">List of all members</a> </div> + <div class="headertitle"> +<div class="title">OptimizedNetwork Class Reference<span class="mlabels"><span class="mlabel">final</span></span></div> </div> +</div><!--header--> +<div class="contents"> + +<p><code>#include <<a class="el" href="_network_8hpp_source.xhtml">Network.hpp</a>></code></p> +<div class="dynheader"> +Inheritance diagram for OptimizedNetwork:</div> +<div class="dyncontent"> + <div class="center"> + <img src="classarmnn_1_1_optimized_network.png" usemap="#OptimizedNetwork_map" alt=""/> + <map id="OptimizedNetwork_map" name="OptimizedNetwork_map"> +<area href="classarmnn_1_1_i_optimized_network.xhtml" alt="IOptimizedNetwork" shape="rect" coords="0,0,116,24"/> +</map> + </div></div> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> +Public Member Functions</h2></td></tr> +<tr class="memitem:a971533529217dab76688ac1b4cb92103"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_optimized_network.xhtml#a971533529217dab76688ac1b4cb92103">OptimizedNetwork</a> (std::unique_ptr< <a class="el" href="classarmnn_1_1_graph.xhtml">Graph</a> > graph)</td></tr> +<tr class="separator:a971533529217dab76688ac1b4cb92103"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ab09173dfe4beb721a6d0585e9bfcf392"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_optimized_network.xhtml#ab09173dfe4beb721a6d0585e9bfcf392">~OptimizedNetwork</a> ()</td></tr> +<tr class="separator:ab09173dfe4beb721a6d0585e9bfcf392"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a9aa1b214fcaec2371fe4226bd126fb73"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacearmnn.xhtml#a67a0db04d321a74b7e7fcfd3f1a3f70b">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_optimized_network.xhtml#a9aa1b214fcaec2371fe4226bd126fb73">PrintGraph</a> () override</td></tr> +<tr class="separator:a9aa1b214fcaec2371fe4226bd126fb73"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a6201b0b0af2110feee1489a5fe9c7ec2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacearmnn.xhtml#a67a0db04d321a74b7e7fcfd3f1a3f70b">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_optimized_network.xhtml#a6201b0b0af2110feee1489a5fe9c7ec2">SerializeToDot</a> (std::ostream &stream) const override</td></tr> +<tr class="separator:a6201b0b0af2110feee1489a5fe9c7ec2"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a29c2c6dd77c6fe10674fc6876751cbce"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarmnn_1_1profiling_1_1_profiling_guid.xhtml">profiling::ProfilingGuid</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_optimized_network.xhtml#a29c2c6dd77c6fe10674fc6876751cbce">GetGuid</a> () const final</td></tr> +<tr class="separator:a29c2c6dd77c6fe10674fc6876751cbce"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a49800ad35ea869aa5569519760d3b339"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarmnn_1_1_graph.xhtml">Graph</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_optimized_network.xhtml#a49800ad35ea869aa5569519760d3b339">GetGraph</a> ()</td></tr> +<tr class="separator:a49800ad35ea869aa5569519760d3b339"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a> +Additional Inherited Members</h2></td></tr> +<tr class="inherit_header pub_static_methods_classarmnn_1_1_i_optimized_network"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_classarmnn_1_1_i_optimized_network')"><img src="closed.png" alt="-"/> Static Public Member Functions inherited from <a class="el" href="classarmnn_1_1_i_optimized_network.xhtml">IOptimizedNetwork</a></td></tr> +<tr class="memitem:a58ee539cf95c1e99fe4f54ef6e8bbd05 inherit pub_static_methods_classarmnn_1_1_i_optimized_network"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_i_optimized_network.xhtml#a58ee539cf95c1e99fe4f54ef6e8bbd05">Destroy</a> (<a class="el" href="classarmnn_1_1_i_optimized_network.xhtml">IOptimizedNetwork</a> *network)</td></tr> +<tr class="separator:a58ee539cf95c1e99fe4f54ef6e8bbd05 inherit pub_static_methods_classarmnn_1_1_i_optimized_network"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="inherit_header pro_methods_classarmnn_1_1_i_optimized_network"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classarmnn_1_1_i_optimized_network')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classarmnn_1_1_i_optimized_network.xhtml">IOptimizedNetwork</a></td></tr> +<tr class="memitem:a437cc59f5247f213adf34e84696f60da inherit pro_methods_classarmnn_1_1_i_optimized_network"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_i_optimized_network.xhtml#a437cc59f5247f213adf34e84696f60da">~IOptimizedNetwork</a> ()</td></tr> +<tr class="separator:a437cc59f5247f213adf34e84696f60da inherit pro_methods_classarmnn_1_1_i_optimized_network"><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="_network_8hpp_source.xhtml#l00265">265</a> of file <a class="el" href="_network_8hpp_source.xhtml">Network.hpp</a>.</p> +</div><h2 class="groupheader">Constructor & Destructor Documentation</h2> +<a id="a971533529217dab76688ac1b4cb92103"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a971533529217dab76688ac1b4cb92103">◆ </a></span>OptimizedNetwork()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classarmnn_1_1_optimized_network.xhtml">OptimizedNetwork</a> </td> + <td>(</td> + <td class="paramtype">std::unique_ptr< <a class="el" href="classarmnn_1_1_graph.xhtml">Graph</a> > </td> + <td class="paramname"><em>graph</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p class="definition">Definition at line <a class="el" href="_network_8cpp_source.xhtml#l01682">1682</a> of file <a class="el" href="_network_8cpp_source.xhtml">Network.cpp</a>.</p> +<div class="fragment"><div class="line"><a name="l01683"></a><span class="lineno"> 1683</span>  : m_Graph(std::move(graph)),</div><div class="line"><a name="l01684"></a><span class="lineno"> 1684</span>  m_Guid(<a class="code" href="classarmnn_1_1profiling_1_1_profiling_service.xhtml#a6d016886de3596fe67dbabf107168f97">profiling::ProfilingService::Instance</a>().NextGuid())</div><div class="line"><a name="l01685"></a><span class="lineno"> 1685</span> {</div><div class="line"><a name="l01686"></a><span class="lineno"> 1686</span> }</div><div class="ttc" id="classarmnn_1_1profiling_1_1_profiling_service_xhtml_a6d016886de3596fe67dbabf107168f97"><div class="ttname"><a href="classarmnn_1_1profiling_1_1_profiling_service.xhtml#a6d016886de3596fe67dbabf107168f97">armnn::profiling::ProfilingService::Instance</a></div><div class="ttdeci">static ProfilingService & Instance()</div><div class="ttdef"><b>Definition:</b> <a href="_profiling_service_8hpp_source.xhtml#l00052">ProfilingService.hpp:52</a></div></div> +</div><!-- fragment --> +</div> +</div> +<a id="ab09173dfe4beb721a6d0585e9bfcf392"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ab09173dfe4beb721a6d0585e9bfcf392">◆ </a></span>~OptimizedNetwork()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">~<a class="el" href="classarmnn_1_1_optimized_network.xhtml">OptimizedNetwork</a> </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p class="definition">Definition at line <a class="el" href="_network_8cpp_source.xhtml#l01688">1688</a> of file <a class="el" href="_network_8cpp_source.xhtml">Network.cpp</a>.</p> +<div class="fragment"><div class="line"><a name="l01689"></a><span class="lineno"> 1689</span> {</div><div class="line"><a name="l01690"></a><span class="lineno"> 1690</span> }</div></div><!-- fragment --> +</div> +</div> +<h2 class="groupheader">Member Function Documentation</h2> +<a id="a49800ad35ea869aa5569519760d3b339"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a49800ad35ea869aa5569519760d3b339">◆ </a></span>GetGraph()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classarmnn_1_1_graph.xhtml">Graph</a>& GetGraph </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p class="definition">Definition at line <a class="el" href="_network_8hpp_source.xhtml#l00276">276</a> of file <a class="el" href="_network_8hpp_source.xhtml">Network.hpp</a>.</p> + +<p class="reference">Referenced by <a class="el" href="_network_8cpp_source.xhtml#l00428">armnn::ApplyBackendOptimizations()</a>, <a class="el" href="_network_8cpp_source.xhtml#l00269">armnn::AssignBackends()</a>, <a class="el" href="_optimizer_tests_8cpp_source.xhtml#l00685">BOOST_AUTO_TEST_CASE()</a>, and <a class="el" href="_network_8cpp_source.xhtml#l00890">armnn::Optimize()</a>.</p> +<div class="fragment"><div class="line"><a name="l00276"></a><span class="lineno"> 276</span> { <span class="keywordflow">return</span> *m_Graph; }</div></div><!-- fragment --> +</div> +</div> +<a id="a29c2c6dd77c6fe10674fc6876751cbce"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a29c2c6dd77c6fe10674fc6876751cbce">◆ </a></span>GetGuid()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classarmnn_1_1profiling_1_1_profiling_guid.xhtml">profiling::ProfilingGuid</a> GetGuid </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td> const</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">final</span><span class="mlabel">virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Implements <a class="el" href="classarmnn_1_1_i_optimized_network.xhtml#acb0f384aead510900e20318cabe58a59">IOptimizedNetwork</a>.</p> + +<p class="definition">Definition at line <a class="el" href="_network_8hpp_source.xhtml#l00274">274</a> of file <a class="el" href="_network_8hpp_source.xhtml">Network.hpp</a>.</p> +<div class="fragment"><div class="line"><a name="l00274"></a><span class="lineno"> 274</span> { <span class="keywordflow">return</span> m_Guid; };</div></div><!-- fragment --> +</div> +</div> +<a id="a9aa1b214fcaec2371fe4226bd126fb73"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a9aa1b214fcaec2371fe4226bd126fb73">◆ </a></span>PrintGraph()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="namespacearmnn.xhtml#a67a0db04d321a74b7e7fcfd3f1a3f70b">Status</a> PrintGraph </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Implements <a class="el" href="classarmnn_1_1_i_optimized_network.xhtml#a06f863df5ac6a76c7407f64d63c04001">IOptimizedNetwork</a>.</p> + +<p class="definition">Definition at line <a class="el" href="_network_8cpp_source.xhtml#l00064">64</a> of file <a class="el" href="_network_8cpp_source.xhtml">Network.cpp</a>.</p> + +<p class="reference">References <a class="el" href="namespacearmnn.xhtml#a67a0db04d321a74b7e7fcfd3f1a3f70ba505a83f220c02df2f85c3810cd9ceb38">armnn::Success</a>.</p> +<div class="fragment"><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> {</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  m_Graph->Print();</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keywordflow">return</span> <a class="code" href="namespacearmnn.xhtml#a67a0db04d321a74b7e7fcfd3f1a3f70ba505a83f220c02df2f85c3810cd9ceb38">Status::Success</a>;</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> }</div><div class="ttc" id="namespacearmnn_xhtml_a67a0db04d321a74b7e7fcfd3f1a3f70ba505a83f220c02df2f85c3810cd9ceb38"><div class="ttname"><a href="namespacearmnn.xhtml#a67a0db04d321a74b7e7fcfd3f1a3f70ba505a83f220c02df2f85c3810cd9ceb38">armnn::Status::Success</a></div></div> +</div><!-- fragment --> +</div> +</div> +<a id="a6201b0b0af2110feee1489a5fe9c7ec2"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a6201b0b0af2110feee1489a5fe9c7ec2">◆ </a></span>SerializeToDot()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="namespacearmnn.xhtml#a67a0db04d321a74b7e7fcfd3f1a3f70b">Status</a> SerializeToDot </td> + <td>(</td> + <td class="paramtype">std::ostream & </td> + <td class="paramname"><em>stream</em></td><td>)</td> + <td> const</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Implements <a class="el" href="classarmnn_1_1_i_optimized_network.xhtml#ab5efbfcd407727b3342698ad57855978">IOptimizedNetwork</a>.</p> + +<p class="definition">Definition at line <a class="el" href="_network_8cpp_source.xhtml#l00070">70</a> of file <a class="el" href="_network_8cpp_source.xhtml">Network.cpp</a>.</p> +<div class="fragment"><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> {</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keywordflow">return</span> m_Graph->SerializeToDot(stream);</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</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="_network_8hpp_source.xhtml">Network.hpp</a></li> +<li>src/armnn/<a class="el" href="_network_8cpp_source.xhtml">Network.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.xhtml">armnn</a></li><li class="navelem"><a class="el" href="classarmnn_1_1_optimized_network.xhtml">OptimizedNetwork</a></li> + <li class="footer">Generated on Fri Mar 13 2020 16:09:19 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> |