blob: bf5e5a4bd2145eca3da4e49a653ff31f2eb5cdf1 [file] [log] [blame]
Nikhil Raj1dc83fe2024-05-16 09:47:51 +01001<!-- 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: IWorkingMemHandle 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_1experimental_1_1_i_working_mem_handle.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_1experimental_1_1_i_working_mem_handle-members.html">List of all members</a> </div>
98 <div class="headertitle">
99<div class="title">IWorkingMemHandle Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
100</div><!--header-->
101<div class="contents">
102
103<p><code>#include &lt;<a class="el" href="_i_working_mem_handle_8hpp_source.html">IWorkingMemHandle.hpp</a>&gt;</code></p>
104<div class="dynheader">
105Inheritance diagram for IWorkingMemHandle:</div>
106<div class="dyncontent">
107<div class="center"><iframe scrolling="no" frameborder="0" src="classarmnn_1_1experimental_1_1_i_working_mem_handle__inherit__graph.svg" width="170" 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<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:aee41760526014b30f5daa1177357eb0d"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1experimental_1_1_i_working_mem_handle.html#aee41760526014b30f5daa1177357eb0d">~IWorkingMemHandle</a> ()</td></tr>
114<tr class="separator:aee41760526014b30f5daa1177357eb0d"><td class="memSeparator" colspan="2">&#160;</td></tr>
115<tr class="memitem:abd6c4b9a4ef8432f47d0df514cd4a014"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespacearmnn.html#a0d8160388a127c1a23b37bc88dc6e2ec">NetworkId</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1experimental_1_1_i_working_mem_handle.html#abd6c4b9a4ef8432f47d0df514cd4a014">GetNetworkId</a> ()=0</td></tr>
116<tr class="memdesc:abd6c4b9a4ef8432f47d0df514cd4a014"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the NetworkId of the Network that this <a class="el" href="classarmnn_1_1experimental_1_1_i_working_mem_handle.html">IWorkingMemHandle</a> works with. <a href="classarmnn_1_1experimental_1_1_i_working_mem_handle.html#abd6c4b9a4ef8432f47d0df514cd4a014">More...</a><br /></td></tr>
117<tr class="separator:abd6c4b9a4ef8432f47d0df514cd4a014"><td class="memSeparator" colspan="2">&#160;</td></tr>
118<tr class="memitem:a5cceed8b707a09bf27eb61f17acf8a88"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1experimental_1_1_i_working_mem_handle.html#a5cceed8b707a09bf27eb61f17acf8a88">Allocate</a> ()=0</td></tr>
119<tr class="memdesc:a5cceed8b707a09bf27eb61f17acf8a88"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allocate the backing memory required for execution. <a href="classarmnn_1_1experimental_1_1_i_working_mem_handle.html#a5cceed8b707a09bf27eb61f17acf8a88">More...</a><br /></td></tr>
120<tr class="separator:a5cceed8b707a09bf27eb61f17acf8a88"><td class="memSeparator" colspan="2">&#160;</td></tr>
121<tr class="memitem:a49db2bfde3ca4fac7d1042a3aa5778aa"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1experimental_1_1_i_working_mem_handle.html#a49db2bfde3ca4fac7d1042a3aa5778aa">Free</a> ()=0</td></tr>
122<tr class="memdesc:a49db2bfde3ca4fac7d1042a3aa5778aa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Free the backing memory required for execution. <a href="classarmnn_1_1experimental_1_1_i_working_mem_handle.html#a49db2bfde3ca4fac7d1042a3aa5778aa">More...</a><br /></td></tr>
123<tr class="separator:a49db2bfde3ca4fac7d1042a3aa5778aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
124<tr class="memitem:a7dc65e81254ebe49a20d5d420fb4f47f"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1experimental_1_1_i_working_mem_handle.html#a7dc65e81254ebe49a20d5d420fb4f47f">IsAllocated</a> ()=0</td></tr>
125<tr class="memdesc:a7dc65e81254ebe49a20d5d420fb4f47f"><td class="mdescLeft">&#160;</td><td class="mdescRight">IsAllocated returns true if the backing memory is currently allocated. <a href="classarmnn_1_1experimental_1_1_i_working_mem_handle.html#a7dc65e81254ebe49a20d5d420fb4f47f">More...</a><br /></td></tr>
126<tr class="separator:a7dc65e81254ebe49a20d5d420fb4f47f"><td class="memSeparator" colspan="2">&#160;</td></tr>
127<tr class="memitem:a43a1da35a1d1d6f78f656717736ad99c"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="structarmnn_1_1experimental_1_1_working_mem_descriptor.html">WorkingMemDescriptor</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1experimental_1_1_i_working_mem_handle.html#a43a1da35a1d1d6f78f656717736ad99c">GetWorkingMemDescriptorAt</a> (unsigned int id)=0</td></tr>
128<tr class="memdesc:a43a1da35a1d1d6f78f656717736ad99c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the <a class="el" href="structarmnn_1_1experimental_1_1_working_mem_descriptor.html">WorkingMemDescriptor</a> at an index. <a href="classarmnn_1_1experimental_1_1_i_working_mem_handle.html#a43a1da35a1d1d6f78f656717736ad99c">More...</a><br /></td></tr>
129<tr class="separator:a43a1da35a1d1d6f78f656717736ad99c"><td class="memSeparator" colspan="2">&#160;</td></tr>
130<tr class="memitem:a9ca04afc5cf914f2356d31062c7c26a7"><td class="memItemLeft" align="right" valign="top">virtual std::pair&lt; <a class="el" href="classarmnn_1_1_backend_id.html">BackendId</a>, <a class="el" href="structarmnn_1_1experimental_1_1_execution_data.html">ExecutionData</a> &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1experimental_1_1_i_working_mem_handle.html#a9ca04afc5cf914f2356d31062c7c26a7">GetExecutionDataAt</a> (unsigned int id)=0</td></tr>
131<tr class="memdesc:a9ca04afc5cf914f2356d31062c7c26a7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the <a class="el" href="structarmnn_1_1experimental_1_1_execution_data.html">ExecutionData</a> at an index. <a href="classarmnn_1_1experimental_1_1_i_working_mem_handle.html#a9ca04afc5cf914f2356d31062c7c26a7">More...</a><br /></td></tr>
132<tr class="separator:a9ca04afc5cf914f2356d31062c7c26a7"><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="_i_working_mem_handle_8hpp_source.html#l00020">20</a> of file <a class="el" href="_i_working_mem_handle_8hpp_source.html">IWorkingMemHandle.hpp</a>.</p>
137</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
138<a id="aee41760526014b30f5daa1177357eb0d"></a>
139<h2 class="memtitle"><span class="permalink"><a href="#aee41760526014b30f5daa1177357eb0d">&#9670;&nbsp;</a></span>~IWorkingMemHandle()</h2>
140
141<div class="memitem">
142<div class="memproto">
143<table class="mlabels">
144 <tr>
145 <td class="mlabels-left">
146 <table class="memname">
147 <tr>
148 <td class="memname">virtual ~<a class="el" href="classarmnn_1_1experimental_1_1_i_working_mem_handle.html">IWorkingMemHandle</a> </td>
149 <td>(</td>
150 <td class="paramname"></td><td>)</td>
151 <td></td>
152 </tr>
153 </table>
154 </td>
155 <td class="mlabels-right">
156<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
157 </tr>
158</table>
159</div><div class="memdoc">
160
161<p class="definition">Definition at line <a class="el" href="_i_working_mem_handle_8hpp_source.html#l00023">23</a> of file <a class="el" href="_i_working_mem_handle_8hpp_source.html">IWorkingMemHandle.hpp</a>.</p>
162<div class="fragment"><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;{};</div>
163</div><!-- fragment -->
164</div>
165</div>
166<h2 class="groupheader">Member Function Documentation</h2>
167<a id="a5cceed8b707a09bf27eb61f17acf8a88"></a>
168<h2 class="memtitle"><span class="permalink"><a href="#a5cceed8b707a09bf27eb61f17acf8a88">&#9670;&nbsp;</a></span>Allocate()</h2>
169
170<div class="memitem">
171<div class="memproto">
172<table class="mlabels">
173 <tr>
174 <td class="mlabels-left">
175 <table class="memname">
176 <tr>
177 <td class="memname">virtual void Allocate </td>
178 <td>(</td>
179 <td class="paramname"></td><td>)</td>
180 <td></td>
181 </tr>
182 </table>
183 </td>
184 <td class="mlabels-right">
185<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
186 </tr>
187</table>
188</div><div class="memdoc">
189
190<p>Allocate the backing memory required for execution. </p>
191<p>If this is not called, then allocation will be deferred to execution time. </p>
192
193<p>Implemented in <a class="el" href="classarmnn_1_1experimental_1_1_working_mem_handle.html#a8518772c5d692e334a76617582b10b92">WorkingMemHandle</a>.</p>
194
195</div>
196</div>
197<a id="a49db2bfde3ca4fac7d1042a3aa5778aa"></a>
198<h2 class="memtitle"><span class="permalink"><a href="#a49db2bfde3ca4fac7d1042a3aa5778aa">&#9670;&nbsp;</a></span>Free()</h2>
199
200<div class="memitem">
201<div class="memproto">
202<table class="mlabels">
203 <tr>
204 <td class="mlabels-left">
205 <table class="memname">
206 <tr>
207 <td class="memname">virtual void Free </td>
208 <td>(</td>
209 <td class="paramname"></td><td>)</td>
210 <td></td>
211 </tr>
212 </table>
213 </td>
214 <td class="mlabels-right">
215<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
216 </tr>
217</table>
218</div><div class="memdoc">
219
220<p>Free the backing memory required for execution. </p>
221
222<p>Implemented in <a class="el" href="classarmnn_1_1experimental_1_1_working_mem_handle.html#a2688c89e6bdec61e0f483d9be6fd688c">WorkingMemHandle</a>.</p>
223
224</div>
225</div>
226<a id="a9ca04afc5cf914f2356d31062c7c26a7"></a>
227<h2 class="memtitle"><span class="permalink"><a href="#a9ca04afc5cf914f2356d31062c7c26a7">&#9670;&nbsp;</a></span>GetExecutionDataAt()</h2>
228
229<div class="memitem">
230<div class="memproto">
231<table class="mlabels">
232 <tr>
233 <td class="mlabels-left">
234 <table class="memname">
235 <tr>
236 <td class="memname">virtual std::pair&lt;<a class="el" href="classarmnn_1_1_backend_id.html">BackendId</a>, <a class="el" href="structarmnn_1_1experimental_1_1_execution_data.html">ExecutionData</a>&gt;&amp; GetExecutionDataAt </td>
237 <td>(</td>
238 <td class="paramtype">unsigned int&#160;</td>
239 <td class="paramname"><em>id</em></td><td>)</td>
240 <td></td>
241 </tr>
242 </table>
243 </td>
244 <td class="mlabels-right">
245<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
246 </tr>
247</table>
248</div><div class="memdoc">
249
250<p>Get the <a class="el" href="structarmnn_1_1experimental_1_1_execution_data.html">ExecutionData</a> at an index. </p>
251<p>The <a class="el" href="structarmnn_1_1experimental_1_1_execution_data.html">ExecutionData</a> is paired with a <a class="el" href="classarmnn_1_1_backend_id.html">BackendId</a> to be able to call backend specific functions upon it. The <a class="el" href="structarmnn_1_1experimental_1_1_execution_data.html">ExecutionData</a> are stored in the same order as the Workloads in a topologically sorted graph. </p>
252
253<p>Implemented in <a class="el" href="classarmnn_1_1experimental_1_1_working_mem_handle.html#ab522849a917e9095c462e5e5980316be">WorkingMemHandle</a>.</p>
254
255</div>
256</div>
257<a id="abd6c4b9a4ef8432f47d0df514cd4a014"></a>
258<h2 class="memtitle"><span class="permalink"><a href="#abd6c4b9a4ef8432f47d0df514cd4a014">&#9670;&nbsp;</a></span>GetNetworkId()</h2>
259
260<div class="memitem">
261<div class="memproto">
262<table class="mlabels">
263 <tr>
264 <td class="mlabels-left">
265 <table class="memname">
266 <tr>
267 <td class="memname">virtual <a class="el" href="namespacearmnn.html#a0d8160388a127c1a23b37bc88dc6e2ec">NetworkId</a> GetNetworkId </td>
268 <td>(</td>
269 <td class="paramname"></td><td>)</td>
270 <td></td>
271 </tr>
272 </table>
273 </td>
274 <td class="mlabels-right">
275<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
276 </tr>
277</table>
278</div><div class="memdoc">
279
280<p>Returns the NetworkId of the Network that this <a class="el" href="classarmnn_1_1experimental_1_1_i_working_mem_handle.html">IWorkingMemHandle</a> works with. </p>
281
282<p>Implemented in <a class="el" href="classarmnn_1_1experimental_1_1_working_mem_handle.html#a6d485a38c5d662a4aa9471587b4688bb">WorkingMemHandle</a>.</p>
283
284<p class="reference">Referenced by <a class="el" href="_runtime_8cpp_source.html#l00699">RuntimeImpl::Execute()</a>.</p>
285
286</div>
287</div>
288<a id="a43a1da35a1d1d6f78f656717736ad99c"></a>
289<h2 class="memtitle"><span class="permalink"><a href="#a43a1da35a1d1d6f78f656717736ad99c">&#9670;&nbsp;</a></span>GetWorkingMemDescriptorAt()</h2>
290
291<div class="memitem">
292<div class="memproto">
293<table class="mlabels">
294 <tr>
295 <td class="mlabels-left">
296 <table class="memname">
297 <tr>
298 <td class="memname">virtual <a class="el" href="structarmnn_1_1experimental_1_1_working_mem_descriptor.html">WorkingMemDescriptor</a>&amp; GetWorkingMemDescriptorAt </td>
299 <td>(</td>
300 <td class="paramtype">unsigned int&#160;</td>
301 <td class="paramname"><em>id</em></td><td>)</td>
302 <td></td>
303 </tr>
304 </table>
305 </td>
306 <td class="mlabels-right">
307<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
308 </tr>
309</table>
310</div><div class="memdoc">
311
312<p>Get the <a class="el" href="structarmnn_1_1experimental_1_1_working_mem_descriptor.html">WorkingMemDescriptor</a> at an index. </p>
313<p>The WorkingMemDescriptors are stored in the same order as the Workloads in a topologically sorted graph. </p>
314
315<p>Implemented in <a class="el" href="classarmnn_1_1experimental_1_1_working_mem_handle.html#a1915a1eb2ba2554103a09de391a9f6bd">WorkingMemHandle</a>.</p>
316
317</div>
318</div>
319<a id="a7dc65e81254ebe49a20d5d420fb4f47f"></a>
320<h2 class="memtitle"><span class="permalink"><a href="#a7dc65e81254ebe49a20d5d420fb4f47f">&#9670;&nbsp;</a></span>IsAllocated()</h2>
321
322<div class="memitem">
323<div class="memproto">
324<table class="mlabels">
325 <tr>
326 <td class="mlabels-left">
327 <table class="memname">
328 <tr>
329 <td class="memname">virtual bool IsAllocated </td>
330 <td>(</td>
331 <td class="paramname"></td><td>)</td>
332 <td></td>
333 </tr>
334 </table>
335 </td>
336 <td class="mlabels-right">
337<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
338 </tr>
339</table>
340</div><div class="memdoc">
341
342<p>IsAllocated returns true if the backing memory is currently allocated. </p>
343
344<p>Implemented in <a class="el" href="classarmnn_1_1experimental_1_1_working_mem_handle.html#a1a573373f4505385578f830caebf6adb">WorkingMemHandle</a>.</p>
345
346</div>
347</div>
348<hr/>The documentation for this class was generated from the following file:<ul>
349<li>include/armnn/<a class="el" href="_i_working_mem_handle_8hpp_source.html">IWorkingMemHandle.hpp</a></li>
350</ul>
351</div><!-- contents -->
352</div><!-- doc-content -->
353<!-- start footer part -->
354<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
355 <ul>
356 <li class="navelem"><a class="el" href="namespacearmnn.html">armnn</a></li><li class="navelem"><a class="el" href="namespacearmnn_1_1experimental.html">experimental</a></li><li class="navelem"><a class="el" href="classarmnn_1_1experimental_1_1_i_working_mem_handle.html">IWorkingMemHandle</a></li>
357 <li class="footer">Generated on Thu May 16 2024 09:32:00 for Arm NN by
358 <a href="http://www.doxygen.org/index.html">
359 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
360 </ul>
361</div>
362</body>
363</html>