blob: 2fd83861ccc247f19e5f984bb8287c43339b9b5b [file] [log] [blame]
Nikhil Raj38b600d2024-02-15 15:02:19 +00001<!-- 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: ILayerSupport 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.02</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_i_layer_support.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-methods">Public Member Functions</a> &#124;
97<a href="#pro-methods">Protected Member Functions</a> &#124;
98<a href="classarmnn_1_1_i_layer_support-members.html">List of all members</a> </div>
99 <div class="headertitle">
100<div class="title">ILayerSupport Class Reference</div> </div>
101</div><!--header-->
102<div class="contents">
103
104<p><code>#include &lt;<a class="el" href="_i_layer_support_8hpp_source.html">ILayerSupport.hpp</a>&gt;</code></p>
105<div class="dynheader">
106Inheritance diagram for ILayerSupport:</div>
107<div class="dyncontent">
108<div class="center"><iframe scrolling="no" frameborder="0" src="classarmnn_1_1_i_layer_support__inherit__graph.svg" width="694" height="187"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
109</div>
110<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
111<table class="memberdecls">
112<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
113Public Member Functions</h2></td></tr>
114<tr class="memitem:ade82d7df4e18bdd77969958a8fccf10a"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_i_layer_support.html#ade82d7df4e18bdd77969958a8fccf10a">IsLayerSupported</a> (const <a class="el" href="namespacearmnn.html#a56943a0946e5f15e5e58054b8e7a04a4">LayerType</a> &amp;type, const std::vector&lt; <a class="el" href="classarmnn_1_1_tensor_info.html">TensorInfo</a> &gt; &amp;infos, const <a class="el" href="structarmnn_1_1_base_descriptor.html">BaseDescriptor</a> &amp;descriptor, const <a class="el" href="classarmnn_1_1_optional.html">Optional</a>&lt; <a class="el" href="structarmnn_1_1_lstm_input_params_info.html">LstmInputParamsInfo</a> &gt; &amp;lstmParamsInfo=<a class="el" href="structarmnn_1_1_empty_optional.html">EmptyOptional</a>(), const <a class="el" href="classarmnn_1_1_optional.html">Optional</a>&lt; <a class="el" href="structarmnn_1_1_quantized_lstm_input_params_info.html">QuantizedLstmInputParamsInfo</a> &gt; &amp;quantizedLstmParamsInfo=<a class="el" href="structarmnn_1_1_empty_optional.html">EmptyOptional</a>(), <a class="el" href="classarmnn_1_1_optional.html">Optional</a>&lt; std::string &amp; &gt; reasonIfUnsupported=<a class="el" href="structarmnn_1_1_empty_optional.html">EmptyOptional</a>()) const</td></tr>
115<tr class="memdesc:ade82d7df4e18bdd77969958a8fccf10a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default implementation of the <a class="el" href="classarmnn_1_1_i_layer_support.html">ILayerSupport</a> interface, Backends should implement this as a switch statement for each of their LayerTypes calling their specific backend implementation of IsXXXLayerSupported. <a href="classarmnn_1_1_i_layer_support.html#ade82d7df4e18bdd77969958a8fccf10a">More...</a><br /></td></tr>
116<tr class="separator:ade82d7df4e18bdd77969958a8fccf10a"><td class="memSeparator" colspan="2">&#160;</td></tr>
117</table><table class="memberdecls">
118<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
119Protected Member Functions</h2></td></tr>
120<tr class="memitem:aab2a487bc88047443d8a0f87c3c40b8d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_i_layer_support.html#aab2a487bc88047443d8a0f87c3c40b8d">ILayerSupport</a> ()</td></tr>
121<tr class="separator:aab2a487bc88047443d8a0f87c3c40b8d"><td class="memSeparator" colspan="2">&#160;</td></tr>
122<tr class="memitem:a9e7f4f28576904804cd759e49173beeb"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_i_layer_support.html#a9e7f4f28576904804cd759e49173beeb">~ILayerSupport</a> ()</td></tr>
123<tr class="separator:a9e7f4f28576904804cd759e49173beeb"><td class="memSeparator" colspan="2">&#160;</td></tr>
124</table>
125<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
126<div class="textblock">
127<p class="definition">Definition at line <a class="el" href="_i_layer_support_8hpp_source.html#l00023">23</a> of file <a class="el" href="_i_layer_support_8hpp_source.html">ILayerSupport.hpp</a>.</p>
128</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
129<a id="aab2a487bc88047443d8a0f87c3c40b8d"></a>
130<h2 class="memtitle"><span class="permalink"><a href="#aab2a487bc88047443d8a0f87c3c40b8d">&#9670;&nbsp;</a></span>ILayerSupport()</h2>
131
132<div class="memitem">
133<div class="memproto">
134<table class="mlabels">
135 <tr>
136 <td class="mlabels-left">
137 <table class="memname">
138 <tr>
139 <td class="memname"><a class="el" href="classarmnn_1_1_i_layer_support.html">ILayerSupport</a> </td>
140 <td>(</td>
141 <td class="paramname"></td><td>)</td>
142 <td></td>
143 </tr>
144 </table>
145 </td>
146 <td class="mlabels-right">
147<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
148 </tr>
149</table>
150</div><div class="memdoc">
151
152<p class="definition">Definition at line <a class="el" href="_i_layer_support_8hpp_source.html#l00026">26</a> of file <a class="el" href="_i_layer_support_8hpp_source.html">ILayerSupport.hpp</a>.</p>
153<div class="fragment"><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;{}</div>
154</div><!-- fragment -->
155</div>
156</div>
157<a id="a9e7f4f28576904804cd759e49173beeb"></a>
158<h2 class="memtitle"><span class="permalink"><a href="#a9e7f4f28576904804cd759e49173beeb">&#9670;&nbsp;</a></span>~ILayerSupport()</h2>
159
160<div class="memitem">
161<div class="memproto">
162<table class="mlabels">
163 <tr>
164 <td class="mlabels-left">
165 <table class="memname">
166 <tr>
167 <td class="memname">virtual ~<a class="el" href="classarmnn_1_1_i_layer_support.html">ILayerSupport</a> </td>
168 <td>(</td>
169 <td class="paramname"></td><td>)</td>
170 <td></td>
171 </tr>
172 </table>
173 </td>
174 <td class="mlabels-right">
175<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
176 </tr>
177</table>
178</div><div class="memdoc">
179
180<p class="definition">Definition at line <a class="el" href="_i_layer_support_8hpp_source.html#l00027">27</a> of file <a class="el" href="_i_layer_support_8hpp_source.html">ILayerSupport.hpp</a>.</p>
181<div class="fragment"><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;{}</div>
182</div><!-- fragment -->
183</div>
184</div>
185<h2 class="groupheader">Member Function Documentation</h2>
186<a id="ade82d7df4e18bdd77969958a8fccf10a"></a>
187<h2 class="memtitle"><span class="permalink"><a href="#ade82d7df4e18bdd77969958a8fccf10a">&#9670;&nbsp;</a></span>IsLayerSupported()</h2>
188
189<div class="memitem">
190<div class="memproto">
191<table class="mlabels">
192 <tr>
193 <td class="mlabels-left">
194 <table class="memname">
195 <tr>
196 <td class="memname">bool IsLayerSupported </td>
197 <td>(</td>
198 <td class="paramtype">const <a class="el" href="namespacearmnn.html#a56943a0946e5f15e5e58054b8e7a04a4">LayerType</a> &amp;&#160;</td>
199 <td class="paramname"><em>type</em>, </td>
200 </tr>
201 <tr>
202 <td class="paramkey"></td>
203 <td></td>
204 <td class="paramtype">const std::vector&lt; <a class="el" href="classarmnn_1_1_tensor_info.html">TensorInfo</a> &gt; &amp;&#160;</td>
205 <td class="paramname"><em>infos</em>, </td>
206 </tr>
207 <tr>
208 <td class="paramkey"></td>
209 <td></td>
210 <td class="paramtype">const <a class="el" href="structarmnn_1_1_base_descriptor.html">BaseDescriptor</a> &amp;&#160;</td>
211 <td class="paramname"><em>descriptor</em>, </td>
212 </tr>
213 <tr>
214 <td class="paramkey"></td>
215 <td></td>
216 <td class="paramtype">const <a class="el" href="classarmnn_1_1_optional.html">Optional</a>&lt; <a class="el" href="structarmnn_1_1_lstm_input_params_info.html">LstmInputParamsInfo</a> &gt; &amp;&#160;</td>
217 <td class="paramname"><em>lstmParamsInfo</em> = <code><a class="el" href="structarmnn_1_1_empty_optional.html">EmptyOptional</a>()</code>, </td>
218 </tr>
219 <tr>
220 <td class="paramkey"></td>
221 <td></td>
222 <td class="paramtype">const <a class="el" href="classarmnn_1_1_optional.html">Optional</a>&lt; <a class="el" href="structarmnn_1_1_quantized_lstm_input_params_info.html">QuantizedLstmInputParamsInfo</a> &gt; &amp;&#160;</td>
223 <td class="paramname"><em>quantizedLstmParamsInfo</em> = <code><a class="el" href="structarmnn_1_1_empty_optional.html">EmptyOptional</a>()</code>, </td>
224 </tr>
225 <tr>
226 <td class="paramkey"></td>
227 <td></td>
228 <td class="paramtype"><a class="el" href="classarmnn_1_1_optional.html">Optional</a>&lt; std::string &amp; &gt;&#160;</td>
229 <td class="paramname"><em>reasonIfUnsupported</em> = <code><a class="el" href="structarmnn_1_1_empty_optional.html">EmptyOptional</a>()</code>&#160;</td>
230 </tr>
231 <tr>
232 <td></td>
233 <td>)</td>
234 <td></td><td> const</td>
235 </tr>
236 </table>
237 </td>
238 <td class="mlabels-right">
239<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
240 </tr>
241</table>
242</div><div class="memdoc">
243
244<p>Default implementation of the <a class="el" href="classarmnn_1_1_i_layer_support.html">ILayerSupport</a> interface, Backends should implement this as a switch statement for each of their LayerTypes calling their specific backend implementation of IsXXXLayerSupported. </p>
245
246<p>Reimplemented in <a class="el" href="classarmnn_1_1_layer_support_base.html#a4da81c0c187071252d23c014db1c867d">LayerSupportBase</a>, <a class="el" href="classarmnn_1_1_neon_layer_support.html#a1f75cea2b43e602f4b99d60375d41a8a">NeonLayerSupport</a>, <a class="el" href="classarmnn_1_1_cl_layer_support.html#a15dd64e49fe95a482dc93d3af8ac108c">ClLayerSupport</a>, <a class="el" href="classarmnn_1_1_gpu_fsa_layer_support.html#a1e128c847b11f20fdedc72ec2951424f">GpuFsaLayerSupport</a>, <a class="el" href="classarmnn_1_1_ref_layer_support.html#a1e128c847b11f20fdedc72ec2951424f">RefLayerSupport</a>, <a class="el" href="classarmnn_1_1_tosa_ref_layer_support.html#a1e128c847b11f20fdedc72ec2951424f">TosaRefLayerSupport</a>, and <a class="el" href="classsdb_1_1_sample_dynamic_layer_support.html#a4a60a937f9f39bc8916af863a305fea2">SampleDynamicLayerSupport</a>.</p>
247
248<p class="definition">Definition at line <a class="el" href="_i_layer_support_8cpp_source.html#l00017">17</a> of file <a class="el" href="_i_layer_support_8cpp_source.html">ILayerSupport.cpp</a>.</p>
249<div class="fragment"><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;{</div>
250<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; <a class="code" href="namespacearmnn.html#a44affeeb090c3c6a3062830562672e84">IgnoreUnused</a>(infos);</div>
251<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; <a class="code" href="namespacearmnn.html#a44affeeb090c3c6a3062830562672e84">IgnoreUnused</a>(descriptor);</div>
252<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; <a class="code" href="namespacearmnn.html#a44affeeb090c3c6a3062830562672e84">IgnoreUnused</a>(lstmParamsInfo);</div>
253<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; <a class="code" href="namespacearmnn.html#a44affeeb090c3c6a3062830562672e84">IgnoreUnused</a>(quantizedLstmParamsInfo);</div>
254<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; <a class="code" href="namespacearmnn.html#a44affeeb090c3c6a3062830562672e84">IgnoreUnused</a>(reasonIfUnsupported);</div>
255<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; <span class="keywordflow">switch</span> (type)</div>
256<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; {</div>
257<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; <span class="keywordflow">case</span> <a class="code" href="namespacearmnn.html#a56943a0946e5f15e5e58054b8e7a04a4a46f3ea056caa3126b91f3f70beea068c">LayerType::Map</a>:</div>
258<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
259<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <span class="keywordflow">case</span> <a class="code" href="namespacearmnn.html#a56943a0946e5f15e5e58054b8e7a04a4a48180ddd584de21589006d56a86d3410">LayerType::Unmap</a>:</div>
260<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
261<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <span class="keywordflow">default</span>:</div>
262<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
263<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; }</div>
264<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;}</div>
265</div><!-- fragment -->
266<p class="reference">References <a class="el" href="_ignore_unused_8hpp_source.html#l00014">armnn::IgnoreUnused()</a>, <a class="el" href="namespacearmnn.html#a56943a0946e5f15e5e58054b8e7a04a4a46f3ea056caa3126b91f3f70beea068c">armnn::Map</a>, and <a class="el" href="namespacearmnn.html#a56943a0946e5f15e5e58054b8e7a04a4a48180ddd584de21589006d56a86d3410">armnn::Unmap</a>.</p>
267
268</div>
269</div>
270<hr/>The documentation for this class was generated from the following files:<ul>
271<li>include/armnn/backends/<a class="el" href="_i_layer_support_8hpp_source.html">ILayerSupport.hpp</a></li>
272<li>src/armnn/<a class="el" href="_i_layer_support_8cpp_source.html">ILayerSupport.cpp</a></li>
273</ul>
274</div><!-- contents -->
275</div><!-- doc-content -->
276<div class="ttc" id="anamespacearmnn_html_a44affeeb090c3c6a3062830562672e84"><div class="ttname"><a href="namespacearmnn.html#a44affeeb090c3c6a3062830562672e84">armnn::IgnoreUnused</a></div><div class="ttdeci">void IgnoreUnused(Ts &amp;&amp;...)</div><div class="ttdef"><b>Definition:</b> <a href="_ignore_unused_8hpp_source.html#l00014">IgnoreUnused.hpp:14</a></div></div>
277<div class="ttc" id="anamespacearmnn_html_a56943a0946e5f15e5e58054b8e7a04a4a46f3ea056caa3126b91f3f70beea068c"><div class="ttname"><a href="namespacearmnn.html#a56943a0946e5f15e5e58054b8e7a04a4a46f3ea056caa3126b91f3f70beea068c">armnn::LayerType::Map</a></div><div class="ttdeci">@ Map</div></div>
278<div class="ttc" id="anamespacearmnn_html_a56943a0946e5f15e5e58054b8e7a04a4a48180ddd584de21589006d56a86d3410"><div class="ttname"><a href="namespacearmnn.html#a56943a0946e5f15e5e58054b8e7a04a4a48180ddd584de21589006d56a86d3410">armnn::LayerType::Unmap</a></div><div class="ttdeci">@ Unmap</div></div>
279<!-- start footer part -->
280<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
281 <ul>
282 <li class="navelem"><a class="el" href="namespacearmnn.html">armnn</a></li><li class="navelem"><a class="el" href="classarmnn_1_1_i_layer_support.html">ILayerSupport</a></li>
283 <li class="footer">Generated on Wed Feb 14 2024 16:36:22 for Arm NN by
284 <a href="http://www.doxygen.org/index.html">
285 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
286 </ul>
287</div>
288</body>
289</html>