Gitiles
Code Review Sign In
review.mlplatform.org / ml / armnn / bca73e1c82438f160364a113793d0a2195c665ac / . / Documentation / classarmnn_1_1_i_execution_frame.xhtml
blob: 0f21a6e3397d8269c1b742f7119027d46755e9dc [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: IExecutionFrame 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_i_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_i_execution_frame-members.xhtml">List of all members</a> </div>
100 <div class="headertitle">
101<div class="title">IExecutionFrame Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
102</div><!--header-->
103<div class="contents">
104
105<p><a class="el" href="classarmnn_1_1_execution_frame.xhtml">ExecutionFrame</a> interface to enqueue a workload computation.
106 <a href="classarmnn_1_1_i_execution_frame.xhtml#details">More...</a></p>
107
108<p><code>#include &lt;<a class="el" href="_execution_frame_8hpp_source.xhtml">ExecutionFrame.hpp</a>&gt;</code></p>
109<div class="dynheader">
110Inheritance diagram for IExecutionFrame:</div>
111<div class="dyncontent">
112 <div class="center">
113 <img src="classarmnn_1_1_i_execution_frame.png" usemap="#IExecutionFrame_map" alt=""/>
114 <map id="IExecutionFrame_map" name="IExecutionFrame_map">
115<area href="classarmnn_1_1_execution_frame.xhtml" alt="ExecutionFrame" shape="rect" coords="0,56,106,80"/>
116</map>
117 </div></div>
118<table class="memberdecls">
119<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
120Public Member Functions</h2></td></tr>
121<tr class="memitem:a1ca0125ac3082676dae03050a52e6068"><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>
122<tr class="separator:a1ca0125ac3082676dae03050a52e6068"><td class="memSeparator" colspan="2">&#160;</td></tr>
123<tr class="memitem:a62a4e8e95f13a5b8fd62008423160362"><td class="memItemLeft" align="right" valign="top">virtual <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_i_execution_frame.xhtml#a62a4e8e95f13a5b8fd62008423160362">ExecuteWorkloads</a> (<a class="el" href="classarmnn_1_1_i_execution_frame.xhtml">IExecutionFrame</a> *previousFrame)=0</td></tr>
124<tr class="separator:a62a4e8e95f13a5b8fd62008423160362"><td class="memSeparator" colspan="2">&#160;</td></tr>
125<tr class="memitem:ae8ab22492f0a5f78d5a2ab7e76486b5d"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_i_execution_frame.xhtml#ae8ab22492f0a5f78d5a2ab7e76486b5d">PostAllocationConfigure</a> ()</td></tr>
126<tr class="separator:ae8ab22492f0a5f78d5a2ab7e76486b5d"><td class="memSeparator" colspan="2">&#160;</td></tr>
127<tr class="memitem:ab81312bd5e64cbae2803de9f243bdb32"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_i_execution_frame.xhtml#ab81312bd5e64cbae2803de9f243bdb32">RegisterDebugCallback</a> (const <a class="el" href="namespacearmnn.xhtml#a15f3ad9b5e4e3d46b0a6dda246a7bc28">DebugCallbackFunction</a> &amp;)</td></tr>
128<tr class="separator:ab81312bd5e64cbae2803de9f243bdb32"><td class="memSeparator" colspan="2">&#160;</td></tr>
129</table>
130<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
131<div class="textblock"><p><a class="el" href="classarmnn_1_1_execution_frame.xhtml">ExecutionFrame</a> interface to enqueue a workload computation. </p>
132
133<p class="definition">Definition at line <a class="el" href="_execution_frame_8hpp_source.xhtml#l00016">16</a> of file <a class="el" href="_execution_frame_8hpp_source.xhtml">ExecutionFrame.hpp</a>.</p>
134</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
135<a id="a1ca0125ac3082676dae03050a52e6068"></a>
136<h2 class="memtitle"><span class="permalink"><a href="#a1ca0125ac3082676dae03050a52e6068">&#9670;&nbsp;</a></span>~IExecutionFrame()</h2>
137
138<div class="memitem">
139<div class="memproto">
140<table class="mlabels">
141 <tr>
142 <td class="mlabels-left">
143 <table class="memname">
144 <tr>
145 <td class="memname">virtual ~<a class="el" href="classarmnn_1_1_i_execution_frame.xhtml">IExecutionFrame</a> </td>
146 <td>(</td>
147 <td class="paramname"></td><td>)</td>
148 <td></td>
149 </tr>
150 </table>
151 </td>
152 <td class="mlabels-right">
153<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
154 </tr>
155</table>
156</div><div class="memdoc">
157
158<p class="definition">Definition at line <a class="el" href="_execution_frame_8hpp_source.xhtml#l00020">20</a> of file <a class="el" href="_execution_frame_8hpp_source.xhtml">ExecutionFrame.hpp</a>.</p>
159
160<p class="reference">References <a class="el" href="classarmnn_1_1_i_execution_frame.xhtml#a62a4e8e95f13a5b8fd62008423160362">IExecutionFrame::ExecuteWorkloads()</a>.</p>
161<div class="fragment"><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;{}</div></div><!-- fragment -->
162</div>
163</div>
164<h2 class="groupheader">Member Function Documentation</h2>
165<a id="a62a4e8e95f13a5b8fd62008423160362"></a>
166<h2 class="memtitle"><span class="permalink"><a href="#a62a4e8e95f13a5b8fd62008423160362">&#9670;&nbsp;</a></span>ExecuteWorkloads()</h2>
167
168<div class="memitem">
169<div class="memproto">
170<table class="mlabels">
171 <tr>
172 <td class="mlabels-left">
173 <table class="memname">
174 <tr>
175 <td class="memname">virtual <a class="el" href="classarmnn_1_1_i_execution_frame.xhtml">IExecutionFrame</a>* ExecuteWorkloads </td>
176 <td>(</td>
177 <td class="paramtype"><a class="el" href="classarmnn_1_1_i_execution_frame.xhtml">IExecutionFrame</a> *&#160;</td>
178 <td class="paramname"><em>previousFrame</em></td><td>)</td>
179 <td></td>
180 </tr>
181 </table>
182 </td>
183 <td class="mlabels-right">
184<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
185 </tr>
186</table>
187</div><div class="memdoc">
188
189<p>Implemented in <a class="el" href="classarmnn_1_1_execution_frame.xhtml#a53bc9f544fe292cbbc2d258595bc3af7">ExecutionFrame</a>.</p>
190
191<p class="reference">Referenced by <a class="el" href="_execution_frame_8hpp_source.xhtml#l00020">IExecutionFrame::~IExecutionFrame()</a>.</p>
192
193</div>
194</div>
195<a id="ae8ab22492f0a5f78d5a2ab7e76486b5d"></a>
196<h2 class="memtitle"><span class="permalink"><a href="#ae8ab22492f0a5f78d5a2ab7e76486b5d">&#9670;&nbsp;</a></span>PostAllocationConfigure()</h2>
197
198<div class="memitem">
199<div class="memproto">
200<table class="mlabels">
201 <tr>
202 <td class="mlabels-left">
203 <table class="memname">
204 <tr>
205 <td class="memname">virtual void PostAllocationConfigure </td>
206 <td>(</td>
207 <td class="paramname"></td><td>)</td>
208 <td></td>
209 </tr>
210 </table>
211 </td>
212 <td class="mlabels-right">
213<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
214 </tr>
215</table>
216</div><div class="memdoc">
217
218<p>Reimplemented in <a class="el" href="classarmnn_1_1_execution_frame.xhtml#a81627f96ba06d76e147f7d392a8117ed">ExecutionFrame</a>.</p>
219
220<p class="definition">Definition at line <a class="el" href="_execution_frame_8hpp_source.xhtml#l00023">23</a> of file <a class="el" href="_execution_frame_8hpp_source.xhtml">ExecutionFrame.hpp</a>.</p>
221<div class="fragment"><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;{};</div></div><!-- fragment -->
222</div>
223</div>
224<a id="ab81312bd5e64cbae2803de9f243bdb32"></a>
225<h2 class="memtitle"><span class="permalink"><a href="#ab81312bd5e64cbae2803de9f243bdb32">&#9670;&nbsp;</a></span>RegisterDebugCallback()</h2>
226
227<div class="memitem">
228<div class="memproto">
229<table class="mlabels">
230 <tr>
231 <td class="mlabels-left">
232 <table class="memname">
233 <tr>
234 <td class="memname">virtual void RegisterDebugCallback </td>
235 <td>(</td>
236 <td class="paramtype">const <a class="el" href="namespacearmnn.xhtml#a15f3ad9b5e4e3d46b0a6dda246a7bc28">DebugCallbackFunction</a> &amp;&#160;</td>
237 <td class="paramname"></td><td>)</td>
238 <td></td>
239 </tr>
240 </table>
241 </td>
242 <td class="mlabels-right">
243<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
244 </tr>
245</table>
246</div><div class="memdoc">
247
248<p>Reimplemented in <a class="el" href="classarmnn_1_1_execution_frame.xhtml#ab27ebaf88cafddc4a6ee001ec7316e73">ExecutionFrame</a>.</p>
249
250<p class="definition">Definition at line <a class="el" href="_execution_frame_8hpp_source.xhtml#l00024">24</a> of file <a class="el" href="_execution_frame_8hpp_source.xhtml">ExecutionFrame.hpp</a>.</p>
251<div class="fragment"><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;{};</div></div><!-- fragment -->
252</div>
253</div>
254<hr/>The documentation for this class was generated from the following file:<ul>
255<li>src/armnn/<a class="el" href="_execution_frame_8hpp_source.xhtml">ExecutionFrame.hpp</a></li>
256</ul>
257</div><!-- contents -->
258</div><!-- doc-content -->
259<!-- start footer part -->
260<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
261 <ul>
262 <li class="navelem"><a class="el" href="namespacearmnn.xhtml">armnn</a></li><li class="navelem"><a class="el" href="classarmnn_1_1_i_execution_frame.xhtml">IExecutionFrame</a></li>
263 <li class="footer">Generated on Fri Mar 13 2020 16:09:18 for ArmNN by
264 <a href="http://www.doxygen.org/index.html">
265 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
266 </ul>
267</div>
268</body>
269</html>