blob: c327c06b026f78830b60fedf368f640c545fcb3e [file] [log] [blame]
Nikhil Raj8d2ca732023-02-24 10:28:19 +00001<!-- 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: IBackend 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">23.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_backend.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="#pro-methods">Protected Member Functions</a> &#124;
100<a href="classarmnn_1_1_i_backend-members.xhtml">List of all members</a> </div>
101 <div class="headertitle">
102<div class="title">IBackend Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
103</div><!--header-->
104<div class="contents">
105
106<p>Each backend should implement an <a class="el" href="classarmnn_1_1_i_backend.xhtml" title="Each backend should implement an IBackend. ">IBackend</a>.
107 <a href="classarmnn_1_1_i_backend.xhtml#details">More...</a></p>
108
109<p><code>#include &lt;<a class="el" href="_types_8hpp_source.xhtml">Types.hpp</a>&gt;</code></p>
110<div class="dynheader">
111Inheritance diagram for IBackend:</div>
112<div class="dyncontent">
113 <div class="center">
114 <img src="classarmnn_1_1_i_backend.png" usemap="#IBackend_map" alt=""/>
115 <map id="IBackend_map" name="IBackend_map">
116<area href="classarmnn_1_1_i_backend_internal.xhtml" alt="IBackendInternal" shape="rect" coords="175,56,282,80"/>
117<area href="classarmnn_1_1_cl_backend.xhtml" alt="ClBackend" shape="rect" coords="0,112,107,136"/>
118<area href="classarmnn_1_1_neon_backend.xhtml" alt="NeonBackend" shape="rect" coords="117,112,224,136"/>
119<area href="classarmnn_1_1_ref_backend.xhtml" alt="RefBackend" shape="rect" coords="234,112,341,136"/>
120<area href="classarmnn_1_1_tosa_ref_backend.xhtml" alt="TosaRefBackend" shape="rect" coords="351,112,458,136"/>
121</map>
122 </div></div>
123<table class="memberdecls">
124<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
125Public Member Functions</h2></td></tr>
126<tr class="memitem:aa9fc23b7155bd678232eeb351059b748"><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="classarmnn_1_1_backend_id.xhtml">BackendId</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_i_backend.xhtml#aa9fc23b7155bd678232eeb351059b748">GetId</a> () const =0</td></tr>
127<tr class="separator:aa9fc23b7155bd678232eeb351059b748"><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:a7cfc55eae265fa65b7d25e7dd3203f22"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_i_backend.xhtml#a7cfc55eae265fa65b7d25e7dd3203f22">IBackend</a> ()</td></tr>
132<tr class="separator:a7cfc55eae265fa65b7d25e7dd3203f22"><td class="memSeparator" colspan="2">&#160;</td></tr>
133<tr class="memitem:aa73289e0503a4f7ec5909e117a57aa2b"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_i_backend.xhtml#aa73289e0503a4f7ec5909e117a57aa2b">~IBackend</a> ()</td></tr>
134<tr class="separator:aa73289e0503a4f7ec5909e117a57aa2b"><td class="memSeparator" colspan="2">&#160;</td></tr>
135</table>
136<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
137<div class="textblock"><p>Each backend should implement an <a class="el" href="classarmnn_1_1_i_backend.xhtml" title="Each backend should implement an IBackend. ">IBackend</a>. </p>
138
139<p class="definition">Definition at line <a class="el" href="_types_8hpp_source.xhtml#l00253">253</a> of file <a class="el" href="_types_8hpp_source.xhtml">Types.hpp</a>.</p>
140</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
141<a id="a7cfc55eae265fa65b7d25e7dd3203f22"></a>
142<h2 class="memtitle"><span class="permalink"><a href="#a7cfc55eae265fa65b7d25e7dd3203f22">&#9670;&nbsp;</a></span>IBackend()</h2>
143
144<div class="memitem">
145<div class="memproto">
146<table class="mlabels">
147 <tr>
148 <td class="mlabels-left">
149 <table class="memname">
150 <tr>
151 <td class="memname"><a class="el" href="classarmnn_1_1_i_backend.xhtml">IBackend</a> </td>
152 <td>(</td>
153 <td class="paramname"></td><td>)</td>
154 <td></td>
155 </tr>
156 </table>
157 </td>
158 <td class="mlabels-right">
159<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
160 </tr>
161</table>
162</div><div class="memdoc">
163
164<p class="definition">Definition at line <a class="el" href="_types_8hpp_source.xhtml#l00256">256</a> of file <a class="el" href="_types_8hpp_source.xhtml">Types.hpp</a>.</p>
165<div class="fragment"><div class="line"><a name="l00256"></a><span class="lineno"> 256</span>&#160;{}</div></div><!-- fragment -->
166</div>
167</div>
168<a id="aa73289e0503a4f7ec5909e117a57aa2b"></a>
169<h2 class="memtitle"><span class="permalink"><a href="#aa73289e0503a4f7ec5909e117a57aa2b">&#9670;&nbsp;</a></span>~IBackend()</h2>
170
171<div class="memitem">
172<div class="memproto">
173<table class="mlabels">
174 <tr>
175 <td class="mlabels-left">
176 <table class="memname">
177 <tr>
178 <td class="memname">virtual ~<a class="el" href="classarmnn_1_1_i_backend.xhtml">IBackend</a> </td>
179 <td>(</td>
180 <td class="paramname"></td><td>)</td>
181 <td></td>
182 </tr>
183 </table>
184 </td>
185 <td class="mlabels-right">
186<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
187 </tr>
188</table>
189</div><div class="memdoc">
190
191<p class="definition">Definition at line <a class="el" href="_types_8hpp_source.xhtml#l00257">257</a> of file <a class="el" href="_types_8hpp_source.xhtml">Types.hpp</a>.</p>
192<div class="fragment"><div class="line"><a name="l00257"></a><span class="lineno"> 257</span>&#160;{}</div></div><!-- fragment -->
193</div>
194</div>
195<h2 class="groupheader">Member Function Documentation</h2>
196<a id="aa9fc23b7155bd678232eeb351059b748"></a>
197<h2 class="memtitle"><span class="permalink"><a href="#aa9fc23b7155bd678232eeb351059b748">&#9670;&nbsp;</a></span>GetId()</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 const <a class="el" href="classarmnn_1_1_backend_id.xhtml">BackendId</a>&amp; GetId </td>
207 <td>(</td>
208 <td class="paramname"></td><td>)</td>
209 <td> const</td>
210 </tr>
211 </table>
212 </td>
213 <td class="mlabels-right">
214<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
215 </tr>
216</table>
217</div><div class="memdoc">
218
219<p>Implemented in <a class="el" href="classarmnn_1_1_cl_backend.xhtml#a6c6c3d137a7792e264a89cc40ea94bb0">ClBackend</a>, <a class="el" href="classarmnn_1_1_ref_backend.xhtml#a6c6c3d137a7792e264a89cc40ea94bb0">RefBackend</a>, <a class="el" href="classarmnn_1_1_neon_backend.xhtml#a6c6c3d137a7792e264a89cc40ea94bb0">NeonBackend</a>, and <a class="el" href="classarmnn_1_1_tosa_ref_backend.xhtml#a6c6c3d137a7792e264a89cc40ea94bb0">TosaRefBackend</a>.</p>
220
221<p class="reference">Referenced by <a class="el" href="_i_backend_internal_8cpp_source.xhtml#l00023">IBackendInternal::CreateWorkloadFactory()</a>, <a class="el" href="_i_backend_internal_8cpp_source.xhtml#l00087">IBackendInternal::GetLayerSupport()</a>, and <a class="el" href="_loaded_network_8cpp_source.xhtml#l00170">LoadedNetwork::MakeLoadedNetwork()</a>.</p>
222
223</div>
224</div>
225<hr/>The documentation for this class was generated from the following file:<ul>
226<li>include/armnn/<a class="el" href="_types_8hpp_source.xhtml">Types.hpp</a></li>
227</ul>
228</div><!-- contents -->
229</div><!-- doc-content -->
230<!-- start footer part -->
231<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
232 <ul>
233 <li class="navelem"><a class="el" href="namespacearmnn.xhtml">armnn</a></li><li class="navelem"><a class="el" href="classarmnn_1_1_i_backend.xhtml">IBackend</a></li>
234 <li class="footer">Generated on Fri Feb 24 2023 10:24:30 for ArmNN by
235 <a href="http://www.doxygen.org/index.html">
236 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
237 </ul>
238</div>
239</body>
240</html>