blob: 5a0c90fbddbf934ad93d493a685b69d660aaeaaf [file] [log] [blame]
Nikhil Raj03c7ff32023-08-22 12:00:04 +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: include/armnn/backends/ILayerSupport.hpp Source File</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">
Nikhil Raj1dc83fe2024-05-16 09:47:51 +010039 &#160;<span id="projectnumber">24.05</span>
Nikhil Raj03c7ff32023-08-22 12:00:04 +010040 </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('_i_layer_support_8hpp_source.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="headertitle">
96<div class="title">ILayerSupport.hpp</div> </div>
97</div><!--header-->
98<div class="contents">
99<a href="_i_layer_support_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">//</span></div>
100<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">// Copyright © 2017 Arm Ltd and Contributors. All rights reserved.</span></div>
101<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">// SPDX-License-Identifier: MIT</span></div>
102<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">//</span></div>
103<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="preprocessor">#pragma once</span></div>
104<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160; </div>
105<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="_deprecated_8hpp.html">armnn/Deprecated.hpp</a>&gt;</span></div>
106<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="_descriptors_8hpp.html">armnn/Descriptors.hpp</a>&gt;</span></div>
107<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="_lstm_params_8hpp.html">armnn/LstmParams.hpp</a>&gt;</span></div>
108<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="_optional_8hpp.html">armnn/Optional.hpp</a>&gt;</span></div>
109<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="_quantized_lstm_params_8hpp.html">armnn/QuantizedLstmParams.hpp</a>&gt;</span></div>
110<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160; </div>
111<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#include &lt;cctype&gt;</span></div>
112<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor">#include &lt;functional&gt;</span></div>
113<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#include &lt;memory&gt;</span></div>
114<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div>
115<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; </div>
116<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacearmnn.html">armnn</a></div>
117<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;{</div>
118<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; </div>
119<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="keyword">class </span>TensorInfo;</div>
120<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; </div>
121<div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="classarmnn_1_1_i_layer_support.html"> 23</a></span>&#160;<span class="keyword">class </span><a class="code" href="classarmnn_1_1_i_layer_support.html">ILayerSupport</a></div>
122<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;{</div>
123<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="keyword">protected</span>:</div>
124<div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="classarmnn_1_1_i_layer_support.html#aab2a487bc88047443d8a0f87c3c40b8d"> 26</a></span>&#160; <a class="code" href="classarmnn_1_1_i_layer_support.html#aab2a487bc88047443d8a0f87c3c40b8d">ILayerSupport</a>() {}</div>
125<div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="classarmnn_1_1_i_layer_support.html#a9e7f4f28576904804cd759e49173beeb"> 27</a></span>&#160; <span class="keyword">virtual</span> <a class="code" href="classarmnn_1_1_i_layer_support.html#a9e7f4f28576904804cd759e49173beeb">~ILayerSupport</a>() {}</div>
126<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; </div>
127<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="keyword">public</span>:</div>
128<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classarmnn_1_1_i_layer_support.html#ade82d7df4e18bdd77969958a8fccf10a">IsLayerSupported</a>(<span class="keyword">const</span> <a class="code" href="namespacearmnn.html#a56943a0946e5f15e5e58054b8e7a04a4">LayerType</a>&amp; type,</div>
129<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; <span class="keyword">const</span> std::vector&lt;TensorInfo&gt;&amp; infos,</div>
130<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <span class="keyword">const</span> <a class="code" href="structarmnn_1_1_base_descriptor.html">BaseDescriptor</a>&amp; descriptor,</div>
131<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <span class="keyword">const</span> <a class="code" href="classarmnn_1_1_optional.html">Optional&lt;LstmInputParamsInfo&gt;</a>&amp; lstmParamsInfo = <a class="code" href="structarmnn_1_1_empty_optional.html">EmptyOptional</a>(),</div>
132<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <span class="keyword">const</span> <a class="code" href="classarmnn_1_1_optional.html">Optional&lt;QuantizedLstmInputParamsInfo&gt;</a>&amp; quantizedLstmParamsInfo =</div>
133<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <a class="code" href="structarmnn_1_1_empty_optional.html">EmptyOptional</a>(),</div>
134<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <a class="code" href="classarmnn_1_1_optional.html">Optional&lt;std::string&amp;&gt;</a> reasonIfUnsupported = <a class="code" href="structarmnn_1_1_empty_optional.html">EmptyOptional</a>()) <span class="keyword">const</span>;</div>
135<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; </div>
136<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;}; <span class="comment">// class ILayerSupport</span></div>
137<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; </div>
138<div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="namespacearmnn.html#a11fa919c11fe46aad613b2e960fcfe90"> 40</a></span>&#160;<span class="keyword">using</span> <a class="code" href="namespacearmnn.html#a11fa919c11fe46aad613b2e960fcfe90">ILayerSupportSharedPtr</a> = std::shared_ptr&lt;ILayerSupport&gt;;</div>
139<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; </div>
140<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;} <span class="comment">// namespace armnn</span></div>
141</div><!-- fragment --></div><!-- contents -->
142</div><!-- doc-content -->
143<div class="ttc" id="aclassarmnn_1_1_optional_html"><div class="ttname"><a href="classarmnn_1_1_optional.html">armnn::Optional</a></div><div class="ttdef"><b>Definition:</b> <a href="_optional_8hpp_source.html#l00270">Optional.hpp:270</a></div></div>
144<div class="ttc" id="aclassarmnn_1_1_i_layer_support_html_aab2a487bc88047443d8a0f87c3c40b8d"><div class="ttname"><a href="classarmnn_1_1_i_layer_support.html#aab2a487bc88047443d8a0f87c3c40b8d">armnn::ILayerSupport::ILayerSupport</a></div><div class="ttdeci">ILayerSupport()</div><div class="ttdef"><b>Definition:</b> <a href="_i_layer_support_8hpp_source.html#l00026">ILayerSupport.hpp:26</a></div></div>
145<div class="ttc" id="a_descriptors_8hpp_html"><div class="ttname"><a href="_descriptors_8hpp.html">Descriptors.hpp</a></div></div>
146<div class="ttc" id="a_deprecated_8hpp_html"><div class="ttname"><a href="_deprecated_8hpp.html">Deprecated.hpp</a></div></div>
147<div class="ttc" id="a_optional_8hpp_html"><div class="ttname"><a href="_optional_8hpp.html">Optional.hpp</a></div></div>
148<div class="ttc" id="a_lstm_params_8hpp_html"><div class="ttname"><a href="_lstm_params_8hpp.html">LstmParams.hpp</a></div></div>
149<div class="ttc" id="aclassarmnn_1_1_i_layer_support_html_ade82d7df4e18bdd77969958a8fccf10a"><div class="ttname"><a href="classarmnn_1_1_i_layer_support.html#ade82d7df4e18bdd77969958a8fccf10a">armnn::ILayerSupport::IsLayerSupported</a></div><div class="ttdeci">virtual bool IsLayerSupported(const LayerType &amp;type, const std::vector&lt; TensorInfo &gt; &amp;infos, const BaseDescriptor &amp;descriptor, const Optional&lt; LstmInputParamsInfo &gt; &amp;lstmParamsInfo=EmptyOptional(), const Optional&lt; QuantizedLstmInputParamsInfo &gt; &amp;quantizedLstmParamsInfo=EmptyOptional(), Optional&lt; std::string &amp; &gt; reasonIfUnsupported=EmptyOptional()) const</div><div class="ttdoc">Default implementation of the ILayerSupport interface, Backends should implement this as a switch sta...</div><div class="ttdef"><b>Definition:</b> <a href="_i_layer_support_8cpp_source.html#l00017">ILayerSupport.cpp:17</a></div></div>
150<div class="ttc" id="aclassarmnn_1_1_i_layer_support_html_a9e7f4f28576904804cd759e49173beeb"><div class="ttname"><a href="classarmnn_1_1_i_layer_support.html#a9e7f4f28576904804cd759e49173beeb">armnn::ILayerSupport::~ILayerSupport</a></div><div class="ttdeci">virtual ~ILayerSupport()</div><div class="ttdef"><b>Definition:</b> <a href="_i_layer_support_8hpp_source.html#l00027">ILayerSupport.hpp:27</a></div></div>
151<div class="ttc" id="astructarmnn_1_1_empty_optional_html"><div class="ttname"><a href="structarmnn_1_1_empty_optional.html">armnn::EmptyOptional</a></div><div class="ttdoc">EmptyOptional is used to initialize the Optional class in case we want to have default value for an O...</div><div class="ttdef"><b>Definition:</b> <a href="_optional_8hpp_source.html#l00032">Optional.hpp:32</a></div></div>
152<div class="ttc" id="astructarmnn_1_1_base_descriptor_html"><div class="ttname"><a href="structarmnn_1_1_base_descriptor.html">armnn::BaseDescriptor</a></div><div class="ttdoc">Base class for all descriptors.</div><div class="ttdef"><b>Definition:</b> <a href="_descriptors_8hpp_source.html#l00022">Descriptors.hpp:22</a></div></div>
153<div class="ttc" id="aclassarmnn_1_1_i_layer_support_html"><div class="ttname"><a href="classarmnn_1_1_i_layer_support.html">armnn::ILayerSupport</a></div><div class="ttdef"><b>Definition:</b> <a href="_i_layer_support_8hpp_source.html#l00023">ILayerSupport.hpp:23</a></div></div>
154<div class="ttc" id="anamespacearmnn_html"><div class="ttname"><a href="namespacearmnn.html">armnn</a></div><div class="ttdoc">Copyright (c) 2021 ARM Limited and Contributors.</div><div class="ttdef"><b>Definition:</b> <a href="01__00__quick__start_8dox_source.html#l00006">01_00_quick_start.dox:6</a></div></div>
155<div class="ttc" id="a_quantized_lstm_params_8hpp_html"><div class="ttname"><a href="_quantized_lstm_params_8hpp.html">QuantizedLstmParams.hpp</a></div></div>
156<div class="ttc" id="anamespacearmnn_html_a11fa919c11fe46aad613b2e960fcfe90"><div class="ttname"><a href="namespacearmnn.html#a11fa919c11fe46aad613b2e960fcfe90">armnn::ILayerSupportSharedPtr</a></div><div class="ttdeci">std::shared_ptr&lt; ILayerSupport &gt; ILayerSupportSharedPtr</div><div class="ttdef"><b>Definition:</b> <a href="_i_layer_support_8hpp_source.html#l00040">ILayerSupport.hpp:40</a></div></div>
Nikhil Raj6f92c8e2023-11-22 11:41:15 +0000157<div class="ttc" id="anamespacearmnn_html_a56943a0946e5f15e5e58054b8e7a04a4"><div class="ttname"><a href="namespacearmnn.html#a56943a0946e5f15e5e58054b8e7a04a4">armnn::LayerType</a></div><div class="ttdeci">LayerType</div><div class="ttdoc">When adding a new layer, adapt also the LastLayer enum value in the enum class LayerType below.</div><div class="ttdef"><b>Definition:</b> <a href="_types_8hpp_source.html#l00491">Types.hpp:491</a></div></div>
Nikhil Raj03c7ff32023-08-22 12:00:04 +0100158<!-- start footer part -->
159<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
160 <ul>
161 <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_2b72cc348e06937955e62ebdd8a13436.html">armnn</a></li><li class="navelem"><a class="el" href="dir_8946eb9d8f826e973720979438627a91.html">backends</a></li><li class="navelem"><a class="el" href="_i_layer_support_8hpp.html">ILayerSupport.hpp</a></li>
Nikhil Raj1dc83fe2024-05-16 09:47:51 +0100162 <li class="footer">Generated on Thu May 16 2024 09:31:43 for Arm NN by
Nikhil Raj03c7ff32023-08-22 12:00:04 +0100163 <a href="http://www.doxygen.org/index.html">
164 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
165 </ul>
166</div>
167</body>
168</html>