Gitiles
Code Review Sign In
review.mlplatform.org / ml / armnn / 1dc83febfb76d6a770bdf3ba16c4034a970c2320 / . / 24.05 / classarmnn_1_1_instrument.html
blob: 1fdcecbd33514afaa94993b50d18f21c2282893c [file] [log] [blame]
Nikhil Raj1dc83fe2024-05-16 09:47:51 +0100[diff] [blame^]1<!-- HTML header for doxygen 1.8.17-->
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml">
4<head>
5<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
6<meta http-equiv="X-UA-Compatible" content="IE=9"/>
7<meta name="generator" content="Doxygen 1.8.17"/>
8<meta name="viewport" content="width=device-width, initial-scale=1"/>
9<title>Arm NN: Instrument Class Reference</title>
10<link href="tabs.css" rel="stylesheet" type="text/css"/>
11<script type="text/javascript" src="jquery.js"></script>
12<script type="text/javascript" src="dynsections.js"></script>
13<link href="navtree.css" rel="stylesheet" type="text/css"/>
14<script type="text/javascript" src="resize.js"></script>
15<script type="text/javascript" src="navtreedata.js"></script>
16<script type="text/javascript" src="navtree.js"></script>
17<link href="search/search.css" rel="stylesheet" type="text/css"/>
18<script type="text/javascript" src="search/searchdata.js"></script>
19<script type="text/javascript" src="search/search.js"></script>
20<script type="text/x-mathjax-config">
21 MathJax.Hub.Config({
22 extensions: ["tex2jax.js"],
23 jax: ["input/TeX","output/HTML-CSS"],
24});
25</script>
26<script type="text/javascript" async="async" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
27<link href="doxygen.css" rel="stylesheet" type="text/css" />
28<link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
29</head>
30<body>
31<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
32<div id="titlearea">
33<table cellspacing="0" cellpadding="0">
34 <tbody>
35 <tr style="height: 56px;">
36 <img alt="ArmNN" src="Arm_NN_horizontal_blue.png" style="max-width: 15rem; margin-top: .5rem; margin-left 13px"/>
37 <td id="projectalign" style="padding-left: 0.9em;">
38 <div id="projectname">
39 &#160;<span id="projectnumber">24.05</span>
40 </div>
41 </td>
42 </tr>
43 </tbody>
44</table>
45</div>
46<!-- end header part -->
47<!-- Generated by Doxygen 1.8.17 -->
48<script type="text/javascript">
49/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
50var searchBox = new SearchBox("searchBox", "search",false,'Search');
51/* @license-end */
52</script>
53<script type="text/javascript" src="menudata.js"></script>
54<script type="text/javascript" src="menu.js"></script>
55<script type="text/javascript">
56/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
57$(function() {
58 initMenu('',true,false,'search.php','Search');
59 $(document).ready(function() { init_search(); });
60});
61/* @license-end */</script>
62<div id="main-nav"></div>
63</div><!-- top -->
64<div id="side-nav" class="ui-resizable side-nav-resizable">
65 <div id="nav-tree">
66 <div id="nav-tree-contents">
67 <div id="nav-sync" class="sync"></div>
68 </div>
69 </div>
70 <div id="splitbar" style="-moz-user-select:none;"
71 class="ui-resizable-handle">
72 </div>
73</div>
74<script type="text/javascript">
75/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
76$(document).ready(function(){initNavTree('classarmnn_1_1_instrument.html',''); initResizable(); });
77/* @license-end */
78</script>
79<div id="doc-content">
80<!-- window showing the filter options -->
81<div id="MSearchSelectWindow"
82 onmouseover="return searchBox.OnSearchSelectShow()"
83 onmouseout="return searchBox.OnSearchSelectHide()"
84 onkeydown="return searchBox.OnSearchSelectKey(event)">
85</div>
86
87<!-- iframe showing the search results (closed by default) -->
88<div id="MSearchResultsWindow">
89<iframe src="javascript:void(0)" frameborder="0"
90 name="MSearchResults" id="MSearchResults">
91</iframe>
92</div>
93
94<div class="header">
95 <div class="summary">
96<a href="#pub-methods">Public Member Functions</a> &#124;
97<a href="classarmnn_1_1_instrument-members.html">List of all members</a> </div>
98 <div class="headertitle">
99<div class="title">Instrument Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
100</div><!--header-->
101<div class="contents">
102
103<p><code>#include &lt;<a class="el" href="_instrument_8hpp_source.html">Instrument.hpp</a>&gt;</code></p>
104<div class="dynheader">
105Inheritance diagram for Instrument:</div>
106<div class="dyncontent">
107<div class="center"><iframe scrolling="no" frameborder="0" src="classarmnn_1_1_instrument__inherit__graph.svg" width="386" height="112"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
108</div>
109<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
110<table class="memberdecls">
111<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
112Public Member Functions</h2></td></tr>
113<tr class="memitem:a37a2de9b867820a7ab15b8dc8d62b153"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_instrument.html#a37a2de9b867820a7ab15b8dc8d62b153">~Instrument</a> ()</td></tr>
114<tr class="separator:a37a2de9b867820a7ab15b8dc8d62b153"><td class="memSeparator" colspan="2">&#160;</td></tr>
115<tr class="memitem:a63ce9b9c6710c0dae98f88d6c602313a"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_instrument.html#a63ce9b9c6710c0dae98f88d6c602313a">Start</a> ()=0</td></tr>
116<tr class="separator:a63ce9b9c6710c0dae98f88d6c602313a"><td class="memSeparator" colspan="2">&#160;</td></tr>
117<tr class="memitem:a4d7bebcc22c1b09cf961b83bf84033b6"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_instrument.html#a4d7bebcc22c1b09cf961b83bf84033b6">Stop</a> ()=0</td></tr>
118<tr class="separator:a4d7bebcc22c1b09cf961b83bf84033b6"><td class="memSeparator" colspan="2">&#160;</td></tr>
119<tr class="memitem:a4055fcf05306a7478db7e192cf1e679d"><td class="memItemLeft" align="right" valign="top">virtual std::vector&lt; <a class="el" href="structarmnn_1_1_measurement.html">Measurement</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_instrument.html#a4055fcf05306a7478db7e192cf1e679d">GetMeasurements</a> () const =0</td></tr>
120<tr class="separator:a4055fcf05306a7478db7e192cf1e679d"><td class="memSeparator" colspan="2">&#160;</td></tr>
121<tr class="memitem:afcc1c3a20bd2860e0ddd21674389246f"><td class="memItemLeft" align="right" valign="top">virtual const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_instrument.html#afcc1c3a20bd2860e0ddd21674389246f">GetName</a> () const =0</td></tr>
122<tr class="separator:afcc1c3a20bd2860e0ddd21674389246f"><td class="memSeparator" colspan="2">&#160;</td></tr>
123<tr class="memitem:af86639ebdd7db055ee07c3d924d4c0ff"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_instrument.html#af86639ebdd7db055ee07c3d924d4c0ff">HasKernelMeasurements</a> () const</td></tr>
124<tr class="separator:af86639ebdd7db055ee07c3d924d4c0ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
125</table>
126<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
127<div class="textblock">
128<p class="definition">Definition at line <a class="el" href="_instrument_8hpp_source.html#l00051">51</a> of file <a class="el" href="_instrument_8hpp_source.html">Instrument.hpp</a>.</p>
129</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
130<a id="a37a2de9b867820a7ab15b8dc8d62b153"></a>
131<h2 class="memtitle"><span class="permalink"><a href="#a37a2de9b867820a7ab15b8dc8d62b153">&#9670;&nbsp;</a></span>~Instrument()</h2>
132
133<div class="memitem">
134<div class="memproto">
135<table class="mlabels">
136 <tr>
137 <td class="mlabels-left">
138 <table class="memname">
139 <tr>
140 <td class="memname">virtual ~<a class="el" href="classarmnn_1_1_instrument.html">Instrument</a> </td>
141 <td>(</td>
142 <td class="paramname"></td><td>)</td>
143 <td></td>
144 </tr>
145 </table>
146 </td>
147 <td class="mlabels-right">
148<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
149 </tr>
150</table>
151</div><div class="memdoc">
152
153<p class="definition">Definition at line <a class="el" href="_instrument_8hpp_source.html#l00054">54</a> of file <a class="el" href="_instrument_8hpp_source.html">Instrument.hpp</a>.</p>
154<div class="fragment"><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;{}</div>
155</div><!-- fragment -->
156</div>
157</div>
158<h2 class="groupheader">Member Function Documentation</h2>
159<a id="a4055fcf05306a7478db7e192cf1e679d"></a>
160<h2 class="memtitle"><span class="permalink"><a href="#a4055fcf05306a7478db7e192cf1e679d">&#9670;&nbsp;</a></span>GetMeasurements()</h2>
161
162<div class="memitem">
163<div class="memproto">
164<table class="mlabels">
165 <tr>
166 <td class="mlabels-left">
167 <table class="memname">
168 <tr>
169 <td class="memname">virtual std::vector&lt;<a class="el" href="structarmnn_1_1_measurement.html">Measurement</a>&gt; GetMeasurements </td>
170 <td>(</td>
171 <td class="paramname"></td><td>)</td>
172 <td> const</td>
173 </tr>
174 </table>
175 </td>
176 <td class="mlabels-right">
177<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
178 </tr>
179</table>
180</div><div class="memdoc">
181
182<p>Implemented in <a class="el" href="classarmnn_1_1_wall_clock_timer.html#a86ea36032637c02c045f2d433036a203">WallClockTimer</a>, <a class="el" href="classarmnn_1_1_open_cl_timer.html#a86ea36032637c02c045f2d433036a203">OpenClTimer</a>, and <a class="el" href="classarmnn_1_1_neon_timer.html#a86ea36032637c02c045f2d433036a203">NeonTimer</a>.</p>
183
184</div>
185</div>
186<a id="afcc1c3a20bd2860e0ddd21674389246f"></a>
187<h2 class="memtitle"><span class="permalink"><a href="#afcc1c3a20bd2860e0ddd21674389246f">&#9670;&nbsp;</a></span>GetName()</h2>
188
189<div class="memitem">
190<div class="memproto">
191<table class="mlabels">
192 <tr>
193 <td class="mlabels-left">
194 <table class="memname">
195 <tr>
196 <td class="memname">virtual const char* GetName </td>
197 <td>(</td>
198 <td class="paramname"></td><td>)</td>
199 <td> const</td>
200 </tr>
201 </table>
202 </td>
203 <td class="mlabels-right">
204<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
205 </tr>
206</table>
207</div><div class="memdoc">
208
209<p>Implemented in <a class="el" href="classarmnn_1_1_wall_clock_timer.html#ad47edad463024345ce1409153c259215">WallClockTimer</a>, <a class="el" href="classarmnn_1_1_open_cl_timer.html#a7ddf0cf6f620d59c10e63495ace795d0">OpenClTimer</a>, and <a class="el" href="classarmnn_1_1_neon_timer.html#ad47edad463024345ce1409153c259215">NeonTimer</a>.</p>
210
211</div>
212</div>
213<a id="af86639ebdd7db055ee07c3d924d4c0ff"></a>
214<h2 class="memtitle"><span class="permalink"><a href="#af86639ebdd7db055ee07c3d924d4c0ff">&#9670;&nbsp;</a></span>HasKernelMeasurements()</h2>
215
216<div class="memitem">
217<div class="memproto">
218<table class="mlabels">
219 <tr>
220 <td class="mlabels-left">
221 <table class="memname">
222 <tr>
223 <td class="memname">virtual bool HasKernelMeasurements </td>
224 <td>(</td>
225 <td class="paramname"></td><td>)</td>
226 <td> const</td>
227 </tr>
228 </table>
229 </td>
230 <td class="mlabels-right">
231<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
232 </tr>
233</table>
234</div><div class="memdoc">
235
236<p>Reimplemented in <a class="el" href="classarmnn_1_1_open_cl_timer.html#ae9faa4ff4d8569776b5686e472c46bb0">OpenClTimer</a>, and <a class="el" href="classarmnn_1_1_neon_timer.html#ae9faa4ff4d8569776b5686e472c46bb0">NeonTimer</a>.</p>
237
238<p class="definition">Definition at line <a class="el" href="_instrument_8hpp_source.html#l00064">64</a> of file <a class="el" href="_instrument_8hpp_source.html">Instrument.hpp</a>.</p>
239<div class="fragment"><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;{ <span class="keywordflow">return</span> <span class="keyword">false</span>;}</div>
240</div><!-- fragment -->
241</div>
242</div>
243<a id="a63ce9b9c6710c0dae98f88d6c602313a"></a>
244<h2 class="memtitle"><span class="permalink"><a href="#a63ce9b9c6710c0dae98f88d6c602313a">&#9670;&nbsp;</a></span>Start()</h2>
245
246<div class="memitem">
247<div class="memproto">
248<table class="mlabels">
249 <tr>
250 <td class="mlabels-left">
251 <table class="memname">
252 <tr>
253 <td class="memname">virtual void Start </td>
254 <td>(</td>
255 <td class="paramname"></td><td>)</td>
256 <td></td>
257 </tr>
258 </table>
259 </td>
260 <td class="mlabels-right">
261<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
262 </tr>
263</table>
264</div><div class="memdoc">
265
266<p>Implemented in <a class="el" href="classarmnn_1_1_wall_clock_timer.html#a156f3866ca69d98b4d9e6e1c1b3ec7da">WallClockTimer</a>, <a class="el" href="classarmnn_1_1_neon_timer.html#a156f3866ca69d98b4d9e6e1c1b3ec7da">NeonTimer</a>, and <a class="el" href="classarmnn_1_1_open_cl_timer.html#a156f3866ca69d98b4d9e6e1c1b3ec7da">OpenClTimer</a>.</p>
267
268</div>
269</div>
270<a id="a4d7bebcc22c1b09cf961b83bf84033b6"></a>
271<h2 class="memtitle"><span class="permalink"><a href="#a4d7bebcc22c1b09cf961b83bf84033b6">&#9670;&nbsp;</a></span>Stop()</h2>
272
273<div class="memitem">
274<div class="memproto">
275<table class="mlabels">
276 <tr>
277 <td class="mlabels-left">
278 <table class="memname">
279 <tr>
280 <td class="memname">virtual void Stop </td>
281 <td>(</td>
282 <td class="paramname"></td><td>)</td>
283 <td></td>
284 </tr>
285 </table>
286 </td>
287 <td class="mlabels-right">
288<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
289 </tr>
290</table>
291</div><div class="memdoc">
292
293<p>Implemented in <a class="el" href="classarmnn_1_1_wall_clock_timer.html#a634c58de2126b4a4e6a2a093e60e1290">WallClockTimer</a>, <a class="el" href="classarmnn_1_1_neon_timer.html#a634c58de2126b4a4e6a2a093e60e1290">NeonTimer</a>, and <a class="el" href="classarmnn_1_1_open_cl_timer.html#a634c58de2126b4a4e6a2a093e60e1290">OpenClTimer</a>.</p>
294
295</div>
296</div>
297<hr/>The documentation for this class was generated from the following file:<ul>
298<li>src/armnn/<a class="el" href="_instrument_8hpp_source.html">Instrument.hpp</a></li>
299</ul>
300</div><!-- contents -->
301</div><!-- doc-content -->
302<!-- start footer part -->
303<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
304 <ul>
305 <li class="navelem"><a class="el" href="namespacearmnn.html">armnn</a></li><li class="navelem"><a class="el" href="classarmnn_1_1_instrument.html">Instrument</a></li>
306 <li class="footer">Generated on Thu May 16 2024 09:31:56 for Arm NN by
307 <a href="http://www.doxygen.org/index.html">
308 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
309 </ul>
310</div>
311</body>
312</html>