blob: 64d5c9ed0aebdccfb965e9c08fc8537e514170c1 [file] [log] [blame]
Nikhil Raj1dc83fe2024-05-16 09:47:51 +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: MaxMinIntoBoundedReluImpl 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.05</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_1optimizations_1_1_max_min_into_bounded_relu_impl.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-static-methods">Static Public Member Functions</a> &#124;
97<a href="#pro-methods">Protected Member Functions</a> &#124;
98<a href="classarmnn_1_1optimizations_1_1_max_min_into_bounded_relu_impl-members.html">List of all members</a> </div>
99 <div class="headertitle">
100<div class="title">MaxMinIntoBoundedReluImpl Class Reference</div> </div>
101</div><!--header-->
102<div class="contents">
103
104<p><code>#include &lt;<a class="el" href="_max_min_into_bounded_relu_8hpp_source.html">MaxMinIntoBoundedRelu.hpp</a>&gt;</code></p>
105<table class="memberdecls">
106<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
107Static Public Member Functions</h2></td></tr>
108<tr class="memitem:ab8beb4d0cfc5c103045f261ff726b08e"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1optimizations_1_1_max_min_into_bounded_relu_impl.html#ab8beb4d0cfc5c103045f261ff726b08e">Run</a> (<a class="el" href="classarmnn_1_1_graph.html">Graph</a> &amp;graph, <a class="el" href="classarmnn_1_1_input_slot.html">InputSlot</a> &amp;connection)</td></tr>
109<tr class="memdesc:ab8beb4d0cfc5c103045f261ff726b08e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Run for every exclusive connection between any Max &amp; Min layers The Max, Min and its associated constant inputs will be removed, and replaced with a BoundedRelu Activation. <a href="classarmnn_1_1optimizations_1_1_max_min_into_bounded_relu_impl.html#ab8beb4d0cfc5c103045f261ff726b08e">More...</a><br /></td></tr>
110<tr class="separator:ab8beb4d0cfc5c103045f261ff726b08e"><td class="memSeparator" colspan="2">&#160;</td></tr>
111</table><table class="memberdecls">
112<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
113Protected Member Functions</h2></td></tr>
114<tr class="memitem:a65db2d72b0776e98bacbd6037b374d09"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1optimizations_1_1_max_min_into_bounded_relu_impl.html#a65db2d72b0776e98bacbd6037b374d09">MaxMinIntoBoundedReluImpl</a> ()=default</td></tr>
115<tr class="separator:a65db2d72b0776e98bacbd6037b374d09"><td class="memSeparator" colspan="2">&#160;</td></tr>
116<tr class="memitem:a43b1f24af6a51c0e749e200d1bbcf765"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1optimizations_1_1_max_min_into_bounded_relu_impl.html#a43b1f24af6a51c0e749e200d1bbcf765">~MaxMinIntoBoundedReluImpl</a> ()=default</td></tr>
117<tr class="separator:a43b1f24af6a51c0e749e200d1bbcf765"><td class="memSeparator" colspan="2">&#160;</td></tr>
118</table>
119<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
120<div class="textblock">
121<p class="definition">Definition at line <a class="el" href="_max_min_into_bounded_relu_8hpp_source.html#l00013">13</a> of file <a class="el" href="_max_min_into_bounded_relu_8hpp_source.html">MaxMinIntoBoundedRelu.hpp</a>.</p>
122</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
123<a id="a65db2d72b0776e98bacbd6037b374d09"></a>
124<h2 class="memtitle"><span class="permalink"><a href="#a65db2d72b0776e98bacbd6037b374d09">&#9670;&nbsp;</a></span>MaxMinIntoBoundedReluImpl()</h2>
125
126<div class="memitem">
127<div class="memproto">
128<table class="mlabels">
129 <tr>
130 <td class="mlabels-left">
131 <table class="memname">
132 <tr>
133 <td class="memname"><a class="el" href="classarmnn_1_1optimizations_1_1_max_min_into_bounded_relu_impl.html">MaxMinIntoBoundedReluImpl</a> </td>
134 <td>(</td>
135 <td class="paramname"></td><td>)</td>
136 <td></td>
137 </tr>
138 </table>
139 </td>
140 <td class="mlabels-right">
141<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">default</span></span> </td>
142 </tr>
143</table>
144</div><div class="memdoc">
145
146</div>
147</div>
148<a id="a43b1f24af6a51c0e749e200d1bbcf765"></a>
149<h2 class="memtitle"><span class="permalink"><a href="#a43b1f24af6a51c0e749e200d1bbcf765">&#9670;&nbsp;</a></span>~MaxMinIntoBoundedReluImpl()</h2>
150
151<div class="memitem">
152<div class="memproto">
153<table class="mlabels">
154 <tr>
155 <td class="mlabels-left">
156 <table class="memname">
157 <tr>
158 <td class="memname">~<a class="el" href="classarmnn_1_1optimizations_1_1_max_min_into_bounded_relu_impl.html">MaxMinIntoBoundedReluImpl</a> </td>
159 <td>(</td>
160 <td class="paramname"></td><td>)</td>
161 <td></td>
162 </tr>
163 </table>
164 </td>
165 <td class="mlabels-right">
166<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">default</span></span> </td>
167 </tr>
168</table>
169</div><div class="memdoc">
170
171</div>
172</div>
173<h2 class="groupheader">Member Function Documentation</h2>
174<a id="ab8beb4d0cfc5c103045f261ff726b08e"></a>
175<h2 class="memtitle"><span class="permalink"><a href="#ab8beb4d0cfc5c103045f261ff726b08e">&#9670;&nbsp;</a></span>Run()</h2>
176
177<div class="memitem">
178<div class="memproto">
179<table class="mlabels">
180 <tr>
181 <td class="mlabels-left">
182 <table class="memname">
183 <tr>
184 <td class="memname">static void Run </td>
185 <td>(</td>
186 <td class="paramtype"><a class="el" href="classarmnn_1_1_graph.html">Graph</a> &amp;&#160;</td>
187 <td class="paramname"><em>graph</em>, </td>
188 </tr>
189 <tr>
190 <td class="paramkey"></td>
191 <td></td>
192 <td class="paramtype"><a class="el" href="classarmnn_1_1_input_slot.html">InputSlot</a> &amp;&#160;</td>
193 <td class="paramname"><em>connection</em>&#160;</td>
194 </tr>
195 <tr>
196 <td></td>
197 <td>)</td>
198 <td></td><td></td>
199 </tr>
200 </table>
201 </td>
202 <td class="mlabels-right">
203<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
204 </tr>
205</table>
206</div><div class="memdoc">
207
208<p>Run for every exclusive connection between any Max &amp; Min layers The Max, Min and its associated constant inputs will be removed, and replaced with a BoundedRelu Activation. </p>
209
210<p class="definition">Definition at line <a class="el" href="_max_min_into_bounded_relu_8hpp_source.html#l00018">18</a> of file <a class="el" href="_max_min_into_bounded_relu_8hpp_source.html">MaxMinIntoBoundedRelu.hpp</a>.</p>
211<div class="fragment"><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; {</div>
212<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; Layer&amp; base = connection.GetConnectedOutputSlot()-&gt;GetOwningLayer();</div>
213<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; Layer&amp; child = connection.GetOwningLayer();</div>
214<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; </div>
215<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; <span class="keyword">auto</span>&amp; maxLayer = *PolymorphicDowncast&lt;ElementwiseBinaryLayer*&gt;(&amp;base);</div>
216<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; <span class="keywordflow">if</span> (maxLayer.GetParameters().m_Operation != <a class="code" href="namespacearmnn.html#ac4f8557279754ed7b3f749d55b0e3047a8321e79c278ec510f63675c040594892">BinaryOperation::Maximum</a>)</div>
217<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; {</div>
218<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; <span class="keywordflow">return</span>;</div>
219<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; }</div>
220<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; <span class="keyword">auto</span>&amp; minLayer = *PolymorphicDowncast&lt;ElementwiseBinaryLayer*&gt;(&amp;child);</div>
221<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; <span class="keywordflow">if</span> (minLayer.GetParameters().m_Operation != <a class="code" href="namespacearmnn.html#ac4f8557279754ed7b3f749d55b0e3047aa1d0ec6d56f8833a078b5a7ac4caf2d4">BinaryOperation::Minimum</a>)</div>
222<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; {</div>
223<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; <span class="keywordflow">return</span>;</div>
224<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; }</div>
225<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; </div>
226<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <span class="keywordflow">if</span> (maxLayer.GetDataType() != minLayer.GetDataType())</div>
227<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; {</div>
228<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="keywordflow">return</span>;</div>
229<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; }</div>
230<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; </div>
231<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="comment">// get max and min values</span></div>
232<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; float_t maxValue;</div>
233<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="keywordflow">if</span> (!GetValue(maxLayer, maxValue))</div>
234<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; {</div>
235<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keywordflow">return</span>;</div>
236<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; }</div>
237<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; float_t minValue;</div>
238<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="keywordflow">if</span> (!GetValue(minLayer, minValue))</div>
239<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; {</div>
240<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="keywordflow">return</span>;</div>
241<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; }</div>
242<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; </div>
243<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="comment">// Save original parent output slot of the max layer</span></div>
244<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; OutputSlot&amp; parentOut = *maxLayer.GetInputSlot(0).GetConnectedOutputSlot();</div>
245<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; </div>
246<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <span class="comment">// Insert activation layer between max layer and its parent layer</span></div>
247<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; ActivationDescriptor boundedReluDescriptor(<a class="code" href="namespacearmnn.html#a56297e0f7b215eea46c818cb7528d9eaabc5a0f0d6e7cf7fca73299dcd46c0f0d">ActivationFunction::BoundedReLu</a>, minValue, maxValue);</div>
248<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <span class="keyword">const</span> std::string name = std::string(<span class="stringliteral">&quot;replaced-&quot;</span>) + maxLayer.GetName() + std::string(<span class="stringliteral">&quot;-&quot;</span>) + minLayer.GetName()</div>
249<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; + std::string(<span class="stringliteral">&quot;-with-BoundedRelu&quot;</span>);</div>
250<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <span class="keyword">auto</span>&amp; boundedReluLayer = *graph.InsertNewLayer&lt;ActivationLayer&gt;(maxLayer.GetInputSlot(0),</div>
251<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; boundedReluDescriptor,</div>
252<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; name.c_str());</div>
253<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; </div>
254<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; <span class="comment">// Reconnects with original parent.</span></div>
255<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; boundedReluLayer.GetOutputSlot().MoveAllConnections(parentOut);</div>
256<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; </div>
257<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; <span class="comment">// Moves connections in min layer output to parent layer.</span></div>
258<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <span class="comment">// Min layer will be removed as it&#39;s left unconnected.</span></div>
259<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; <span class="comment">// Max layer will be removed if left unconnected.</span></div>
260<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; minLayer.GetOutputSlot().MoveAllConnections(boundedReluLayer.GetOutputSlot());</div>
261<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; }</div>
262</div><!-- fragment -->
263<p class="reference">References <a class="el" href="namespacearmnn.html#a56297e0f7b215eea46c818cb7528d9eaabc5a0f0d6e7cf7fca73299dcd46c0f0d">armnn::BoundedReLu</a>, <a class="el" href="_layer_8hpp_source.html#l00056">InputSlot::GetConnectedOutputSlot()</a>, <a class="el" href="_layer_8hpp_source.html#l00339">Layer::GetOutputSlot()</a>, <a class="el" href="_layer_8hpp_source.html#l00053">InputSlot::GetOwningLayer()</a>, <a class="el" href="_layer_8hpp_source.html#l00132">OutputSlot::GetOwningLayer()</a>, <a class="el" href="_graph_8hpp_source.html#l00481">Graph::InsertNewLayer()</a>, <a class="el" href="namespacearmnn.html#ac4f8557279754ed7b3f749d55b0e3047a8321e79c278ec510f63675c040594892">armnn::Maximum</a>, <a class="el" href="namespacearmnn.html#ac4f8557279754ed7b3f749d55b0e3047aa1d0ec6d56f8833a078b5a7ac4caf2d4">armnn::Minimum</a>, and <a class="el" href="_layer_8cpp_source.html#l00156">OutputSlot::MoveAllConnections()</a>.</p>
264
265</div>
266</div>
267<hr/>The documentation for this class was generated from the following file:<ul>
268<li>src/armnn/optimizations/<a class="el" href="_max_min_into_bounded_relu_8hpp_source.html">MaxMinIntoBoundedRelu.hpp</a></li>
269</ul>
270</div><!-- contents -->
271</div><!-- doc-content -->
272<div class="ttc" id="anamespacearmnn_html_a56297e0f7b215eea46c818cb7528d9eaabc5a0f0d6e7cf7fca73299dcd46c0f0d"><div class="ttname"><a href="namespacearmnn.html#a56297e0f7b215eea46c818cb7528d9eaabc5a0f0d6e7cf7fca73299dcd46c0f0d">armnn::ActivationFunction::BoundedReLu</a></div><div class="ttdeci">@ BoundedReLu</div><div class="ttdoc">min(a, max(b, input)) ReLu1 &amp; ReLu6.</div></div>
273<div class="ttc" id="anamespacearmnn_html_ac4f8557279754ed7b3f749d55b0e3047a8321e79c278ec510f63675c040594892"><div class="ttname"><a href="namespacearmnn.html#ac4f8557279754ed7b3f749d55b0e3047a8321e79c278ec510f63675c040594892">armnn::BinaryOperation::Maximum</a></div><div class="ttdeci">@ Maximum</div></div>
274<div class="ttc" id="anamespacearmnn_html_ac4f8557279754ed7b3f749d55b0e3047aa1d0ec6d56f8833a078b5a7ac4caf2d4"><div class="ttname"><a href="namespacearmnn.html#ac4f8557279754ed7b3f749d55b0e3047aa1d0ec6d56f8833a078b5a7ac4caf2d4">armnn::BinaryOperation::Minimum</a></div><div class="ttdeci">@ Minimum</div></div>
275<!-- start footer part -->
276<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
277 <ul>
278 <li class="navelem"><a class="el" href="namespacearmnn.html">armnn</a></li><li class="navelem"><a class="el" href="namespacearmnn_1_1optimizations.html">optimizations</a></li><li class="navelem"><a class="el" href="classarmnn_1_1optimizations_1_1_max_min_into_bounded_relu_impl.html">MaxMinIntoBoundedReluImpl</a></li>
279 <li class="footer">Generated on Thu May 16 2024 09:32:00 for Arm NN by
280 <a href="http://www.doxygen.org/index.html">
281 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
282 </ul>
283</div>
284</body>
285</html>