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: ScopedProfilingEvent 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_scoped_profiling_event.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-types">Public Types</a> | |
| 99 | <a href="#pub-methods">Public Member Functions</a> | |
| 100 | <a href="classarmnn_1_1_scoped_profiling_event-members.xhtml">List of all members</a> </div> |
| 101 | <div class="headertitle"> |
| 102 | <div class="title">ScopedProfilingEvent Class Reference</div> </div> |
| 103 | </div><!--header--> |
| 104 | <div class="contents"> |
| 105 | |
| 106 | <p><code>#include <<a class="el" href="_profiling_8hpp_source.xhtml">Profiling.hpp</a>></code></p> |
| 107 | <table class="memberdecls"> |
| 108 | <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a> |
| 109 | Public Types</h2></td></tr> |
| 110 | <tr class="memitem:a70926d23f3aef7e657a9057a7badb014"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_scoped_profiling_event.xhtml#a70926d23f3aef7e657a9057a7badb014">InstrumentPtr</a> = std::unique_ptr< <a class="el" href="classarmnn_1_1_instrument.xhtml">Instrument</a> ></td></tr> |
| 111 | <tr class="separator:a70926d23f3aef7e657a9057a7badb014"><td class="memSeparator" colspan="2"> </td></tr> |
| 112 | </table><table class="memberdecls"> |
| 113 | <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> |
| 114 | Public Member Functions</h2></td></tr> |
| 115 | <tr class="memitem:ac7608b3f327d278d885252b6b808ed82"><td class="memTemplParams" colspan="2">template<typename... Args> </td></tr> |
| 116 | <tr class="memitem:ac7608b3f327d278d885252b6b808ed82"><td class="memTemplItemLeft" align="right" valign="top"> </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_scoped_profiling_event.xhtml#ac7608b3f327d278d885252b6b808ed82">ScopedProfilingEvent</a> (const <a class="el" href="classarmnn_1_1_backend_id.xhtml">BackendId</a> &backendId, const std::string &name, Args... args)</td></tr> |
| 117 | <tr class="separator:ac7608b3f327d278d885252b6b808ed82"><td class="memSeparator" colspan="2"> </td></tr> |
| 118 | <tr class="memitem:aa4f6b27d8649f796fba223997c3a9087"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_scoped_profiling_event.xhtml#aa4f6b27d8649f796fba223997c3a9087">~ScopedProfilingEvent</a> ()</td></tr> |
| 119 | <tr class="separator:aa4f6b27d8649f796fba223997c3a9087"><td class="memSeparator" colspan="2"> </td></tr> |
| 120 | </table> |
| 121 | <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| 122 | <div class="textblock"> |
| 123 | <p class="definition">Definition at line <a class="el" href="_profiling_8hpp_source.xhtml#l00112">112</a> of file <a class="el" href="_profiling_8hpp_source.xhtml">Profiling.hpp</a>.</p> |
| 124 | </div><h2 class="groupheader">Member Typedef Documentation</h2> |
| 125 | <a id="a70926d23f3aef7e657a9057a7badb014"></a> |
| 126 | <h2 class="memtitle"><span class="permalink"><a href="#a70926d23f3aef7e657a9057a7badb014">◆ </a></span>InstrumentPtr</h2> |
| 127 | |
| 128 | <div class="memitem"> |
| 129 | <div class="memproto"> |
| 130 | <table class="memname"> |
| 131 | <tr> |
| 132 | <td class="memname">using <a class="el" href="classarmnn_1_1_scoped_profiling_event.xhtml#a70926d23f3aef7e657a9057a7badb014">InstrumentPtr</a> = std::unique_ptr<<a class="el" href="classarmnn_1_1_instrument.xhtml">Instrument</a>></td> |
| 133 | </tr> |
| 134 | </table> |
| 135 | </div><div class="memdoc"> |
| 136 | |
| 137 | <p class="definition">Definition at line <a class="el" href="_profiling_8hpp_source.xhtml#l00115">115</a> of file <a class="el" href="_profiling_8hpp_source.xhtml">Profiling.hpp</a>.</p> |
| 138 | |
| 139 | </div> |
| 140 | </div> |
| 141 | <h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| 142 | <a id="ac7608b3f327d278d885252b6b808ed82"></a> |
| 143 | <h2 class="memtitle"><span class="permalink"><a href="#ac7608b3f327d278d885252b6b808ed82">◆ </a></span>ScopedProfilingEvent()</h2> |
| 144 | |
| 145 | <div class="memitem"> |
| 146 | <div class="memproto"> |
| 147 | <table class="mlabels"> |
| 148 | <tr> |
| 149 | <td class="mlabels-left"> |
| 150 | <table class="memname"> |
| 151 | <tr> |
| 152 | <td class="memname"><a class="el" href="classarmnn_1_1_scoped_profiling_event.xhtml">ScopedProfilingEvent</a> </td> |
| 153 | <td>(</td> |
| 154 | <td class="paramtype">const <a class="el" href="classarmnn_1_1_backend_id.xhtml">BackendId</a> & </td> |
| 155 | <td class="paramname"><em>backendId</em>, </td> |
| 156 | </tr> |
| 157 | <tr> |
| 158 | <td class="paramkey"></td> |
| 159 | <td></td> |
| 160 | <td class="paramtype">const std::string & </td> |
| 161 | <td class="paramname"><em>name</em>, </td> |
| 162 | </tr> |
| 163 | <tr> |
| 164 | <td class="paramkey"></td> |
| 165 | <td></td> |
| 166 | <td class="paramtype">Args... </td> |
| 167 | <td class="paramname"><em>args</em> </td> |
| 168 | </tr> |
| 169 | <tr> |
| 170 | <td></td> |
| 171 | <td>)</td> |
| 172 | <td></td><td></td> |
| 173 | </tr> |
| 174 | </table> |
| 175 | </td> |
| 176 | <td class="mlabels-right"> |
| 177 | <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| 178 | </tr> |
| 179 | </table> |
| 180 | </div><div class="memdoc"> |
| 181 | |
| 182 | <p class="definition">Definition at line <a class="el" href="_profiling_8hpp_source.xhtml#l00118">118</a> of file <a class="el" href="_profiling_8hpp_source.xhtml">Profiling.hpp</a>.</p> |
| 183 | <div class="fragment"><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  : m_Event(<span class="keyword">nullptr</span>)</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  , m_Profiler(<a class="code" href="classarmnn_1_1_profiler_manager.xhtml#a93857080c2523bf3395e7aa7e6024d5c">ProfilerManager::GetInstance</a>().GetProfiler())</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  {</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  <span class="keywordflow">if</span> (m_Profiler && m_Profiler-><a class="code" href="classarmnn_1_1_profiler.xhtml#ad5ac843dd60a0ff7d4ab327f43fb88a5">IsProfilingEnabled</a>())</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  {</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  std::vector<InstrumentPtr> instruments(0);</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  instruments.reserve(<span class="keyword">sizeof</span>...(args)); <span class="comment">//One allocation</span></div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  ConstructNextInVector(instruments, args...);</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  m_Event = m_Profiler-><a class="code" href="classarmnn_1_1_profiler.xhtml#abaf660a136b904fbcbd0c374fea38cd0">BeginEvent</a>(backendId, name, std::move(instruments));</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  }</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  }</div><div class="ttc" id="classarmnn_1_1_profiler_manager_xhtml_a93857080c2523bf3395e7aa7e6024d5c"><div class="ttname"><a href="classarmnn_1_1_profiler_manager.xhtml#a93857080c2523bf3395e7aa7e6024d5c">armnn::ProfilerManager::GetInstance</a></div><div class="ttdeci">static ProfilerManager & GetInstance()</div><div class="ttdef"><b>Definition:</b> <a href="_profiling_8cpp_source.xhtml#l00487">Profiling.cpp:487</a></div></div> |
| 184 | <div class="ttc" id="classarmnn_1_1_profiler_xhtml_ad5ac843dd60a0ff7d4ab327f43fb88a5"><div class="ttname"><a href="classarmnn_1_1_profiler.xhtml#ad5ac843dd60a0ff7d4ab327f43fb88a5">armnn::Profiler::IsProfilingEnabled</a></div><div class="ttdeci">bool IsProfilingEnabled() override</div><div class="ttdoc">Checks whether profiling is enabled. </div><div class="ttdef"><b>Definition:</b> <a href="_profiling_8cpp_source.xhtml#l00191">Profiling.cpp:191</a></div></div> |
| 185 | <div class="ttc" id="classarmnn_1_1_profiler_xhtml_abaf660a136b904fbcbd0c374fea38cd0"><div class="ttname"><a href="classarmnn_1_1_profiler.xhtml#abaf660a136b904fbcbd0c374fea38cd0">armnn::Profiler::BeginEvent</a></div><div class="ttdeci">Event * BeginEvent(const BackendId &backendId, const std::string &name, std::vector< InstrumentPtr > &&instruments)</div><div class="ttdef"><b>Definition:</b> <a href="_profiling_8cpp_source.xhtml#l00201">Profiling.cpp:201</a></div></div> |
| 186 | </div><!-- fragment --> |
| 187 | </div> |
| 188 | </div> |
| 189 | <a id="aa4f6b27d8649f796fba223997c3a9087"></a> |
| 190 | <h2 class="memtitle"><span class="permalink"><a href="#aa4f6b27d8649f796fba223997c3a9087">◆ </a></span>~ScopedProfilingEvent()</h2> |
| 191 | |
| 192 | <div class="memitem"> |
| 193 | <div class="memproto"> |
| 194 | <table class="mlabels"> |
| 195 | <tr> |
| 196 | <td class="mlabels-left"> |
| 197 | <table class="memname"> |
| 198 | <tr> |
| 199 | <td class="memname">~<a class="el" href="classarmnn_1_1_scoped_profiling_event.xhtml">ScopedProfilingEvent</a> </td> |
| 200 | <td>(</td> |
| 201 | <td class="paramname"></td><td>)</td> |
| 202 | <td></td> |
| 203 | </tr> |
| 204 | </table> |
| 205 | </td> |
| 206 | <td class="mlabels-right"> |
| 207 | <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| 208 | </tr> |
| 209 | </table> |
| 210 | </div><div class="memdoc"> |
| 211 | |
| 212 | <p class="definition">Definition at line <a class="el" href="_profiling_8hpp_source.xhtml#l00131">131</a> of file <a class="el" href="_profiling_8hpp_source.xhtml">Profiling.hpp</a>.</p> |
| 213 | |
| 214 | <p class="reference">References <a class="el" href="_ignore_unused_8hpp_source.xhtml#l00014">armnn::IgnoreUnused()</a>.</p> |
| 215 | <div class="fragment"><div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  {</div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  <span class="keywordflow">if</span> (m_Profiler && m_Event)</div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  {</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  m_Profiler-><a class="code" href="classarmnn_1_1_profiler.xhtml#a8ed16398e69bb7b0625e3cf4a279b1f3">EndEvent</a>(m_Event);</div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  }</div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  }</div><div class="ttc" id="classarmnn_1_1_profiler_xhtml_a8ed16398e69bb7b0625e3cf4a279b1f3"><div class="ttname"><a href="classarmnn_1_1_profiler.xhtml#a8ed16398e69bb7b0625e3cf4a279b1f3">armnn::Profiler::EndEvent</a></div><div class="ttdeci">void EndEvent(Event *event)</div><div class="ttdef"><b>Definition:</b> <a href="_profiling_8cpp_source.xhtml#l00218">Profiling.cpp:218</a></div></div> |
| 216 | </div><!-- fragment --> |
| 217 | </div> |
| 218 | </div> |
| 219 | <hr/>The documentation for this class was generated from the following file:<ul> |
| 220 | <li>src/armnn/<a class="el" href="_profiling_8hpp_source.xhtml">Profiling.hpp</a></li> |
| 221 | </ul> |
| 222 | </div><!-- contents --> |
| 223 | </div><!-- doc-content --> |
| 224 | <!-- start footer part --> |
| 225 | <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> |
| 226 | <ul> |
| 227 | <li class="navelem"><a class="el" href="namespacearmnn.xhtml">armnn</a></li><li class="navelem"><a class="el" href="classarmnn_1_1_scoped_profiling_event.xhtml">ScopedProfilingEvent</a></li> |
| 228 | <li class="footer">Generated on Fri Mar 13 2020 16:09:20 for ArmNN by |
| 229 | <a href="http://www.doxygen.org/index.html"> |
| 230 | <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li> |
| 231 | </ul> |
| 232 | </div> |
| 233 | </body> |
| 234 | </html> |