Gitiles
Code Review Sign In
review.mlplatform.org / ml / armnn / 8efb48a6847c5cd166c561127ae6611150963ce3 / . / 23.05 / _shape_layer_8hpp_source.xhtml
blob: a43b3fa581adccdc4e181977aeb71daa18bcc75e [file] [log] [blame]
Nikhil Raj8efb48a2023-05-19 11:14:28 +0100[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.17"/>
12<meta name="robots" content="NOINDEX, NOFOLLOW" />
13<meta name="viewport" content="width=device-width, initial-scale=1"/>
14<title>ArmNN: src/armnn/layers/ShapeLayer.hpp Source File</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<link href="search/search.css" rel="stylesheet" type="text/css"/>
23<script type="text/javascript" src="search/searchdata.js"></script>
24<script type="text/javascript" src="search/search.js"></script>
25<script type="text/x-mathjax-config">
26 MathJax.Hub.Config({
27 extensions: ["tex2jax.js"],
28 jax: ["input/TeX","output/HTML-CSS"],
29});
30</script>
31<script type="text/javascript" async="async" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
32<link href="doxygen.css" rel="stylesheet" type="text/css" />
33<link href="stylesheet.css" rel="stylesheet" type="text/css"/>
34</head>
35<body>
36<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
37<div id="titlearea">
38<table cellspacing="0" cellpadding="0">
39 <tbody>
40 <tr style="height: 56px;">
41 <img alt="ArmNN" src="Arm_NN_horizontal_blue.png" style="max-width: 10rem; margin-top: .5rem; margin-left 10px"/>
42 <td style="padding-left: 0.5em;">
43 <div id="projectname">
44 &#160;<span id="projectnumber">23.05</span>
45 </div>
46 </td>
47 </tr>
48 </tbody>
49</table>
50</div>
51<!-- end header part -->
52<!-- Generated by Doxygen 1.8.17 -->
53<script type="text/javascript">
54/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
55var searchBox = new SearchBox("searchBox", "search",false,'Search');
56/* @license-end */
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/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
62$(function() {
63 initMenu('',true,false,'search.php','Search');
64 $(document).ready(function() { init_search(); });
65});
66/* @license-end */</script>
67<div id="main-nav"></div>
68</div><!-- top -->
69<div id="side-nav" class="ui-resizable side-nav-resizable">
70 <div id="nav-tree">
71 <div id="nav-tree-contents">
72 <div id="nav-sync" class="sync"></div>
73 </div>
74 </div>
75 <div id="splitbar" style="-moz-user-select:none;"
76 class="ui-resizable-handle">
77 </div>
78</div>
79<script type="text/javascript">
80/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
81$(document).ready(function(){initNavTree('_shape_layer_8hpp_source.xhtml',''); initResizable(); });
82/* @license-end */
83</script>
84<div id="doc-content">
85<!-- window showing the filter options -->
86<div id="MSearchSelectWindow"
87 onmouseover="return searchBox.OnSearchSelectShow()"
88 onmouseout="return searchBox.OnSearchSelectHide()"
89 onkeydown="return searchBox.OnSearchSelectKey(event)">
90</div>
91
92<!-- iframe showing the search results (closed by default) -->
93<div id="MSearchResultsWindow">
94<iframe src="javascript:void(0)" frameborder="0"
95 name="MSearchResults" id="MSearchResults">
96</iframe>
97</div>
98
99<div class="header">
100 <div class="headertitle">
101<div class="title">ShapeLayer.hpp</div> </div>
102</div><!--header-->
103<div class="contents">
104<a href="_shape_layer_8hpp.xhtml">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>
105<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">// Copyright © 2021 Arm Ltd and Contributors. All rights reserved.</span></div>
106<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">// SPDX-License-Identifier: MIT</span></div>
107<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">//</span></div>
108<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160; </div>
109<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor">#pragma once</span></div>
110<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160; </div>
111<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="_layer_with_parameters_8hpp.xhtml">LayerWithParameters.hpp</a>&quot;</span></div>
112<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160; </div>
113<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacearmnn.xhtml">armnn</a></div>
114<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;{</div>
115<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160; </div>
116<div class="line"><a name="l00013"></a><span class="lineno"><a class="line" href="classarmnn_1_1_shape_layer.xhtml"> 13</a></span>&#160;<span class="keyword">class </span><a class="code" href="classarmnn_1_1_shape_layer.xhtml">ShapeLayer</a> : <span class="keyword">public</span> <a class="code" href="classarmnn_1_1_layer.xhtml">Layer</a></div>
117<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;{</div>
118<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="keyword">public</span>:<span class="comment"></span></div>
119<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> /// Makes a workload for the Shape type.</span></div>
120<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment"> /// @param [in] graph The graph where this layer can be found.</span></div>
121<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment"> /// @param [in] factory The workload factory which will create the workload.</span></div>
122<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="comment"> /// @return A pointer to the created workload, or nullptr if not created.</span></div>
123<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="comment"></span> <span class="keyword">virtual</span> std::unique_ptr&lt;IWorkload&gt; <a class="code" href="classarmnn_1_1_shape_layer.xhtml#adfa912d0c4c6c00f1af2cbfa799572b7">CreateWorkload</a>(<span class="keyword">const</span> <a class="code" href="classarmnn_1_1_i_workload_factory.xhtml">IWorkloadFactory</a>&amp; factory) <span class="keyword">const override</span>;</div>
124<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="comment"></span> </div>
125<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="comment"> /// Creates a dynamically-allocated copy of this layer.</span></div>
126<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="comment"> /// @param [in] graph The graph into which this layer is being cloned.</span></div>
127<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="comment"></span> <a class="code" href="classarmnn_1_1_shape_layer.xhtml">ShapeLayer</a>* <a class="code" href="classarmnn_1_1_shape_layer.xhtml#a5cd87ec92bac76b14887717f91c561e1">Clone</a>(<a class="code" href="classarmnn_1_1_graph.xhtml">Graph</a>&amp; graph) <span class="keyword">const override</span>;</div>
128<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="comment"></span> </div>
129<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="comment"> /// Check if the input tensor shape(s)</span></div>
130<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="comment"> /// will lead to a valid configuration of @ref ShapeLayer.</span></div>
131<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="comment"> /// @param [in] shapeInferenceMethod Indicates if output shape shall be overwritten or just validated.</span></div>
132<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="classarmnn_1_1_shape_layer.xhtml#a8c8f543d7e9729362c266d12ec169966">ValidateTensorShapesFromInputs</a>() <span class="keyword">override</span>;</div>
133<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="comment"></span> </div>
134<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="comment"> /// By default returns inputShapes if the number of inputs are equal to number of outputs,</span></div>
135<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="comment"> /// otherwise infers the output shapes from given input shapes and layer properties.</span></div>
136<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="comment"> /// @param [in] inputShapes The input shapes layer has.</span></div>
137<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="comment"> /// @return A vector to the inferred output shape.</span></div>
138<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="comment"></span> std::vector&lt;TensorShape&gt; <a class="code" href="classarmnn_1_1_shape_layer.xhtml#a65ca562c882ad619684445a1402f415a">InferOutputShapes</a>(<span class="keyword">const</span> std::vector&lt;TensorShape&gt;&amp; inputShapes) <span class="keyword">const override</span>;</div>
139<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; </div>
140<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classarmnn_1_1_shape_layer.xhtml#a46fc3fdd4b2a5dd6d184e57983cf20bc">ExecuteStrategy</a>(<a class="code" href="classarmnn_1_1_i_strategy.xhtml">IStrategy</a>&amp; strategy) <span class="keyword">const override</span>;</div>
141<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; </div>
142<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;<span class="keyword">protected</span>:<span class="comment"></span></div>
143<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="comment"> /// Constructor to create a ShapeLayer.</span></div>
144<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="comment"> /// @param [in] name Optional name for the layer.</span></div>
145<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<span class="comment"></span> <a class="code" href="classarmnn_1_1_shape_layer.xhtml#a617c84869ebb7f91d779f3121c9cef85">ShapeLayer</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* name);</div>
146<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;<span class="comment"></span> </div>
147<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;<span class="comment"> /// Default destructor.</span></div>
148<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;<span class="comment"></span> <a class="code" href="classarmnn_1_1_shape_layer.xhtml#aa16f15674044e6a8fe4a2229f281f478">~ShapeLayer</a>() = <span class="keywordflow">default</span>;</div>
149<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;};</div>
150<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; </div>
151<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;} <span class="comment">// namespace armnn</span></div>
152</div><!-- fragment --></div><!-- contents -->
153</div><!-- doc-content -->
154<div class="ttc" id="aclassarmnn_1_1_shape_layer_xhtml_a65ca562c882ad619684445a1402f415a"><div class="ttname"><a href="classarmnn_1_1_shape_layer.xhtml#a65ca562c882ad619684445a1402f415a">armnn::ShapeLayer::InferOutputShapes</a></div><div class="ttdeci">std::vector&lt; TensorShape &gt; InferOutputShapes(const std::vector&lt; TensorShape &gt; &amp;inputShapes) const override</div><div class="ttdoc">By default returns inputShapes if the number of inputs are equal to number of outputs,...</div><div class="ttdef"><b>Definition:</b> <a href="_shape_layer_8cpp_source.xhtml#l00052">ShapeLayer.cpp:52</a></div></div>
155<div class="ttc" id="aclassarmnn_1_1_shape_layer_xhtml_aa16f15674044e6a8fe4a2229f281f478"><div class="ttname"><a href="classarmnn_1_1_shape_layer.xhtml#aa16f15674044e6a8fe4a2229f281f478">armnn::ShapeLayer::~ShapeLayer</a></div><div class="ttdeci">~ShapeLayer()=default</div><div class="ttdoc">Default destructor.</div></div>
156<div class="ttc" id="a_layer_with_parameters_8hpp_xhtml"><div class="ttname"><a href="_layer_with_parameters_8hpp.xhtml">LayerWithParameters.hpp</a></div></div>
157<div class="ttc" id="aclassarmnn_1_1_layer_xhtml"><div class="ttname"><a href="classarmnn_1_1_layer.xhtml">armnn::Layer</a></div><div class="ttdef"><b>Definition:</b> <a href="_layer_8hpp_source.xhtml#l00217">Layer.hpp:217</a></div></div>
158<div class="ttc" id="aclassarmnn_1_1_shape_layer_xhtml_a617c84869ebb7f91d779f3121c9cef85"><div class="ttname"><a href="classarmnn_1_1_shape_layer.xhtml#a617c84869ebb7f91d779f3121c9cef85">armnn::ShapeLayer::ShapeLayer</a></div><div class="ttdeci">ShapeLayer(const char *name)</div><div class="ttdoc">Constructor to create a ShapeLayer.</div><div class="ttdef"><b>Definition:</b> <a href="_shape_layer_8cpp_source.xhtml#l00019">ShapeLayer.cpp:19</a></div></div>
159<div class="ttc" id="aclassarmnn_1_1_shape_layer_xhtml_a5cd87ec92bac76b14887717f91c561e1"><div class="ttname"><a href="classarmnn_1_1_shape_layer.xhtml#a5cd87ec92bac76b14887717f91c561e1">armnn::ShapeLayer::Clone</a></div><div class="ttdeci">ShapeLayer * Clone(Graph &amp;graph) const override</div><div class="ttdoc">Creates a dynamically-allocated copy of this layer.</div><div class="ttdef"><b>Definition:</b> <a href="_shape_layer_8cpp_source.xhtml#l00032">ShapeLayer.cpp:32</a></div></div>
160<div class="ttc" id="aclassarmnn_1_1_i_workload_factory_xhtml"><div class="ttname"><a href="classarmnn_1_1_i_workload_factory.xhtml">armnn::IWorkloadFactory</a></div><div class="ttdef"><b>Definition:</b> <a href="_workload_factory_8hpp_source.xhtml#l00022">WorkloadFactory.hpp:22</a></div></div>
161<div class="ttc" id="aclassarmnn_1_1_shape_layer_xhtml_a46fc3fdd4b2a5dd6d184e57983cf20bc"><div class="ttname"><a href="classarmnn_1_1_shape_layer.xhtml#a46fc3fdd4b2a5dd6d184e57983cf20bc">armnn::ShapeLayer::ExecuteStrategy</a></div><div class="ttdeci">void ExecuteStrategy(IStrategy &amp;strategy) const override</div><div class="ttdoc">Apply a visitor to this layer.</div><div class="ttdef"><b>Definition:</b> <a href="_shape_layer_8cpp_source.xhtml#l00063">ShapeLayer.cpp:63</a></div></div>
162<div class="ttc" id="anamespacearmnn_xhtml"><div class="ttname"><a href="namespacearmnn.xhtml">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.xhtml#l00006">01_00_quick_start.dox:6</a></div></div>
163<div class="ttc" id="aclassarmnn_1_1_i_strategy_xhtml"><div class="ttname"><a href="classarmnn_1_1_i_strategy.xhtml">armnn::IStrategy</a></div><div class="ttdef"><b>Definition:</b> <a href="_i_strategy_8hpp_source.xhtml#l00016">IStrategy.hpp:16</a></div></div>
164<div class="ttc" id="aclassarmnn_1_1_shape_layer_xhtml_a8c8f543d7e9729362c266d12ec169966"><div class="ttname"><a href="classarmnn_1_1_shape_layer.xhtml#a8c8f543d7e9729362c266d12ec169966">armnn::ShapeLayer::ValidateTensorShapesFromInputs</a></div><div class="ttdeci">void ValidateTensorShapesFromInputs() override</div><div class="ttdoc">Check if the input tensor shape(s) will lead to a valid configuration of ShapeLayer.</div><div class="ttdef"><b>Definition:</b> <a href="_shape_layer_8cpp_source.xhtml#l00037">ShapeLayer.cpp:37</a></div></div>
165<div class="ttc" id="aclassarmnn_1_1_shape_layer_xhtml"><div class="ttname"><a href="classarmnn_1_1_shape_layer.xhtml">armnn::ShapeLayer</a></div><div class="ttdef"><b>Definition:</b> <a href="_shape_layer_8hpp_source.xhtml#l00013">ShapeLayer.hpp:13</a></div></div>
166<div class="ttc" id="aclassarmnn_1_1_graph_xhtml"><div class="ttname"><a href="classarmnn_1_1_graph.xhtml">armnn::Graph</a></div><div class="ttdef"><b>Definition:</b> <a href="_graph_8hpp_source.xhtml#l00030">Graph.hpp:30</a></div></div>
167<div class="ttc" id="aclassarmnn_1_1_shape_layer_xhtml_adfa912d0c4c6c00f1af2cbfa799572b7"><div class="ttname"><a href="classarmnn_1_1_shape_layer.xhtml#adfa912d0c4c6c00f1af2cbfa799572b7">armnn::ShapeLayer::CreateWorkload</a></div><div class="ttdeci">virtual std::unique_ptr&lt; IWorkload &gt; CreateWorkload(const IWorkloadFactory &amp;factory) const override</div><div class="ttdoc">Makes a workload for the Shape type.</div><div class="ttdef"><b>Definition:</b> <a href="_shape_layer_8cpp_source.xhtml#l00024">ShapeLayer.cpp:24</a></div></div>
168<!-- start footer part -->
169<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
170 <ul>
171 <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.xhtml">src</a></li><li class="navelem"><a class="el" href="dir_e0a84d05c80a2ef4231141dcbbeac5c8.xhtml">armnn</a></li><li class="navelem"><a class="el" href="dir_9da6642ce0fd5a8c83524f1b621275be.xhtml">layers</a></li><li class="navelem"><a class="el" href="_shape_layer_8hpp.xhtml">ShapeLayer.hpp</a></li>
172 <li class="footer">Generated on Thu May 18 2023 10:35:40 for ArmNN by
173 <a href="http://www.doxygen.org/index.html">
174 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
175 </ul>
176</div>
177</body>
178</html>