Gitiles
Code Review Sign In
review.mlplatform.org / ml / armnn / 1dc83febfb76d6a770bdf3ba16c4034a970c2320 / . / 24.05 / classarmnn_1_1_execution_frame.html
blob: 2994e9d601ac1b445597f71503ed2afbb5993670 [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: ExecutionFrame 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_execution_frame.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-methods">Public Member Functions</a> &#124;
97<a href="classarmnn_1_1_execution_frame-members.html">List of all members</a> </div>
98 <div class="headertitle">
99<div class="title">ExecutionFrame Class Reference</div> </div>
100</div><!--header-->
101<div class="contents">
102
103<p><code>#include &lt;<a class="el" href="_execution_frame_8hpp_source.html">ExecutionFrame.hpp</a>&gt;</code></p>
104<div class="dynheader">
105Inheritance diagram for ExecutionFrame:</div>
106<div class="dyncontent">
107<div class="center"><iframe scrolling="no" frameborder="0" src="classarmnn_1_1_execution_frame__inherit__graph.svg" width="142" height="112"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
108</div>
109<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
110<div class="dynheader">
111Collaboration diagram for ExecutionFrame:</div>
112<div class="dyncontent">
113<div class="center"><iframe scrolling="no" frameborder="0" src="classarmnn_1_1_execution_frame__coll__graph.svg" width="142" height="112"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
114</div>
115<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
116<table class="memberdecls">
117<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
118Public Member Functions</h2></td></tr>
119<tr class="memitem:ad93148c735945f614be3a5e57c3c1dad"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_execution_frame.html#ad93148c735945f614be3a5e57c3c1dad">ExecutionFrame</a> ()</td></tr>
120<tr class="separator:ad93148c735945f614be3a5e57c3c1dad"><td class="memSeparator" colspan="2">&#160;</td></tr>
121<tr class="memitem:a53bc9f544fe292cbbc2d258595bc3af7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarmnn_1_1_i_execution_frame.html">IExecutionFrame</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_execution_frame.html#a53bc9f544fe292cbbc2d258595bc3af7">ExecuteWorkloads</a> (<a class="el" href="classarmnn_1_1_i_execution_frame.html">IExecutionFrame</a> *previousFrame) override</td></tr>
122<tr class="separator:a53bc9f544fe292cbbc2d258595bc3af7"><td class="memSeparator" colspan="2">&#160;</td></tr>
123<tr class="memitem:a81627f96ba06d76e147f7d392a8117ed"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_execution_frame.html#a81627f96ba06d76e147f7d392a8117ed">PostAllocationConfigure</a> () override</td></tr>
124<tr class="separator:a81627f96ba06d76e147f7d392a8117ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
125<tr class="memitem:ab27ebaf88cafddc4a6ee001ec7316e73"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_execution_frame.html#ab27ebaf88cafddc4a6ee001ec7316e73">RegisterDebugCallback</a> (const <a class="el" href="namespacearmnn.html#a15f3ad9b5e4e3d46b0a6dda246a7bc28">DebugCallbackFunction</a> &amp;func) override</td></tr>
126<tr class="separator:ab27ebaf88cafddc4a6ee001ec7316e73"><td class="memSeparator" colspan="2">&#160;</td></tr>
127<tr class="memitem:a66a0f659f0630312604b65cb8f144c0e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_execution_frame.html#a66a0f659f0630312604b65cb8f144c0e">AddWorkloadToQueue</a> (std::unique_ptr&lt; <a class="el" href="classarmnn_1_1_i_workload.html">IWorkload</a> &gt; workload)</td></tr>
128<tr class="separator:a66a0f659f0630312604b65cb8f144c0e"><td class="memSeparator" colspan="2">&#160;</td></tr>
129<tr class="memitem:a695550617960685f2626ef23c30e2c9d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_execution_frame.html#a695550617960685f2626ef23c30e2c9d">SetNextExecutionFrame</a> (<a class="el" href="classarmnn_1_1_i_execution_frame.html">IExecutionFrame</a> *nextExecutionFrame)</td></tr>
130<tr class="separator:a695550617960685f2626ef23c30e2c9d"><td class="memSeparator" colspan="2">&#160;</td></tr>
131<tr class="inherit_header pub_methods_classarmnn_1_1_i_execution_frame"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarmnn_1_1_i_execution_frame')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classarmnn_1_1_i_execution_frame.html">IExecutionFrame</a></td></tr>
132<tr class="memitem:a1ca0125ac3082676dae03050a52e6068 inherit pub_methods_classarmnn_1_1_i_execution_frame"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_i_execution_frame.html#a1ca0125ac3082676dae03050a52e6068">~IExecutionFrame</a> ()</td></tr>
133<tr class="separator:a1ca0125ac3082676dae03050a52e6068 inherit pub_methods_classarmnn_1_1_i_execution_frame"><td class="memSeparator" colspan="2">&#160;</td></tr>
134</table>
135<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
136<div class="textblock">
137<p class="definition">Definition at line <a class="el" href="_execution_frame_8hpp_source.html#l00027">27</a> of file <a class="el" href="_execution_frame_8hpp_source.html">ExecutionFrame.hpp</a>.</p>
138</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
139<a id="ad93148c735945f614be3a5e57c3c1dad"></a>
140<h2 class="memtitle"><span class="permalink"><a href="#ad93148c735945f614be3a5e57c3c1dad">&#9670;&nbsp;</a></span>ExecutionFrame()</h2>
141
142<div class="memitem">
143<div class="memproto">
144 <table class="memname">
145 <tr>
146 <td class="memname"><a class="el" href="classarmnn_1_1_execution_frame.html">ExecutionFrame</a> </td>
147 <td>(</td>
148 <td class="paramname"></td><td>)</td>
149 <td></td>
150 </tr>
151 </table>
152</div><div class="memdoc">
153
154<p class="definition">Definition at line <a class="el" href="_execution_frame_8cpp_source.html#l00012">12</a> of file <a class="el" href="_execution_frame_8cpp_source.html">ExecutionFrame.cpp</a>.</p>
155<div class="fragment"><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;{}</div>
156</div><!-- fragment -->
157</div>
158</div>
159<h2 class="groupheader">Member Function Documentation</h2>
160<a id="a66a0f659f0630312604b65cb8f144c0e"></a>
161<h2 class="memtitle"><span class="permalink"><a href="#a66a0f659f0630312604b65cb8f144c0e">&#9670;&nbsp;</a></span>AddWorkloadToQueue()</h2>
162
163<div class="memitem">
164<div class="memproto">
165 <table class="memname">
166 <tr>
167 <td class="memname">void AddWorkloadToQueue </td>
168 <td>(</td>
169 <td class="paramtype">std::unique_ptr&lt; <a class="el" href="classarmnn_1_1_i_workload.html">IWorkload</a> &gt;&#160;</td>
170 <td class="paramname"><em>workload</em></td><td>)</td>
171 <td></td>
172 </tr>
173 </table>
174</div><div class="memdoc">
175
176<p class="definition">Definition at line <a class="el" href="_execution_frame_8cpp_source.html#l00040">40</a> of file <a class="el" href="_execution_frame_8cpp_source.html">ExecutionFrame.cpp</a>.</p>
177<div class="fragment"><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;{</div>
178<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; m_WorkloadQueue.push_back(std::move(workload));</div>
179<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;}</div>
180</div><!-- fragment -->
181</div>
182</div>
183<a id="a53bc9f544fe292cbbc2d258595bc3af7"></a>
184<h2 class="memtitle"><span class="permalink"><a href="#a53bc9f544fe292cbbc2d258595bc3af7">&#9670;&nbsp;</a></span>ExecuteWorkloads()</h2>
185
186<div class="memitem">
187<div class="memproto">
188<table class="mlabels">
189 <tr>
190 <td class="mlabels-left">
191 <table class="memname">
192 <tr>
193 <td class="memname"><a class="el" href="classarmnn_1_1_i_execution_frame.html">IExecutionFrame</a> * ExecuteWorkloads </td>
194 <td>(</td>
195 <td class="paramtype"><a class="el" href="classarmnn_1_1_i_execution_frame.html">IExecutionFrame</a> *&#160;</td>
196 <td class="paramname"><em>previousFrame</em></td><td>)</td>
197 <td></td>
198 </tr>
199 </table>
200 </td>
201 <td class="mlabels-right">
202<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
203 </tr>
204</table>
205</div><div class="memdoc">
206
207<p>Implements <a class="el" href="classarmnn_1_1_i_execution_frame.html#a62a4e8e95f13a5b8fd62008423160362">IExecutionFrame</a>.</p>
208
209<p class="definition">Definition at line <a class="el" href="_execution_frame_8cpp_source.html#l00014">14</a> of file <a class="el" href="_execution_frame_8cpp_source.html">ExecutionFrame.cpp</a>.</p>
210<div class="fragment"><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;{</div>
211<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; <a class="code" href="namespacearmnn.html#a44affeeb090c3c6a3062830562672e84">IgnoreUnused</a>(previousFrame);</div>
212<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; <span class="keywordflow">for</span> (<span class="keyword">auto</span>&amp; workload: m_WorkloadQueue)</div>
213<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; {</div>
214<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; workload-&gt;Execute();</div>
215<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; }</div>
216<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; <span class="keywordflow">return</span> m_NextExecutionFrame;</div>
217<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;}</div>
218</div><!-- fragment -->
219<p class="reference">References <a class="el" href="_ignore_unused_8hpp_source.html#l00014">armnn::IgnoreUnused()</a>.</p>
220
221</div>
222</div>
223<a id="a81627f96ba06d76e147f7d392a8117ed"></a>
224<h2 class="memtitle"><span class="permalink"><a href="#a81627f96ba06d76e147f7d392a8117ed">&#9670;&nbsp;</a></span>PostAllocationConfigure()</h2>
225
226<div class="memitem">
227<div class="memproto">
228<table class="mlabels">
229 <tr>
230 <td class="mlabels-left">
231 <table class="memname">
232 <tr>
233 <td class="memname">void PostAllocationConfigure </td>
234 <td>(</td>
235 <td class="paramname"></td><td>)</td>
236 <td></td>
237 </tr>
238 </table>
239 </td>
240 <td class="mlabels-right">
241<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
242 </tr>
243</table>
244</div><div class="memdoc">
245
246<p>Reimplemented from <a class="el" href="classarmnn_1_1_i_execution_frame.html#ae8ab22492f0a5f78d5a2ab7e76486b5d">IExecutionFrame</a>.</p>
247
248<p class="definition">Definition at line <a class="el" href="_execution_frame_8cpp_source.html#l00024">24</a> of file <a class="el" href="_execution_frame_8cpp_source.html">ExecutionFrame.cpp</a>.</p>
249<div class="fragment"><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;{</div>
250<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; <span class="keywordflow">for</span> (<span class="keyword">auto</span>&amp;&amp; workloadPtr: m_WorkloadQueue)</div>
251<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; {</div>
252<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; workloadPtr.get()-&gt;PostAllocationConfigure();</div>
253<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; }</div>
254<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;}</div>
255</div><!-- fragment -->
256</div>
257</div>
258<a id="ab27ebaf88cafddc4a6ee001ec7316e73"></a>
259<h2 class="memtitle"><span class="permalink"><a href="#ab27ebaf88cafddc4a6ee001ec7316e73">&#9670;&nbsp;</a></span>RegisterDebugCallback()</h2>
260
261<div class="memitem">
262<div class="memproto">
263<table class="mlabels">
264 <tr>
265 <td class="mlabels-left">
266 <table class="memname">
267 <tr>
268 <td class="memname">void RegisterDebugCallback </td>
269 <td>(</td>
270 <td class="paramtype">const <a class="el" href="namespacearmnn.html#a15f3ad9b5e4e3d46b0a6dda246a7bc28">DebugCallbackFunction</a> &amp;&#160;</td>
271 <td class="paramname"><em>func</em></td><td>)</td>
272 <td></td>
273 </tr>
274 </table>
275 </td>
276 <td class="mlabels-right">
277<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
278 </tr>
279</table>
280</div><div class="memdoc">
281
282<p>Reimplemented from <a class="el" href="classarmnn_1_1_i_execution_frame.html#ab81312bd5e64cbae2803de9f243bdb32">IExecutionFrame</a>.</p>
283
284<p class="definition">Definition at line <a class="el" href="_execution_frame_8cpp_source.html#l00032">32</a> of file <a class="el" href="_execution_frame_8cpp_source.html">ExecutionFrame.cpp</a>.</p>
285<div class="fragment"><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;{</div>
286<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <span class="keywordflow">for</span> (<span class="keyword">auto</span>&amp;&amp; workloadPtr: m_WorkloadQueue)</div>
287<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; {</div>
288<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; workloadPtr.get()-&gt;RegisterDebugCallback(func);</div>
289<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; }</div>
290<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;}</div>
291</div><!-- fragment -->
292</div>
293</div>
294<a id="a695550617960685f2626ef23c30e2c9d"></a>
295<h2 class="memtitle"><span class="permalink"><a href="#a695550617960685f2626ef23c30e2c9d">&#9670;&nbsp;</a></span>SetNextExecutionFrame()</h2>
296
297<div class="memitem">
298<div class="memproto">
299 <table class="memname">
300 <tr>
301 <td class="memname">void SetNextExecutionFrame </td>
302 <td>(</td>
303 <td class="paramtype"><a class="el" href="classarmnn_1_1_i_execution_frame.html">IExecutionFrame</a> *&#160;</td>
304 <td class="paramname"><em>nextExecutionFrame</em></td><td>)</td>
305 <td></td>
306 </tr>
307 </table>
308</div><div class="memdoc">
309
310<p class="definition">Definition at line <a class="el" href="_execution_frame_8cpp_source.html#l00045">45</a> of file <a class="el" href="_execution_frame_8cpp_source.html">ExecutionFrame.cpp</a>.</p>
311<div class="fragment"><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;{</div>
312<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; m_NextExecutionFrame = nextExecutionFrame;</div>
313<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;}</div>
314</div><!-- fragment -->
315</div>
316</div>
317<hr/>The documentation for this class was generated from the following files:<ul>
318<li>src/armnn/<a class="el" href="_execution_frame_8hpp_source.html">ExecutionFrame.hpp</a></li>
319<li>src/armnn/<a class="el" href="_execution_frame_8cpp_source.html">ExecutionFrame.cpp</a></li>
320</ul>
321</div><!-- contents -->
322</div><!-- doc-content -->
323<div class="ttc" id="anamespacearmnn_html_a44affeeb090c3c6a3062830562672e84"><div class="ttname"><a href="namespacearmnn.html#a44affeeb090c3c6a3062830562672e84">armnn::IgnoreUnused</a></div><div class="ttdeci">void IgnoreUnused(Ts &amp;&amp;...)</div><div class="ttdef"><b>Definition:</b> <a href="_ignore_unused_8hpp_source.html#l00014">IgnoreUnused.hpp:14</a></div></div>
324<!-- start footer part -->
325<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
326 <ul>
327 <li class="navelem"><a class="el" href="namespacearmnn.html">armnn</a></li><li class="navelem"><a class="el" href="classarmnn_1_1_execution_frame.html">ExecutionFrame</a></li>
328 <li class="footer">Generated on Thu May 16 2024 09:31:56 for Arm NN by
329 <a href="http://www.doxygen.org/index.html">
330 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
331 </ul>
332</div>
333</body>
334</html>