Gitiles
Code Review Sign In
review.mlplatform.org / ml / armnn / ac2770a4bb6461bfbddec928bb6208f26f898f02 / . / Documentation / classarmnn_1_1profiling_1_1_i_backend_profiling.xhtml
blob: 9c68156b177d891fee602d89691ecb92d871f276 [file] [log] [blame]
Ryan OSheade36e4a2020-03-13 16:26:19 +0000[diff] [blame]1<!-- 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: IBackendProfiling 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">20.02</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_backend_profiling.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_backend_profiling-members.xhtml">List of all members</a> </div>
100 <div class="headertitle">
101<div class="title">IBackendProfiling 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 IBackendProfiling:</div>
108<div class="dyncontent">
109 <div class="center">
110 <img src="classarmnn_1_1profiling_1_1_i_backend_profiling.png" usemap="#IBackendProfiling_map" alt=""/>
111 <map id="IBackendProfiling_map" name="IBackendProfiling_map">
112<area href="classarmnn_1_1profiling_1_1_backend_profiling.xhtml" alt="BackendProfiling" shape="rect" coords="0,56,111,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:a1179976118abc3d6765a5b2fea4be35c"><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_backend_profiling.xhtml#a1179976118abc3d6765a5b2fea4be35c">~IBackendProfiling</a> ()</td></tr>
119<tr class="separator:a1179976118abc3d6765a5b2fea4be35c"><td class="memSeparator" colspan="2">&#160;</td></tr>
120<tr class="memitem:a3af5b700b06e401119749bd3a80bacf0"><td class="memItemLeft" align="right" valign="top">virtual std::unique_ptr&lt; <a class="el" href="classarmnn_1_1profiling_1_1_i_register_backend_counters.xhtml">IRegisterBackendCounters</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_i_backend_profiling.xhtml#a3af5b700b06e401119749bd3a80bacf0">GetCounterRegistrationInterface</a> (uint16_t currentMaxGlobalCounterID)=0</td></tr>
121<tr class="separator:a3af5b700b06e401119749bd3a80bacf0"><td class="memSeparator" colspan="2">&#160;</td></tr>
122<tr class="memitem:af3bab90857bb0cd2363f654cdd257e34"><td class="memItemLeft" align="right" valign="top">virtual std::unique_ptr&lt; <a class="el" href="classarmnn_1_1profiling_1_1_i_send_timeline_packet.xhtml">ISendTimelinePacket</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_i_backend_profiling.xhtml#af3bab90857bb0cd2363f654cdd257e34">GetSendTimelinePacket</a> ()=0</td></tr>
123<tr class="separator:af3bab90857bb0cd2363f654cdd257e34"><td class="memSeparator" colspan="2">&#160;</td></tr>
124<tr class="memitem:a9b9e803df01765cbfe9c9148fe757db5"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classarmnn_1_1profiling_1_1_i_profiling_guid_generator.xhtml">IProfilingGuidGenerator</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_i_backend_profiling.xhtml#a9b9e803df01765cbfe9c9148fe757db5">GetProfilingGuidGenerator</a> ()=0</td></tr>
125<tr class="separator:a9b9e803df01765cbfe9c9148fe757db5"><td class="memSeparator" colspan="2">&#160;</td></tr>
126<tr class="memitem:a691685749cd1a917b8e6e9cb1afcc045"><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_backend_profiling.xhtml#a691685749cd1a917b8e6e9cb1afcc045">ReportCounters</a> (const std::vector&lt; <a class="el" href="structarmnn_1_1profiling_1_1_timestamp.xhtml">Timestamp</a> &gt; &amp;counterValues)=0</td></tr>
127<tr class="separator:a691685749cd1a917b8e6e9cb1afcc045"><td class="memSeparator" colspan="2">&#160;</td></tr>
128<tr class="memitem:ab159fe93b4a4357f55b55920e03b9af6"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="structarmnn_1_1profiling_1_1_counter_status.xhtml">CounterStatus</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_i_backend_profiling.xhtml#ab159fe93b4a4357f55b55920e03b9af6">GetCounterStatus</a> (uint16_t backendCounterId)=0</td></tr>
129<tr class="separator:ab159fe93b4a4357f55b55920e03b9af6"><td class="memSeparator" colspan="2">&#160;</td></tr>
130<tr class="memitem:a33b3b8d541860022fe9edecfee7284d6"><td class="memItemLeft" align="right" valign="top">virtual std::vector&lt; <a class="el" href="structarmnn_1_1profiling_1_1_counter_status.xhtml">CounterStatus</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_i_backend_profiling.xhtml#a33b3b8d541860022fe9edecfee7284d6">GetActiveCounters</a> ()=0</td></tr>
131<tr class="separator:a33b3b8d541860022fe9edecfee7284d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
132<tr class="memitem:a93ee1c2509b9db845936a291b575dd17"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_i_backend_profiling.xhtml#a93ee1c2509b9db845936a291b575dd17">IsProfilingEnabled</a> () const =0</td></tr>
133<tr class="separator:a93ee1c2509b9db845936a291b575dd17"><td class="memSeparator" colspan="2">&#160;</td></tr>
134</table>
135<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
136<div class="textblock">
137<p class="definition">Definition at line <a class="el" href="_i_backend_profiling_8hpp_source.xhtml#l00077">77</a> of file <a class="el" href="_i_backend_profiling_8hpp_source.xhtml">IBackendProfiling.hpp</a>.</p>
138</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
139<a id="a1179976118abc3d6765a5b2fea4be35c"></a>
140<h2 class="memtitle"><span class="permalink"><a href="#a1179976118abc3d6765a5b2fea4be35c">&#9670;&nbsp;</a></span>~IBackendProfiling()</h2>
141
142<div class="memitem">
143<div class="memproto">
144<table class="mlabels">
145 <tr>
146 <td class="mlabels-left">
147 <table class="memname">
148 <tr>
149 <td class="memname">virtual ~<a class="el" href="classarmnn_1_1profiling_1_1_i_backend_profiling.xhtml">IBackendProfiling</a> </td>
150 <td>(</td>
151 <td class="paramname"></td><td>)</td>
152 <td></td>
153 </tr>
154 </table>
155 </td>
156 <td class="mlabels-right">
157<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
158 </tr>
159</table>
160</div><div class="memdoc">
161
162<p class="definition">Definition at line <a class="el" href="_i_backend_profiling_8hpp_source.xhtml#l00080">80</a> of file <a class="el" href="_i_backend_profiling_8hpp_source.xhtml">IBackendProfiling.hpp</a>.</p>
163<div class="fragment"><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; {}</div></div><!-- fragment -->
164</div>
165</div>
166<h2 class="groupheader">Member Function Documentation</h2>
167<a id="a33b3b8d541860022fe9edecfee7284d6"></a>
168<h2 class="memtitle"><span class="permalink"><a href="#a33b3b8d541860022fe9edecfee7284d6">&#9670;&nbsp;</a></span>GetActiveCounters()</h2>
169
170<div class="memitem">
171<div class="memproto">
172<table class="mlabels">
173 <tr>
174 <td class="mlabels-left">
175 <table class="memname">
176 <tr>
177 <td class="memname">virtual std::vector&lt;<a class="el" href="structarmnn_1_1profiling_1_1_counter_status.xhtml">CounterStatus</a>&gt; GetActiveCounters </td>
178 <td>(</td>
179 <td class="paramname"></td><td>)</td>
180 <td></td>
181 </tr>
182 </table>
183 </td>
184 <td class="mlabels-right">
185<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
186 </tr>
187</table>
188</div><div class="memdoc">
189
190<p>Implemented in <a class="el" href="classarmnn_1_1profiling_1_1_backend_profiling.xhtml#a54b66ce39aa9a413d8d68f6e2569af45">BackendProfiling</a>.</p>
191
192</div>
193</div>
194<a id="a3af5b700b06e401119749bd3a80bacf0"></a>
195<h2 class="memtitle"><span class="permalink"><a href="#a3af5b700b06e401119749bd3a80bacf0">&#9670;&nbsp;</a></span>GetCounterRegistrationInterface()</h2>
196
197<div class="memitem">
198<div class="memproto">
199<table class="mlabels">
200 <tr>
201 <td class="mlabels-left">
202 <table class="memname">
203 <tr>
204 <td class="memname">virtual std::unique_ptr&lt;<a class="el" href="classarmnn_1_1profiling_1_1_i_register_backend_counters.xhtml">IRegisterBackendCounters</a>&gt; GetCounterRegistrationInterface </td>
205 <td>(</td>
206 <td class="paramtype">uint16_t&#160;</td>
207 <td class="paramname"><em>currentMaxGlobalCounterID</em></td><td>)</td>
208 <td></td>
209 </tr>
210 </table>
211 </td>
212 <td class="mlabels-right">
213<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
214 </tr>
215</table>
216</div><div class="memdoc">
217
218<p>Implemented in <a class="el" href="classarmnn_1_1profiling_1_1_backend_profiling.xhtml#a0ac323cf9d8c03c718065cd775bc2a48">BackendProfiling</a>.</p>
219
220</div>
221</div>
222<a id="ab159fe93b4a4357f55b55920e03b9af6"></a>
223<h2 class="memtitle"><span class="permalink"><a href="#ab159fe93b4a4357f55b55920e03b9af6">&#9670;&nbsp;</a></span>GetCounterStatus()</h2>
224
225<div class="memitem">
226<div class="memproto">
227<table class="mlabels">
228 <tr>
229 <td class="mlabels-left">
230 <table class="memname">
231 <tr>
232 <td class="memname">virtual <a class="el" href="structarmnn_1_1profiling_1_1_counter_status.xhtml">CounterStatus</a> GetCounterStatus </td>
233 <td>(</td>
234 <td class="paramtype">uint16_t&#160;</td>
235 <td class="paramname"><em>backendCounterId</em></td><td>)</td>
236 <td></td>
237 </tr>
238 </table>
239 </td>
240 <td class="mlabels-right">
241<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
242 </tr>
243</table>
244</div><div class="memdoc">
245
246<p>Implemented in <a class="el" href="classarmnn_1_1profiling_1_1_backend_profiling.xhtml#a23d09d59f5da5d396a89c9543204dce3">BackendProfiling</a>.</p>
247
248</div>
249</div>
250<a id="a9b9e803df01765cbfe9c9148fe757db5"></a>
251<h2 class="memtitle"><span class="permalink"><a href="#a9b9e803df01765cbfe9c9148fe757db5">&#9670;&nbsp;</a></span>GetProfilingGuidGenerator()</h2>
252
253<div class="memitem">
254<div class="memproto">
255<table class="mlabels">
256 <tr>
257 <td class="mlabels-left">
258 <table class="memname">
259 <tr>
260 <td class="memname">virtual <a class="el" href="classarmnn_1_1profiling_1_1_i_profiling_guid_generator.xhtml">IProfilingGuidGenerator</a>&amp; GetProfilingGuidGenerator </td>
261 <td>(</td>
262 <td class="paramname"></td><td>)</td>
263 <td></td>
264 </tr>
265 </table>
266 </td>
267 <td class="mlabels-right">
268<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
269 </tr>
270</table>
271</div><div class="memdoc">
272
273<p>Implemented in <a class="el" href="classarmnn_1_1profiling_1_1_backend_profiling.xhtml#a281672bed6fd49540270725a3eea867b">BackendProfiling</a>.</p>
274
275</div>
276</div>
277<a id="af3bab90857bb0cd2363f654cdd257e34"></a>
278<h2 class="memtitle"><span class="permalink"><a href="#af3bab90857bb0cd2363f654cdd257e34">&#9670;&nbsp;</a></span>GetSendTimelinePacket()</h2>
279
280<div class="memitem">
281<div class="memproto">
282<table class="mlabels">
283 <tr>
284 <td class="mlabels-left">
285 <table class="memname">
286 <tr>
287 <td class="memname">virtual std::unique_ptr&lt;<a class="el" href="classarmnn_1_1profiling_1_1_i_send_timeline_packet.xhtml">ISendTimelinePacket</a>&gt; GetSendTimelinePacket </td>
288 <td>(</td>
289 <td class="paramname"></td><td>)</td>
290 <td></td>
291 </tr>
292 </table>
293 </td>
294 <td class="mlabels-right">
295<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
296 </tr>
297</table>
298</div><div class="memdoc">
299
300<p>Implemented in <a class="el" href="classarmnn_1_1profiling_1_1_backend_profiling.xhtml#a24eb027ca494ee70c27e6322494325d8">BackendProfiling</a>.</p>
301
302</div>
303</div>
304<a id="a93ee1c2509b9db845936a291b575dd17"></a>
305<h2 class="memtitle"><span class="permalink"><a href="#a93ee1c2509b9db845936a291b575dd17">&#9670;&nbsp;</a></span>IsProfilingEnabled()</h2>
306
307<div class="memitem">
308<div class="memproto">
309<table class="mlabels">
310 <tr>
311 <td class="mlabels-left">
312 <table class="memname">
313 <tr>
314 <td class="memname">virtual bool IsProfilingEnabled </td>
315 <td>(</td>
316 <td class="paramname"></td><td>)</td>
317 <td> const</td>
318 </tr>
319 </table>
320 </td>
321 <td class="mlabels-right">
322<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
323 </tr>
324</table>
325</div><div class="memdoc">
326
327<p>Implemented in <a class="el" href="classarmnn_1_1profiling_1_1_backend_profiling.xhtml#a70db5b1cdd0d22c1fa912c6e8b9089ce">BackendProfiling</a>.</p>
328
329</div>
330</div>
331<a id="a691685749cd1a917b8e6e9cb1afcc045"></a>
332<h2 class="memtitle"><span class="permalink"><a href="#a691685749cd1a917b8e6e9cb1afcc045">&#9670;&nbsp;</a></span>ReportCounters()</h2>
333
334<div class="memitem">
335<div class="memproto">
336<table class="mlabels">
337 <tr>
338 <td class="mlabels-left">
339 <table class="memname">
340 <tr>
341 <td class="memname">virtual void ReportCounters </td>
342 <td>(</td>
343 <td class="paramtype">const std::vector&lt; <a class="el" href="structarmnn_1_1profiling_1_1_timestamp.xhtml">Timestamp</a> &gt; &amp;&#160;</td>
344 <td class="paramname"><em>counterValues</em></td><td>)</td>
345 <td></td>
346 </tr>
347 </table>
348 </td>
349 <td class="mlabels-right">
350<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
351 </tr>
352</table>
353</div><div class="memdoc">
354
355<p>Implemented in <a class="el" href="classarmnn_1_1profiling_1_1_backend_profiling.xhtml#aa51df0c342290615803a99525816e3e3">BackendProfiling</a>.</p>
356
357</div>
358</div>
359<hr/>The documentation for this class was generated from the following file:<ul>
360<li>include/armnn/backends/profiling/<a class="el" href="_i_backend_profiling_8hpp_source.xhtml">IBackendProfiling.hpp</a></li>
361</ul>
362</div><!-- contents -->
363</div><!-- doc-content -->
364<!-- start footer part -->
365<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
366 <ul>
367 <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_backend_profiling.xhtml">IBackendProfiling</a></li>
368 <li class="footer">Generated on Fri Mar 13 2020 16:09:21 for ArmNN by
369 <a href="http://www.doxygen.org/index.html">
370 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
371 </ul>
372</div>
373</body>
374</html>