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