blob: c383548fbcf9da1b386e10857f7c70d8d444b1f4 [file] [log] [blame]
Nikhil Raj9aed8fb2021-11-17 13:16:45 +00001<!-- Copyright (c) 2020 ARM Limited. -->
2<!-- -->
3<!-- SPDX-License-Identifier: MIT -->
4<!-- -->
5<!-- HTML header for doxygen 1.8.13-->
6<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
7<html xmlns="http://www.w3.org/1999/xhtml">
8<head>
9<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
10<meta http-equiv="X-UA-Compatible" content="IE=9"/>
11<meta name="generator" content="Doxygen 1.8.13"/>
12<meta name="robots" content="NOINDEX, NOFOLLOW" />
13<meta name="viewport" content="width=device-width, initial-scale=1"/>
14<title>ArmNN: IRegisterBackendCounters Class Reference</title>
15<link href="tabs.css" rel="stylesheet" type="text/css"/>
16<script type="text/javascript" src="jquery.js"></script>
17<script type="text/javascript" src="dynsections.js"></script>
18<link href="navtree.css" rel="stylesheet" type="text/css"/>
19<script type="text/javascript" src="resize.js"></script>
20<script type="text/javascript" src="navtreedata.js"></script>
21<script type="text/javascript" src="navtree.js"></script>
22<script type="text/javascript">
23 $(document).ready(initResizable);
24</script>
25<link href="search/search.css" rel="stylesheet" type="text/css"/>
26<script type="text/javascript" src="search/searchdata.js"></script>
27<script type="text/javascript" src="search/search.js"></script>
28<script type="text/x-mathjax-config">
29 MathJax.Hub.Config({
30 extensions: ["tex2jax.js"],
31 jax: ["input/TeX","output/HTML-CSS"],
32});
33</script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
34<link href="doxygen.css" rel="stylesheet" type="text/css" />
35<link href="stylesheet.css" rel="stylesheet" type="text/css"/>
36</head>
37<body>
38<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
39<div id="titlearea">
40<table cellspacing="0" cellpadding="0">
41 <tbody>
42 <tr style="height: 56px;">
43 <img alt="ArmNN" src="Arm_NN_horizontal_blue.png" style="max-width: 10rem; margin-top: .5rem; margin-left 10px"/>
44 <td style="padding-left: 0.5em;">
45 <div id="projectname">
46 &#160;<span id="projectnumber">21.11</span>
47 </div>
48 </td>
49 </tr>
50 </tbody>
51</table>
52</div>
53<!-- end header part -->
54<!-- Generated by Doxygen 1.8.13 -->
55<script type="text/javascript">
56var searchBox = new SearchBox("searchBox", "search",false,'Search');
57</script>
58<script type="text/javascript" src="menudata.js"></script>
59<script type="text/javascript" src="menu.js"></script>
60<script type="text/javascript">
61$(function() {
62 initMenu('',true,false,'search.php','Search');
63 $(document).ready(function() { init_search(); });
64});
65</script>
66<div id="main-nav"></div>
67</div><!-- top -->
68<div id="side-nav" class="ui-resizable side-nav-resizable">
69 <div id="nav-tree">
70 <div id="nav-tree-contents">
71 <div id="nav-sync" class="sync"></div>
72 </div>
73 </div>
74 <div id="splitbar" style="-moz-user-select:none;"
75 class="ui-resizable-handle">
76 </div>
77</div>
78<script type="text/javascript">
79$(document).ready(function(){initNavTree('classarmnn_1_1profiling_1_1_i_register_backend_counters.xhtml','');});
80</script>
81<div id="doc-content">
82<!-- window showing the filter options -->
83<div id="MSearchSelectWindow"
84 onmouseover="return searchBox.OnSearchSelectShow()"
85 onmouseout="return searchBox.OnSearchSelectHide()"
86 onkeydown="return searchBox.OnSearchSelectKey(event)">
87</div>
88
89<!-- iframe showing the search results (closed by default) -->
90<div id="MSearchResultsWindow">
91<iframe src="javascript:void(0)" frameborder="0"
92 name="MSearchResults" id="MSearchResults">
93</iframe>
94</div>
95
96<div class="header">
97 <div class="summary">
98<a href="#pub-methods">Public Member Functions</a> &#124;
99<a href="classarmnn_1_1profiling_1_1_i_register_backend_counters-members.xhtml">List of all members</a> </div>
100 <div class="headertitle">
101<div class="title">IRegisterBackendCounters Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
102</div><!--header-->
103<div class="contents">
104
105<p><code>#include &lt;<a class="el" href="_i_backend_profiling_8hpp_source.xhtml">IBackendProfiling.hpp</a>&gt;</code></p>
106<div class="dynheader">
107Inheritance diagram for IRegisterBackendCounters:</div>
108<div class="dyncontent">
109 <div class="center">
110 <img src="classarmnn_1_1profiling_1_1_i_register_backend_counters.png" usemap="#IRegisterBackendCounters_map" alt=""/>
111 <map id="IRegisterBackendCounters_map" name="IRegisterBackendCounters_map">
112<area href="classarmnn_1_1profiling_1_1_register_backend_counters.xhtml" alt="RegisterBackendCounters" shape="rect" coords="0,56,161,80"/>
113</map>
114 </div></div>
115<table class="memberdecls">
116<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
117Public Member Functions</h2></td></tr>
118<tr class="memitem:a745a18d2d50f88ae616af5e3fe67892f"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_i_register_backend_counters.xhtml#a745a18d2d50f88ae616af5e3fe67892f">RegisterCategory</a> (const std::string &amp;categoryName)=0</td></tr>
119<tr class="separator:a745a18d2d50f88ae616af5e3fe67892f"><td class="memSeparator" colspan="2">&#160;</td></tr>
120<tr class="memitem:a1e48221e1b2a005b133f0043c8ed7190"><td class="memItemLeft" align="right" valign="top">virtual uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_i_register_backend_counters.xhtml#a1e48221e1b2a005b133f0043c8ed7190">RegisterDevice</a> (const std::string &amp;deviceName, uint16_t cores=0, const <a class="el" href="classarmnn_1_1_optional.xhtml">Optional</a>&lt; std::string &gt; &amp;parentCategoryName=<a class="el" href="structarmnn_1_1_empty_optional.xhtml">EmptyOptional</a>())=0</td></tr>
121<tr class="separator:a1e48221e1b2a005b133f0043c8ed7190"><td class="memSeparator" colspan="2">&#160;</td></tr>
122<tr class="memitem:a9c9fb969e907ab6e67d5b605ff019489"><td class="memItemLeft" align="right" valign="top">virtual uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_i_register_backend_counters.xhtml#a9c9fb969e907ab6e67d5b605ff019489">RegisterCounterSet</a> (const std::string &amp;counterSetName, uint16_t count=0, const <a class="el" href="classarmnn_1_1_optional.xhtml">Optional</a>&lt; std::string &gt; &amp;parentCategoryName=<a class="el" href="structarmnn_1_1_empty_optional.xhtml">EmptyOptional</a>())=0</td></tr>
123<tr class="separator:a9c9fb969e907ab6e67d5b605ff019489"><td class="memSeparator" colspan="2">&#160;</td></tr>
124<tr class="memitem:a9bd077ffa9adfaedd89b83505a1da115"><td class="memItemLeft" align="right" valign="top">virtual uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_i_register_backend_counters.xhtml#a9bd077ffa9adfaedd89b83505a1da115">RegisterCounter</a> (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 <a class="el" href="classarmnn_1_1_optional.xhtml">Optional</a>&lt; std::string &gt; &amp;units=<a class="el" href="structarmnn_1_1_empty_optional.xhtml">EmptyOptional</a>(), const <a class="el" href="classarmnn_1_1_optional.xhtml">Optional</a>&lt; uint16_t &gt; &amp;numberOfCores=<a class="el" href="structarmnn_1_1_empty_optional.xhtml">EmptyOptional</a>(), const <a class="el" href="classarmnn_1_1_optional.xhtml">Optional</a>&lt; uint16_t &gt; &amp;deviceUid=<a class="el" href="structarmnn_1_1_empty_optional.xhtml">EmptyOptional</a>(), const <a class="el" href="classarmnn_1_1_optional.xhtml">Optional</a>&lt; uint16_t &gt; &amp;counterSetUid=<a class="el" href="structarmnn_1_1_empty_optional.xhtml">EmptyOptional</a>())=0</td></tr>
125<tr class="separator:a9bd077ffa9adfaedd89b83505a1da115"><td class="memSeparator" colspan="2">&#160;</td></tr>
126<tr class="memitem:a1df38f206d3d114ab5c98624a74595e7"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_i_register_backend_counters.xhtml#a1df38f206d3d114ab5c98624a74595e7">~IRegisterBackendCounters</a> ()</td></tr>
127<tr class="separator:a1df38f206d3d114ab5c98624a74595e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
128</table>
129<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
130<div class="textblock">
131<p class="definition">Definition at line <a class="el" href="_i_backend_profiling_8hpp_source.xhtml#l00051">51</a> of file <a class="el" href="_i_backend_profiling_8hpp_source.xhtml">IBackendProfiling.hpp</a>.</p>
132</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
133<a id="a1df38f206d3d114ab5c98624a74595e7"></a>
134<h2 class="memtitle"><span class="permalink"><a href="#a1df38f206d3d114ab5c98624a74595e7">&#9670;&nbsp;</a></span>~IRegisterBackendCounters()</h2>
135
136<div class="memitem">
137<div class="memproto">
138<table class="mlabels">
139 <tr>
140 <td class="mlabels-left">
141 <table class="memname">
142 <tr>
143 <td class="memname">virtual ~<a class="el" href="classarmnn_1_1profiling_1_1_i_register_backend_counters.xhtml">IRegisterBackendCounters</a> </td>
144 <td>(</td>
145 <td class="paramname"></td><td>)</td>
146 <td></td>
147 </tr>
148 </table>
149 </td>
150 <td class="mlabels-right">
151<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
152 </tr>
153</table>
154</div><div class="memdoc">
155
156<p class="definition">Definition at line <a class="el" href="_i_backend_profiling_8hpp_source.xhtml#l00076">76</a> of file <a class="el" href="_i_backend_profiling_8hpp_source.xhtml">IBackendProfiling.hpp</a>.</p>
157<div class="fragment"><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160;{}</div></div><!-- fragment -->
158</div>
159</div>
160<h2 class="groupheader">Member Function Documentation</h2>
161<a id="a745a18d2d50f88ae616af5e3fe67892f"></a>
162<h2 class="memtitle"><span class="permalink"><a href="#a745a18d2d50f88ae616af5e3fe67892f">&#9670;&nbsp;</a></span>RegisterCategory()</h2>
163
164<div class="memitem">
165<div class="memproto">
166<table class="mlabels">
167 <tr>
168 <td class="mlabels-left">
169 <table class="memname">
170 <tr>
171 <td class="memname">virtual void RegisterCategory </td>
172 <td>(</td>
173 <td class="paramtype">const std::string &amp;&#160;</td>
174 <td class="paramname"><em>categoryName</em></td><td>)</td>
175 <td></td>
176 </tr>
177 </table>
178 </td>
179 <td class="mlabels-right">
180<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
181 </tr>
182</table>
183</div><div class="memdoc">
184
185<p>Implemented in <a class="el" href="classarmnn_1_1profiling_1_1_register_backend_counters.xhtml#a547f56db3e9e8c6f5b6ac7b7d3194bfe">RegisterBackendCounters</a>.</p>
186
187</div>
188</div>
189<a id="a9bd077ffa9adfaedd89b83505a1da115"></a>
190<h2 class="memtitle"><span class="permalink"><a href="#a9bd077ffa9adfaedd89b83505a1da115">&#9670;&nbsp;</a></span>RegisterCounter()</h2>
191
192<div class="memitem">
193<div class="memproto">
194<table class="mlabels">
195 <tr>
196 <td class="mlabels-left">
197 <table class="memname">
198 <tr>
199 <td class="memname">virtual uint16_t RegisterCounter </td>
200 <td>(</td>
201 <td class="paramtype">const uint16_t&#160;</td>
202 <td class="paramname"><em>uid</em>, </td>
203 </tr>
204 <tr>
205 <td class="paramkey"></td>
206 <td></td>
207 <td class="paramtype">const std::string &amp;&#160;</td>
208 <td class="paramname"><em>parentCategoryName</em>, </td>
209 </tr>
210 <tr>
211 <td class="paramkey"></td>
212 <td></td>
213 <td class="paramtype">uint16_t&#160;</td>
214 <td class="paramname"><em>counterClass</em>, </td>
215 </tr>
216 <tr>
217 <td class="paramkey"></td>
218 <td></td>
219 <td class="paramtype">uint16_t&#160;</td>
220 <td class="paramname"><em>interpolation</em>, </td>
221 </tr>
222 <tr>
223 <td class="paramkey"></td>
224 <td></td>
225 <td class="paramtype">double&#160;</td>
226 <td class="paramname"><em>multiplier</em>, </td>
227 </tr>
228 <tr>
229 <td class="paramkey"></td>
230 <td></td>
231 <td class="paramtype">const std::string &amp;&#160;</td>
232 <td class="paramname"><em>name</em>, </td>
233 </tr>
234 <tr>
235 <td class="paramkey"></td>
236 <td></td>
237 <td class="paramtype">const std::string &amp;&#160;</td>
238 <td class="paramname"><em>description</em>, </td>
239 </tr>
240 <tr>
241 <td class="paramkey"></td>
242 <td></td>
243 <td class="paramtype">const <a class="el" href="classarmnn_1_1_optional.xhtml">Optional</a>&lt; std::string &gt; &amp;&#160;</td>
244 <td class="paramname"><em>units</em> = <code><a class="el" href="structarmnn_1_1_empty_optional.xhtml">EmptyOptional</a>()</code>, </td>
245 </tr>
246 <tr>
247 <td class="paramkey"></td>
248 <td></td>
249 <td class="paramtype">const <a class="el" href="classarmnn_1_1_optional.xhtml">Optional</a>&lt; uint16_t &gt; &amp;&#160;</td>
250 <td class="paramname"><em>numberOfCores</em> = <code><a class="el" href="structarmnn_1_1_empty_optional.xhtml">EmptyOptional</a>()</code>, </td>
251 </tr>
252 <tr>
253 <td class="paramkey"></td>
254 <td></td>
255 <td class="paramtype">const <a class="el" href="classarmnn_1_1_optional.xhtml">Optional</a>&lt; uint16_t &gt; &amp;&#160;</td>
256 <td class="paramname"><em>deviceUid</em> = <code><a class="el" href="structarmnn_1_1_empty_optional.xhtml">EmptyOptional</a>()</code>, </td>
257 </tr>
258 <tr>
259 <td class="paramkey"></td>
260 <td></td>
261 <td class="paramtype">const <a class="el" href="classarmnn_1_1_optional.xhtml">Optional</a>&lt; uint16_t &gt; &amp;&#160;</td>
262 <td class="paramname"><em>counterSetUid</em> = <code><a class="el" href="structarmnn_1_1_empty_optional.xhtml">EmptyOptional</a>()</code>&#160;</td>
263 </tr>
264 <tr>
265 <td></td>
266 <td>)</td>
267 <td></td><td></td>
268 </tr>
269 </table>
270 </td>
271 <td class="mlabels-right">
272<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
273 </tr>
274</table>
275</div><div class="memdoc">
276
277<p>Implemented in <a class="el" href="classarmnn_1_1profiling_1_1_register_backend_counters.xhtml#a380988b279ec147ed405cc86d4436975">RegisterBackendCounters</a>.</p>
278
279</div>
280</div>
281<a id="a9c9fb969e907ab6e67d5b605ff019489"></a>
282<h2 class="memtitle"><span class="permalink"><a href="#a9c9fb969e907ab6e67d5b605ff019489">&#9670;&nbsp;</a></span>RegisterCounterSet()</h2>
283
284<div class="memitem">
285<div class="memproto">
286<table class="mlabels">
287 <tr>
288 <td class="mlabels-left">
289 <table class="memname">
290 <tr>
291 <td class="memname">virtual uint16_t RegisterCounterSet </td>
292 <td>(</td>
293 <td class="paramtype">const std::string &amp;&#160;</td>
294 <td class="paramname"><em>counterSetName</em>, </td>
295 </tr>
296 <tr>
297 <td class="paramkey"></td>
298 <td></td>
299 <td class="paramtype">uint16_t&#160;</td>
300 <td class="paramname"><em>count</em> = <code>0</code>, </td>
301 </tr>
302 <tr>
303 <td class="paramkey"></td>
304 <td></td>
305 <td class="paramtype">const <a class="el" href="classarmnn_1_1_optional.xhtml">Optional</a>&lt; std::string &gt; &amp;&#160;</td>
306 <td class="paramname"><em>parentCategoryName</em> = <code><a class="el" href="structarmnn_1_1_empty_optional.xhtml">EmptyOptional</a>()</code>&#160;</td>
307 </tr>
308 <tr>
309 <td></td>
310 <td>)</td>
311 <td></td><td></td>
312 </tr>
313 </table>
314 </td>
315 <td class="mlabels-right">
316<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
317 </tr>
318</table>
319</div><div class="memdoc">
320
321<p>Implemented in <a class="el" href="classarmnn_1_1profiling_1_1_register_backend_counters.xhtml#a3760d7378ebc54c779f5032662890154">RegisterBackendCounters</a>.</p>
322
323</div>
324</div>
325<a id="a1e48221e1b2a005b133f0043c8ed7190"></a>
326<h2 class="memtitle"><span class="permalink"><a href="#a1e48221e1b2a005b133f0043c8ed7190">&#9670;&nbsp;</a></span>RegisterDevice()</h2>
327
328<div class="memitem">
329<div class="memproto">
330<table class="mlabels">
331 <tr>
332 <td class="mlabels-left">
333 <table class="memname">
334 <tr>
335 <td class="memname">virtual uint16_t RegisterDevice </td>
336 <td>(</td>
337 <td class="paramtype">const std::string &amp;&#160;</td>
338 <td class="paramname"><em>deviceName</em>, </td>
339 </tr>
340 <tr>
341 <td class="paramkey"></td>
342 <td></td>
343 <td class="paramtype">uint16_t&#160;</td>
344 <td class="paramname"><em>cores</em> = <code>0</code>, </td>
345 </tr>
346 <tr>
347 <td class="paramkey"></td>
348 <td></td>
349 <td class="paramtype">const <a class="el" href="classarmnn_1_1_optional.xhtml">Optional</a>&lt; std::string &gt; &amp;&#160;</td>
350 <td class="paramname"><em>parentCategoryName</em> = <code><a class="el" href="structarmnn_1_1_empty_optional.xhtml">EmptyOptional</a>()</code>&#160;</td>
351 </tr>
352 <tr>
353 <td></td>
354 <td>)</td>
355 <td></td><td></td>
356 </tr>
357 </table>
358 </td>
359 <td class="mlabels-right">
360<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
361 </tr>
362</table>
363</div><div class="memdoc">
364
365<p>Implemented in <a class="el" href="classarmnn_1_1profiling_1_1_register_backend_counters.xhtml#aa59f702553e07454e57b7d75294ded25">RegisterBackendCounters</a>.</p>
366
367</div>
368</div>
369<hr/>The documentation for this class was generated from the following file:<ul>
370<li>include/armnn/backends/profiling/<a class="el" href="_i_backend_profiling_8hpp_source.xhtml">IBackendProfiling.hpp</a></li>
371</ul>
372</div><!-- contents -->
373</div><!-- doc-content -->
374<!-- start footer part -->
375<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
376 <ul>
377 <li class="navelem"><a class="el" href="namespacearmnn.xhtml">armnn</a></li><li class="navelem"><a class="el" href="namespacearmnn_1_1profiling.xhtml">profiling</a></li><li class="navelem"><a class="el" href="classarmnn_1_1profiling_1_1_i_register_backend_counters.xhtml">IRegisterBackendCounters</a></li>
378 <li class="footer">Generated on Wed Nov 17 2021 12:59:46 for ArmNN by
379 <a href="http://www.doxygen.org/index.html">
380 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
381 </ul>
382</div>
383</body>
384</html>