blob: 0cacaa61b2357f010a921696156b13d5140216c7 [file] [log] [blame]
Nikhil Raj03c7ff32023-08-22 12:00:04 +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: IBackendContext 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">
Nikhil Raj1dc83fe2024-05-16 09:47:51 +010039 &#160;<span id="projectnumber">24.05</span>
Nikhil Raj03c7ff32023-08-22 12:00:04 +010040 </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_i_backend_context.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="#pro-methods">Protected Member Functions</a> &#124;
98<a href="classarmnn_1_1_i_backend_context-members.html">List of all members</a> </div>
99 <div class="headertitle">
100<div class="title">IBackendContext Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
101</div><!--header-->
102<div class="contents">
103
104<p><code>#include &lt;<a class="el" href="_i_backend_context_8hpp_source.html">IBackendContext.hpp</a>&gt;</code></p>
105<div class="dynheader">
106Inheritance diagram for IBackendContext:</div>
107<div class="dyncontent">
Nikhil Raj38b600d2024-02-15 15:02:19 +0000108<div class="center"><iframe scrolling="no" frameborder="0" src="classarmnn_1_1_i_backend_context__inherit__graph.svg" width="355" height="112"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
Nikhil Raj03c7ff32023-08-22 12:00:04 +0100109</div>
110<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
111<table class="memberdecls">
112<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
113Public Member Functions</h2></td></tr>
114<tr class="memitem:a713bc02a1dd5b8e9ef512a8d32d70b61"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_i_backend_context.html#a713bc02a1dd5b8e9ef512a8d32d70b61">BeforeLoadNetwork</a> (<a class="el" href="namespacearmnn.html#a0d8160388a127c1a23b37bc88dc6e2ec">NetworkId</a> networkId)=0</td></tr>
115<tr class="memdesc:a713bc02a1dd5b8e9ef512a8d32d70b61"><td class="mdescLeft">&#160;</td><td class="mdescRight">Before and after Load network events. <a href="classarmnn_1_1_i_backend_context.html#a713bc02a1dd5b8e9ef512a8d32d70b61">More...</a><br /></td></tr>
116<tr class="separator:a713bc02a1dd5b8e9ef512a8d32d70b61"><td class="memSeparator" colspan="2">&#160;</td></tr>
117<tr class="memitem:ac938e77cdaee5ad3b2ed5edb29e71ec4"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_i_backend_context.html#ac938e77cdaee5ad3b2ed5edb29e71ec4">AfterLoadNetwork</a> (<a class="el" href="namespacearmnn.html#a0d8160388a127c1a23b37bc88dc6e2ec">NetworkId</a> networkId)=0</td></tr>
118<tr class="separator:ac938e77cdaee5ad3b2ed5edb29e71ec4"><td class="memSeparator" colspan="2">&#160;</td></tr>
119<tr class="memitem:a8c6bb1875b98f745a05ca3881d3122d9"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_i_backend_context.html#a8c6bb1875b98f745a05ca3881d3122d9">BeforeUnloadNetwork</a> (<a class="el" href="namespacearmnn.html#a0d8160388a127c1a23b37bc88dc6e2ec">NetworkId</a> networkId)=0</td></tr>
120<tr class="memdesc:a8c6bb1875b98f745a05ca3881d3122d9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Before and after Unload network events. <a href="classarmnn_1_1_i_backend_context.html#a8c6bb1875b98f745a05ca3881d3122d9">More...</a><br /></td></tr>
121<tr class="separator:a8c6bb1875b98f745a05ca3881d3122d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
122<tr class="memitem:a9daa97deba9fecfe23bdd0b6ec387ceb"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_i_backend_context.html#a9daa97deba9fecfe23bdd0b6ec387ceb">AfterUnloadNetwork</a> (<a class="el" href="namespacearmnn.html#a0d8160388a127c1a23b37bc88dc6e2ec">NetworkId</a> networkId)=0</td></tr>
123<tr class="separator:a9daa97deba9fecfe23bdd0b6ec387ceb"><td class="memSeparator" colspan="2">&#160;</td></tr>
124<tr class="memitem:af9ea83aa9d06f0de13ea92693a9672fd"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_i_backend_context.html#af9ea83aa9d06f0de13ea92693a9672fd">AfterEnqueueWorkload</a> (<a class="el" href="namespacearmnn.html#a0d8160388a127c1a23b37bc88dc6e2ec">NetworkId</a> networkId)=0</td></tr>
125<tr class="separator:af9ea83aa9d06f0de13ea92693a9672fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
126<tr class="memitem:a13815a4455284ba43cae24ff99f6fc43"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_i_backend_context.html#a13815a4455284ba43cae24ff99f6fc43">~IBackendContext</a> ()</td></tr>
127<tr class="separator:a13815a4455284ba43cae24ff99f6fc43"><td class="memSeparator" colspan="2">&#160;</td></tr>
128</table><table class="memberdecls">
129<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
130Protected Member Functions</h2></td></tr>
131<tr class="memitem:a5d40cc5069980f1cd99780fdd6230cc8"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_i_backend_context.html#a5d40cc5069980f1cd99780fdd6230cc8">IBackendContext</a> (const <a class="el" href="structarmnn_1_1_i_runtime_1_1_creation_options.html">IRuntime::CreationOptions</a> &amp;)</td></tr>
132<tr class="separator:a5d40cc5069980f1cd99780fdd6230cc8"><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_backend_context_8hpp_source.html#l00014">14</a> of file <a class="el" href="_i_backend_context_8hpp_source.html">IBackendContext.hpp</a>.</p>
137</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
138<a id="a5d40cc5069980f1cd99780fdd6230cc8"></a>
139<h2 class="memtitle"><span class="permalink"><a href="#a5d40cc5069980f1cd99780fdd6230cc8">&#9670;&nbsp;</a></span>IBackendContext()</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"><a class="el" href="classarmnn_1_1_i_backend_context.html">IBackendContext</a> </td>
149 <td>(</td>
150 <td class="paramtype">const <a class="el" href="structarmnn_1_1_i_runtime_1_1_creation_options.html">IRuntime::CreationOptions</a> &amp;&#160;</td>
151 <td class="paramname"></td><td>)</td>
152 <td></td>
153 </tr>
154 </table>
155 </td>
156 <td class="mlabels-right">
157<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
158 </tr>
159</table>
160</div><div class="memdoc">
161
162<p class="definition">Definition at line <a class="el" href="_i_backend_context_8hpp_source.html#l00017">17</a> of file <a class="el" href="_i_backend_context_8hpp_source.html">IBackendContext.hpp</a>.</p>
163<div class="fragment"><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;{}</div>
164</div><!-- fragment -->
165</div>
166</div>
167<a id="a13815a4455284ba43cae24ff99f6fc43"></a>
168<h2 class="memtitle"><span class="permalink"><a href="#a13815a4455284ba43cae24ff99f6fc43">&#9670;&nbsp;</a></span>~IBackendContext()</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 ~<a class="el" href="classarmnn_1_1_i_backend_context.html">IBackendContext</a> </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">inline</span><span class="mlabel">virtual</span></span> </td>
186 </tr>
187</table>
188</div><div class="memdoc">
189
190<p class="definition">Definition at line <a class="el" href="_i_backend_context_8hpp_source.html#l00031">31</a> of file <a class="el" href="_i_backend_context_8hpp_source.html">IBackendContext.hpp</a>.</p>
191<div class="fragment"><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;{}</div>
192</div><!-- fragment -->
193</div>
194</div>
195<h2 class="groupheader">Member Function Documentation</h2>
196<a id="af9ea83aa9d06f0de13ea92693a9672fd"></a>
197<h2 class="memtitle"><span class="permalink"><a href="#af9ea83aa9d06f0de13ea92693a9672fd">&#9670;&nbsp;</a></span>AfterEnqueueWorkload()</h2>
198
199<div class="memitem">
200<div class="memproto">
201<table class="mlabels">
202 <tr>
203 <td class="mlabels-left">
204 <table class="memname">
205 <tr>
206 <td class="memname">virtual bool AfterEnqueueWorkload </td>
207 <td>(</td>
208 <td class="paramtype"><a class="el" href="namespacearmnn.html#a0d8160388a127c1a23b37bc88dc6e2ec">NetworkId</a>&#160;</td>
209 <td class="paramname"><em>networkId</em></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
Nikhil Raj38b600d2024-02-15 15:02:19 +0000220<p>Implemented in <a class="el" href="classarmnn_1_1_cl_backend_context.html#ad895de5df365dc112b9a796603bf7a27">ClBackendContext</a>, and <a class="el" href="classarmnn_1_1_gpu_fsa_backend_context.html#ad895de5df365dc112b9a796603bf7a27">GpuFsaBackendContext</a>.</p>
Nikhil Raj03c7ff32023-08-22 12:00:04 +0100221
222</div>
223</div>
224<a id="ac938e77cdaee5ad3b2ed5edb29e71ec4"></a>
225<h2 class="memtitle"><span class="permalink"><a href="#ac938e77cdaee5ad3b2ed5edb29e71ec4">&#9670;&nbsp;</a></span>AfterLoadNetwork()</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 bool AfterLoadNetwork </td>
235 <td>(</td>
236 <td class="paramtype"><a class="el" href="namespacearmnn.html#a0d8160388a127c1a23b37bc88dc6e2ec">NetworkId</a>&#160;</td>
237 <td class="paramname"><em>networkId</em></td><td>)</td>
238 <td></td>
239 </tr>
240 </table>
241 </td>
242 <td class="mlabels-right">
243<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
244 </tr>
245</table>
246</div><div class="memdoc">
247
Nikhil Raj38b600d2024-02-15 15:02:19 +0000248<p>Implemented in <a class="el" href="classarmnn_1_1_cl_backend_context.html#a8285e428113914dee00fb06ac0f3af1e">ClBackendContext</a>, and <a class="el" href="classarmnn_1_1_gpu_fsa_backend_context.html#a8285e428113914dee00fb06ac0f3af1e">GpuFsaBackendContext</a>.</p>
Nikhil Raj03c7ff32023-08-22 12:00:04 +0100249
250</div>
251</div>
252<a id="a9daa97deba9fecfe23bdd0b6ec387ceb"></a>
253<h2 class="memtitle"><span class="permalink"><a href="#a9daa97deba9fecfe23bdd0b6ec387ceb">&#9670;&nbsp;</a></span>AfterUnloadNetwork()</h2>
254
255<div class="memitem">
256<div class="memproto">
257<table class="mlabels">
258 <tr>
259 <td class="mlabels-left">
260 <table class="memname">
261 <tr>
262 <td class="memname">virtual bool AfterUnloadNetwork </td>
263 <td>(</td>
264 <td class="paramtype"><a class="el" href="namespacearmnn.html#a0d8160388a127c1a23b37bc88dc6e2ec">NetworkId</a>&#160;</td>
265 <td class="paramname"><em>networkId</em></td><td>)</td>
266 <td></td>
267 </tr>
268 </table>
269 </td>
270 <td class="mlabels-right">
271<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
272 </tr>
273</table>
274</div><div class="memdoc">
275
Nikhil Raj38b600d2024-02-15 15:02:19 +0000276<p>Implemented in <a class="el" href="classarmnn_1_1_cl_backend_context.html#a16900a3d8c0121a45ceb870f1815bc4d">ClBackendContext</a>, and <a class="el" href="classarmnn_1_1_gpu_fsa_backend_context.html#a16900a3d8c0121a45ceb870f1815bc4d">GpuFsaBackendContext</a>.</p>
Nikhil Raj03c7ff32023-08-22 12:00:04 +0100277
278</div>
279</div>
280<a id="a713bc02a1dd5b8e9ef512a8d32d70b61"></a>
281<h2 class="memtitle"><span class="permalink"><a href="#a713bc02a1dd5b8e9ef512a8d32d70b61">&#9670;&nbsp;</a></span>BeforeLoadNetwork()</h2>
282
283<div class="memitem">
284<div class="memproto">
285<table class="mlabels">
286 <tr>
287 <td class="mlabels-left">
288 <table class="memname">
289 <tr>
290 <td class="memname">virtual bool BeforeLoadNetwork </td>
291 <td>(</td>
292 <td class="paramtype"><a class="el" href="namespacearmnn.html#a0d8160388a127c1a23b37bc88dc6e2ec">NetworkId</a>&#160;</td>
293 <td class="paramname"><em>networkId</em></td><td>)</td>
294 <td></td>
295 </tr>
296 </table>
297 </td>
298 <td class="mlabels-right">
299<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
300 </tr>
301</table>
302</div><div class="memdoc">
303
304<p>Before and after Load network events. </p>
305
Nikhil Raj38b600d2024-02-15 15:02:19 +0000306<p>Implemented in <a class="el" href="classarmnn_1_1_cl_backend_context.html#ae8b132bb727f3594b8613a66096fbd99">ClBackendContext</a>, and <a class="el" href="classarmnn_1_1_gpu_fsa_backend_context.html#ae8b132bb727f3594b8613a66096fbd99">GpuFsaBackendContext</a>.</p>
Nikhil Raj03c7ff32023-08-22 12:00:04 +0100307
308</div>
309</div>
310<a id="a8c6bb1875b98f745a05ca3881d3122d9"></a>
311<h2 class="memtitle"><span class="permalink"><a href="#a8c6bb1875b98f745a05ca3881d3122d9">&#9670;&nbsp;</a></span>BeforeUnloadNetwork()</h2>
312
313<div class="memitem">
314<div class="memproto">
315<table class="mlabels">
316 <tr>
317 <td class="mlabels-left">
318 <table class="memname">
319 <tr>
320 <td class="memname">virtual bool BeforeUnloadNetwork </td>
321 <td>(</td>
322 <td class="paramtype"><a class="el" href="namespacearmnn.html#a0d8160388a127c1a23b37bc88dc6e2ec">NetworkId</a>&#160;</td>
323 <td class="paramname"><em>networkId</em></td><td>)</td>
324 <td></td>
325 </tr>
326 </table>
327 </td>
328 <td class="mlabels-right">
329<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
330 </tr>
331</table>
332</div><div class="memdoc">
333
334<p>Before and after Unload network events. </p>
335
Nikhil Raj38b600d2024-02-15 15:02:19 +0000336<p>Implemented in <a class="el" href="classarmnn_1_1_cl_backend_context.html#acb272e49e9da9835827451184feee061">ClBackendContext</a>, and <a class="el" href="classarmnn_1_1_gpu_fsa_backend_context.html#acb272e49e9da9835827451184feee061">GpuFsaBackendContext</a>.</p>
Nikhil Raj03c7ff32023-08-22 12:00:04 +0100337
338</div>
339</div>
340<hr/>The documentation for this class was generated from the following file:<ul>
341<li>include/armnn/backends/<a class="el" href="_i_backend_context_8hpp_source.html">IBackendContext.hpp</a></li>
342</ul>
343</div><!-- contents -->
344</div><!-- doc-content -->
345<!-- start footer part -->
346<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
347 <ul>
348 <li class="navelem"><a class="el" href="namespacearmnn.html">armnn</a></li><li class="navelem"><a class="el" href="classarmnn_1_1_i_backend_context.html">IBackendContext</a></li>
Nikhil Raj1dc83fe2024-05-16 09:47:51 +0100349 <li class="footer">Generated on Thu May 16 2024 09:31:56 for Arm NN by
Nikhil Raj03c7ff32023-08-22 12:00:04 +0100350 <a href="http://www.doxygen.org/index.html">
351 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
352 </ul>
353</div>
354</body>
355</html>