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