Gitiles
Code Review Sign In
review.mlplatform.org / ml / armnn / 25334cf3d53fe7fff98776b44a199ca341f62f1a / . / Documentation / classarmnn_1_1_i_backend.html
blob: 87eda4508f352f4b4abe65ae06ed4782641c5bef [file] [log] [blame]
Ryan OSheade36e4a2020-03-13 16:26:19 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml">
3<head>
4<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6<meta name="generator" content="Doxygen 1.8.13"/>
7<meta name="viewport" content="width=device-width, initial-scale=1"/>
8<title>ArmNN: IBackend Class Reference</title>
9<link href="tabs.css" rel="stylesheet" type="text/css"/>
10<script type="text/javascript" src="jquery.js"></script>
11<script type="text/javascript" src="dynsections.js"></script>
12<link href="navtree.css" rel="stylesheet" type="text/css"/>
13<script type="text/javascript" src="resize.js"></script>
14<script type="text/javascript" src="navtreedata.js"></script>
15<script type="text/javascript" src="navtree.js"></script>
16<script type="text/javascript">
17 $(document).ready(initResizable);
18</script>
19<link href="search/search.css" rel="stylesheet" type="text/css"/>
20<script type="text/javascript" src="search/searchdata.js"></script>
21<script type="text/javascript" src="search/search.js"></script>
22<link href="doxygen.css" rel="stylesheet" type="text/css" />
23</head>
24<body>
25<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
26<div id="titlearea">
27<table cellspacing="0" cellpadding="0">
28 <tbody>
29 <tr style="height: 56px;">
30 <td id="projectalign" style="padding-left: 0.5em;">
31 <div id="projectname">ArmNN
32 &#160;<span id="projectnumber">NotReleased</span>
33 </div>
34 </td>
35 </tr>
36 </tbody>
37</table>
38</div>
39<!-- end header part -->
40<!-- Generated by Doxygen 1.8.13 -->
41<script type="text/javascript">
42var searchBox = new SearchBox("searchBox", "search",false,'Search');
43</script>
44<script type="text/javascript" src="menudata.js"></script>
45<script type="text/javascript" src="menu.js"></script>
46<script type="text/javascript">
47$(function() {
48 initMenu('',true,false,'search.php','Search');
49 $(document).ready(function() { init_search(); });
50});
51</script>
52<div id="main-nav"></div>
53</div><!-- top -->
54<div id="side-nav" class="ui-resizable side-nav-resizable">
55 <div id="nav-tree">
56 <div id="nav-tree-contents">
57 <div id="nav-sync" class="sync"></div>
58 </div>
59 </div>
60 <div id="splitbar" style="-moz-user-select:none;"
61 class="ui-resizable-handle">
62 </div>
63</div>
64<script type="text/javascript">
65$(document).ready(function(){initNavTree('classarmnn_1_1_i_backend.html','');});
66</script>
67<div id="doc-content">
68<!-- window showing the filter options -->
69<div id="MSearchSelectWindow"
70 onmouseover="return searchBox.OnSearchSelectShow()"
71 onmouseout="return searchBox.OnSearchSelectHide()"
72 onkeydown="return searchBox.OnSearchSelectKey(event)">
73</div>
74
75<!-- iframe showing the search results (closed by default) -->
76<div id="MSearchResultsWindow">
77<iframe src="javascript:void(0)" frameborder="0"
78 name="MSearchResults" id="MSearchResults">
79</iframe>
80</div>
81
82<div class="header">
83 <div class="summary">
84<a href="#pub-methods">Public Member Functions</a> &#124;
85<a href="#pro-methods">Protected Member Functions</a> &#124;
86<a href="classarmnn_1_1_i_backend-members.html">List of all members</a> </div>
87 <div class="headertitle">
88<div class="title">IBackend Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
89</div><!--header-->
90<div class="contents">
91
92<p>Each backend should implement an <a class="el" href="classarmnn_1_1_i_backend.html" title="Each backend should implement an IBackend. ">IBackend</a>.
93 <a href="classarmnn_1_1_i_backend.html#details">More...</a></p>
94
95<p><code>#include &lt;<a class="el" href="_types_8hpp_source.html">Types.hpp</a>&gt;</code></p>
96<div class="dynheader">
97Inheritance diagram for IBackend:</div>
98<div class="dyncontent">
99 <div class="center">
100 <img src="classarmnn_1_1_i_backend.png" usemap="#IBackend_map" alt=""/>
101 <map id="IBackend_map" name="IBackend_map">
102<area href="classarmnn_1_1_i_backend_internal.html" alt="IBackendInternal" shape="rect" coords="174,56,280,80"/>
103<area href="classarmnn_1_1_cl_backend.html" alt="ClBackend" shape="rect" coords="0,112,106,136"/>
104<area href="classarmnn_1_1_mock_backend.html" alt="MockBackend" shape="rect" coords="116,112,222,136"/>
105<area href="classarmnn_1_1_neon_backend.html" alt="NeonBackend" shape="rect" coords="232,112,338,136"/>
106<area href="classarmnn_1_1_ref_backend.html" alt="RefBackend" shape="rect" coords="348,112,454,136"/>
107</map>
108 </div></div>
109<table class="memberdecls">
110<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
111Public Member Functions</h2></td></tr>
112<tr class="memitem:aa9fc23b7155bd678232eeb351059b748"><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="classarmnn_1_1_backend_id.html">BackendId</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_i_backend.html#aa9fc23b7155bd678232eeb351059b748">GetId</a> () const =0</td></tr>
113<tr class="separator:aa9fc23b7155bd678232eeb351059b748"><td class="memSeparator" colspan="2">&#160;</td></tr>
114</table><table class="memberdecls">
115<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
116Protected Member Functions</h2></td></tr>
117<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.html#a7cfc55eae265fa65b7d25e7dd3203f22">IBackend</a> ()</td></tr>
118<tr class="separator:a7cfc55eae265fa65b7d25e7dd3203f22"><td class="memSeparator" colspan="2">&#160;</td></tr>
119<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.html#aa73289e0503a4f7ec5909e117a57aa2b">~IBackend</a> ()</td></tr>
120<tr class="separator:aa73289e0503a4f7ec5909e117a57aa2b"><td class="memSeparator" colspan="2">&#160;</td></tr>
121</table>
122<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
123<div class="textblock"><p>Each backend should implement an <a class="el" href="classarmnn_1_1_i_backend.html" title="Each backend should implement an IBackend. ">IBackend</a>. </p>
124
125<p class="definition">Definition at line <a class="el" href="_types_8hpp_source.html#l00144">144</a> of file <a class="el" href="_types_8hpp_source.html">Types.hpp</a>.</p>
126</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
127<a id="a7cfc55eae265fa65b7d25e7dd3203f22"></a>
128<h2 class="memtitle"><span class="permalink"><a href="#a7cfc55eae265fa65b7d25e7dd3203f22">&#9670;&nbsp;</a></span>IBackend()</h2>
129
130<div class="memitem">
131<div class="memproto">
132<table class="mlabels">
133 <tr>
134 <td class="mlabels-left">
135 <table class="memname">
136 <tr>
137 <td class="memname"><a class="el" href="classarmnn_1_1_i_backend.html">IBackend</a> </td>
138 <td>(</td>
139 <td class="paramname"></td><td>)</td>
140 <td></td>
141 </tr>
142 </table>
143 </td>
144 <td class="mlabels-right">
145<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
146 </tr>
147</table>
148</div><div class="memdoc">
149
150<p class="definition">Definition at line <a class="el" href="_types_8hpp_source.html#l00147">147</a> of file <a class="el" href="_types_8hpp_source.html">Types.hpp</a>.</p>
151<div class="fragment"><div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160;{}</div></div><!-- fragment -->
152</div>
153</div>
154<a id="aa73289e0503a4f7ec5909e117a57aa2b"></a>
155<h2 class="memtitle"><span class="permalink"><a href="#aa73289e0503a4f7ec5909e117a57aa2b">&#9670;&nbsp;</a></span>~IBackend()</h2>
156
157<div class="memitem">
158<div class="memproto">
159<table class="mlabels">
160 <tr>
161 <td class="mlabels-left">
162 <table class="memname">
163 <tr>
164 <td class="memname">virtual ~<a class="el" href="classarmnn_1_1_i_backend.html">IBackend</a> </td>
165 <td>(</td>
166 <td class="paramname"></td><td>)</td>
167 <td></td>
168 </tr>
169 </table>
170 </td>
171 <td class="mlabels-right">
172<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
173 </tr>
174</table>
175</div><div class="memdoc">
176
177<p class="definition">Definition at line <a class="el" href="_types_8hpp_source.html#l00148">148</a> of file <a class="el" href="_types_8hpp_source.html">Types.hpp</a>.</p>
178<div class="fragment"><div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160;{}</div></div><!-- fragment -->
179</div>
180</div>
181<h2 class="groupheader">Member Function Documentation</h2>
182<a id="aa9fc23b7155bd678232eeb351059b748"></a>
183<h2 class="memtitle"><span class="permalink"><a href="#aa9fc23b7155bd678232eeb351059b748">&#9670;&nbsp;</a></span>GetId()</h2>
184
185<div class="memitem">
186<div class="memproto">
187<table class="mlabels">
188 <tr>
189 <td class="mlabels-left">
190 <table class="memname">
191 <tr>
192 <td class="memname">virtual const <a class="el" href="classarmnn_1_1_backend_id.html">BackendId</a>&amp; GetId </td>
193 <td>(</td>
194 <td class="paramname"></td><td>)</td>
195 <td> const</td>
196 </tr>
197 </table>
198 </td>
199 <td class="mlabels-right">
200<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
201 </tr>
202</table>
203</div><div class="memdoc">
204
205<p>Implemented in <a class="el" href="classarmnn_1_1_mock_backend.html#a6c6c3d137a7792e264a89cc40ea94bb0">MockBackend</a>, <a class="el" href="classarmnn_1_1_cl_backend.html#a6c6c3d137a7792e264a89cc40ea94bb0">ClBackend</a>, <a class="el" href="classarmnn_1_1_neon_backend.html#a6c6c3d137a7792e264a89cc40ea94bb0">NeonBackend</a>, and <a class="el" href="classarmnn_1_1_ref_backend.html#a6c6c3d137a7792e264a89cc40ea94bb0">RefBackend</a>.</p>
206
207<p class="reference">Referenced by <a class="el" href="_test_dynamic_backend_8cpp_source.html#l00012">TestDynamicBackendId()</a>.</p>
208
209</div>
210</div>
211<hr/>The documentation for this class was generated from the following file:<ul>
212<li>include/armnn/<a class="el" href="_types_8hpp_source.html">Types.hpp</a></li>
213</ul>
214</div><!-- contents -->
215</div><!-- doc-content -->
216<!-- start footer part -->
217<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
218 <ul>
219 <li class="navelem"><a class="el" href="namespacearmnn.html">armnn</a></li><li class="navelem"><a class="el" href="classarmnn_1_1_i_backend.html">IBackend</a></li>
220 <li class="footer">Generated on Fri Mar 13 2020 16:07:03 for ArmNN by
221 <a href="http://www.doxygen.org/index.html">
222 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
223 </ul>
224</div>
225</body>
226</html>