Gitiles
Code Review Sign In
review.mlplatform.org / ml / armnn / 78229c4e6472b6e30627d549c97e9cbe678ec4d3 / . / Documentation / _ref_dynamic_backend_8hpp.html
blob: a6f68320ee9b52132d41b4002a960f9b10cf8f7a [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: src/backends/dynamic/reference/RefDynamicBackend.hpp File 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('_ref_dynamic_backend_8hpp.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="#func-members">Functions</a> </div>
85 <div class="headertitle">
86<div class="title">RefDynamicBackend.hpp File Reference</div> </div>
87</div><!--header-->
88<div class="contents">
89<div class="textblock"><code>#include &lt;cstdint&gt;</code><br />
90</div>
91<p><a href="_ref_dynamic_backend_8hpp_source.html">Go to the source code of this file.</a></p>
92<table class="memberdecls">
93<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
94Functions</h2></td></tr>
95<tr class="memitem:adaff295134ed2825ae43a8e9281b6f2a"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_ref_dynamic_backend_8hpp.html#adaff295134ed2825ae43a8e9281b6f2a">GetBackendId</a> ()</td></tr>
96<tr class="separator:adaff295134ed2825ae43a8e9281b6f2a"><td class="memSeparator" colspan="2">&#160;</td></tr>
97<tr class="memitem:aa8f09f94b0356f870c9bdb9c594cddfc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_ref_dynamic_backend_8hpp.html#aa8f09f94b0356f870c9bdb9c594cddfc">GetVersion</a> (uint32_t *outMajor, uint32_t *outMinor)</td></tr>
98<tr class="separator:aa8f09f94b0356f870c9bdb9c594cddfc"><td class="memSeparator" colspan="2">&#160;</td></tr>
99<tr class="memitem:a6a075b7c32d5511f95903749eef44b22"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_ref_dynamic_backend_8hpp.html#a6a075b7c32d5511f95903749eef44b22">BackendFactory</a> ()</td></tr>
100<tr class="separator:a6a075b7c32d5511f95903749eef44b22"><td class="memSeparator" colspan="2">&#160;</td></tr>
101</table>
102<h2 class="groupheader">Function Documentation</h2>
103<a id="a6a075b7c32d5511f95903749eef44b22"></a>
104<h2 class="memtitle"><span class="permalink"><a href="#a6a075b7c32d5511f95903749eef44b22">&#9670;&nbsp;</a></span>BackendFactory()</h2>
105
106<div class="memitem">
107<div class="memproto">
108 <table class="memname">
109 <tr>
110 <td class="memname">void* BackendFactory </td>
111 <td>(</td>
112 <td class="paramname"></td><td>)</td>
113 <td></td>
114 </tr>
115 </table>
116</div><div class="memdoc">
117
118<p class="definition">Definition at line <a class="el" href="_test_dynamic_backend_8cpp_source.html#l00128">128</a> of file <a class="el" href="_test_dynamic_backend_8cpp_source.html">TestDynamicBackend.cpp</a>.</p>
119<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 -->
120</div>
121</div>
122<a id="adaff295134ed2825ae43a8e9281b6f2a"></a>
123<h2 class="memtitle"><span class="permalink"><a href="#adaff295134ed2825ae43a8e9281b6f2a">&#9670;&nbsp;</a></span>GetBackendId()</h2>
124
125<div class="memitem">
126<div class="memproto">
127 <table class="memname">
128 <tr>
129 <td class="memname">const char* GetBackendId </td>
130 <td>(</td>
131 <td class="paramname"></td><td>)</td>
132 <td></td>
133 </tr>
134 </table>
135</div><div class="memdoc">
136
137<p class="definition">Definition at line <a class="el" href="_test_dynamic_backend_8cpp_source.html#l00080">80</a> of file <a class="el" href="_test_dynamic_backend_8cpp_source.html">TestDynamicBackend.cpp</a>.</p>
138<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.html#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_html_aec75c1d78333f881f2516f55a0ed00df"><div class="ttname"><a href="_test_dynamic_backend_8cpp.html#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.html#l00012">TestDynamicBackend.cpp:12</a></div></div>
139</div><!-- fragment -->
140</div>
141</div>
142<a id="aa8f09f94b0356f870c9bdb9c594cddfc"></a>
143<h2 class="memtitle"><span class="permalink"><a href="#aa8f09f94b0356f870c9bdb9c594cddfc">&#9670;&nbsp;</a></span>GetVersion()</h2>
144
145<div class="memitem">
146<div class="memproto">
147 <table class="memname">
148 <tr>
149 <td class="memname">void GetVersion </td>
150 <td>(</td>
151 <td class="paramtype">uint32_t *&#160;</td>
152 <td class="paramname"><em>outMajor</em>, </td>
153 </tr>
154 <tr>
155 <td class="paramkey"></td>
156 <td></td>
157 <td class="paramtype">uint32_t *&#160;</td>
158 <td class="paramname"><em>outMinor</em>&#160;</td>
159 </tr>
160 <tr>
161 <td></td>
162 <td>)</td>
163 <td></td><td></td>
164 </tr>
165 </table>
166</div><div class="memdoc">
167
168<p class="definition">Definition at line <a class="el" href="_test_dynamic_backend_8cpp_source.html#l00096">96</a> of file <a class="el" href="_test_dynamic_backend_8cpp_source.html">TestDynamicBackend.cpp</a>.</p>
169<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.html">armnn::BackendVersion</a> apiVersion = <a class="code" href="classarmnn_1_1_i_backend_internal.html#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.html#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.html#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.html#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_html_a421dbc9bee3ebd2721de5c82e6cd7d20"><div class="ttname"><a href="structarmnn_1_1_backend_version.html#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.html#l00035">IBackendInternal.hpp:35</a></div></div>
170<div class="ttc" id="structarmnn_1_1_backend_version_html"><div class="ttname"><a href="structarmnn_1_1_backend_version.html">armnn::BackendVersion</a></div><div class="ttdef"><b>Definition:</b> <a href="include_2armnn_2backends_2_i_backend_internal_8hpp_source.html#l00032">IBackendInternal.hpp:32</a></div></div>
171<div class="ttc" id="classarmnn_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="include_2armnn_2backends_2_i_backend_internal_8hpp_source.html#l00149">IBackendInternal.hpp:149</a></div></div>
172<div class="ttc" id="structarmnn_1_1_backend_version_html_aa98a6e78930567c2d9cdcf320eaddb7a"><div class="ttname"><a href="structarmnn_1_1_backend_version.html#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.html#l00034">IBackendInternal.hpp:34</a></div></div>
173</div><!-- fragment -->
174</div>
175</div>
176</div><!-- contents -->
177</div><!-- doc-content -->
178<!-- start footer part -->
179<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
180 <ul>
181 <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_0f3cdec46afbc61a1ded8e1687c9c9a0.html">backends</a></li><li class="navelem"><a class="el" href="dir_f234204b1f126bf9b6cfe31d58f18cc7.html">dynamic</a></li><li class="navelem"><a class="el" href="dir_414f8b02beb3463029aafd015d1bf7a0.html">reference</a></li><li class="navelem"><a class="el" href="_ref_dynamic_backend_8hpp.html">RefDynamicBackend.hpp</a></li>
182 <li class="footer">Generated on Fri Mar 13 2020 16:07:00 for ArmNN by
183 <a href="http://www.doxygen.org/index.html">
184 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
185 </ul>
186</div>
187</body>
188</html>