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