Gitiles
Code Review Sign In
review.mlplatform.org / ml / armnn / fdad393d5611dad69f65f9765c9472fc41cbcfe4 / . / Documentation / _sample_dynamic_backend_8hpp.xhtml
blob: 272aade9105e6842ad7ebd950ca945a68b603147 [file] [log] [blame]
Ryan OSheade36e4a2020-03-13 16:26:19 +0000[diff] [blame]1<!-- 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: src/dynamic/sample/SampleDynamicBackend.hpp File 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">20.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('_sample_dynamic_backend_8hpp.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="#func-members">Functions</a> </div>
99 <div class="headertitle">
100<div class="title">SampleDynamicBackend.hpp File Reference</div> </div>
101</div><!--header-->
102<div class="contents">
103<div class="textblock"><code>#include &lt;cstdint&gt;</code><br />
104</div>
105<p><a href="_sample_dynamic_backend_8hpp_source.xhtml">Go to the source code of this file.</a></p>
106<table class="memberdecls">
107<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
108Functions</h2></td></tr>
109<tr class="memitem:adaff295134ed2825ae43a8e9281b6f2a"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_sample_dynamic_backend_8hpp.xhtml#adaff295134ed2825ae43a8e9281b6f2a">GetBackendId</a> ()</td></tr>
110<tr class="separator:adaff295134ed2825ae43a8e9281b6f2a"><td class="memSeparator" colspan="2">&#160;</td></tr>
111<tr class="memitem:aa8f09f94b0356f870c9bdb9c594cddfc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_sample_dynamic_backend_8hpp.xhtml#aa8f09f94b0356f870c9bdb9c594cddfc">GetVersion</a> (uint32_t *outMajor, uint32_t *outMinor)</td></tr>
112<tr class="separator:aa8f09f94b0356f870c9bdb9c594cddfc"><td class="memSeparator" colspan="2">&#160;</td></tr>
113<tr class="memitem:a6a075b7c32d5511f95903749eef44b22"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_sample_dynamic_backend_8hpp.xhtml#a6a075b7c32d5511f95903749eef44b22">BackendFactory</a> ()</td></tr>
114<tr class="separator:a6a075b7c32d5511f95903749eef44b22"><td class="memSeparator" colspan="2">&#160;</td></tr>
115</table>
116<h2 class="groupheader">Function Documentation</h2>
117<a id="a6a075b7c32d5511f95903749eef44b22"></a>
118<h2 class="memtitle"><span class="permalink"><a href="#a6a075b7c32d5511f95903749eef44b22">&#9670;&nbsp;</a></span>BackendFactory()</h2>
119
120<div class="memitem">
121<div class="memproto">
122 <table class="memname">
123 <tr>
124 <td class="memname">void* BackendFactory </td>
125 <td>(</td>
126 <td class="paramname"></td><td>)</td>
127 <td></td>
128 </tr>
129 </table>
130</div><div class="memdoc">
131
132<p class="definition">Definition at line <a class="el" href="_test_dynamic_backend_8cpp_source.xhtml#l00128">128</a> of file <a class="el" href="_test_dynamic_backend_8cpp_source.xhtml">TestDynamicBackend.cpp</a>.</p>
133<div class="fragment"><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160;{</div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160;<span class="preprocessor">#if defined(INVALID_TEST_DYNAMIC_BACKEND_6)</span></div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160;</div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160; <span class="comment">// Return an invalid backend instance</span></div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160; <span class="keywordflow">return</span> <span class="keyword">nullptr</span>;</div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160;</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160;<span class="preprocessor">#else</span></div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160;</div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160; <span class="comment">// Return a non-null backend instance</span></div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160; <span class="keywordflow">return</span> <span class="keyword">new</span> TestDynamicBackend();</div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160;</div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160;}</div></div><!-- fragment -->
134</div>
135</div>
136<a id="adaff295134ed2825ae43a8e9281b6f2a"></a>
137<h2 class="memtitle"><span class="permalink"><a href="#adaff295134ed2825ae43a8e9281b6f2a">&#9670;&nbsp;</a></span>GetBackendId()</h2>
138
139<div class="memitem">
140<div class="memproto">
141 <table class="memname">
142 <tr>
143 <td class="memname">const char* GetBackendId </td>
144 <td>(</td>
145 <td class="paramname"></td><td>)</td>
146 <td></td>
147 </tr>
148 </table>
149</div><div class="memdoc">
150
151<p class="definition">Definition at line <a class="el" href="_test_dynamic_backend_8cpp_source.xhtml#l00080">80</a> of file <a class="el" href="_test_dynamic_backend_8cpp_source.xhtml">TestDynamicBackend.cpp</a>.</p>
152
153<p class="reference">References <a class="el" href="_backend_id_8hpp_source.xhtml#l00136">BackendId::Get()</a>, <a class="el" href="_ref_backend_8cpp_source.xhtml#l00024">RefBackend::GetIdStatic()</a>, and <a class="el" href="_test_dynamic_backend_8cpp_source.xhtml#l00012">TestDynamicBackendId()</a>.</p>
154
155<p class="reference">Referenced by <a class="el" href="_runtime_tests_8cpp_source.xhtml#l00276">BOOST_AUTO_TEST_CASE()</a>.</p>
156<div class="fragment"><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;{</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;<span class="preprocessor">#if defined(INVALID_TEST_DYNAMIC_BACKEND_5) || \</span></div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;<span class="preprocessor"> defined(INVALID_TEST_DYNAMIC_BACKEND_8)</span></div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; <span class="comment">// Return an invalid backend id</span></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; <span class="keywordflow">return</span> <span class="keyword">nullptr</span>;</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160;</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160;<span class="preprocessor">#else</span></div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160;</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; <span class="comment">// Return a valid backend id</span></div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; <span class="keywordflow">return</span> <a class="code" href="_test_dynamic_backend_8cpp.xhtml#aec75c1d78333f881f2516f55a0ed00df">TestDynamicBackendId</a>();</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160;</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160;}</div><div class="ttc" id="_test_dynamic_backend_8cpp_xhtml_aec75c1d78333f881f2516f55a0ed00df"><div class="ttname"><a href="_test_dynamic_backend_8cpp.xhtml#aec75c1d78333f881f2516f55a0ed00df">TestDynamicBackendId</a></div><div class="ttdeci">constexpr const char * TestDynamicBackendId()</div><div class="ttdef"><b>Definition:</b> <a href="_test_dynamic_backend_8cpp_source.xhtml#l00012">TestDynamicBackend.cpp:12</a></div></div>
157</div><!-- fragment -->
158</div>
159</div>
160<a id="aa8f09f94b0356f870c9bdb9c594cddfc"></a>
161<h2 class="memtitle"><span class="permalink"><a href="#aa8f09f94b0356f870c9bdb9c594cddfc">&#9670;&nbsp;</a></span>GetVersion()</h2>
162
163<div class="memitem">
164<div class="memproto">
165 <table class="memname">
166 <tr>
167 <td class="memname">void GetVersion </td>
168 <td>(</td>
169 <td class="paramtype">uint32_t *&#160;</td>
170 <td class="paramname"><em>outMajor</em>, </td>
171 </tr>
172 <tr>
173 <td class="paramkey"></td>
174 <td></td>
175 <td class="paramtype">uint32_t *&#160;</td>
176 <td class="paramname"><em>outMinor</em>&#160;</td>
177 </tr>
178 <tr>
179 <td></td>
180 <td>)</td>
181 <td></td><td></td>
182 </tr>
183 </table>
184</div><div class="memdoc">
185
186<p class="definition">Definition at line <a class="el" href="_test_dynamic_backend_8cpp_source.xhtml#l00096">96</a> of file <a class="el" href="_test_dynamic_backend_8cpp_source.xhtml">TestDynamicBackend.cpp</a>.</p>
187
188<p class="reference">References <a class="el" href="include_2armnn_2backends_2_i_backend_internal_8hpp_source.xhtml#l00149">IBackendInternal::GetApiVersion()</a>, <a class="el" href="include_2armnn_2backends_2_i_backend_internal_8hpp_source.xhtml#l00034">BackendVersion::m_Major</a>, and <a class="el" href="include_2armnn_2backends_2_i_backend_internal_8hpp_source.xhtml#l00035">BackendVersion::m_Minor</a>.</p>
189<div class="fragment"><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160;{</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; <span class="keywordflow">if</span> (!outMajor || !outMinor)</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; {</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; <span class="keywordflow">return</span>;</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; }</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160;</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160;<span class="preprocessor">#if defined(INVALID_TEST_DYNAMIC_BACKEND_7) || \</span></div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160;<span class="preprocessor"> defined(INVALID_TEST_DYNAMIC_BACKEND_8)</span></div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160;</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; *outMajor = 0;</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; *outMinor = 7;</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160;</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160;<span class="preprocessor">#else</span></div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160;</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; <a class="code" href="structarmnn_1_1_backend_version.xhtml">armnn::BackendVersion</a> apiVersion = <a class="code" href="classarmnn_1_1_i_backend_internal.xhtml#a878b8f50d8a2f92ed624803e9f6968ae">armnn::IBackendInternal::GetApiVersion</a>();</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160;</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; *outMajor = apiVersion.<a class="code" href="structarmnn_1_1_backend_version.xhtml#aa98a6e78930567c2d9cdcf320eaddb7a">m_Major</a>;</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160;</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160;<span class="preprocessor">#if defined(INVALID_TEST_DYNAMIC_BACKEND_9)</span></div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160;</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; *outMinor = apiVersion.<a class="code" href="structarmnn_1_1_backend_version.xhtml#a421dbc9bee3ebd2721de5c82e6cd7d20">m_Minor</a> + 1;</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160;</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160;<span class="preprocessor">#else</span></div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160;</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160; *outMinor = apiVersion.<a class="code" href="structarmnn_1_1_backend_version.xhtml#a421dbc9bee3ebd2721de5c82e6cd7d20">m_Minor</a>;</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160;</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160;</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160;}</div><div class="ttc" id="structarmnn_1_1_backend_version_xhtml_a421dbc9bee3ebd2721de5c82e6cd7d20"><div class="ttname"><a href="structarmnn_1_1_backend_version.xhtml#a421dbc9bee3ebd2721de5c82e6cd7d20">armnn::BackendVersion::m_Minor</a></div><div class="ttdeci">uint32_t m_Minor</div><div class="ttdef"><b>Definition:</b> <a href="include_2armnn_2backends_2_i_backend_internal_8hpp_source.xhtml#l00035">IBackendInternal.hpp:35</a></div></div>
190<div class="ttc" id="structarmnn_1_1_backend_version_xhtml"><div class="ttname"><a href="structarmnn_1_1_backend_version.xhtml">armnn::BackendVersion</a></div><div class="ttdef"><b>Definition:</b> <a href="include_2armnn_2backends_2_i_backend_internal_8hpp_source.xhtml#l00032">IBackendInternal.hpp:32</a></div></div>
191<div class="ttc" id="classarmnn_1_1_i_backend_internal_xhtml_a878b8f50d8a2f92ed624803e9f6968ae"><div class="ttname"><a href="classarmnn_1_1_i_backend_internal.xhtml#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="include_2armnn_2backends_2_i_backend_internal_8hpp_source.xhtml#l00149">IBackendInternal.hpp:149</a></div></div>
192<div class="ttc" id="structarmnn_1_1_backend_version_xhtml_aa98a6e78930567c2d9cdcf320eaddb7a"><div class="ttname"><a href="structarmnn_1_1_backend_version.xhtml#aa98a6e78930567c2d9cdcf320eaddb7a">armnn::BackendVersion::m_Major</a></div><div class="ttdeci">uint32_t m_Major</div><div class="ttdef"><b>Definition:</b> <a href="include_2armnn_2backends_2_i_backend_internal_8hpp_source.xhtml#l00034">IBackendInternal.hpp:34</a></div></div>
193</div><!-- fragment -->
194</div>
195</div>
196</div><!-- contents -->
197</div><!-- doc-content -->
198<!-- start footer part -->
199<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
200 <ul>
201 <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.xhtml">src</a></li><li class="navelem"><a class="el" href="dir_101da30fc6c118b726c448f5a6ab9e53.xhtml">dynamic</a></li><li class="navelem"><a class="el" href="dir_b94b32fb1d16ed92698df04c7e9ebd86.xhtml">sample</a></li><li class="navelem"><a class="el" href="_sample_dynamic_backend_8hpp.xhtml">SampleDynamicBackend.hpp</a></li>
202 <li class="footer">Generated on Fri Mar 13 2020 16:09:15 for ArmNN by
203 <a href="http://www.doxygen.org/index.html">
204 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
205 </ul>
206</div>
207</body>
208</html>