Gitiles
Code Review Sign In
review.mlplatform.org / ml / armnn / refs/heads/gh-pages / . / 24.02 / _reduce_layer_8hpp_source.html
blob: f3827c9553eea50fe68ad3ca1eb9753085e6e627 [file] [log] [blame]
Nikhil Raj38b600d2024-02-15 15:02:19 +0000[diff] [blame]1<!-- 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: src/armnn/layers/ReduceLayer.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">
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('_reduce_layer_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">ReduceLayer.hpp</div> </div>
97</div><!--header-->
98<div class="contents">
99<a href="_reduce_layer_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 © 2020 Samsung Electronics Co 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">// Copyright © 2023 Arm Ltd and Contributors. All rights reserved.</span></div>
102<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">// SPDX-License-Identifier: MIT</span></div>
103<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment">//</span></div>
104<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor">#pragma once</span></div>
105<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160; </div>
106<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.html">LayerWithParameters.hpp</a>&quot;</span></div>
107<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160; </div>
108<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacearmnn.html">armnn</a></div>
109<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;{</div>
110<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"></span> </div>
111<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment">/// This layer represents a reduction operation.</span></div>
112<div class="line"><a name="l00014"></a><span class="lineno"><a class="line" href="classarmnn_1_1_reduce_layer.html"> 14</a></span>&#160;<span class="comment"></span><span class="keyword">class </span><a class="code" href="classarmnn_1_1_reduce_layer.html">ReduceLayer</a> : <span class="keyword">public</span> <a class="code" href="classarmnn_1_1_layer_with_parameters.html">LayerWithParameters</a>&lt;ReduceDescriptor&gt;</div>
113<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;{</div>
114<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="keyword">public</span>:<span class="comment"></span></div>
115<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment"> /// Makes a workload for the Reduce type.</span></div>
116<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment"> /// @param [in] graph The graph where this layer can be found.</span></div>
117<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="comment"> /// @param [in] factory The workload factory which will create the workload.</span></div>
118<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="comment"> /// @return A pointer to the created workload, or nullptr if not created.</span></div>
119<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="comment"></span> <span class="keyword">virtual</span> std::unique_ptr&lt;IWorkload&gt;<a class="code" href="classarmnn_1_1_reduce_layer.html#adfa912d0c4c6c00f1af2cbfa799572b7">CreateWorkload</a>(<span class="keyword">const</span> <a class="code" href="classarmnn_1_1_i_workload_factory.html">IWorkloadFactory</a>&amp; factory) <span class="keyword">const override</span>;</div>
120<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="comment"></span> </div>
121<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="comment"> /// Creates a dynamically-allocated copy of this layer.</span></div>
122<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="comment"> /// @param [in] graph The graph into which this layer is being cloned.</span></div>
123<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="comment"></span> <a class="code" href="classarmnn_1_1_reduce_layer.html">ReduceLayer</a>* <a class="code" href="classarmnn_1_1_reduce_layer.html#a4de59b22933eabce862ae43fb24e0e1c">Clone</a>(<a class="code" href="classarmnn_1_1_graph.html">Graph</a>&amp; graph) <span class="keyword">const override</span>;</div>
124<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="comment"></span> </div>
125<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="comment"> /// By default returns inputShapes if the number of inputs are equal to number of outputs,</span></div>
126<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="comment"> /// otherwise infers the output shapes from given input shapes and layer properties.</span></div>
127<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="comment"> /// @param [in] inputShapes The input shapes layer has.</span></div>
128<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="comment"> /// @return A vector to the inferred output shape.</span></div>
129<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="comment"></span> std::vector&lt;TensorShape&gt; <a class="code" href="classarmnn_1_1_reduce_layer.html#a65ca562c882ad619684445a1402f415a">InferOutputShapes</a>(<span class="keyword">const</span> std::vector&lt;TensorShape&gt;&amp; inputShapes) <span class="keyword">const override</span>;</div>
130<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="comment"></span> </div>
131<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="comment"> /// Check if the input tensor shape(s)</span></div>
132<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="comment"> /// will lead to a valid configuration of @ref ReduceLayer.</span></div>
133<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="classarmnn_1_1_reduce_layer.html#a8c8f543d7e9729362c266d12ec169966">ValidateTensorShapesFromInputs</a>() <span class="keyword">override</span>;</div>
134<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; </div>
135<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_reduce_layer.html#a46fc3fdd4b2a5dd6d184e57983cf20bc">ExecuteStrategy</a>(<a class="code" href="classarmnn_1_1_i_strategy.html">IStrategy</a>&amp; strategy) <span class="keyword">const override</span>;</div>
136<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; </div>
137<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;<span class="keyword">protected</span>:<span class="comment"></span></div>
138<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="comment"> /// Constructor to create a ReduceLayer.</span></div>
139<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="comment"> /// @param [in] param ReduceDescriptor to configure the reduction operation.</span></div>
140<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<span class="comment"> /// @param [in] name Optional name for the layer.</span></div>
141<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;<span class="comment"></span> <a class="code" href="classarmnn_1_1_reduce_layer.html#ac06a623e2161c8754aa80020ed3530e0">ReduceLayer</a>(<span class="keyword">const</span> <a class="code" href="structarmnn_1_1_reduce_descriptor.html">ReduceDescriptor</a>&amp; param, <span class="keyword">const</span> <span class="keywordtype">char</span>* name);</div>
142<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;<span class="comment"></span> </div>
143<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;<span class="comment"> /// Default destructor</span></div>
144<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;<span class="comment"></span> <a class="code" href="classarmnn_1_1_reduce_layer.html#a3b3f3bc1bc9186f14ccdc469eabf5db9">~ReduceLayer</a>() = <span class="keywordflow">default</span>;</div>
145<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;};</div>
146<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; </div>
147<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;} <span class="comment">// namespace armnn</span></div>
148</div><!-- fragment --></div><!-- contents -->
149</div><!-- doc-content -->
150<div class="ttc" id="aclassarmnn_1_1_reduce_layer_html_ac06a623e2161c8754aa80020ed3530e0"><div class="ttname"><a href="classarmnn_1_1_reduce_layer.html#ac06a623e2161c8754aa80020ed3530e0">armnn::ReduceLayer::ReduceLayer</a></div><div class="ttdeci">ReduceLayer(const ReduceDescriptor &amp;param, const char *name)</div><div class="ttdoc">Constructor to create a ReduceLayer.</div><div class="ttdef"><b>Definition:</b> <a href="_reduce_layer_8cpp_source.html#l00018">ReduceLayer.cpp:18</a></div></div>
151<div class="ttc" id="aclassarmnn_1_1_i_strategy_html"><div class="ttname"><a href="classarmnn_1_1_i_strategy.html">armnn::IStrategy</a></div><div class="ttdef"><b>Definition:</b> <a href="_i_strategy_8hpp_source.html#l00016">IStrategy.hpp:16</a></div></div>
152<div class="ttc" id="aclassarmnn_1_1_layer_with_parameters_html"><div class="ttname"><a href="classarmnn_1_1_layer_with_parameters.html">armnn::LayerWithParameters</a></div><div class="ttdef"><b>Definition:</b> <a href="_layer_with_parameters_8hpp_source.html#l00014">LayerWithParameters.hpp:14</a></div></div>
153<div class="ttc" id="aclassarmnn_1_1_reduce_layer_html_a8c8f543d7e9729362c266d12ec169966"><div class="ttname"><a href="classarmnn_1_1_reduce_layer.html#a8c8f543d7e9729362c266d12ec169966">armnn::ReduceLayer::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 ReduceLayer.</div><div class="ttdef"><b>Definition:</b> <a href="_reduce_layer_8cpp_source.html#l00044">ReduceLayer.cpp:44</a></div></div>
154<div class="ttc" id="aclassarmnn_1_1_reduce_layer_html_a3b3f3bc1bc9186f14ccdc469eabf5db9"><div class="ttname"><a href="classarmnn_1_1_reduce_layer.html#a3b3f3bc1bc9186f14ccdc469eabf5db9">armnn::ReduceLayer::~ReduceLayer</a></div><div class="ttdeci">~ReduceLayer()=default</div><div class="ttdoc">Default destructor.</div></div>
155<div class="ttc" id="aclassarmnn_1_1_reduce_layer_html"><div class="ttname"><a href="classarmnn_1_1_reduce_layer.html">armnn::ReduceLayer</a></div><div class="ttdoc">This layer represents a reduction operation.</div><div class="ttdef"><b>Definition:</b> <a href="_reduce_layer_8hpp_source.html#l00014">ReduceLayer.hpp:14</a></div></div>
156<div class="ttc" id="aclassarmnn_1_1_i_workload_factory_html"><div class="ttname"><a href="classarmnn_1_1_i_workload_factory.html">armnn::IWorkloadFactory</a></div><div class="ttdef"><b>Definition:</b> <a href="_workload_factory_8hpp_source.html#l00022">WorkloadFactory.hpp:22</a></div></div>
157<div class="ttc" id="aclassarmnn_1_1_reduce_layer_html_a4de59b22933eabce862ae43fb24e0e1c"><div class="ttname"><a href="classarmnn_1_1_reduce_layer.html#a4de59b22933eabce862ae43fb24e0e1c">armnn::ReduceLayer::Clone</a></div><div class="ttdeci">ReduceLayer * 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="_reduce_layer_8cpp_source.html#l00034">ReduceLayer.cpp:34</a></div></div>
158<div class="ttc" id="a_layer_with_parameters_8hpp_html"><div class="ttname"><a href="_layer_with_parameters_8hpp.html">LayerWithParameters.hpp</a></div></div>
159<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>
160<div class="ttc" id="aclassarmnn_1_1_reduce_layer_html_a65ca562c882ad619684445a1402f415a"><div class="ttname"><a href="classarmnn_1_1_reduce_layer.html#a65ca562c882ad619684445a1402f415a">armnn::ReduceLayer::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="_reduce_layer_8cpp_source.html#l00062">ReduceLayer.cpp:62</a></div></div>
161<div class="ttc" id="aclassarmnn_1_1_reduce_layer_html_a46fc3fdd4b2a5dd6d184e57983cf20bc"><div class="ttname"><a href="classarmnn_1_1_reduce_layer.html#a46fc3fdd4b2a5dd6d184e57983cf20bc">armnn::ReduceLayer::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="_reduce_layer_8cpp_source.html#l00117">ReduceLayer.cpp:117</a></div></div>
162<div class="ttc" id="astructarmnn_1_1_reduce_descriptor_html"><div class="ttname"><a href="structarmnn_1_1_reduce_descriptor.html">armnn::ReduceDescriptor</a></div><div class="ttdoc">A ReduceDescriptor for the REDUCE operators.</div><div class="ttdef"><b>Definition:</b> <a href="_descriptors_8hpp_source.html#l01538">Descriptors.hpp:1538</a></div></div>
163<div class="ttc" id="aclassarmnn_1_1_reduce_layer_html_adfa912d0c4c6c00f1af2cbfa799572b7"><div class="ttname"><a href="classarmnn_1_1_reduce_layer.html#adfa912d0c4c6c00f1af2cbfa799572b7">armnn::ReduceLayer::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 Reduce type.</div><div class="ttdef"><b>Definition:</b> <a href="_reduce_layer_8cpp_source.html#l00023">ReduceLayer.cpp:23</a></div></div>
164<div class="ttc" id="aclassarmnn_1_1_graph_html"><div class="ttname"><a href="classarmnn_1_1_graph.html">armnn::Graph</a></div><div class="ttdef"><b>Definition:</b> <a href="_graph_8hpp_source.html#l00030">Graph.hpp:30</a></div></div>
165<!-- start footer part -->
166<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
167 <ul>
168 <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_e0a84d05c80a2ef4231141dcbbeac5c8.html">armnn</a></li><li class="navelem"><a class="el" href="dir_9da6642ce0fd5a8c83524f1b621275be.html">layers</a></li><li class="navelem"><a class="el" href="_reduce_layer_8hpp.html">ReduceLayer.hpp</a></li>
169 <li class="footer">Generated on Wed Feb 14 2024 16:36:14 for Arm NN by
170 <a href="http://www.doxygen.org/index.html">
171 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
172 </ul>
173</div>
174</body>
175</html>