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_1profiling_1_1_i_counter_registry.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_1profiling_1_1_i_counter_registry.html')
-rw-r--r-- | Documentation/classarmnn_1_1profiling_1_1_i_counter_registry.html | 402 |
1 files changed, 402 insertions, 0 deletions
diff --git a/Documentation/classarmnn_1_1profiling_1_1_i_counter_registry.html b/Documentation/classarmnn_1_1profiling_1_1_i_counter_registry.html new file mode 100644 index 0000000000..5d704772fd --- /dev/null +++ b/Documentation/classarmnn_1_1profiling_1_1_i_counter_registry.html @@ -0,0 +1,402 @@ +<!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: ICounterRegistry 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_1profiling_1_1_i_counter_registry.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_1profiling_1_1_i_counter_registry-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">ICounterRegistry Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> +</div><!--header--> +<div class="contents"> + +<p><code>#include <<a class="el" href="_i_counter_registry_8hpp_source.html">ICounterRegistry.hpp</a>></code></p> +<div class="dynheader"> +Inheritance diagram for ICounterRegistry:</div> +<div class="dyncontent"> + <div class="center"> + <img src="classarmnn_1_1profiling_1_1_i_counter_registry.png" usemap="#ICounterRegistry_map" alt=""/> + <map id="ICounterRegistry_map" name="ICounterRegistry_map"> +<area href="classarmnn_1_1profiling_1_1_counter_directory.html" alt="CounterDirectory" shape="rect" coords="0,56,110,80"/> +</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:ae975a04ac3e352f5ed0c13501a684cb5"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_i_counter_registry.html#ae975a04ac3e352f5ed0c13501a684cb5">~ICounterRegistry</a> ()</td></tr> +<tr class="separator:ae975a04ac3e352f5ed0c13501a684cb5"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a4e6bfd22b99c6f43e2d1cd4784664501"><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="classarmnn_1_1profiling_1_1_category.html">Category</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_i_counter_registry.html#a4e6bfd22b99c6f43e2d1cd4784664501">RegisterCategory</a> (const std::string &categoryName, const <a class="el" href="classarmnn_1_1_optional.html">Optional</a>< uint16_t > &deviceUid, const <a class="el" href="classarmnn_1_1_optional.html">Optional</a>< uint16_t > &counterSetUid)=0</td></tr> +<tr class="separator:a4e6bfd22b99c6f43e2d1cd4784664501"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a552c43eab6a2ba99f68f98802631db8e"><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="classarmnn_1_1profiling_1_1_device.html">Device</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_i_counter_registry.html#a552c43eab6a2ba99f68f98802631db8e">RegisterDevice</a> (const std::string &deviceName, uint16_t cores, const <a class="el" href="classarmnn_1_1_optional.html">Optional</a>< std::string > &parentCategoryName)=0</td></tr> +<tr class="separator:a552c43eab6a2ba99f68f98802631db8e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a0338e5b744c9c2d08143cf70d319940f"><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="classarmnn_1_1profiling_1_1_counter_set.html">CounterSet</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_i_counter_registry.html#a0338e5b744c9c2d08143cf70d319940f">RegisterCounterSet</a> (const std::string &counterSetName, uint16_t count, const <a class="el" href="classarmnn_1_1_optional.html">Optional</a>< std::string > &parentCategoryName)=0</td></tr> +<tr class="separator:a0338e5b744c9c2d08143cf70d319940f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a1d4c2bc2310f063afdf3691f3228012f"><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="classarmnn_1_1profiling_1_1_counter.html">Counter</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_i_counter_registry.html#a1d4c2bc2310f063afdf3691f3228012f">RegisterCounter</a> (const <a class="el" href="classarmnn_1_1_backend_id.html">BackendId</a> &backendId, const uint16_t uid, const std::string &parentCategoryName, uint16_t counterClass, uint16_t interpolation, double multiplier, const std::string &name, const std::string &description, const <a class="el" href="classarmnn_1_1_optional.html">Optional</a>< std::string > &units, const <a class="el" href="classarmnn_1_1_optional.html">Optional</a>< uint16_t > &numberOfCores, const <a class="el" href="classarmnn_1_1_optional.html">Optional</a>< uint16_t > &deviceUid, const <a class="el" href="classarmnn_1_1_optional.html">Optional</a>< uint16_t > &counterSetUid)=0</td></tr> +<tr class="separator:a1d4c2bc2310f063afdf3691f3228012f"><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="_i_counter_registry_8hpp_source.html#l00017">17</a> of file <a class="el" href="_i_counter_registry_8hpp_source.html">ICounterRegistry.hpp</a>.</p> +</div><h2 class="groupheader">Constructor & Destructor Documentation</h2> +<a id="ae975a04ac3e352f5ed0c13501a684cb5"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ae975a04ac3e352f5ed0c13501a684cb5">◆ </a></span>~ICounterRegistry()</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_1profiling_1_1_i_counter_registry.html">ICounterRegistry</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="_i_counter_registry_8hpp_source.html#l00020">20</a> of file <a class="el" href="_i_counter_registry_8hpp_source.html">ICounterRegistry.hpp</a>.</p> + +<p class="reference">References <a class="el" href="classarmnn_1_1profiling_1_1_i_counter_registry.html#a4e6bfd22b99c6f43e2d1cd4784664501">ICounterRegistry::RegisterCategory()</a>, <a class="el" href="classarmnn_1_1profiling_1_1_i_counter_registry.html#a1d4c2bc2310f063afdf3691f3228012f">ICounterRegistry::RegisterCounter()</a>, <a class="el" href="classarmnn_1_1profiling_1_1_i_counter_registry.html#a0338e5b744c9c2d08143cf70d319940f">ICounterRegistry::RegisterCounterSet()</a>, and <a class="el" href="classarmnn_1_1profiling_1_1_i_counter_registry.html#a552c43eab6a2ba99f68f98802631db8e">ICounterRegistry::RegisterDevice()</a>.</p> +<div class="fragment"><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> {}</div></div><!-- fragment --> +</div> +</div> +<h2 class="groupheader">Member Function Documentation</h2> +<a id="a4e6bfd22b99c6f43e2d1cd4784664501"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a4e6bfd22b99c6f43e2d1cd4784664501">◆ </a></span>RegisterCategory()</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="classarmnn_1_1profiling_1_1_category.html">Category</a>* RegisterCategory </td> + <td>(</td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>categoryName</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classarmnn_1_1_optional.html">Optional</a>< uint16_t > & </td> + <td class="paramname"><em>deviceUid</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classarmnn_1_1_optional.html">Optional</a>< uint16_t > & </td> + <td class="paramname"><em>counterSetUid</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">pure virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Implemented in <a class="el" href="classarmnn_1_1profiling_1_1_counter_directory.html#aaa547e84c90dc8dc30ac1115a7556124">CounterDirectory</a>.</p> + +<p class="reference">Referenced by <a class="el" href="_register_backend_counters_8cpp_source.html#l00014">RegisterBackendCounters::RegisterCategory()</a>, and <a class="el" href="_i_counter_registry_8hpp_source.html#l00020">ICounterRegistry::~ICounterRegistry()</a>.</p> + +</div> +</div> +<a id="a1d4c2bc2310f063afdf3691f3228012f"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a1d4c2bc2310f063afdf3691f3228012f">◆ </a></span>RegisterCounter()</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="classarmnn_1_1profiling_1_1_counter.html">Counter</a>* RegisterCounter </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classarmnn_1_1_backend_id.html">BackendId</a> & </td> + <td class="paramname"><em>backendId</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const uint16_t </td> + <td class="paramname"><em>uid</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>parentCategoryName</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">uint16_t </td> + <td class="paramname"><em>counterClass</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">uint16_t </td> + <td class="paramname"><em>interpolation</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">double </td> + <td class="paramname"><em>multiplier</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>description</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classarmnn_1_1_optional.html">Optional</a>< std::string > & </td> + <td class="paramname"><em>units</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classarmnn_1_1_optional.html">Optional</a>< uint16_t > & </td> + <td class="paramname"><em>numberOfCores</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classarmnn_1_1_optional.html">Optional</a>< uint16_t > & </td> + <td class="paramname"><em>deviceUid</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classarmnn_1_1_optional.html">Optional</a>< uint16_t > & </td> + <td class="paramname"><em>counterSetUid</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">pure virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Implemented in <a class="el" href="classarmnn_1_1profiling_1_1_counter_directory.html#ab9756dfaf9b36cc51262369a27d1384f">CounterDirectory</a>.</p> + +<p class="reference">Referenced by <a class="el" href="_register_backend_counters_8cpp_source.html#l00037">RegisterBackendCounters::RegisterCounter()</a>, and <a class="el" href="_i_counter_registry_8hpp_source.html#l00020">ICounterRegistry::~ICounterRegistry()</a>.</p> + +</div> +</div> +<a id="a0338e5b744c9c2d08143cf70d319940f"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a0338e5b744c9c2d08143cf70d319940f">◆ </a></span>RegisterCounterSet()</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="classarmnn_1_1profiling_1_1_counter_set.html">CounterSet</a>* RegisterCounterSet </td> + <td>(</td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>counterSetName</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">uint16_t </td> + <td class="paramname"><em>count</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classarmnn_1_1_optional.html">Optional</a>< std::string > & </td> + <td class="paramname"><em>parentCategoryName</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">pure virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Implemented in <a class="el" href="classarmnn_1_1profiling_1_1_counter_directory.html#a161604d904508d5b86b459c2c2ace4be">CounterDirectory</a>.</p> + +<p class="reference">Referenced by <a class="el" href="_register_backend_counters_8cpp_source.html#l00029">RegisterBackendCounters::RegisterCounterSet()</a>, and <a class="el" href="_i_counter_registry_8hpp_source.html#l00020">ICounterRegistry::~ICounterRegistry()</a>.</p> + +</div> +</div> +<a id="a552c43eab6a2ba99f68f98802631db8e"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a552c43eab6a2ba99f68f98802631db8e">◆ </a></span>RegisterDevice()</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="classarmnn_1_1profiling_1_1_device.html">Device</a>* RegisterDevice </td> + <td>(</td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>deviceName</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">uint16_t </td> + <td class="paramname"><em>cores</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classarmnn_1_1_optional.html">Optional</a>< std::string > & </td> + <td class="paramname"><em>parentCategoryName</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">pure virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Implemented in <a class="el" href="classarmnn_1_1profiling_1_1_counter_directory.html#a6ec101239653ba9260e1362c5381e81d">CounterDirectory</a>.</p> + +<p class="reference">Referenced by <a class="el" href="_register_backend_counters_8cpp_source.html#l00021">RegisterBackendCounters::RegisterDevice()</a>, and <a class="el" href="_i_counter_registry_8hpp_source.html#l00020">ICounterRegistry::~ICounterRegistry()</a>.</p> + +</div> +</div> +<hr/>The documentation for this class was generated from the following file:<ul> +<li>src/profiling/<a class="el" href="_i_counter_registry_8hpp_source.html">ICounterRegistry.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="namespacearmnn_1_1profiling.html">profiling</a></li><li class="navelem"><a class="el" href="classarmnn_1_1profiling_1_1_i_counter_registry.html">ICounterRegistry</a></li> + <li class="footer">Generated on Fri Mar 13 2020 16:07:06 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> |