Gitiles
Code Review Sign In
review.mlplatform.org / ml / armnn / 2624dd719a78d02e7500557d284191f90f7a707e / . / Documentation / structarmnn_1_1_l2_normalization_descriptor.xhtml
blob: c7704a66df24ad614fb3f61193b3d990b3b66797 [file] [log] [blame]
Ryan OSheade36e4a2020-03-13 16:26:19 +0000[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.13"/>
12<meta name="robots" content="NOINDEX, NOFOLLOW" />
13<meta name="viewport" content="width=device-width, initial-scale=1"/>
14<title>ArmNN: L2NormalizationDescriptor Struct Reference</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<script type="text/javascript">
23 $(document).ready(initResizable);
24</script>
25<link href="search/search.css" rel="stylesheet" type="text/css"/>
26<script type="text/javascript" src="search/searchdata.js"></script>
27<script type="text/javascript" src="search/search.js"></script>
28<script type="text/x-mathjax-config">
29 MathJax.Hub.Config({
30 extensions: ["tex2jax.js"],
31 jax: ["input/TeX","output/HTML-CSS"],
32});
33</script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
34<link href="doxygen.css" rel="stylesheet" type="text/css" />
35<link href="stylesheet.css" rel="stylesheet" type="text/css"/>
36</head>
37<body>
38<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
39<div id="titlearea">
40<table cellspacing="0" cellpadding="0">
41 <tbody>
42 <tr style="height: 56px;">
43 <img alt="ArmNN" src="Arm_NN_horizontal_blue.png" style="max-width: 10rem; margin-top: .5rem; margin-left 10px"/>
44 <td style="padding-left: 0.5em;">
45 <div id="projectname">
46 &#160;<span id="projectnumber">20.02</span>
47 </div>
48 </td>
49 </tr>
50 </tbody>
51</table>
52</div>
53<!-- end header part -->
54<!-- Generated by Doxygen 1.8.13 -->
55<script type="text/javascript">
56var searchBox = new SearchBox("searchBox", "search",false,'Search');
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$(function() {
62 initMenu('',true,false,'search.php','Search');
63 $(document).ready(function() { init_search(); });
64});
65</script>
66<div id="main-nav"></div>
67</div><!-- top -->
68<div id="side-nav" class="ui-resizable side-nav-resizable">
69 <div id="nav-tree">
70 <div id="nav-tree-contents">
71 <div id="nav-sync" class="sync"></div>
72 </div>
73 </div>
74 <div id="splitbar" style="-moz-user-select:none;"
75 class="ui-resizable-handle">
76 </div>
77</div>
78<script type="text/javascript">
79$(document).ready(function(){initNavTree('structarmnn_1_1_l2_normalization_descriptor.xhtml','');});
80</script>
81<div id="doc-content">
82<!-- window showing the filter options -->
83<div id="MSearchSelectWindow"
84 onmouseover="return searchBox.OnSearchSelectShow()"
85 onmouseout="return searchBox.OnSearchSelectHide()"
86 onkeydown="return searchBox.OnSearchSelectKey(event)">
87</div>
88
89<!-- iframe showing the search results (closed by default) -->
90<div id="MSearchResultsWindow">
91<iframe src="javascript:void(0)" frameborder="0"
92 name="MSearchResults" id="MSearchResults">
93</iframe>
94</div>
95
96<div class="header">
97 <div class="summary">
98<a href="#pub-methods">Public Member Functions</a> &#124;
99<a href="#pub-attribs">Public Attributes</a> &#124;
100<a href="structarmnn_1_1_l2_normalization_descriptor-members.xhtml">List of all members</a> </div>
101 <div class="headertitle">
102<div class="title">L2NormalizationDescriptor Struct Reference</div> </div>
103</div><!--header-->
104<div class="contents">
105
106<p>A <a class="el" href="structarmnn_1_1_l2_normalization_descriptor.xhtml" title="A L2NormalizationDescriptor for the L2NormalizationLayer. ">L2NormalizationDescriptor</a> for the <a class="el" href="classarmnn_1_1_l2_normalization_layer.xhtml" title="This layer represents a L2 normalization operation. ">L2NormalizationLayer</a>.
107 <a href="structarmnn_1_1_l2_normalization_descriptor.xhtml#details">More...</a></p>
108
109<p><code>#include &lt;<a class="el" href="_descriptors_8hpp_source.xhtml">Descriptors.hpp</a>&gt;</code></p>
110<table class="memberdecls">
111<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
112Public Member Functions</h2></td></tr>
113<tr class="memitem:a7c758226ee35a1387dff4fb8a5f14948"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_l2_normalization_descriptor.xhtml#a7c758226ee35a1387dff4fb8a5f14948">L2NormalizationDescriptor</a> ()</td></tr>
114<tr class="separator:a7c758226ee35a1387dff4fb8a5f14948"><td class="memSeparator" colspan="2">&#160;</td></tr>
115<tr class="memitem:affc4fe96bd046f459ae712bd811b9d28"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_l2_normalization_descriptor.xhtml#affc4fe96bd046f459ae712bd811b9d28">operator==</a> (const <a class="el" href="structarmnn_1_1_l2_normalization_descriptor.xhtml">L2NormalizationDescriptor</a> &amp;rhs) const</td></tr>
116<tr class="separator:affc4fe96bd046f459ae712bd811b9d28"><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="pub-attribs"></a>
119Public Attributes</h2></td></tr>
120<tr class="memitem:a11c821c7524251004a72ed13c510853c"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_l2_normalization_descriptor.xhtml#a11c821c7524251004a72ed13c510853c">m_Eps</a></td></tr>
121<tr class="memdesc:a11c821c7524251004a72ed13c510853c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Used to avoid dividing by zero. <a href="#a11c821c7524251004a72ed13c510853c">More...</a><br /></td></tr>
122<tr class="separator:a11c821c7524251004a72ed13c510853c"><td class="memSeparator" colspan="2">&#160;</td></tr>
123<tr class="memitem:a6089e1ca91914015777ea780a513131a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacearmnn.xhtml#ad1d5cce2d9e9a5d61c243e5c989112e0">DataLayout</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_l2_normalization_descriptor.xhtml#a6089e1ca91914015777ea780a513131a">m_DataLayout</a></td></tr>
124<tr class="memdesc:a6089e1ca91914015777ea780a513131a"><td class="mdescLeft">&#160;</td><td class="mdescRight">The data layout to be used (NCHW, NHWC). <a href="#a6089e1ca91914015777ea780a513131a">More...</a><br /></td></tr>
125<tr class="separator:a6089e1ca91914015777ea780a513131a"><td class="memSeparator" colspan="2">&#160;</td></tr>
126</table>
127<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
128<div class="textblock"><p>A <a class="el" href="structarmnn_1_1_l2_normalization_descriptor.xhtml" title="A L2NormalizationDescriptor for the L2NormalizationLayer. ">L2NormalizationDescriptor</a> for the <a class="el" href="classarmnn_1_1_l2_normalization_layer.xhtml" title="This layer represents a L2 normalization operation. ">L2NormalizationLayer</a>. </p>
129
130<p class="definition">Definition at line <a class="el" href="_descriptors_8hpp_source.xhtml#l00591">591</a> of file <a class="el" href="_descriptors_8hpp_source.xhtml">Descriptors.hpp</a>.</p>
131</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
132<a id="a7c758226ee35a1387dff4fb8a5f14948"></a>
133<h2 class="memtitle"><span class="permalink"><a href="#a7c758226ee35a1387dff4fb8a5f14948">&#9670;&nbsp;</a></span>L2NormalizationDescriptor()</h2>
134
135<div class="memitem">
136<div class="memproto">
137<table class="mlabels">
138 <tr>
139 <td class="mlabels-left">
140 <table class="memname">
141 <tr>
142 <td class="memname"><a class="el" href="structarmnn_1_1_l2_normalization_descriptor.xhtml">L2NormalizationDescriptor</a> </td>
143 <td>(</td>
144 <td class="paramname"></td><td>)</td>
145 <td></td>
146 </tr>
147 </table>
148 </td>
149 <td class="mlabels-right">
150<span class="mlabels"><span class="mlabel">inline</span></span> </td>
151 </tr>
152</table>
153</div><div class="memdoc">
154
155<p class="definition">Definition at line <a class="el" href="_descriptors_8hpp_source.xhtml#l00593">593</a> of file <a class="el" href="_descriptors_8hpp_source.xhtml">Descriptors.hpp</a>.</p>
156<div class="fragment"><div class="line"><a name="l00594"></a><span class="lineno"> 594</span>&#160; : <a class="code" href="structarmnn_1_1_l2_normalization_descriptor.xhtml#a11c821c7524251004a72ed13c510853c">m_Eps</a>(1e-12f)</div><div class="line"><a name="l00595"></a><span class="lineno"> 595</span>&#160; , <a class="code" href="structarmnn_1_1_l2_normalization_descriptor.xhtml#a6089e1ca91914015777ea780a513131a">m_DataLayout</a>(<a class="code" href="namespacearmnn.xhtml#ad1d5cce2d9e9a5d61c243e5c989112e0a6b99f356fe3b30a2a850b5ea897c289f">DataLayout::NCHW</a>)</div><div class="line"><a name="l00596"></a><span class="lineno"> 596</span>&#160; {}</div><div class="ttc" id="structarmnn_1_1_l2_normalization_descriptor_xhtml_a11c821c7524251004a72ed13c510853c"><div class="ttname"><a href="structarmnn_1_1_l2_normalization_descriptor.xhtml#a11c821c7524251004a72ed13c510853c">armnn::L2NormalizationDescriptor::m_Eps</a></div><div class="ttdeci">float m_Eps</div><div class="ttdoc">Used to avoid dividing by zero. </div><div class="ttdef"><b>Definition:</b> <a href="_descriptors_8hpp_source.xhtml#l00604">Descriptors.hpp:604</a></div></div>
157<div class="ttc" id="structarmnn_1_1_l2_normalization_descriptor_xhtml_a6089e1ca91914015777ea780a513131a"><div class="ttname"><a href="structarmnn_1_1_l2_normalization_descriptor.xhtml#a6089e1ca91914015777ea780a513131a">armnn::L2NormalizationDescriptor::m_DataLayout</a></div><div class="ttdeci">DataLayout m_DataLayout</div><div class="ttdoc">The data layout to be used (NCHW, NHWC). </div><div class="ttdef"><b>Definition:</b> <a href="_descriptors_8hpp_source.xhtml#l00606">Descriptors.hpp:606</a></div></div>
158<div class="ttc" id="namespacearmnn_xhtml_ad1d5cce2d9e9a5d61c243e5c989112e0a6b99f356fe3b30a2a850b5ea897c289f"><div class="ttname"><a href="namespacearmnn.xhtml#ad1d5cce2d9e9a5d61c243e5c989112e0a6b99f356fe3b30a2a850b5ea897c289f">armnn::DataLayout::NCHW</a></div></div>
159</div><!-- fragment -->
160</div>
161</div>
162<h2 class="groupheader">Member Function Documentation</h2>
163<a id="affc4fe96bd046f459ae712bd811b9d28"></a>
164<h2 class="memtitle"><span class="permalink"><a href="#affc4fe96bd046f459ae712bd811b9d28">&#9670;&nbsp;</a></span>operator==()</h2>
165
166<div class="memitem">
167<div class="memproto">
168<table class="mlabels">
169 <tr>
170 <td class="mlabels-left">
171 <table class="memname">
172 <tr>
173 <td class="memname">bool operator== </td>
174 <td>(</td>
175 <td class="paramtype">const <a class="el" href="structarmnn_1_1_l2_normalization_descriptor.xhtml">L2NormalizationDescriptor</a> &amp;&#160;</td>
176 <td class="paramname"><em>rhs</em></td><td>)</td>
177 <td> const</td>
178 </tr>
179 </table>
180 </td>
181 <td class="mlabels-right">
182<span class="mlabels"><span class="mlabel">inline</span></span> </td>
183 </tr>
184</table>
185</div><div class="memdoc">
186
187<p class="definition">Definition at line <a class="el" href="_descriptors_8hpp_source.xhtml#l00598">598</a> of file <a class="el" href="_descriptors_8hpp_source.xhtml">Descriptors.hpp</a>.</p>
188
189<p class="reference">References <a class="el" href="_descriptors_8hpp_source.xhtml#l00606">L2NormalizationDescriptor::m_DataLayout</a>, and <a class="el" href="_descriptors_8hpp_source.xhtml#l00604">L2NormalizationDescriptor::m_Eps</a>.</p>
190<div class="fragment"><div class="line"><a name="l00599"></a><span class="lineno"> 599</span>&#160; {</div><div class="line"><a name="l00600"></a><span class="lineno"> 600</span>&#160; <span class="keywordflow">return</span> <a class="code" href="structarmnn_1_1_l2_normalization_descriptor.xhtml#a11c821c7524251004a72ed13c510853c">m_Eps</a> == rhs.m_Eps &amp;&amp; <a class="code" href="structarmnn_1_1_l2_normalization_descriptor.xhtml#a6089e1ca91914015777ea780a513131a">m_DataLayout</a> == rhs.m_DataLayout;</div><div class="line"><a name="l00601"></a><span class="lineno"> 601</span>&#160; }</div><div class="ttc" id="structarmnn_1_1_l2_normalization_descriptor_xhtml_a11c821c7524251004a72ed13c510853c"><div class="ttname"><a href="structarmnn_1_1_l2_normalization_descriptor.xhtml#a11c821c7524251004a72ed13c510853c">armnn::L2NormalizationDescriptor::m_Eps</a></div><div class="ttdeci">float m_Eps</div><div class="ttdoc">Used to avoid dividing by zero. </div><div class="ttdef"><b>Definition:</b> <a href="_descriptors_8hpp_source.xhtml#l00604">Descriptors.hpp:604</a></div></div>
191<div class="ttc" id="structarmnn_1_1_l2_normalization_descriptor_xhtml_a6089e1ca91914015777ea780a513131a"><div class="ttname"><a href="structarmnn_1_1_l2_normalization_descriptor.xhtml#a6089e1ca91914015777ea780a513131a">armnn::L2NormalizationDescriptor::m_DataLayout</a></div><div class="ttdeci">DataLayout m_DataLayout</div><div class="ttdoc">The data layout to be used (NCHW, NHWC). </div><div class="ttdef"><b>Definition:</b> <a href="_descriptors_8hpp_source.xhtml#l00606">Descriptors.hpp:606</a></div></div>
192</div><!-- fragment -->
193</div>
194</div>
195<h2 class="groupheader">Member Data Documentation</h2>
196<a id="a6089e1ca91914015777ea780a513131a"></a>
197<h2 class="memtitle"><span class="permalink"><a href="#a6089e1ca91914015777ea780a513131a">&#9670;&nbsp;</a></span>m_DataLayout</h2>
198
199<div class="memitem">
200<div class="memproto">
201 <table class="memname">
202 <tr>
203 <td class="memname"><a class="el" href="namespacearmnn.xhtml#ad1d5cce2d9e9a5d61c243e5c989112e0">DataLayout</a> m_DataLayout</td>
204 </tr>
205 </table>
206</div><div class="memdoc">
207
208<p>The data layout to be used (NCHW, NHWC). </p>
209
210<p class="definition">Definition at line <a class="el" href="_descriptors_8hpp_source.xhtml#l00606">606</a> of file <a class="el" href="_descriptors_8hpp_source.xhtml">Descriptors.hpp</a>.</p>
211
212<p class="reference">Referenced by <a class="el" href="_serializer_tests_8cpp_source.xhtml#l01316">BOOST_AUTO_TEST_CASE()</a>, <a class="el" href="_tf_lite_parser_8cpp_source.xhtml#l00605">TfLiteParser::CreateNetworkFromBinary()</a>, <a class="el" href="_ref_l2_normalization_workload_8cpp_source.xhtml#l00028">RefL2NormalizationWorkload::Execute()</a>, <a class="el" href="_deserializer_8cpp_source.xhtml#l00764">Deserializer::GetNetworkOutputBindingInfo()</a>, <a class="el" href="_l2_normalization_test_impl_8cpp_source.xhtml#l00672">L2Normalization2dShapeTest()</a>, <a class="el" href="_descriptors_8hpp_source.xhtml#l00598">L2NormalizationDescriptor::operator==()</a>, <a class="el" href="_serialize_layer_parameters_8cpp_source.xhtml#l00240">StringifyLayerParameters&lt; L2NormalizationDescriptor &gt;::Serialize()</a>, and <a class="el" href="_serializer_8cpp_source.xhtml#l00521">SerializerVisitor::VisitL2NormalizationLayer()</a>.</p>
213
214</div>
215</div>
216<a id="a11c821c7524251004a72ed13c510853c"></a>
217<h2 class="memtitle"><span class="permalink"><a href="#a11c821c7524251004a72ed13c510853c">&#9670;&nbsp;</a></span>m_Eps</h2>
218
219<div class="memitem">
220<div class="memproto">
221 <table class="memname">
222 <tr>
223 <td class="memname">float m_Eps</td>
224 </tr>
225 </table>
226</div><div class="memdoc">
227
228<p>Used to avoid dividing by zero. </p>
229
230<p class="definition">Definition at line <a class="el" href="_descriptors_8hpp_source.xhtml#l00604">604</a> of file <a class="el" href="_descriptors_8hpp_source.xhtml">Descriptors.hpp</a>.</p>
231
232<p class="reference">Referenced by <a class="el" href="_ref_l2_normalization_workload_8cpp_source.xhtml#l00028">RefL2NormalizationWorkload::Execute()</a>, <a class="el" href="_deserializer_8cpp_source.xhtml#l00764">Deserializer::GetNetworkOutputBindingInfo()</a>, <a class="el" href="_l2_normalization_test_impl_8cpp_source.xhtml#l00672">L2Normalization2dShapeTest()</a>, <a class="el" href="_l2_normalization_test_impl_8cpp_source.xhtml#l00547">L2NormalizationDefaultEpsilonTest()</a>, <a class="el" href="_descriptors_8hpp_source.xhtml#l00598">L2NormalizationDescriptor::operator==()</a>, <a class="el" href="_serialize_layer_parameters_8cpp_source.xhtml#l00240">StringifyLayerParameters&lt; L2NormalizationDescriptor &gt;::Serialize()</a>, and <a class="el" href="_serializer_8cpp_source.xhtml#l00521">SerializerVisitor::VisitL2NormalizationLayer()</a>.</p>
233
234</div>
235</div>
236<hr/>The documentation for this struct was generated from the following file:<ul>
237<li>include/armnn/<a class="el" href="_descriptors_8hpp_source.xhtml">Descriptors.hpp</a></li>
238</ul>
239</div><!-- contents -->
240</div><!-- doc-content -->
241<!-- start footer part -->
242<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
243 <ul>
244 <li class="navelem"><a class="el" href="namespacearmnn.xhtml">armnn</a></li><li class="navelem"><a class="el" href="structarmnn_1_1_l2_normalization_descriptor.xhtml">L2NormalizationDescriptor</a></li>
245 <li class="footer">Generated on Fri Mar 13 2020 16:09:18 for ArmNN by
246 <a href="http://www.doxygen.org/index.html">
247 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
248 </ul>
249</div>
250</body>
251</html>