Gitiles
Code Review Sign In
review.mlplatform.org / ml / armnn / c77874a487da081c365fc1a3baeb5745e7a08be9 / . / Documentation / classarmnn_1_1_i_profiler.html
blob: 4c237a078ba6c2e156b9de32283b50aba74813fa [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: IProfiler 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_1_i_profiler.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="#pro-methods">Protected Member Functions</a> &#124;
86<a href="classarmnn_1_1_i_profiler-members.html">List of all members</a> </div>
87 <div class="headertitle">
88<div class="title">IProfiler Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
89</div><!--header-->
90<div class="contents">
91
92<p><code>#include &lt;<a class="el" href="_i_profiler_8hpp_source.html">IProfiler.hpp</a>&gt;</code></p>
93<div class="dynheader">
94Inheritance diagram for IProfiler:</div>
95<div class="dyncontent">
96 <div class="center">
97 <img src="classarmnn_1_1_i_profiler.png" usemap="#IProfiler_map" alt=""/>
98 <map id="IProfiler_map" name="IProfiler_map">
99<area href="classarmnn_1_1_profiler.html" alt="Profiler" shape="rect" coords="0,56,57,80"/>
100</map>
101 </div></div>
102<table class="memberdecls">
103<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
104Public Member Functions</h2></td></tr>
105<tr class="memitem:a769cdf670bd7cda3cda29dd40fbdebf4"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_i_profiler.html#a769cdf670bd7cda3cda29dd40fbdebf4">EnableProfiling</a> (bool enableProfiling)=0</td></tr>
106<tr class="separator:a769cdf670bd7cda3cda29dd40fbdebf4"><td class="memSeparator" colspan="2">&#160;</td></tr>
107<tr class="memitem:a1ebebad65df6718dc07aeab66550d0a7"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_i_profiler.html#a1ebebad65df6718dc07aeab66550d0a7">IsProfilingEnabled</a> ()=0</td></tr>
108<tr class="separator:a1ebebad65df6718dc07aeab66550d0a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
109<tr class="memitem:aea4e445e340cb3a7fbb51465cf029724"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_i_profiler.html#aea4e445e340cb3a7fbb51465cf029724">AnalyzeEventsAndWriteResults</a> (std::ostream &amp;outStream) const =0</td></tr>
110<tr class="separator:aea4e445e340cb3a7fbb51465cf029724"><td class="memSeparator" colspan="2">&#160;</td></tr>
111<tr class="memitem:aa369a934075a340fe59b7c9f481f9a57"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_i_profiler.html#aa369a934075a340fe59b7c9f481f9a57">Print</a> (std::ostream &amp;outStream) const =0</td></tr>
112<tr class="separator:aa369a934075a340fe59b7c9f481f9a57"><td class="memSeparator" colspan="2">&#160;</td></tr>
113</table><table class="memberdecls">
114<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
115Protected Member Functions</h2></td></tr>
116<tr class="memitem:a3e96ca374a63bd8547fe68a5d9809df7"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_i_profiler.html#a3e96ca374a63bd8547fe68a5d9809df7">~IProfiler</a> ()</td></tr>
117<tr class="separator:a3e96ca374a63bd8547fe68a5d9809df7"><td class="memSeparator" colspan="2">&#160;</td></tr>
118</table>
119<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
120<div class="textblock">
121<p class="definition">Definition at line <a class="el" href="_i_profiler_8hpp_source.html#l00013">13</a> of file <a class="el" href="_i_profiler_8hpp_source.html">IProfiler.hpp</a>.</p>
122</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
123<a id="a3e96ca374a63bd8547fe68a5d9809df7"></a>
124<h2 class="memtitle"><span class="permalink"><a href="#a3e96ca374a63bd8547fe68a5d9809df7">&#9670;&nbsp;</a></span>~IProfiler()</h2>
125
126<div class="memitem">
127<div class="memproto">
128<table class="mlabels">
129 <tr>
130 <td class="mlabels-left">
131 <table class="memname">
132 <tr>
133 <td class="memname">~<a class="el" href="classarmnn_1_1_i_profiler.html">IProfiler</a> </td>
134 <td>(</td>
135 <td class="paramname"></td><td>)</td>
136 <td></td>
137 </tr>
138 </table>
139 </td>
140 <td class="mlabels-right">
141<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
142 </tr>
143</table>
144</div><div class="memdoc">
145
146<p class="definition">Definition at line <a class="el" href="_i_profiler_8hpp_source.html#l00035">35</a> of file <a class="el" href="_i_profiler_8hpp_source.html">IProfiler.hpp</a>.</p>
147<div class="fragment"><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;{}</div></div><!-- fragment -->
148</div>
149</div>
150<h2 class="groupheader">Member Function Documentation</h2>
151<a id="aea4e445e340cb3a7fbb51465cf029724"></a>
152<h2 class="memtitle"><span class="permalink"><a href="#aea4e445e340cb3a7fbb51465cf029724">&#9670;&nbsp;</a></span>AnalyzeEventsAndWriteResults()</h2>
153
154<div class="memitem">
155<div class="memproto">
156<table class="mlabels">
157 <tr>
158 <td class="mlabels-left">
159 <table class="memname">
160 <tr>
161 <td class="memname">virtual void AnalyzeEventsAndWriteResults </td>
162 <td>(</td>
163 <td class="paramtype">std::ostream &amp;&#160;</td>
164 <td class="paramname"><em>outStream</em></td><td>)</td>
165 <td> const</td>
166 </tr>
167 </table>
168 </td>
169 <td class="mlabels-right">
170<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
171 </tr>
172</table>
173</div><div class="memdoc">
174<p>Analyzes the tracked events and writes the results to the given output stream. Please refer to the configuration variables in <a class="el" href="_profiling_8cpp.html">Profiling.cpp</a> to customize the information written. </p><dl class="params"><dt>Parameters</dt><dd>
175 <table class="params">
176 <tr><td class="paramdir">[out]</td><td class="paramname">outStream</td><td>The stream where to write the profiling results to. </td></tr>
177 </table>
178 </dd>
179</dl>
180
181<p>Implemented in <a class="el" href="classarmnn_1_1_profiler.html#aeb61437c18e4bc111811428aec0e3ae9">Profiler</a>.</p>
182
183</div>
184</div>
185<a id="a769cdf670bd7cda3cda29dd40fbdebf4"></a>
186<h2 class="memtitle"><span class="permalink"><a href="#a769cdf670bd7cda3cda29dd40fbdebf4">&#9670;&nbsp;</a></span>EnableProfiling()</h2>
187
188<div class="memitem">
189<div class="memproto">
190<table class="mlabels">
191 <tr>
192 <td class="mlabels-left">
193 <table class="memname">
194 <tr>
195 <td class="memname">virtual void EnableProfiling </td>
196 <td>(</td>
197 <td class="paramtype">bool&#160;</td>
198 <td class="paramname"><em>enableProfiling</em></td><td>)</td>
199 <td></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<p>Enables/disables profiling for this profiler. </p><dl class="params"><dt>Parameters</dt><dd>
209 <table class="params">
210 <tr><td class="paramdir">[in]</td><td class="paramname">enableProfiling</td><td>A flag that indicates whether profiling should be enabled or not. </td></tr>
211 </table>
212 </dd>
213</dl>
214
215<p>Implemented in <a class="el" href="classarmnn_1_1_profiler.html#a537b76b2a9f7fbcb538eabe994e424e0">Profiler</a>.</p>
216
217</div>
218</div>
219<a id="a1ebebad65df6718dc07aeab66550d0a7"></a>
220<h2 class="memtitle"><span class="permalink"><a href="#a1ebebad65df6718dc07aeab66550d0a7">&#9670;&nbsp;</a></span>IsProfilingEnabled()</h2>
221
222<div class="memitem">
223<div class="memproto">
224<table class="mlabels">
225 <tr>
226 <td class="mlabels-left">
227 <table class="memname">
228 <tr>
229 <td class="memname">virtual bool IsProfilingEnabled </td>
230 <td>(</td>
231 <td class="paramname"></td><td>)</td>
232 <td></td>
233 </tr>
234 </table>
235 </td>
236 <td class="mlabels-right">
237<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
238 </tr>
239</table>
240</div><div class="memdoc">
241<p>Checks whether profiling is enabled. Profiling is disabled by default. </p><dl class="section return"><dt>Returns</dt><dd>true if profiling is enabled, false otherwise. </dd></dl>
242
243<p>Implemented in <a class="el" href="classarmnn_1_1_profiler.html#ad5ac843dd60a0ff7d4ab327f43fb88a5">Profiler</a>.</p>
244
245</div>
246</div>
247<a id="aa369a934075a340fe59b7c9f481f9a57"></a>
248<h2 class="memtitle"><span class="permalink"><a href="#aa369a934075a340fe59b7c9f481f9a57">&#9670;&nbsp;</a></span>Print()</h2>
249
250<div class="memitem">
251<div class="memproto">
252<table class="mlabels">
253 <tr>
254 <td class="mlabels-left">
255 <table class="memname">
256 <tr>
257 <td class="memname">virtual void Print </td>
258 <td>(</td>
259 <td class="paramtype">std::ostream &amp;&#160;</td>
260 <td class="paramname"><em>outStream</em></td><td>)</td>
261 <td> const</td>
262 </tr>
263 </table>
264 </td>
265 <td class="mlabels-right">
266<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
267 </tr>
268</table>
269</div><div class="memdoc">
270<p>Print stats for events in JSON Format to the given output stream. </p><dl class="params"><dt>Parameters</dt><dd>
271 <table class="params">
272 <tr><td class="paramdir">[out]</td><td class="paramname">outStream</td><td>The stream where to write the profiling results to. </td></tr>
273 </table>
274 </dd>
275</dl>
276
277<p>Implemented in <a class="el" href="classarmnn_1_1_profiler.html#a352a82f3a338acf06a20d290f605c489">Profiler</a>.</p>
278
279</div>
280</div>
281<hr/>The documentation for this class was generated from the following file:<ul>
282<li>include/armnn/<a class="el" href="_i_profiler_8hpp_source.html">IProfiler.hpp</a></li>
283</ul>
284</div><!-- contents -->
285</div><!-- doc-content -->
286<!-- start footer part -->
287<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
288 <ul>
289 <li class="navelem"><a class="el" href="namespacearmnn.html">armnn</a></li><li class="navelem"><a class="el" href="classarmnn_1_1_i_profiler.html">IProfiler</a></li>
290 <li class="footer">Generated on Fri Mar 13 2020 16:07:03 for ArmNN by
291 <a href="http://www.doxygen.org/index.html">
292 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
293 </ul>
294</div>
295</body>
296</html>