blob: 844fceebd224f625e916e0d8afb25bccf1b2c367 [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: DynamicBackend 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_1_dynamic_backend.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-types">Public Types</a> &#124;
97<a href="#pub-methods">Public Member Functions</a> &#124;
98<a href="classarmnn_1_1_dynamic_backend-members.html">List of all members</a> </div>
99 <div class="headertitle">
100<div class="title">DynamicBackend Class Reference<span class="mlabels"><span class="mlabel">final</span></span></div> </div>
101</div><!--header-->
102<div class="contents">
103
104<p><code>#include &lt;<a class="el" href="_dynamic_backend_8hpp_source.html">DynamicBackend.hpp</a>&gt;</code></p>
105<table class="memberdecls">
106<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
107Public Types</h2></td></tr>
108<tr class="memitem:afc391d6dc3d75baff0e86b70ae710a50"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_dynamic_backend.html#afc391d6dc3d75baff0e86b70ae710a50">HandleCloser</a> = std::function&lt; void(const void *)&gt;</td></tr>
109<tr class="separator:afc391d6dc3d75baff0e86b70ae710a50"><td class="memSeparator" colspan="2">&#160;</td></tr>
110<tr class="memitem:a8bdc460894ec6fe25c7754d0d5d10866"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_dynamic_backend.html#a8bdc460894ec6fe25c7754d0d5d10866">HandlePtr</a> = std::unique_ptr&lt; void, <a class="el" href="classarmnn_1_1_dynamic_backend.html#afc391d6dc3d75baff0e86b70ae710a50">HandleCloser</a> &gt;</td></tr>
111<tr class="separator:a8bdc460894ec6fe25c7754d0d5d10866"><td class="memSeparator" colspan="2">&#160;</td></tr>
112</table><table class="memberdecls">
113<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
114Public Member Functions</h2></td></tr>
115<tr class="memitem:a1c1454fae6258415712b5e720023fbd1"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_dynamic_backend.html#a1c1454fae6258415712b5e720023fbd1">DynamicBackend</a> (const void *sharedObjectHandle)</td></tr>
116<tr class="separator:a1c1454fae6258415712b5e720023fbd1"><td class="memSeparator" colspan="2">&#160;</td></tr>
117<tr class="memitem:a6deb5373920ee59a800eca6b01085654"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarmnn_1_1_backend_id.html">BackendId</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_dynamic_backend.html#a6deb5373920ee59a800eca6b01085654">GetBackendId</a> ()</td></tr>
118<tr class="memdesc:a6deb5373920ee59a800eca6b01085654"><td class="mdescLeft">&#160;</td><td class="mdescRight">Public dynamic backend functions. <a href="classarmnn_1_1_dynamic_backend.html#a6deb5373920ee59a800eca6b01085654">More...</a><br /></td></tr>
119<tr class="separator:a6deb5373920ee59a800eca6b01085654"><td class="memSeparator" colspan="2">&#160;</td></tr>
120<tr class="memitem:a74db049ad0000a58b9a58a6cd6d88feb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structarmnn_1_1_backend_version.html">BackendVersion</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_dynamic_backend.html#a74db049ad0000a58b9a58a6cd6d88feb">GetBackendVersion</a> ()</td></tr>
121<tr class="separator:a74db049ad0000a58b9a58a6cd6d88feb"><td class="memSeparator" colspan="2">&#160;</td></tr>
122<tr class="memitem:a9d10388a851fc1a748c3e385f484b52a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacearmnn.html#ade0af9dacaa52cafdd701bef2e901c77">IBackendInternalUniquePtr</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_dynamic_backend.html#a9d10388a851fc1a748c3e385f484b52a">GetBackend</a> ()</td></tr>
123<tr class="separator:a9d10388a851fc1a748c3e385f484b52a"><td class="memSeparator" colspan="2">&#160;</td></tr>
124<tr class="memitem:a4c24f07cb0b4bff43655dfdbd5eac539"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarmnn_1_1_backend_registry.html#aa33ac375677ee8436456a585dd6f68d9">BackendRegistry::FactoryFunction</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_dynamic_backend.html#a4c24f07cb0b4bff43655dfdbd5eac539">GetFactoryFunction</a> ()</td></tr>
125<tr class="separator:a4c24f07cb0b4bff43655dfdbd5eac539"><td class="memSeparator" colspan="2">&#160;</td></tr>
126</table>
127<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
128<div class="textblock">
129<p class="definition">Definition at line <a class="el" href="_dynamic_backend_8hpp_source.html#l00020">20</a> of file <a class="el" href="_dynamic_backend_8hpp_source.html">DynamicBackend.hpp</a>.</p>
130</div><h2 class="groupheader">Member Typedef Documentation</h2>
131<a id="afc391d6dc3d75baff0e86b70ae710a50"></a>
132<h2 class="memtitle"><span class="permalink"><a href="#afc391d6dc3d75baff0e86b70ae710a50">&#9670;&nbsp;</a></span>HandleCloser</h2>
133
134<div class="memitem">
135<div class="memproto">
136 <table class="memname">
137 <tr>
138 <td class="memname">using <a class="el" href="classarmnn_1_1_dynamic_backend.html#afc391d6dc3d75baff0e86b70ae710a50">HandleCloser</a> = std::function&lt;void(const void*)&gt;</td>
139 </tr>
140 </table>
141</div><div class="memdoc">
142
143<p class="definition">Definition at line <a class="el" href="_dynamic_backend_8hpp_source.html#l00023">23</a> of file <a class="el" href="_dynamic_backend_8hpp_source.html">DynamicBackend.hpp</a>.</p>
144
145</div>
146</div>
147<a id="a8bdc460894ec6fe25c7754d0d5d10866"></a>
148<h2 class="memtitle"><span class="permalink"><a href="#a8bdc460894ec6fe25c7754d0d5d10866">&#9670;&nbsp;</a></span>HandlePtr</h2>
149
150<div class="memitem">
151<div class="memproto">
152 <table class="memname">
153 <tr>
154 <td class="memname">using <a class="el" href="classarmnn_1_1_dynamic_backend.html#a8bdc460894ec6fe25c7754d0d5d10866">HandlePtr</a> = std::unique_ptr&lt;void, <a class="el" href="classarmnn_1_1_dynamic_backend.html#afc391d6dc3d75baff0e86b70ae710a50">HandleCloser</a>&gt;</td>
155 </tr>
156 </table>
157</div><div class="memdoc">
158
159<p class="definition">Definition at line <a class="el" href="_dynamic_backend_8hpp_source.html#l00024">24</a> of file <a class="el" href="_dynamic_backend_8hpp_source.html">DynamicBackend.hpp</a>.</p>
160
161</div>
162</div>
163<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
164<a id="a1c1454fae6258415712b5e720023fbd1"></a>
165<h2 class="memtitle"><span class="permalink"><a href="#a1c1454fae6258415712b5e720023fbd1">&#9670;&nbsp;</a></span>DynamicBackend()</h2>
166
167<div class="memitem">
168<div class="memproto">
169<table class="mlabels">
170 <tr>
171 <td class="mlabels-left">
172 <table class="memname">
173 <tr>
174 <td class="memname"><a class="el" href="classarmnn_1_1_dynamic_backend.html">DynamicBackend</a> </td>
175 <td>(</td>
176 <td class="paramtype">const void *&#160;</td>
177 <td class="paramname"><em>sharedObjectHandle</em></td><td>)</td>
178 <td></td>
179 </tr>
180 </table>
181 </td>
182 <td class="mlabels-right">
183<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
184 </tr>
185</table>
186</div><div class="memdoc">
187
188<p class="definition">Definition at line <a class="el" href="_dynamic_backend_8cpp_source.html#l00012">12</a> of file <a class="el" href="_dynamic_backend_8cpp_source.html">DynamicBackend.cpp</a>.</p>
189<div class="fragment"><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160; : m_BackendIdFunction(<span class="keyword">nullptr</span>)</div>
190<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160; , m_BackendVersionFunction(<span class="keyword">nullptr</span>)</div>
191<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160; , m_BackendFactoryFunction(<span class="keyword">nullptr</span>)</div>
192<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; , m_Handle(<span class="keyword">const_cast&lt;</span><span class="keywordtype">void</span>*<span class="keyword">&gt;</span>(sharedObjectHandle), &amp;<a class="code" href="classarmnn_1_1_dynamic_backend_utils.html#aebd30d283660a07b4123fdb0245e8426">DynamicBackendUtils::CloseHandle</a>)</div>
193<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;{</div>
194<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; <span class="keywordflow">if</span> (m_Handle == <span class="keyword">nullptr</span>)</div>
195<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; {</div>
196<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; <span class="keywordflow">throw</span> InvalidArgumentException(<span class="stringliteral">&quot;Cannot create a DynamicBackend object from an invalid shared object handle&quot;</span>);</div>
197<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; }</div>
198<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; </div>
199<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; <span class="comment">// These calls will throw in case of error</span></div>
200<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; m_BackendIdFunction = SetFunctionPointer&lt;IdFunctionType&gt;(<span class="stringliteral">&quot;GetBackendId&quot;</span>);</div>
201<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; m_BackendVersionFunction = SetFunctionPointer&lt;VersionFunctionType&gt;(<span class="stringliteral">&quot;GetVersion&quot;</span>);</div>
202<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; m_BackendFactoryFunction = SetFunctionPointer&lt;FactoryFunctionType&gt;(<span class="stringliteral">&quot;BackendFactory&quot;</span>);</div>
203<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; </div>
204<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; <span class="comment">// Check that the backend is compatible with the current Backend API</span></div>
205<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; BackendId backendId = <a class="code" href="classarmnn_1_1_dynamic_backend.html#a6deb5373920ee59a800eca6b01085654">GetBackendId</a>();</div>
206<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; BackendVersion backendVersion = <a class="code" href="classarmnn_1_1_dynamic_backend.html#a74db049ad0000a58b9a58a6cd6d88feb">GetBackendVersion</a>();</div>
207<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; <span class="keywordflow">if</span> (!<a class="code" href="classarmnn_1_1_dynamic_backend_utils.html#a6789076aa25c6a10faeff1043359bda8">DynamicBackendUtils::IsBackendCompatible</a>(backendVersion))</div>
208<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; {</div>
209<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <span class="comment">// This exception message could not be formatted simply using fmt::format</span></div>
210<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; std::stringstream message;</div>
211<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; message &lt;&lt; <span class="stringliteral">&quot;The dynamic backend &quot;</span> &lt;&lt; backendId &lt;&lt; <span class="stringliteral">&quot; (version &quot;</span> &lt;&lt; backendVersion &lt;&lt;</div>
212<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="stringliteral">&quot;) is not compatible with the current Backend API (version &quot;</span> &lt;&lt; <a class="code" href="classarmnn_1_1_i_backend_internal.html#a878b8f50d8a2f92ed624803e9f6968ae">IBackendInternal::GetApiVersion</a>() &lt;&lt; <span class="stringliteral">&quot;)&quot;</span>;</div>
213<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; </div>
214<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="keywordflow">throw</span> RuntimeException(message.str());</div>
215<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; }</div>
216<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;}</div>
217</div><!-- fragment -->
218<p class="reference">References <a class="el" href="_i_backend_internal_8hpp_source.html#l00167">IBackendInternal::GetApiVersion()</a>, <a class="el" href="_dynamic_backend_8cpp_source.html#l00042">DynamicBackend::GetBackendId()</a>, <a class="el" href="_dynamic_backend_8cpp_source.html#l00058">DynamicBackend::GetBackendVersion()</a>, and <a class="el" href="_dynamic_backend_utils_8cpp_source.html#l00052">DynamicBackendUtils::IsBackendCompatible()</a>.</p>
219
220</div>
221</div>
222<h2 class="groupheader">Member Function Documentation</h2>
223<a id="a9d10388a851fc1a748c3e385f484b52a"></a>
224<h2 class="memtitle"><span class="permalink"><a href="#a9d10388a851fc1a748c3e385f484b52a">&#9670;&nbsp;</a></span>GetBackend()</h2>
225
226<div class="memitem">
227<div class="memproto">
228 <table class="memname">
229 <tr>
230 <td class="memname"><a class="el" href="namespacearmnn.html#ade0af9dacaa52cafdd701bef2e901c77">IBackendInternalUniquePtr</a> GetBackend </td>
231 <td>(</td>
232 <td class="paramname"></td><td>)</td>
233 <td></td>
234 </tr>
235 </table>
236</div><div class="memdoc">
237
238<p class="definition">Definition at line <a class="el" href="_dynamic_backend_8cpp_source.html#l00072">72</a> of file <a class="el" href="_dynamic_backend_8cpp_source.html">DynamicBackend.cpp</a>.</p>
239<div class="fragment"><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;{</div>
240<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; <span class="comment">// This call throws in case of error</span></div>
241<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; <span class="keywordflow">return</span> CreateBackend();</div>
242<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160;}</div>
243</div><!-- fragment -->
244</div>
245</div>
246<a id="a6deb5373920ee59a800eca6b01085654"></a>
247<h2 class="memtitle"><span class="permalink"><a href="#a6deb5373920ee59a800eca6b01085654">&#9670;&nbsp;</a></span>GetBackendId()</h2>
248
249<div class="memitem">
250<div class="memproto">
251 <table class="memname">
252 <tr>
253 <td class="memname"><a class="el" href="classarmnn_1_1_backend_id.html">BackendId</a> GetBackendId </td>
254 <td>(</td>
255 <td class="paramname"></td><td>)</td>
256 <td></td>
257 </tr>
258 </table>
259</div><div class="memdoc">
260
261<p>Public dynamic backend functions. </p>
262
263<p class="definition">Definition at line <a class="el" href="_dynamic_backend_8cpp_source.html#l00042">42</a> of file <a class="el" href="_dynamic_backend_8cpp_source.html">DynamicBackend.cpp</a>.</p>
264<div class="fragment"><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;{</div>
265<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="keywordflow">if</span> (m_BackendIdFunction == <span class="keyword">nullptr</span>)</div>
266<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; {</div>
267<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="keywordflow">throw</span> RuntimeException(<span class="stringliteral">&quot;GetBackendId error: invalid function pointer&quot;</span>);</div>
268<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; }</div>
269<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; </div>
270<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span>* backendId = m_BackendIdFunction();</div>
271<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <span class="keywordflow">if</span> (backendId == <span class="keyword">nullptr</span>)</div>
272<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; {</div>
273<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="keywordflow">throw</span> RuntimeException(<span class="stringliteral">&quot;GetBackendId error: invalid backend id&quot;</span>);</div>
274<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; }</div>
275<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; </div>
276<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <span class="keywordflow">return</span> BackendId(backendId);</div>
277<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;}</div>
278</div><!-- fragment -->
279<p class="reference">Referenced by <a class="el" href="_dynamic_backend_8cpp_source.html#l00012">DynamicBackend::DynamicBackend()</a>.</p>
280
281</div>
282</div>
283<a id="a74db049ad0000a58b9a58a6cd6d88feb"></a>
284<h2 class="memtitle"><span class="permalink"><a href="#a74db049ad0000a58b9a58a6cd6d88feb">&#9670;&nbsp;</a></span>GetBackendVersion()</h2>
285
286<div class="memitem">
287<div class="memproto">
288 <table class="memname">
289 <tr>
290 <td class="memname"><a class="el" href="structarmnn_1_1_backend_version.html">BackendVersion</a> GetBackendVersion </td>
291 <td>(</td>
292 <td class="paramname"></td><td>)</td>
293 <td></td>
294 </tr>
295 </table>
296</div><div class="memdoc">
297
298<p class="definition">Definition at line <a class="el" href="_dynamic_backend_8cpp_source.html#l00058">58</a> of file <a class="el" href="_dynamic_backend_8cpp_source.html">DynamicBackend.cpp</a>.</p>
299<div class="fragment"><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;{</div>
300<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; <span class="keywordflow">if</span> (m_BackendVersionFunction == <span class="keyword">nullptr</span>)</div>
301<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; {</div>
302<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; <span class="keywordflow">throw</span> RuntimeException(<span class="stringliteral">&quot;GetBackendVersion error: invalid function pointer&quot;</span>);</div>
303<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; }</div>
304<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; </div>
305<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; uint32_t major = 0;</div>
306<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; uint32_t minor = 0;</div>
307<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; m_BackendVersionFunction(&amp;major, &amp;minor);</div>
308<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; </div>
309<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <span class="keywordflow">return</span> BackendVersion{ major, minor };</div>
310<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;}</div>
311</div><!-- fragment -->
312<p class="reference">Referenced by <a class="el" href="_dynamic_backend_8cpp_source.html#l00012">DynamicBackend::DynamicBackend()</a>.</p>
313
314</div>
315</div>
316<a id="a4c24f07cb0b4bff43655dfdbd5eac539"></a>
317<h2 class="memtitle"><span class="permalink"><a href="#a4c24f07cb0b4bff43655dfdbd5eac539">&#9670;&nbsp;</a></span>GetFactoryFunction()</h2>
318
319<div class="memitem">
320<div class="memproto">
321 <table class="memname">
322 <tr>
323 <td class="memname"><a class="el" href="classarmnn_1_1_backend_registry.html#aa33ac375677ee8436456a585dd6f68d9">BackendRegistry::FactoryFunction</a> GetFactoryFunction </td>
324 <td>(</td>
325 <td class="paramname"></td><td>)</td>
326 <td></td>
327 </tr>
328 </table>
329</div><div class="memdoc">
330
331<p class="definition">Definition at line <a class="el" href="_dynamic_backend_8cpp_source.html#l00078">78</a> of file <a class="el" href="_dynamic_backend_8cpp_source.html">DynamicBackend.cpp</a>.</p>
332<div class="fragment"><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160;{</div>
333<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; <span class="keywordflow">if</span> (m_BackendFactoryFunction == <span class="keyword">nullptr</span>)</div>
334<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; {</div>
335<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; <span class="keywordflow">throw</span> RuntimeException(<span class="stringliteral">&quot;GetFactoryFunction error: invalid function pointer&quot;</span>);</div>
336<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; }</div>
337<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; </div>
338<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; <span class="keywordflow">return</span> [<span class="keyword">this</span>]() -&gt; <a class="code" href="namespacearmnn.html#ade0af9dacaa52cafdd701bef2e901c77">IBackendInternalUniquePtr</a></div>
339<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; {</div>
340<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; <span class="comment">// This call throws in case of error</span></div>
341<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; <span class="keywordflow">return</span> CreateBackend();</div>
342<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; };</div>
343<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160;}</div>
344</div><!-- fragment -->
345</div>
346</div>
347<hr/>The documentation for this class was generated from the following files:<ul>
348<li>include/armnn/backends/<a class="el" href="_dynamic_backend_8hpp_source.html">DynamicBackend.hpp</a></li>
349<li>src/backends/backendsCommon/<a class="el" href="_dynamic_backend_8cpp_source.html">DynamicBackend.cpp</a></li>
350</ul>
351</div><!-- contents -->
352</div><!-- doc-content -->
353<div class="ttc" id="aclassarmnn_1_1_dynamic_backend_html_a74db049ad0000a58b9a58a6cd6d88feb"><div class="ttname"><a href="classarmnn_1_1_dynamic_backend.html#a74db049ad0000a58b9a58a6cd6d88feb">armnn::DynamicBackend::GetBackendVersion</a></div><div class="ttdeci">BackendVersion GetBackendVersion()</div><div class="ttdef"><b>Definition:</b> <a href="_dynamic_backend_8cpp_source.html#l00058">DynamicBackend.cpp:58</a></div></div>
354<div class="ttc" id="aclassarmnn_1_1_dynamic_backend_html_a6deb5373920ee59a800eca6b01085654"><div class="ttname"><a href="classarmnn_1_1_dynamic_backend.html#a6deb5373920ee59a800eca6b01085654">armnn::DynamicBackend::GetBackendId</a></div><div class="ttdeci">BackendId GetBackendId()</div><div class="ttdoc">Public dynamic backend functions.</div><div class="ttdef"><b>Definition:</b> <a href="_dynamic_backend_8cpp_source.html#l00042">DynamicBackend.cpp:42</a></div></div>
355<div class="ttc" id="aclassarmnn_1_1_dynamic_backend_utils_html_aebd30d283660a07b4123fdb0245e8426"><div class="ttname"><a href="classarmnn_1_1_dynamic_backend_utils.html#aebd30d283660a07b4123fdb0245e8426">armnn::DynamicBackendUtils::CloseHandle</a></div><div class="ttdeci">static void CloseHandle(const void *sharedObjectHandle)</div><div class="ttdef"><b>Definition:</b> <a href="_dynamic_backend_utils_8cpp_source.html#l00037">DynamicBackendUtils.cpp:37</a></div></div>
356<div class="ttc" id="aclassarmnn_1_1_i_backend_internal_html_a878b8f50d8a2f92ed624803e9f6968ae"><div class="ttname"><a href="classarmnn_1_1_i_backend_internal.html#a878b8f50d8a2f92ed624803e9f6968ae">armnn::IBackendInternal::GetApiVersion</a></div><div class="ttdeci">static constexpr BackendVersion GetApiVersion()</div><div class="ttdoc">Returns the version of the Backend API.</div><div class="ttdef"><b>Definition:</b> <a href="_i_backend_internal_8hpp_source.html#l00167">IBackendInternal.hpp:167</a></div></div>
357<div class="ttc" id="aclassarmnn_1_1_dynamic_backend_utils_html_a6789076aa25c6a10faeff1043359bda8"><div class="ttname"><a href="classarmnn_1_1_dynamic_backend_utils.html#a6789076aa25c6a10faeff1043359bda8">armnn::DynamicBackendUtils::IsBackendCompatible</a></div><div class="ttdeci">static bool IsBackendCompatible(const BackendVersion &amp;backendVersion)</div><div class="ttdef"><b>Definition:</b> <a href="_dynamic_backend_utils_8cpp_source.html#l00052">DynamicBackendUtils.cpp:52</a></div></div>
358<div class="ttc" id="anamespacearmnn_html_ade0af9dacaa52cafdd701bef2e901c77"><div class="ttname"><a href="namespacearmnn.html#ade0af9dacaa52cafdd701bef2e901c77">armnn::IBackendInternalUniquePtr</a></div><div class="ttdeci">std::unique_ptr&lt; IBackendInternal &gt; IBackendInternalUniquePtr</div><div class="ttdef"><b>Definition:</b> <a href="_backend_registry_8hpp_source.html#l00032">BackendRegistry.hpp:32</a></div></div>
359<!-- start footer part -->
360<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
361 <ul>
362 <li class="navelem"><a class="el" href="namespacearmnn.html">armnn</a></li><li class="navelem"><a class="el" href="classarmnn_1_1_dynamic_backend.html">DynamicBackend</a></li>
363 <li class="footer">Generated on Thu May 16 2024 09:31:55 for Arm NN by
364 <a href="http://www.doxygen.org/index.html">
365 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
366 </ul>
367</div>
368</body>
369</html>