Gitiles
Code Review Sign In
review.mlplatform.org / ml / armnn / 1dc83febfb76d6a770bdf3ba16c4034a970c2320 / . / 24.05 / classarmnn_1_1_scoped_profiling_event.html
blob: 8070445404bb17034385cc27781f538920be5c0d [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: ScopedProfilingEvent 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_scoped_profiling_event.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-types">Public Types</a> &#124;
97<a href="#pub-methods">Public Member Functions</a> &#124;
98<a href="classarmnn_1_1_scoped_profiling_event-members.html">List of all members</a> </div>
99 <div class="headertitle">
100<div class="title">ScopedProfilingEvent Class Reference</div> </div>
101</div><!--header-->
102<div class="contents">
103
104<p><code>#include &lt;<a class="el" href="_profiling_8hpp_source.html">Profiling.hpp</a>&gt;</code></p>
105<table class="memberdecls">
106<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
107Public Types</h2></td></tr>
108<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>
109<tr class="separator:a70926d23f3aef7e657a9057a7badb014"><td class="memSeparator" colspan="2">&#160;</td></tr>
110</table><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:a8607dcc995844bd9a7d9296b79c6c1be"><td class="memTemplParams" colspan="2">template&lt;typename... Args&gt; </td></tr>
114<tr class="memitem:a8607dcc995844bd9a7d9296b79c6c1be"><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#a8607dcc995844bd9a7d9296b79c6c1be">ScopedProfilingEvent</a> (const <a class="el" href="classarmnn_1_1_backend_id.html">BackendId</a> &amp;backendId, const <a class="el" href="classarmnn_1_1_optional.html">Optional</a>&lt; arm::pipe::ProfilingGuid &gt; &amp;guid, const std::string &amp;name, Args &amp;&amp;... args)</td></tr>
115<tr class="separator:a8607dcc995844bd9a7d9296b79c6c1be"><td class="memSeparator" colspan="2">&#160;</td></tr>
116<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>
117<tr class="separator:aa4f6b27d8649f796fba223997c3a9087"><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="_profiling_8hpp_source.html#l00130">130</a> of file <a class="el" href="_profiling_8hpp_source.html">Profiling.hpp</a>.</p>
122</div><h2 class="groupheader">Member Typedef Documentation</h2>
123<a id="a70926d23f3aef7e657a9057a7badb014"></a>
124<h2 class="memtitle"><span class="permalink"><a href="#a70926d23f3aef7e657a9057a7badb014">&#9670;&nbsp;</a></span>InstrumentPtr</h2>
125
126<div class="memitem">
127<div class="memproto">
128 <table class="memname">
129 <tr>
130 <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>
131 </tr>
132 </table>
133</div><div class="memdoc">
134
135<p class="definition">Definition at line <a class="el" href="_profiling_8hpp_source.html#l00133">133</a> of file <a class="el" href="_profiling_8hpp_source.html">Profiling.hpp</a>.</p>
136
137</div>
138</div>
139<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
140<a id="a8607dcc995844bd9a7d9296b79c6c1be"></a>
141<h2 class="memtitle"><span class="permalink"><a href="#a8607dcc995844bd9a7d9296b79c6c1be">&#9670;&nbsp;</a></span>ScopedProfilingEvent()</h2>
142
143<div class="memitem">
144<div class="memproto">
145<table class="mlabels">
146 <tr>
147 <td class="mlabels-left">
148 <table class="memname">
149 <tr>
150 <td class="memname"><a class="el" href="classarmnn_1_1_scoped_profiling_event.html">ScopedProfilingEvent</a> </td>
151 <td>(</td>
152 <td class="paramtype">const <a class="el" href="classarmnn_1_1_backend_id.html">BackendId</a> &amp;&#160;</td>
153 <td class="paramname"><em>backendId</em>, </td>
154 </tr>
155 <tr>
156 <td class="paramkey"></td>
157 <td></td>
158 <td class="paramtype">const <a class="el" href="classarmnn_1_1_optional.html">Optional</a>&lt; arm::pipe::ProfilingGuid &gt; &amp;&#160;</td>
159 <td class="paramname"><em>guid</em>, </td>
160 </tr>
161 <tr>
162 <td class="paramkey"></td>
163 <td></td>
164 <td class="paramtype">const std::string &amp;&#160;</td>
165 <td class="paramname"><em>name</em>, </td>
166 </tr>
167 <tr>
168 <td class="paramkey"></td>
169 <td></td>
170 <td class="paramtype">Args &amp;&amp;...&#160;</td>
171 <td class="paramname"><em>args</em>&#160;</td>
172 </tr>
173 <tr>
174 <td></td>
175 <td>)</td>
176 <td></td><td></td>
177 </tr>
178 </table>
179 </td>
180 <td class="mlabels-right">
181<span class="mlabels"><span class="mlabel">inline</span></span> </td>
182 </tr>
183</table>
184</div><div class="memdoc">
185
186<p class="definition">Definition at line <a class="el" href="_profiling_8hpp_source.html#l00136">136</a> of file <a class="el" href="_profiling_8hpp_source.html">Profiling.hpp</a>.</p>
187<div class="fragment"><div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160; : m_Event(<span class="keyword">nullptr</span>)</div>
188<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160; , m_Profiler(<a class="code" href="classarmnn_1_1_profiler_manager.html#a93857080c2523bf3395e7aa7e6024d5c">ProfilerManager::GetInstance</a>().GetProfiler())</div>
189<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160; {</div>
190<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>&#160; <span class="keywordflow">if</span> (m_Profiler &amp;&amp; m_Profiler-&gt;<a class="code" href="classarmnn_1_1_i_profiler.html#aa5a25e3cf143724a9460c4aa9c47841b">IsProfilingEnabled</a>())</div>
191<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>&#160; {</div>
192<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>&#160; std::vector&lt;InstrumentPtr&gt; instruments(0);</div>
193<div class="line"><a name="l00146"></a><span class="lineno"> 146</span>&#160; instruments.reserve(<span class="keyword">sizeof</span>...(args)); <span class="comment">//One allocation</span></div>
194<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160; ConstructNextInVector(instruments, std::forward&lt;Args&gt;(args)...);</div>
195<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160; m_Event = m_Profiler-&gt;BeginEvent(backendId, name, std::move(instruments), guid);</div>
196<div class="line"><a name="l00149"></a><span class="lineno"> 149</span>&#160; }</div>
197<div class="line"><a name="l00150"></a><span class="lineno"> 150</span>&#160; }</div>
198</div><!-- fragment -->
199<p class="reference">References <a class="el" href="_profiling_8cpp_source.html#l00629">IProfiler::IsProfilingEnabled()</a>.</p>
200
201</div>
202</div>
203<a id="aa4f6b27d8649f796fba223997c3a9087"></a>
204<h2 class="memtitle"><span class="permalink"><a href="#aa4f6b27d8649f796fba223997c3a9087">&#9670;&nbsp;</a></span>~ScopedProfilingEvent()</h2>
205
206<div class="memitem">
207<div class="memproto">
208<table class="mlabels">
209 <tr>
210 <td class="mlabels-left">
211 <table class="memname">
212 <tr>
213 <td class="memname">~<a class="el" href="classarmnn_1_1_scoped_profiling_event.html">ScopedProfilingEvent</a> </td>
214 <td>(</td>
215 <td class="paramname"></td><td>)</td>
216 <td></td>
217 </tr>
218 </table>
219 </td>
220 <td class="mlabels-right">
221<span class="mlabels"><span class="mlabel">inline</span></span> </td>
222 </tr>
223</table>
224</div><div class="memdoc">
225
226<p class="definition">Definition at line <a class="el" href="_profiling_8hpp_source.html#l00152">152</a> of file <a class="el" href="_profiling_8hpp_source.html">Profiling.hpp</a>.</p>
227<div class="fragment"><div class="line"><a name="l00153"></a><span class="lineno"> 153</span>&#160; {</div>
228<div class="line"><a name="l00154"></a><span class="lineno"> 154</span>&#160; <span class="keywordflow">if</span> (m_Profiler &amp;&amp; m_Event)</div>
229<div class="line"><a name="l00155"></a><span class="lineno"> 155</span>&#160; {</div>
230<div class="line"><a name="l00156"></a><span class="lineno"> 156</span>&#160; m_Profiler-&gt;pProfilerImpl-&gt;EndEvent(m_Event);</div>
231<div class="line"><a name="l00157"></a><span class="lineno"> 157</span>&#160; }</div>
232<div class="line"><a name="l00158"></a><span class="lineno"> 158</span>&#160; }</div>
233</div><!-- fragment -->
234</div>
235</div>
236<hr/>The documentation for this class was generated from the following file:<ul>
237<li>src/armnn/<a class="el" href="_profiling_8hpp_source.html">Profiling.hpp</a></li>
238</ul>
239</div><!-- contents -->
240</div><!-- doc-content -->
241<div class="ttc" id="aclassarmnn_1_1_i_profiler_html_aa5a25e3cf143724a9460c4aa9c47841b"><div class="ttname"><a href="classarmnn_1_1_i_profiler.html#aa5a25e3cf143724a9460c4aa9c47841b">armnn::IProfiler::IsProfilingEnabled</a></div><div class="ttdeci">bool IsProfilingEnabled()</div><div class="ttdoc">Checks whether profiling is enabled.</div><div class="ttdef"><b>Definition:</b> <a href="_profiling_8cpp_source.html#l00629">Profiling.cpp:629</a></div></div>
242<div class="ttc" id="aclassarmnn_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#l00602">Profiling.cpp:602</a></div></div>
243<!-- start footer part -->
244<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
245 <ul>
246 <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>
247 <li class="footer">Generated on Thu May 16 2024 09:31:59 for Arm NN by
248 <a href="http://www.doxygen.org/index.html">
249 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
250 </ul>
251</div>
252</body>
253</html>