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_dot_node.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_dot_node.xhtml')
-rw-r--r-- | Documentation/classarmnn_1_1_dot_node.xhtml | 279 |
1 files changed, 279 insertions, 0 deletions
diff --git a/Documentation/classarmnn_1_1_dot_node.xhtml b/Documentation/classarmnn_1_1_dot_node.xhtml new file mode 100644 index 0000000000..584b8cd411 --- /dev/null +++ b/Documentation/classarmnn_1_1_dot_node.xhtml @@ -0,0 +1,279 @@ +<!-- 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: DotNode 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_dot_node.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_dot_node-members.xhtml">List of all members</a> </div> + <div class="headertitle"> +<div class="title">DotNode Class Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p><code>#include <<a class="el" href="_dot_serializer_8hpp_source.xhtml">DotSerializer.hpp</a>></code></p> +<div class="dynheader"> +Inheritance diagram for DotNode:</div> +<div class="dyncontent"> + <div class="center"> + <img src="classarmnn_1_1_dot_node.png" usemap="#DotNode_map" alt=""/> + <map id="DotNode_map" name="DotNode_map"> +<area href="classarmnn_1_1_dot_base.xhtml" alt="DotBase" shape="rect" coords="0,0,61,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:a8ba78d7bbd1838e28d4208c3a1f2110d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_dot_node.xhtml#a8ba78d7bbd1838e28d4208c3a1f2110d">DotNode</a> (std::ostream &stream, <a class="el" href="namespacearmnn.xhtml#afad4088a9a058114ee5f87246f87bf49">LayerGuid</a> nodeId, const char *label)</td></tr> +<tr class="separator:a8ba78d7bbd1838e28d4208c3a1f2110d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a1a90b7c27390c5b4f7828a0c9917f6fe"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_dot_node.xhtml#a1a90b7c27390c5b4f7828a0c9917f6fe">~DotNode</a> ()</td></tr> +<tr class="separator:a1a90b7c27390c5b4f7828a0c9917f6fe"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a1734bc659f144a8465e22d4b53b8f580"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarmnn_1_1_node_content.xhtml">NodeContent</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_dot_node.xhtml#a1734bc659f144a8465e22d4b53b8f580">GetContents</a> ()</td></tr> +<tr class="separator:a1734bc659f144a8465e22d4b53b8f580"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a721c9bf7f2e6a2d88d340253ccc19815"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarmnn_1_1_dot_attribute_set.xhtml">DotAttributeSet</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_dot_node.xhtml#a721c9bf7f2e6a2d88d340253ccc19815">GetAttributeSet</a> ()</td></tr> +<tr class="separator:a721c9bf7f2e6a2d88d340253ccc19815"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="inherit_header pub_methods_classarmnn_1_1_dot_base"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarmnn_1_1_dot_base')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classarmnn_1_1_dot_base.xhtml">DotBase</a></td></tr> +<tr class="memitem:afba1dd3b85fb26c87e892ed80452d116 inherit pub_methods_classarmnn_1_1_dot_base"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_dot_base.xhtml#afba1dd3b85fb26c87e892ed80452d116">DotBase</a> (std::ostream &stream)</td></tr> +<tr class="separator:afba1dd3b85fb26c87e892ed80452d116 inherit pub_methods_classarmnn_1_1_dot_base"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a99131c6a3da28cceeeb67d732ff39d7d inherit pub_methods_classarmnn_1_1_dot_base"><td class="memItemLeft" align="right" valign="top">std::ostream & </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_dot_base.xhtml#a99131c6a3da28cceeeb67d732ff39d7d">GetStream</a> ()</td></tr> +<tr class="separator:a99131c6a3da28cceeeb67d732ff39d7d inherit pub_methods_classarmnn_1_1_dot_base"><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="_dot_serializer_8hpp_source.xhtml#l00101">101</a> of file <a class="el" href="_dot_serializer_8hpp_source.xhtml">DotSerializer.hpp</a>.</p> +</div><h2 class="groupheader">Constructor & Destructor Documentation</h2> +<a id="a8ba78d7bbd1838e28d4208c3a1f2110d"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a8ba78d7bbd1838e28d4208c3a1f2110d">◆ </a></span>DotNode()</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_dot_node.xhtml">DotNode</a> </td> + <td>(</td> + <td class="paramtype">std::ostream & </td> + <td class="paramname"><em>stream</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="namespacearmnn.xhtml#afad4088a9a058114ee5f87246f87bf49">LayerGuid</a> </td> + <td class="paramname"><em>nodeId</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>label</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">explicit</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p class="definition">Definition at line <a class="el" href="_dot_serializer_8cpp_source.xhtml#l00179">179</a> of file <a class="el" href="_dot_serializer_8cpp_source.xhtml">DotSerializer.cpp</a>.</p> + +<p class="reference">References <a class="el" href="_dot_serializer_8hpp_source.xhtml#l00023">DotBase::GetStream()</a>.</p> +<div class="fragment"><div class="line"><a name="l00180"></a><span class="lineno"> 180</span>  : <a class="code" href="classarmnn_1_1_dot_base.xhtml#afba1dd3b85fb26c87e892ed80452d116">DotBase</a>(stream)</div><div class="line"><a name="l00181"></a><span class="lineno"> 181</span> {</div><div class="line"><a name="l00182"></a><span class="lineno"> 182</span>  std::stringstream ss;</div><div class="line"><a name="l00183"></a><span class="lineno"> 183</span>  ss << Indent(4) << nodeId;</div><div class="line"><a name="l00184"></a><span class="lineno"> 184</span> </div><div class="line"><a name="l00185"></a><span class="lineno"> 185</span>  <a class="code" href="classarmnn_1_1_dot_base.xhtml#a99131c6a3da28cceeeb67d732ff39d7d">GetStream</a>() << ss.str() << <span class="stringliteral">" "</span>;</div><div class="line"><a name="l00186"></a><span class="lineno"> 186</span> </div><div class="line"><a name="l00187"></a><span class="lineno"> 187</span>  m_Contents = std::make_unique<NodeContent>(stream);</div><div class="line"><a name="l00188"></a><span class="lineno"> 188</span>  m_Attributes = std::make_unique<DotAttributeSet>(stream);</div><div class="line"><a name="l00189"></a><span class="lineno"> 189</span> </div><div class="line"><a name="l00190"></a><span class="lineno"> 190</span>  <span class="keywordflow">if</span> (std::strlen(label) != 0)</div><div class="line"><a name="l00191"></a><span class="lineno"> 191</span>  {</div><div class="line"><a name="l00192"></a><span class="lineno"> 192</span>  m_Contents->SetName(label);</div><div class="line"><a name="l00193"></a><span class="lineno"> 193</span>  }</div><div class="line"><a name="l00194"></a><span class="lineno"> 194</span>  <span class="keywordflow">else</span></div><div class="line"><a name="l00195"></a><span class="lineno"> 195</span>  {</div><div class="line"><a name="l00196"></a><span class="lineno"> 196</span>  m_Contents->SetName(<span class="stringliteral">"<noname>"</span>);</div><div class="line"><a name="l00197"></a><span class="lineno"> 197</span>  }</div><div class="line"><a name="l00198"></a><span class="lineno"> 198</span> }</div><div class="ttc" id="classarmnn_1_1_dot_base_xhtml_afba1dd3b85fb26c87e892ed80452d116"><div class="ttname"><a href="classarmnn_1_1_dot_base.xhtml#afba1dd3b85fb26c87e892ed80452d116">armnn::DotBase::DotBase</a></div><div class="ttdeci">DotBase(std::ostream &stream)</div><div class="ttdef"><b>Definition:</b> <a href="_dot_serializer_8hpp_source.xhtml#l00020">DotSerializer.hpp:20</a></div></div> +<div class="ttc" id="classarmnn_1_1_dot_base_xhtml_a99131c6a3da28cceeeb67d732ff39d7d"><div class="ttname"><a href="classarmnn_1_1_dot_base.xhtml#a99131c6a3da28cceeeb67d732ff39d7d">armnn::DotBase::GetStream</a></div><div class="ttdeci">std::ostream & GetStream()</div><div class="ttdef"><b>Definition:</b> <a href="_dot_serializer_8hpp_source.xhtml#l00023">DotSerializer.hpp:23</a></div></div> +</div><!-- fragment --> +</div> +</div> +<a id="a1a90b7c27390c5b4f7828a0c9917f6fe"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a1a90b7c27390c5b4f7828a0c9917f6fe">◆ </a></span>~DotNode()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">~<a class="el" href="classarmnn_1_1_dot_node.xhtml">DotNode</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="_dot_serializer_8cpp_source.xhtml#l00200">200</a> of file <a class="el" href="_dot_serializer_8cpp_source.xhtml">DotSerializer.cpp</a>.</p> + +<p class="reference">References <a class="el" href="_dot_serializer_8hpp_source.xhtml#l00023">DotBase::GetStream()</a>.</p> +<div class="fragment"><div class="line"><a name="l00201"></a><span class="lineno"> 201</span> {</div><div class="line"><a name="l00202"></a><span class="lineno"> 202</span>  m_Contents.reset(<span class="keyword">nullptr</span>);</div><div class="line"><a name="l00203"></a><span class="lineno"> 203</span>  m_Attributes.reset(<span class="keyword">nullptr</span>);</div><div class="line"><a name="l00204"></a><span class="lineno"> 204</span>  <a class="code" href="classarmnn_1_1_dot_base.xhtml#a99131c6a3da28cceeeb67d732ff39d7d">GetStream</a>() << <span class="stringliteral">";"</span> << std::endl;</div><div class="line"><a name="l00205"></a><span class="lineno"> 205</span> }</div><div class="ttc" id="classarmnn_1_1_dot_base_xhtml_a99131c6a3da28cceeeb67d732ff39d7d"><div class="ttname"><a href="classarmnn_1_1_dot_base.xhtml#a99131c6a3da28cceeeb67d732ff39d7d">armnn::DotBase::GetStream</a></div><div class="ttdeci">std::ostream & GetStream()</div><div class="ttdef"><b>Definition:</b> <a href="_dot_serializer_8hpp_source.xhtml#l00023">DotSerializer.hpp:23</a></div></div> +</div><!-- fragment --> +</div> +</div> +<h2 class="groupheader">Member Function Documentation</h2> +<a id="a721c9bf7f2e6a2d88d340253ccc19815"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a721c9bf7f2e6a2d88d340253ccc19815">◆ </a></span>GetAttributeSet()</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_dot_attribute_set.xhtml">DotAttributeSet</a>& GetAttributeSet </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="_dot_serializer_8hpp_source.xhtml#l00108">108</a> of file <a class="el" href="_dot_serializer_8hpp_source.xhtml">DotSerializer.hpp</a>.</p> +<div class="fragment"><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> { <span class="keywordflow">return</span> *m_Attributes.get(); }</div></div><!-- fragment --> +</div> +</div> +<a id="a1734bc659f144a8465e22d4b53b8f580"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a1734bc659f144a8465e22d4b53b8f580">◆ </a></span>GetContents()</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_node_content.xhtml">NodeContent</a>& GetContents </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="_dot_serializer_8hpp_source.xhtml#l00107">107</a> of file <a class="el" href="_dot_serializer_8hpp_source.xhtml">DotSerializer.hpp</a>.</p> + +<p class="reference">Referenced by <a class="el" href="_graph_8cpp_source.xhtml#l00081">Graph::SerializeToDot()</a>.</p> +<div class="fragment"><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> { <span class="keywordflow">return</span> *m_Contents.get(); }</div></div><!-- fragment --> +</div> +</div> +<hr/>The documentation for this class was generated from the following files:<ul> +<li>src/armnnUtils/<a class="el" href="_dot_serializer_8hpp_source.xhtml">DotSerializer.hpp</a></li> +<li>src/armnnUtils/<a class="el" href="_dot_serializer_8cpp_source.xhtml">DotSerializer.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_dot_node.xhtml">DotNode</a></li> + <li class="footer">Generated on Fri Mar 13 2020 16:09:17 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> |