diff options
author | Jim Flynn <jim.flynn@arm.com> | 2020-03-19 17:03:14 +0000 |
---|---|---|
committer | Jim Flynn <jim.flynn@arm.com> | 2020-03-19 17:03:14 +0000 |
commit | 0e2bab81442ee6cc2b94e4f7881ed0c5c6af65e7 (patch) | |
tree | b0af08b5a0b74149fca422151127ac6310385399 /Documentation/classarmnn_1_1_device_spec.html | |
parent | 8c3259fa007d43fcc5ea56fe6928526dbe79f3c0 (diff) | |
download | armnn-0e2bab81442ee6cc2b94e4f7881ed0c5c6af65e7.tar.gz |
Creating gh-pages documentation for ArmNN
Signed-off-by: Jim Flynn <jim.flynn@arm.com>
Diffstat (limited to 'Documentation/classarmnn_1_1_device_spec.html')
-rw-r--r-- | Documentation/classarmnn_1_1_device_spec.html | 358 |
1 files changed, 358 insertions, 0 deletions
diff --git a/Documentation/classarmnn_1_1_device_spec.html b/Documentation/classarmnn_1_1_device_spec.html new file mode 100644 index 0000000000..bd04e32890 --- /dev/null +++ b/Documentation/classarmnn_1_1_device_spec.html @@ -0,0 +1,358 @@ +<!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: DeviceSpec 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_device_spec.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-methods">Public Member Functions</a> | +<a href="classarmnn_1_1_device_spec-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">DeviceSpec Class Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p><code>#include <<a class="el" href="_device_spec_8hpp_source.html">DeviceSpec.hpp</a>></code></p> +<div class="dynheader"> +Inheritance diagram for DeviceSpec:</div> +<div class="dyncontent"> + <div class="center"> + <img src="classarmnn_1_1_device_spec.png" usemap="#DeviceSpec_map" alt=""/> + <map id="DeviceSpec_map" name="DeviceSpec_map"> +<area href="classarmnn_1_1_i_device_spec.html" title="Device specific knowledge to be passed to the optimizer. " alt="IDeviceSpec" shape="rect" coords="0,0,84,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:a7cb8360a6e7bada5ef374c9cc77f2339"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_device_spec.html#a7cb8360a6e7bada5ef374c9cc77f2339">DeviceSpec</a> ()</td></tr> +<tr class="separator:a7cb8360a6e7bada5ef374c9cc77f2339"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a6ddc7e2f74bffe83d8e64b72c101dd7a"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_device_spec.html#a6ddc7e2f74bffe83d8e64b72c101dd7a">DeviceSpec</a> (const <a class="el" href="namespacearmnn.html#a1854d9cda81304325664363c1fd0fb27">BackendIdSet</a> &supportedBackends)</td></tr> +<tr class="separator:a6ddc7e2f74bffe83d8e64b72c101dd7a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a36963441acb57ec53af7fef48bfd434c"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_device_spec.html#a36963441acb57ec53af7fef48bfd434c">~DeviceSpec</a> ()</td></tr> +<tr class="separator:a36963441acb57ec53af7fef48bfd434c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a89d4c29e22db837f787e2171b8a71892"><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="namespacearmnn.html#a1854d9cda81304325664363c1fd0fb27">BackendIdSet</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_device_spec.html#a89d4c29e22db837f787e2171b8a71892">GetSupportedBackends</a> () const override</td></tr> +<tr class="separator:a89d4c29e22db837f787e2171b8a71892"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a35b48a741948fd9b2fca9698a698fdae"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_device_spec.html#a35b48a741948fd9b2fca9698a698fdae">AddSupportedBackends</a> (const <a class="el" href="namespacearmnn.html#a1854d9cda81304325664363c1fd0fb27">BackendIdSet</a> &backendIds, bool isDynamic=<a class="el" href="_ref_layer_tests_8cpp.html#a67e2647a90dec71bb79c8b38872ba570">false</a>)</td></tr> +<tr class="separator:a35b48a741948fd9b2fca9698a698fdae"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a5051d926510964d87440330c0469d9c5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_device_spec.html#a5051d926510964d87440330c0469d9c5">ClearDynamicBackends</a> ()</td></tr> +<tr class="separator:a5051d926510964d87440330c0469d9c5"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a2a52bc9548350a186cdb8f9565eed4f0"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="namespacearmnn.html#a1854d9cda81304325664363c1fd0fb27">BackendIdSet</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_device_spec.html#a2a52bc9548350a186cdb8f9565eed4f0">GetDynamicBackends</a> () const</td></tr> +<tr class="separator:a2a52bc9548350a186cdb8f9565eed4f0"><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 pro_methods_classarmnn_1_1_i_device_spec"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classarmnn_1_1_i_device_spec')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classarmnn_1_1_i_device_spec.html">IDeviceSpec</a></td></tr> +<tr class="memitem:a78094a70ac68736ddbc2b7a6e7442a7a inherit pro_methods_classarmnn_1_1_i_device_spec"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_i_device_spec.html#a78094a70ac68736ddbc2b7a6e7442a7a">IDeviceSpec</a> ()</td></tr> +<tr class="separator:a78094a70ac68736ddbc2b7a6e7442a7a inherit pro_methods_classarmnn_1_1_i_device_spec"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aa95584a320afb7c759ad27e3f8e7f3f5 inherit pro_methods_classarmnn_1_1_i_device_spec"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_i_device_spec.html#aa95584a320afb7c759ad27e3f8e7f3f5">~IDeviceSpec</a> ()</td></tr> +<tr class="separator:aa95584a320afb7c759ad27e3f8e7f3f5 inherit pro_methods_classarmnn_1_1_i_device_spec"><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="_device_spec_8hpp_source.html#l00014">14</a> of file <a class="el" href="_device_spec_8hpp_source.html">DeviceSpec.hpp</a>.</p> +</div><h2 class="groupheader">Constructor & Destructor Documentation</h2> +<a id="a7cb8360a6e7bada5ef374c9cc77f2339"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a7cb8360a6e7bada5ef374c9cc77f2339">◆ </a></span>DeviceSpec() <span class="overload">[1/2]</span></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_device_spec.html">DeviceSpec</a> </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="_device_spec_8hpp_source.html#l00017">17</a> of file <a class="el" href="_device_spec_8hpp_source.html">DeviceSpec.hpp</a>.</p> +<div class="fragment"><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  {}</div></div><!-- fragment --> +</div> +</div> +<a id="a6ddc7e2f74bffe83d8e64b72c101dd7a"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a6ddc7e2f74bffe83d8e64b72c101dd7a">◆ </a></span>DeviceSpec() <span class="overload">[2/2]</span></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_device_spec.html">DeviceSpec</a> </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="namespacearmnn.html#a1854d9cda81304325664363c1fd0fb27">BackendIdSet</a> & </td> + <td class="paramname"><em>supportedBackends</em></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="_device_spec_8hpp_source.html#l00020">20</a> of file <a class="el" href="_device_spec_8hpp_source.html">DeviceSpec.hpp</a>.</p> +<div class="fragment"><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  : m_SupportedBackends{supportedBackends} {}</div></div><!-- fragment --> +</div> +</div> +<a id="a36963441acb57ec53af7fef48bfd434c"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a36963441acb57ec53af7fef48bfd434c">◆ </a></span>~DeviceSpec()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual ~<a class="el" href="classarmnn_1_1_device_spec.html">DeviceSpec</a> </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 class="mlabel">virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p class="definition">Definition at line <a class="el" href="_device_spec_8hpp_source.html#l00023">23</a> of file <a class="el" href="_device_spec_8hpp_source.html">DeviceSpec.hpp</a>.</p> +<div class="fragment"><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> {}</div></div><!-- fragment --> +</div> +</div> +<h2 class="groupheader">Member Function Documentation</h2> +<a id="a35b48a741948fd9b2fca9698a698fdae"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a35b48a741948fd9b2fca9698a698fdae">◆ </a></span>AddSupportedBackends()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">void AddSupportedBackends </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="namespacearmnn.html#a1854d9cda81304325664363c1fd0fb27">BackendIdSet</a> & </td> + <td class="paramname"><em>backendIds</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">bool </td> + <td class="paramname"><em>isDynamic</em> = <code><a class="el" href="_ref_layer_tests_8cpp.html#a67e2647a90dec71bb79c8b38872ba570">false</a></code> </td> + </tr> + <tr> + <td></td> + <td>)</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="_device_spec_8hpp_source.html#l00030">30</a> of file <a class="el" href="_device_spec_8hpp_source.html">DeviceSpec.hpp</a>.</p> + +<p class="reference">Referenced by <a class="el" href="_runtime_8cpp_source.html#l00290">Runtime::RegisterDebugCallback()</a>, and <a class="el" href="_runtime_8cpp_source.html#l00155">Runtime::Runtime()</a>.</p> +<div class="fragment"><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  {</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  m_SupportedBackends.insert(backendIds.begin(), backendIds.end());</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="keywordflow">if</span> (isDynamic)</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  {</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  m_DynamicBackends.insert(backendIds.begin(), backendIds.end());</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  }</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  }</div></div><!-- fragment --> +</div> +</div> +<a id="a5051d926510964d87440330c0469d9c5"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a5051d926510964d87440330c0469d9c5">◆ </a></span>ClearDynamicBackends()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">void ClearDynamicBackends </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="_device_spec_8hpp_source.html#l00039">39</a> of file <a class="el" href="_device_spec_8hpp_source.html">DeviceSpec.hpp</a>.</p> + +<p class="reference">Referenced by <a class="el" href="_runtime_8cpp_source.html#l00208">Runtime::~Runtime()</a>.</p> +<div class="fragment"><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>  <span class="keywordflow">for</span> (<span class="keyword">const</span> <span class="keyword">auto</span>& <span class="keywordtype">id</span> : m_DynamicBackends)</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  {</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  m_SupportedBackends.erase(<span class="keywordtype">id</span>);</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>  m_DynamicBackends.clear();</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  }</div></div><!-- fragment --> +</div> +</div> +<a id="a2a52bc9548350a186cdb8f9565eed4f0"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a2a52bc9548350a186cdb8f9565eed4f0">◆ </a></span>GetDynamicBackends()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">const <a class="el" href="namespacearmnn.html#a1854d9cda81304325664363c1fd0fb27">BackendIdSet</a>& GetDynamicBackends </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> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p class="definition">Definition at line <a class="el" href="_device_spec_8hpp_source.html#l00048">48</a> of file <a class="el" href="_device_spec_8hpp_source.html">DeviceSpec.hpp</a>.</p> + +<p class="reference">Referenced by <a class="el" href="_runtime_8cpp_source.html#l00208">Runtime::~Runtime()</a>.</p> +<div class="fragment"><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>  <span class="keywordflow">return</span> m_DynamicBackends;</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  }</div></div><!-- fragment --> +</div> +</div> +<a id="a89d4c29e22db837f787e2171b8a71892"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a89d4c29e22db837f787e2171b8a71892">◆ </a></span>GetSupportedBackends()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual const <a class="el" href="namespacearmnn.html#a1854d9cda81304325664363c1fd0fb27">BackendIdSet</a>& GetSupportedBackends </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">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_device_spec.html#a9e5847ef27016a08de6751040a17cbaa">IDeviceSpec</a>.</p> + +<p class="definition">Definition at line <a class="el" href="_device_spec_8hpp_source.html#l00025">25</a> of file <a class="el" href="_device_spec_8hpp_source.html">DeviceSpec.hpp</a>.</p> + +<p class="reference">Referenced by <a class="el" href="_backend_settings_8hpp_source.html#l00063">BackendSettings::GetAvailablePreferredBackends()</a>, <a class="el" href="_dynamic_backend_tests_8hpp_source.html#l01202">RuntimeEmptyTestImpl()</a>, and <a class="el" href="_dynamic_backend_tests_8hpp_source.html#l01331">RuntimeInvalidOverridePathTestImpl()</a>.</p> +<div class="fragment"><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  {</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <span class="keywordflow">return</span> m_SupportedBackends;</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  }</div></div><!-- fragment --> +</div> +</div> +<hr/>The documentation for this class was generated from the following file:<ul> +<li>src/armnn/<a class="el" href="_device_spec_8hpp_source.html">DeviceSpec.hpp</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_device_spec.html">DeviceSpec</a></li> + <li class="footer">Generated on Fri Mar 13 2020 16:07:03 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> |