blob: 89e12bdc7b4d67bed61e9c3e8aea1e2582b3cbe5 [file] [log] [blame]
<!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: src/profiling/ICounterRegistry.hpp Source File</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
&#160;<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('_i_counter_registry_8hpp_source.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="headertitle">
<div class="title">ICounterRegistry.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="_i_counter_registry_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">// Copyright © 2020 Arm Ltd. All rights reserved.</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">// SPDX-License-Identifier: MIT</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;</div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor">#pragma once</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;</div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="_optional_8hpp.html">armnn/Optional.hpp</a>&gt;</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="_backend_id_8hpp.html">armnn/BackendId.hpp</a>&gt;</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;</div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacearmnn.html">armnn</a></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;{</div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;</div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="keyword">namespace </span>profiling</div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;{</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;</div><div class="line"><a name="l00017"></a><span class="lineno"><a class="line" href="classarmnn_1_1profiling_1_1_i_counter_registry.html"> 17</a></span>&#160;<span class="keyword">class </span><a class="code" href="classarmnn_1_1profiling_1_1_i_counter_registry.html">ICounterRegistry</a></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;{</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="classarmnn_1_1profiling_1_1_i_counter_registry.html#ae975a04ac3e352f5ed0c13501a684cb5"> 20</a></span>&#160; <span class="keyword">virtual</span> <a class="code" href="classarmnn_1_1profiling_1_1_i_counter_registry.html#ae975a04ac3e352f5ed0c13501a684cb5">~ICounterRegistry</a>() {}</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; <span class="comment">// Register profiling objects</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="classarmnn_1_1profiling_1_1_category.html">Category</a>* <a class="code" href="classarmnn_1_1profiling_1_1_i_counter_registry.html#a4e6bfd22b99c6f43e2d1cd4784664501">RegisterCategory</a> (<span class="keyword">const</span> std::string&amp; categoryName,</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; <span class="keyword">const</span> <a class="code" href="classarmnn_1_1_optional.html">Optional&lt;uint16_t&gt;</a>&amp; deviceUid,</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; <span class="keyword">const</span> <a class="code" href="classarmnn_1_1_optional.html">Optional&lt;uint16_t&gt;</a>&amp; counterSetUid) = 0;</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="classarmnn_1_1profiling_1_1_device.html">Device</a>* <a class="code" href="classarmnn_1_1profiling_1_1_i_counter_registry.html#a552c43eab6a2ba99f68f98802631db8e">RegisterDevice</a> (<span class="keyword">const</span> std::string&amp; deviceName,</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; uint16_t cores,</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; <span class="keyword">const</span> <a class="code" href="classarmnn_1_1_optional.html">Optional&lt;std::string&gt;</a>&amp; parentCategoryName) = 0;</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="classarmnn_1_1profiling_1_1_counter_set.html">CounterSet</a>* <a class="code" href="classarmnn_1_1profiling_1_1_i_counter_registry.html#a0338e5b744c9c2d08143cf70d319940f">RegisterCounterSet</a>(<span class="keyword">const</span> std::string&amp; counterSetName,</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; uint16_t count,</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <span class="keyword">const</span> <a class="code" href="classarmnn_1_1_optional.html">Optional&lt;std::string&gt;</a>&amp; parentCategoryName) = 0;</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="classarmnn_1_1profiling_1_1_counter.html">Counter</a>* <a class="code" href="classarmnn_1_1profiling_1_1_i_counter_registry.html#a1d4c2bc2310f063afdf3691f3228012f">RegisterCounter</a>(<span class="keyword">const</span> <a class="code" href="classarmnn_1_1_backend_id.html">BackendId</a>&amp; backendId,</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="keyword">const</span> uint16_t uid,</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="keyword">const</span> std::string&amp; parentCategoryName,</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; uint16_t counterClass,</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; uint16_t interpolation,</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="keywordtype">double</span> multiplier,</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="keyword">const</span> std::string&amp; name,</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="keyword">const</span> std::string&amp; description,</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keyword">const</span> <a class="code" href="classarmnn_1_1_optional.html">Optional&lt;std::string&gt;</a>&amp; units,</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="keyword">const</span> <a class="code" href="classarmnn_1_1_optional.html">Optional&lt;uint16_t&gt;</a>&amp; numberOfCores,</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="keyword">const</span> <a class="code" href="classarmnn_1_1_optional.html">Optional&lt;uint16_t&gt;</a>&amp; deviceUid,</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="keyword">const</span> <a class="code" href="classarmnn_1_1_optional.html">Optional&lt;uint16_t&gt;</a>&amp; counterSetUid) = 0;</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;};</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;} <span class="comment">// namespace profiling</span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;} <span class="comment">// namespace armnn</span></div><div class="ttc" id="classarmnn_1_1profiling_1_1_device_html"><div class="ttname"><a href="classarmnn_1_1profiling_1_1_device.html">armnn::profiling::Device</a></div><div class="ttdef"><b>Definition:</b> <a href="_i_counter_directory_8hpp_source.html#l00067">ICounterDirectory.hpp:67</a></div></div>
<div class="ttc" id="classarmnn_1_1profiling_1_1_i_counter_registry_html_a552c43eab6a2ba99f68f98802631db8e"><div class="ttname"><a href="classarmnn_1_1profiling_1_1_i_counter_registry.html#a552c43eab6a2ba99f68f98802631db8e">armnn::profiling::ICounterRegistry::RegisterDevice</a></div><div class="ttdeci">virtual const Device * RegisterDevice(const std::string &amp;deviceName, uint16_t cores, const Optional&lt; std::string &gt; &amp;parentCategoryName)=0</div></div>
<div class="ttc" id="classarmnn_1_1_optional_html"><div class="ttname"><a href="classarmnn_1_1_optional.html">armnn::Optional</a></div><div class="ttdef"><b>Definition:</b> <a href="_optional_8hpp_source.html#l00270">Optional.hpp:270</a></div></div>
<div class="ttc" id="classarmnn_1_1profiling_1_1_counter_set_html"><div class="ttname"><a href="classarmnn_1_1profiling_1_1_counter_set.html">armnn::profiling::CounterSet</a></div><div class="ttdef"><b>Definition:</b> <a href="_i_counter_directory_8hpp_source.html#l00083">ICounterDirectory.hpp:83</a></div></div>
<div class="ttc" id="classarmnn_1_1profiling_1_1_i_counter_registry_html_a4e6bfd22b99c6f43e2d1cd4784664501"><div class="ttname"><a href="classarmnn_1_1profiling_1_1_i_counter_registry.html#a4e6bfd22b99c6f43e2d1cd4784664501">armnn::profiling::ICounterRegistry::RegisterCategory</a></div><div class="ttdeci">virtual const Category * RegisterCategory(const std::string &amp;categoryName, const Optional&lt; uint16_t &gt; &amp;deviceUid, const Optional&lt; uint16_t &gt; &amp;counterSetUid)=0</div></div>
<div class="ttc" id="classarmnn_1_1_backend_id_html"><div class="ttname"><a href="classarmnn_1_1_backend_id.html">armnn::BackendId</a></div><div class="ttdef"><b>Definition:</b> <a href="_backend_id_8hpp_source.html#l00075">BackendId.hpp:75</a></div></div>
<div class="ttc" id="classarmnn_1_1profiling_1_1_i_counter_registry_html_ae975a04ac3e352f5ed0c13501a684cb5"><div class="ttname"><a href="classarmnn_1_1profiling_1_1_i_counter_registry.html#ae975a04ac3e352f5ed0c13501a684cb5">armnn::profiling::ICounterRegistry::~ICounterRegistry</a></div><div class="ttdeci">virtual ~ICounterRegistry()</div><div class="ttdef"><b>Definition:</b> <a href="_i_counter_registry_8hpp_source.html#l00020">ICounterRegistry.hpp:20</a></div></div>
<div class="ttc" id="_backend_id_8hpp_html"><div class="ttname"><a href="_backend_id_8hpp.html">BackendId.hpp</a></div></div>
<div class="ttc" id="classarmnn_1_1profiling_1_1_counter_html"><div class="ttname"><a href="classarmnn_1_1profiling_1_1_counter.html">armnn::profiling::Counter</a></div><div class="ttdef"><b>Definition:</b> <a href="_i_counter_directory_8hpp_source.html#l00099">ICounterDirectory.hpp:99</a></div></div>
<div class="ttc" id="classarmnn_1_1profiling_1_1_i_counter_registry_html"><div class="ttname"><a href="classarmnn_1_1profiling_1_1_i_counter_registry.html">armnn::profiling::ICounterRegistry</a></div><div class="ttdef"><b>Definition:</b> <a href="_i_counter_registry_8hpp_source.html#l00017">ICounterRegistry.hpp:17</a></div></div>
<div class="ttc" id="namespacearmnn_html"><div class="ttname"><a href="namespacearmnn.html">armnn</a></div><div class="ttdef"><b>Definition:</b> <a href="_backend_helper_8hpp_source.html#l00011">BackendHelper.hpp:11</a></div></div>
<div class="ttc" id="_optional_8hpp_html"><div class="ttname"><a href="_optional_8hpp.html">Optional.hpp</a></div></div>
<div class="ttc" id="classarmnn_1_1profiling_1_1_category_html"><div class="ttname"><a href="classarmnn_1_1profiling_1_1_category.html">armnn::profiling::Category</a></div><div class="ttdef"><b>Definition:</b> <a href="_i_counter_directory_8hpp_source.html#l00048">ICounterDirectory.hpp:48</a></div></div>
<div class="ttc" id="classarmnn_1_1profiling_1_1_i_counter_registry_html_a0338e5b744c9c2d08143cf70d319940f"><div class="ttname"><a href="classarmnn_1_1profiling_1_1_i_counter_registry.html#a0338e5b744c9c2d08143cf70d319940f">armnn::profiling::ICounterRegistry::RegisterCounterSet</a></div><div class="ttdeci">virtual const CounterSet * RegisterCounterSet(const std::string &amp;counterSetName, uint16_t count, const Optional&lt; std::string &gt; &amp;parentCategoryName)=0</div></div>
<div class="ttc" id="classarmnn_1_1profiling_1_1_i_counter_registry_html_a1d4c2bc2310f063afdf3691f3228012f"><div class="ttname"><a href="classarmnn_1_1profiling_1_1_i_counter_registry.html#a1d4c2bc2310f063afdf3691f3228012f">armnn::profiling::ICounterRegistry::RegisterCounter</a></div><div class="ttdeci">virtual const Counter * RegisterCounter(const BackendId &amp;backendId, const uint16_t uid, const std::string &amp;parentCategoryName, uint16_t counterClass, uint16_t interpolation, double multiplier, const std::string &amp;name, const std::string &amp;description, const Optional&lt; std::string &gt; &amp;units, const Optional&lt; uint16_t &gt; &amp;numberOfCores, const Optional&lt; uint16_t &gt; &amp;deviceUid, const Optional&lt; uint16_t &gt; &amp;counterSetUid)=0</div></div>
</div><!-- fragment --></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="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_637c692f14729569dd2eac0c18e2a54a.html">profiling</a></li><li class="navelem"><a class="el" href="_i_counter_registry_8hpp.html">ICounterRegistry.hpp</a></li>
<li class="footer">Generated on Fri Mar 13 2020 16:06:58 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>