Gitiles
Code Review Sign In
review.mlplatform.org / ml / armnn / 7ddbbae7ad3e0000d8e6a76458cac68254dc8048 / . / Documentation / classarmnn_1_1_scoped_profiling_event.html
blob: f00096cf65b058259431e0873afa67d1ba9ffad6 [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: ScopedProfilingEvent 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_scoped_profiling_event.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-types">Public Types</a> &#124;
85<a href="#pub-methods">Public Member Functions</a> &#124;
86<a href="classarmnn_1_1_scoped_profiling_event-members.html">List of all members</a> </div>
87 <div class="headertitle">
88<div class="title">ScopedProfilingEvent Class Reference</div> </div>
89</div><!--header-->
90<div class="contents">
91
92<p><code>#include &lt;<a class="el" href="_profiling_8hpp_source.html">Profiling.hpp</a>&gt;</code></p>
93<table class="memberdecls">
94<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
95Public Types</h2></td></tr>
96<tr class="memitem:a70926d23f3aef7e657a9057a7badb014"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_scoped_profiling_event.html#a70926d23f3aef7e657a9057a7badb014">InstrumentPtr</a> = std::unique_ptr&lt; <a class="el" href="classarmnn_1_1_instrument.html">Instrument</a> &gt;</td></tr>
97<tr class="separator:a70926d23f3aef7e657a9057a7badb014"><td class="memSeparator" colspan="2">&#160;</td></tr>
98</table><table class="memberdecls">
99<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
100Public Member Functions</h2></td></tr>
101<tr class="memitem:ac7608b3f327d278d885252b6b808ed82"><td class="memTemplParams" colspan="2">template&lt;typename... Args&gt; </td></tr>
102<tr class="memitem:ac7608b3f327d278d885252b6b808ed82"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_scoped_profiling_event.html#ac7608b3f327d278d885252b6b808ed82">ScopedProfilingEvent</a> (const <a class="el" href="classarmnn_1_1_backend_id.html">BackendId</a> &amp;backendId, const std::string &amp;name, Args... args)</td></tr>
103<tr class="separator:ac7608b3f327d278d885252b6b808ed82"><td class="memSeparator" colspan="2">&#160;</td></tr>
104<tr class="memitem:aa4f6b27d8649f796fba223997c3a9087"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_scoped_profiling_event.html#aa4f6b27d8649f796fba223997c3a9087">~ScopedProfilingEvent</a> ()</td></tr>
105<tr class="separator:aa4f6b27d8649f796fba223997c3a9087"><td class="memSeparator" colspan="2">&#160;</td></tr>
106</table>
107<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
108<div class="textblock">
109<p class="definition">Definition at line <a class="el" href="_profiling_8hpp_source.html#l00113">113</a> of file <a class="el" href="_profiling_8hpp_source.html">Profiling.hpp</a>.</p>
110</div><h2 class="groupheader">Member Typedef Documentation</h2>
111<a id="a70926d23f3aef7e657a9057a7badb014"></a>
112<h2 class="memtitle"><span class="permalink"><a href="#a70926d23f3aef7e657a9057a7badb014">&#9670;&nbsp;</a></span>InstrumentPtr</h2>
113
114<div class="memitem">
115<div class="memproto">
116 <table class="memname">
117 <tr>
118 <td class="memname">using <a class="el" href="classarmnn_1_1_scoped_profiling_event.html#a70926d23f3aef7e657a9057a7badb014">InstrumentPtr</a> = std::unique_ptr&lt;<a class="el" href="classarmnn_1_1_instrument.html">Instrument</a>&gt;</td>
119 </tr>
120 </table>
121</div><div class="memdoc">
122
123<p class="definition">Definition at line <a class="el" href="_profiling_8hpp_source.html#l00116">116</a> of file <a class="el" href="_profiling_8hpp_source.html">Profiling.hpp</a>.</p>
124
125</div>
126</div>
127<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
128<a id="ac7608b3f327d278d885252b6b808ed82"></a>
129<h2 class="memtitle"><span class="permalink"><a href="#ac7608b3f327d278d885252b6b808ed82">&#9670;&nbsp;</a></span>ScopedProfilingEvent()</h2>
130
131<div class="memitem">
132<div class="memproto">
133<table class="mlabels">
134 <tr>
135 <td class="mlabels-left">
136 <table class="memname">
137 <tr>
138 <td class="memname"><a class="el" href="classarmnn_1_1_scoped_profiling_event.html">ScopedProfilingEvent</a> </td>
139 <td>(</td>
140 <td class="paramtype">const <a class="el" href="classarmnn_1_1_backend_id.html">BackendId</a> &amp;&#160;</td>
141 <td class="paramname"><em>backendId</em>, </td>
142 </tr>
143 <tr>
144 <td class="paramkey"></td>
145 <td></td>
146 <td class="paramtype">const std::string &amp;&#160;</td>
147 <td class="paramname"><em>name</em>, </td>
148 </tr>
149 <tr>
150 <td class="paramkey"></td>
151 <td></td>
152 <td class="paramtype">Args...&#160;</td>
153 <td class="paramname"><em>args</em>&#160;</td>
154 </tr>
155 <tr>
156 <td></td>
157 <td>)</td>
158 <td></td><td></td>
159 </tr>
160 </table>
161 </td>
162 <td class="mlabels-right">
163<span class="mlabels"><span class="mlabel">inline</span></span> </td>
164 </tr>
165</table>
166</div><div class="memdoc">
167
168<p class="definition">Definition at line <a class="el" href="_profiling_8hpp_source.html#l00119">119</a> of file <a class="el" href="_profiling_8hpp_source.html">Profiling.hpp</a>.</p>
169<div class="fragment"><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; : m_Event(<span class="keyword">nullptr</span>)</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160; , m_Profiler(<a class="code" href="classarmnn_1_1_profiler_manager.html#a93857080c2523bf3395e7aa7e6024d5c">ProfilerManager::GetInstance</a>().GetProfiler())</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160; {</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160; <span class="keywordflow">if</span> (m_Profiler &amp;&amp; m_Profiler-&gt;<a class="code" href="classarmnn_1_1_profiler.html#ad5ac843dd60a0ff7d4ab327f43fb88a5">IsProfilingEnabled</a>())</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; {</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160; std::vector&lt;InstrumentPtr&gt; instruments(0);</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160; instruments.reserve(<span class="keyword">sizeof</span>...(args)); <span class="comment">//One allocation</span></div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160; ConstructNextInVector(instruments, args...);</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160; m_Event = m_Profiler-&gt;<a class="code" href="classarmnn_1_1_profiler.html#abaf660a136b904fbcbd0c374fea38cd0">BeginEvent</a>(backendId, name, std::move(instruments));</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160; }</div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160; }</div><div class="ttc" id="classarmnn_1_1_profiler_html_abaf660a136b904fbcbd0c374fea38cd0"><div class="ttname"><a href="classarmnn_1_1_profiler.html#abaf660a136b904fbcbd0c374fea38cd0">armnn::Profiler::BeginEvent</a></div><div class="ttdeci">Event * BeginEvent(const BackendId &amp;backendId, const std::string &amp;name, std::vector&lt; InstrumentPtr &gt; &amp;&amp;instruments)</div><div class="ttdef"><b>Definition:</b> <a href="_profiling_8cpp_source.html#l00200">Profiling.cpp:200</a></div></div>
170<div class="ttc" id="classarmnn_1_1_profiler_manager_html_a93857080c2523bf3395e7aa7e6024d5c"><div class="ttname"><a href="classarmnn_1_1_profiler_manager.html#a93857080c2523bf3395e7aa7e6024d5c">armnn::ProfilerManager::GetInstance</a></div><div class="ttdeci">static ProfilerManager &amp; GetInstance()</div><div class="ttdef"><b>Definition:</b> <a href="_profiling_8cpp_source.html#l00486">Profiling.cpp:486</a></div></div>
171<div class="ttc" id="classarmnn_1_1_profiler_html_ad5ac843dd60a0ff7d4ab327f43fb88a5"><div class="ttname"><a href="classarmnn_1_1_profiler.html#ad5ac843dd60a0ff7d4ab327f43fb88a5">armnn::Profiler::IsProfilingEnabled</a></div><div class="ttdeci">bool IsProfilingEnabled() override</div><div class="ttdef"><b>Definition:</b> <a href="_profiling_8cpp_source.html#l00190">Profiling.cpp:190</a></div></div>
172</div><!-- fragment -->
173</div>
174</div>
175<a id="aa4f6b27d8649f796fba223997c3a9087"></a>
176<h2 class="memtitle"><span class="permalink"><a href="#aa4f6b27d8649f796fba223997c3a9087">&#9670;&nbsp;</a></span>~ScopedProfilingEvent()</h2>
177
178<div class="memitem">
179<div class="memproto">
180<table class="mlabels">
181 <tr>
182 <td class="mlabels-left">
183 <table class="memname">
184 <tr>
185 <td class="memname">~<a class="el" href="classarmnn_1_1_scoped_profiling_event.html">ScopedProfilingEvent</a> </td>
186 <td>(</td>
187 <td class="paramname"></td><td>)</td>
188 <td></td>
189 </tr>
190 </table>
191 </td>
192 <td class="mlabels-right">
193<span class="mlabels"><span class="mlabel">inline</span></span> </td>
194 </tr>
195</table>
196</div><div class="memdoc">
197
198<p class="definition">Definition at line <a class="el" href="_profiling_8hpp_source.html#l00132">132</a> of file <a class="el" href="_profiling_8hpp_source.html">Profiling.hpp</a>.</p>
199<div class="fragment"><div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160; {</div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160; <span class="keywordflow">if</span> (m_Profiler &amp;&amp; m_Event)</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160; {</div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160; m_Profiler-&gt;<a class="code" href="classarmnn_1_1_profiler.html#a8ed16398e69bb7b0625e3cf4a279b1f3">EndEvent</a>(m_Event);</div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160; }</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160; }</div><div class="ttc" id="classarmnn_1_1_profiler_html_a8ed16398e69bb7b0625e3cf4a279b1f3"><div class="ttname"><a href="classarmnn_1_1_profiler.html#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.html#l00217">Profiling.cpp:217</a></div></div>
200</div><!-- fragment -->
201</div>
202</div>
203<hr/>The documentation for this class was generated from the following file:<ul>
204<li>src/armnn/<a class="el" href="_profiling_8hpp_source.html">Profiling.hpp</a></li>
205</ul>
206</div><!-- contents -->
207</div><!-- doc-content -->
208<!-- start footer part -->
209<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
210 <ul>
211 <li class="navelem"><a class="el" href="namespacearmnn.html">armnn</a></li><li class="navelem"><a class="el" href="classarmnn_1_1_scoped_profiling_event.html">ScopedProfilingEvent</a></li>
212 <li class="footer">Generated on Fri Mar 13 2020 16:07:05 for ArmNN by
213 <a href="http://www.doxygen.org/index.html">
214 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
215 </ul>
216</div>
217</body>
218</html>