arm_compute v18.05
[platform/upstream/armcl.git] / documentation / classarm__compute_1_1_n_e_l2_normalize_layer_kernel.xhtml
1 <!-- HTML header for doxygen 1.8.9.1-->
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.11"/>
8 <meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
9 <title>Compute Library: NEL2NormalizeLayerKernel 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 <script type="text/javascript">
18   $(document).ready(initResizable);
19   $(window).load(resizeHeight);
20 </script>
21 <link href="search/search.css" rel="stylesheet" type="text/css"/>
22 <script type="text/javascript" src="search/searchdata.js"></script>
23 <script type="text/javascript" src="search/search.js"></script>
24 <script type="text/javascript">
25   $(document).ready(function() { init_search(); });
26 </script>
27 <script type="text/x-mathjax-config">
28   MathJax.Hub.Config({
29     extensions: ["tex2jax.js"],
30     jax: ["input/TeX","output/HTML-CSS"],
31 });
32 </script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
33 <link href="doxygen.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   <td style="padding-left: 0.5em;">
42    <div id="projectname">Compute Library
43    &#160;<span id="projectnumber">18.05</span>
44    </div>
45   </td>
46  </tr>
47  </tbody>
48 </table>
49 </div>
50 <!-- end header part -->
51 <!-- Generated by Doxygen 1.8.11 -->
52 <script type="text/javascript">
53 var searchBox = new SearchBox("searchBox", "search",false,'Search');
54 </script>
55   <div id="navrow1" class="tabs">
56     <ul class="tablist">
57       <li><a href="index.xhtml"><span>Main&#160;Page</span></a></li>
58       <li><a href="pages.xhtml"><span>Related&#160;Pages</span></a></li>
59       <li><a href="namespaces.xhtml"><span>Namespaces</span></a></li>
60       <li class="current"><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
61       <li><a href="files.xhtml"><span>Files</span></a></li>
62       <li>
63         <div id="MSearchBox" class="MSearchBoxInactive">
64         <span class="left">
65           <img id="MSearchSelect" src="search/mag_sel.png"
66                onmouseover="return searchBox.OnSearchSelectShow()"
67                onmouseout="return searchBox.OnSearchSelectHide()"
68                alt=""/>
69           <input type="text" id="MSearchField" value="Search" accesskey="S"
70                onfocus="searchBox.OnSearchFieldFocus(true)" 
71                onblur="searchBox.OnSearchFieldFocus(false)" 
72                onkeyup="searchBox.OnSearchFieldChange(event)"/>
73           </span><span class="right">
74             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
75           </span>
76         </div>
77       </li>
78     </ul>
79   </div>
80   <div id="navrow2" class="tabs2">
81     <ul class="tablist">
82       <li><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
83       <li><a href="classes.xhtml"><span>Data&#160;Structure&#160;Index</span></a></li>
84       <li><a href="inherits.xhtml"><span>Class&#160;Hierarchy</span></a></li>
85       <li><a href="functions.xhtml"><span>Data&#160;Fields</span></a></li>
86     </ul>
87   </div>
88 </div><!-- top -->
89 <div id="side-nav" class="ui-resizable side-nav-resizable">
90   <div id="nav-tree">
91     <div id="nav-tree-contents">
92       <div id="nav-sync" class="sync"></div>
93     </div>
94   </div>
95   <div id="splitbar" style="-moz-user-select:none;" 
96        class="ui-resizable-handle">
97   </div>
98 </div>
99 <script type="text/javascript">
100 $(document).ready(function(){initNavTree('classarm__compute_1_1_n_e_l2_normalize_layer_kernel.xhtml','');});
101 </script>
102 <div id="doc-content">
103 <!-- window showing the filter options -->
104 <div id="MSearchSelectWindow"
105      onmouseover="return searchBox.OnSearchSelectShow()"
106      onmouseout="return searchBox.OnSearchSelectHide()"
107      onkeydown="return searchBox.OnSearchSelectKey(event)">
108 </div>
109
110 <!-- iframe showing the search results (closed by default) -->
111 <div id="MSearchResultsWindow">
112 <iframe src="javascript:void(0)" frameborder="0" 
113         name="MSearchResults" id="MSearchResults">
114 </iframe>
115 </div>
116
117 <div class="header">
118   <div class="summary">
119 <a href="#pub-methods">Public Member Functions</a> &#124;
120 <a href="#pub-static-methods">Static Public Member Functions</a>  </div>
121   <div class="headertitle">
122 <div class="title">NEL2NormalizeLayerKernel Class Reference</div>  </div>
123 </div><!--header-->
124 <div class="contents">
125
126 <p>Interface for performing a L2 normalize on a given axis given the square sum of it in this axis.  
127  <a href="classarm__compute_1_1_n_e_l2_normalize_layer_kernel.xhtml#details">More...</a></p>
128
129 <p><code>#include &lt;<a class="el" href="_n_e_l2_normalize_layer_kernel_8h_source.xhtml">NEL2NormalizeLayerKernel.h</a>&gt;</code></p>
130 <div class="dynheader">
131 Collaboration diagram for NEL2NormalizeLayerKernel:</div>
132 <div class="dyncontent">
133 <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_n_e_l2_normalize_layer_kernel__coll__graph.svg" width="206" height="187"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
134 </div>
135 <center><span class="legend">[<a target="top" href="graph_legend.xhtml">legend</a>]</span></center></div>
136 <table class="memberdecls">
137 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
138 Public Member Functions</h2></td></tr>
139 <tr class="memitem:ab5656bb5b6334bdbe6e606c715872828"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_l2_normalize_layer_kernel.xhtml#ab5656bb5b6334bdbe6e606c715872828">name</a> () const override</td></tr>
140 <tr class="memdesc:ab5656bb5b6334bdbe6e606c715872828"><td class="mdescLeft">&#160;</td><td class="mdescRight">Name of the kernel.  <a href="#ab5656bb5b6334bdbe6e606c715872828">More...</a><br /></td></tr>
141 <tr class="separator:ab5656bb5b6334bdbe6e606c715872828"><td class="memSeparator" colspan="2">&#160;</td></tr>
142 <tr class="memitem:a074123c53d349a9f418a7a269e331230"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_l2_normalize_layer_kernel.xhtml#a074123c53d349a9f418a7a269e331230">NEL2NormalizeLayerKernel</a> ()</td></tr>
143 <tr class="memdesc:a074123c53d349a9f418a7a269e331230"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor.  <a href="#a074123c53d349a9f418a7a269e331230">More...</a><br /></td></tr>
144 <tr class="separator:a074123c53d349a9f418a7a269e331230"><td class="memSeparator" colspan="2">&#160;</td></tr>
145 <tr class="memitem:a82265061e07c888085faad1ec861d507"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_l2_normalize_layer_kernel.xhtml#a82265061e07c888085faad1ec861d507">NEL2NormalizeLayerKernel</a> (const <a class="el" href="classarm__compute_1_1_n_e_l2_normalize_layer_kernel.xhtml">NEL2NormalizeLayerKernel</a> &amp;)=delete</td></tr>
146 <tr class="memdesc:a82265061e07c888085faad1ec861d507"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent instances of this class from being copied (As this class contains pointers)  <a href="#a82265061e07c888085faad1ec861d507">More...</a><br /></td></tr>
147 <tr class="separator:a82265061e07c888085faad1ec861d507"><td class="memSeparator" colspan="2">&#160;</td></tr>
148 <tr class="memitem:a8028a2c0f5d9fedccbaa8b10c91fcacc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_n_e_l2_normalize_layer_kernel.xhtml">NEL2NormalizeLayerKernel</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_l2_normalize_layer_kernel.xhtml#a8028a2c0f5d9fedccbaa8b10c91fcacc">operator=</a> (const <a class="el" href="classarm__compute_1_1_n_e_l2_normalize_layer_kernel.xhtml">NEL2NormalizeLayerKernel</a> &amp;)=delete</td></tr>
149 <tr class="memdesc:a8028a2c0f5d9fedccbaa8b10c91fcacc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent instances of this class from being copied (As this class contains pointers)  <a href="#a8028a2c0f5d9fedccbaa8b10c91fcacc">More...</a><br /></td></tr>
150 <tr class="separator:a8028a2c0f5d9fedccbaa8b10c91fcacc"><td class="memSeparator" colspan="2">&#160;</td></tr>
151 <tr class="memitem:a52cd2d465ac76389e383fda9997be37b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_l2_normalize_layer_kernel.xhtml#a52cd2d465ac76389e383fda9997be37b">NEL2NormalizeLayerKernel</a> (<a class="el" href="classarm__compute_1_1_n_e_l2_normalize_layer_kernel.xhtml">NEL2NormalizeLayerKernel</a> &amp;&amp;)=default</td></tr>
152 <tr class="memdesc:a52cd2d465ac76389e383fda9997be37b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be moved.  <a href="#a52cd2d465ac76389e383fda9997be37b">More...</a><br /></td></tr>
153 <tr class="separator:a52cd2d465ac76389e383fda9997be37b"><td class="memSeparator" colspan="2">&#160;</td></tr>
154 <tr class="memitem:a4cc3301a251cb2c41fba0752ea047781"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_n_e_l2_normalize_layer_kernel.xhtml">NEL2NormalizeLayerKernel</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_l2_normalize_layer_kernel.xhtml#a4cc3301a251cb2c41fba0752ea047781">operator=</a> (<a class="el" href="classarm__compute_1_1_n_e_l2_normalize_layer_kernel.xhtml">NEL2NormalizeLayerKernel</a> &amp;&amp;)=default</td></tr>
155 <tr class="memdesc:a4cc3301a251cb2c41fba0752ea047781"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be moved.  <a href="#a4cc3301a251cb2c41fba0752ea047781">More...</a><br /></td></tr>
156 <tr class="separator:a4cc3301a251cb2c41fba0752ea047781"><td class="memSeparator" colspan="2">&#160;</td></tr>
157 <tr class="memitem:af780d4877cb699566c6dca8e695e3d84"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_l2_normalize_layer_kernel.xhtml#af780d4877cb699566c6dca8e695e3d84">~NEL2NormalizeLayerKernel</a> ()=default</td></tr>
158 <tr class="memdesc:af780d4877cb699566c6dca8e695e3d84"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default destructor.  <a href="#af780d4877cb699566c6dca8e695e3d84">More...</a><br /></td></tr>
159 <tr class="separator:af780d4877cb699566c6dca8e695e3d84"><td class="memSeparator" colspan="2">&#160;</td></tr>
160 <tr class="memitem:a7b9a0d39ba4aa3e6feba587a149d69e5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_l2_normalize_layer_kernel.xhtml#a7b9a0d39ba4aa3e6feba587a149d69e5">configure</a> (const <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *input, const <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *<a class="el" href="reduction__operation_8cl.xhtml#ab0df00f5333da51860deb93deb44a782">sum</a>, <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *output, unsigned int axis, float epsilon)</td></tr>
161 <tr class="memdesc:a7b9a0d39ba4aa3e6feba587a149d69e5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the input and output tensors.  <a href="#a7b9a0d39ba4aa3e6feba587a149d69e5">More...</a><br /></td></tr>
162 <tr class="separator:a7b9a0d39ba4aa3e6feba587a149d69e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
163 <tr class="memitem:a112b35dd205c62ea6ed1447ef226da82"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_l2_normalize_layer_kernel.xhtml#a112b35dd205c62ea6ed1447ef226da82">run</a> (const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> &amp;<a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a3f5646133956f06348b310ccc3d36353">window</a>, const <a class="el" href="structarm__compute_1_1_thread_info.xhtml">ThreadInfo</a> &amp;info) override</td></tr>
164 <tr class="memdesc:a112b35dd205c62ea6ed1447ef226da82"><td class="mdescLeft">&#160;</td><td class="mdescRight">Execute the kernel on the passed window.  <a href="#a112b35dd205c62ea6ed1447ef226da82">More...</a><br /></td></tr>
165 <tr class="separator:a112b35dd205c62ea6ed1447ef226da82"><td class="memSeparator" colspan="2">&#160;</td></tr>
166 <tr class="inherit_header pub_methods_classarm__compute_1_1_i_c_p_p_kernel"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarm__compute_1_1_i_c_p_p_kernel')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classarm__compute_1_1_i_c_p_p_kernel.xhtml">ICPPKernel</a></td></tr>
167 <tr class="memitem:a033d17a97e07cea7fe83eefcf23540f6 inherit pub_methods_classarm__compute_1_1_i_c_p_p_kernel"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_p_p_kernel.xhtml#a033d17a97e07cea7fe83eefcf23540f6">~ICPPKernel</a> ()=default</td></tr>
168 <tr class="memdesc:a033d17a97e07cea7fe83eefcf23540f6 inherit pub_methods_classarm__compute_1_1_i_c_p_p_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default destructor.  <a href="#a033d17a97e07cea7fe83eefcf23540f6">More...</a><br /></td></tr>
169 <tr class="separator:a033d17a97e07cea7fe83eefcf23540f6 inherit pub_methods_classarm__compute_1_1_i_c_p_p_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
170 <tr class="inherit_header pub_methods_classarm__compute_1_1_i_kernel"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarm__compute_1_1_i_kernel')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classarm__compute_1_1_i_kernel.xhtml">IKernel</a></td></tr>
171 <tr class="memitem:a7250cb8cbaa4104a93a2d77155085507 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a7250cb8cbaa4104a93a2d77155085507">IKernel</a> ()</td></tr>
172 <tr class="memdesc:a7250cb8cbaa4104a93a2d77155085507 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a7250cb8cbaa4104a93a2d77155085507">More...</a><br /></td></tr>
173 <tr class="separator:a7250cb8cbaa4104a93a2d77155085507 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
174 <tr class="memitem:a341b60d15a5e12a5b8f3825194dd3b12 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a341b60d15a5e12a5b8f3825194dd3b12">~IKernel</a> ()=default</td></tr>
175 <tr class="memdesc:a341b60d15a5e12a5b8f3825194dd3b12 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#a341b60d15a5e12a5b8f3825194dd3b12">More...</a><br /></td></tr>
176 <tr class="separator:a341b60d15a5e12a5b8f3825194dd3b12 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
177 <tr class="memitem:abfab8f0d4928e1081d9f65b77933e24a inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_kernel.xhtml#abfab8f0d4928e1081d9f65b77933e24a">is_parallelisable</a> () const </td></tr>
178 <tr class="memdesc:abfab8f0d4928e1081d9f65b77933e24a inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">Indicates whether or not the kernel is parallelisable.  <a href="#abfab8f0d4928e1081d9f65b77933e24a">More...</a><br /></td></tr>
179 <tr class="separator:abfab8f0d4928e1081d9f65b77933e24a inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
180 <tr class="memitem:aa6daa9b04e2035bf007e5e5c3c4396a8 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="structarm__compute_1_1_border_size.xhtml">BorderSize</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_kernel.xhtml#aa6daa9b04e2035bf007e5e5c3c4396a8">border_size</a> () const </td></tr>
181 <tr class="memdesc:aa6daa9b04e2035bf007e5e5c3c4396a8 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">The size of the border for that kernel.  <a href="#aa6daa9b04e2035bf007e5e5c3c4396a8">More...</a><br /></td></tr>
182 <tr class="separator:aa6daa9b04e2035bf007e5e5c3c4396a8 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
183 <tr class="memitem:a3f5646133956f06348b310ccc3d36353 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a3f5646133956f06348b310ccc3d36353">window</a> () const </td></tr>
184 <tr class="memdesc:a3f5646133956f06348b310ccc3d36353 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">The maximum window the kernel can be executed on.  <a href="#a3f5646133956f06348b310ccc3d36353">More...</a><br /></td></tr>
185 <tr class="separator:a3f5646133956f06348b310ccc3d36353 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
186 </table><table class="memberdecls">
187 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
188 Static Public Member Functions</h2></td></tr>
189 <tr class="memitem:a95b11d7f930f7e1fd9924cd300457098"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classarm__compute_1_1_status.xhtml">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_l2_normalize_layer_kernel.xhtml#a95b11d7f930f7e1fd9924cd300457098">validate</a> (const <a class="el" href="classarm__compute_1_1_i_tensor_info.xhtml">ITensorInfo</a> *input, const <a class="el" href="classarm__compute_1_1_i_tensor_info.xhtml">ITensorInfo</a> *<a class="el" href="reduction__operation_8cl.xhtml#ab0df00f5333da51860deb93deb44a782">sum</a>, const <a class="el" href="classarm__compute_1_1_i_tensor_info.xhtml">ITensorInfo</a> *output, unsigned int axis, float epsilon)</td></tr>
190 <tr class="memdesc:a95b11d7f930f7e1fd9924cd300457098"><td class="mdescLeft">&#160;</td><td class="mdescRight">Static function to check if given info will lead to a valid configuration of <a class="el" href="classarm__compute_1_1_n_e_l2_normalize_layer_kernel.xhtml">NEL2NormalizeLayerKernel</a>.  <a href="#a95b11d7f930f7e1fd9924cd300457098">More...</a><br /></td></tr>
191 <tr class="separator:a95b11d7f930f7e1fd9924cd300457098"><td class="memSeparator" colspan="2">&#160;</td></tr>
192 </table>
193 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
194 <div class="textblock"><p>Interface for performing a L2 normalize on a given axis given the square sum of it in this axis. </p>
195
196 <p>Definition at line <a class="el" href="_n_e_l2_normalize_layer_kernel_8h_source.xhtml#l00034">34</a> of file <a class="el" href="_n_e_l2_normalize_layer_kernel_8h_source.xhtml">NEL2NormalizeLayerKernel.h</a>.</p>
197 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
198 <a class="anchor" id="a074123c53d349a9f418a7a269e331230"></a>
199 <div class="memitem">
200 <div class="memproto">
201       <table class="memname">
202         <tr>
203           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_l2_normalize_layer_kernel.xhtml">NEL2NormalizeLayerKernel</a> </td>
204           <td>(</td>
205           <td class="paramname"></td><td>)</td>
206           <td></td>
207         </tr>
208       </table>
209 </div><div class="memdoc">
210
211 <p>Default constructor. </p>
212
213 <p>Referenced by <a class="el" href="_n_e_l2_normalize_layer_kernel_8h_source.xhtml#l00037">NEL2NormalizeLayerKernel::name()</a>.</p>
214
215 </div>
216 </div>
217 <a class="anchor" id="a82265061e07c888085faad1ec861d507"></a>
218 <div class="memitem">
219 <div class="memproto">
220 <table class="mlabels">
221   <tr>
222   <td class="mlabels-left">
223       <table class="memname">
224         <tr>
225           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_l2_normalize_layer_kernel.xhtml">NEL2NormalizeLayerKernel</a> </td>
226           <td>(</td>
227           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_n_e_l2_normalize_layer_kernel.xhtml">NEL2NormalizeLayerKernel</a> &amp;&#160;</td>
228           <td class="paramname"></td><td>)</td>
229           <td></td>
230         </tr>
231       </table>
232   </td>
233   <td class="mlabels-right">
234 <span class="mlabels"><span class="mlabel">delete</span></span>  </td>
235   </tr>
236 </table>
237 </div><div class="memdoc">
238
239 <p>Prevent instances of this class from being copied (As this class contains pointers) </p>
240
241 </div>
242 </div>
243 <a class="anchor" id="a52cd2d465ac76389e383fda9997be37b"></a>
244 <div class="memitem">
245 <div class="memproto">
246 <table class="mlabels">
247   <tr>
248   <td class="mlabels-left">
249       <table class="memname">
250         <tr>
251           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_l2_normalize_layer_kernel.xhtml">NEL2NormalizeLayerKernel</a> </td>
252           <td>(</td>
253           <td class="paramtype"><a class="el" href="classarm__compute_1_1_n_e_l2_normalize_layer_kernel.xhtml">NEL2NormalizeLayerKernel</a> &amp;&amp;&#160;</td>
254           <td class="paramname"></td><td>)</td>
255           <td></td>
256         </tr>
257       </table>
258   </td>
259   <td class="mlabels-right">
260 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
261   </tr>
262 </table>
263 </div><div class="memdoc">
264
265 <p>Allow instances of this class to be moved. </p>
266
267 </div>
268 </div>
269 <a class="anchor" id="af780d4877cb699566c6dca8e695e3d84"></a>
270 <div class="memitem">
271 <div class="memproto">
272 <table class="mlabels">
273   <tr>
274   <td class="mlabels-left">
275       <table class="memname">
276         <tr>
277           <td class="memname">~<a class="el" href="classarm__compute_1_1_n_e_l2_normalize_layer_kernel.xhtml">NEL2NormalizeLayerKernel</a> </td>
278           <td>(</td>
279           <td class="paramname"></td><td>)</td>
280           <td></td>
281         </tr>
282       </table>
283   </td>
284   <td class="mlabels-right">
285 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
286   </tr>
287 </table>
288 </div><div class="memdoc">
289
290 <p>Default destructor. </p>
291
292 <p>Referenced by <a class="el" href="_n_e_l2_normalize_layer_kernel_8h_source.xhtml#l00037">NEL2NormalizeLayerKernel::name()</a>.</p>
293
294 </div>
295 </div>
296 <h2 class="groupheader">Member Function Documentation</h2>
297 <a class="anchor" id="a7b9a0d39ba4aa3e6feba587a149d69e5"></a>
298 <div class="memitem">
299 <div class="memproto">
300       <table class="memname">
301         <tr>
302           <td class="memname">void configure </td>
303           <td>(</td>
304           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *&#160;</td>
305           <td class="paramname"><em>input</em>, </td>
306         </tr>
307         <tr>
308           <td class="paramkey"></td>
309           <td></td>
310           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *&#160;</td>
311           <td class="paramname"><em>sum</em>, </td>
312         </tr>
313         <tr>
314           <td class="paramkey"></td>
315           <td></td>
316           <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *&#160;</td>
317           <td class="paramname"><em>output</em>, </td>
318         </tr>
319         <tr>
320           <td class="paramkey"></td>
321           <td></td>
322           <td class="paramtype">unsigned int&#160;</td>
323           <td class="paramname"><em>axis</em>, </td>
324         </tr>
325         <tr>
326           <td class="paramkey"></td>
327           <td></td>
328           <td class="paramtype">float&#160;</td>
329           <td class="paramname"><em>epsilon</em>&#160;</td>
330         </tr>
331         <tr>
332           <td></td>
333           <td>)</td>
334           <td></td><td></td>
335         </tr>
336       </table>
337 </div><div class="memdoc">
338
339 <p>Set the input and output tensors. </p>
340 <dl class="params"><dt>Parameters</dt><dd>
341   <table class="params">
342     <tr><td class="paramdir">[in]</td><td class="paramname">input</td><td>Source tensor. Data types supported: F32. Data layouts supported: NCHW. </td></tr>
343     <tr><td class="paramdir">[in]</td><td class="paramname">sum</td><td>Sum values tensor. Data types supported: same as <code>input</code>. Sum will have the same number of dimensions as input. </td></tr>
344     <tr><td class="paramdir">[out]</td><td class="paramname">output</td><td>Destination tensor. Data types and data layouts supported: same as <code>input</code>. Output will have the same number of dimensions as input. </td></tr>
345     <tr><td class="paramdir">[in]</td><td class="paramname">axis</td><td>Dimension along which to reduce. Supported reduction axis : 0 </td></tr>
346     <tr><td class="paramdir">[in]</td><td class="paramname">epsilon</td><td>Lower bound value for the normalization. </td></tr>
347   </table>
348   </dd>
349 </dl>
350
351 <p>Referenced by <a class="el" href="_n_e_l2_normalize_layer_kernel_8h_source.xhtml#l00037">NEL2NormalizeLayerKernel::name()</a>.</p>
352
353 </div>
354 </div>
355 <a class="anchor" id="ab5656bb5b6334bdbe6e606c715872828"></a>
356 <div class="memitem">
357 <div class="memproto">
358 <table class="mlabels">
359   <tr>
360   <td class="mlabels-left">
361       <table class="memname">
362         <tr>
363           <td class="memname">const char* name </td>
364           <td>(</td>
365           <td class="paramname"></td><td>)</td>
366           <td> const</td>
367         </tr>
368       </table>
369   </td>
370   <td class="mlabels-right">
371 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
372   </tr>
373 </table>
374 </div><div class="memdoc">
375
376 <p>Name of the kernel. </p>
377 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="classarm__compute_1_1_kernel.xhtml" title="Kernel class. ">Kernel</a> name </dd></dl>
378
379 <p>Implements <a class="el" href="classarm__compute_1_1_i_c_p_p_kernel.xhtml#a1a30ad8f276a2310571c36239554831a">ICPPKernel</a>.</p>
380
381 <p>Definition at line <a class="el" href="_n_e_l2_normalize_layer_kernel_8h_source.xhtml#l00037">37</a> of file <a class="el" href="_n_e_l2_normalize_layer_kernel_8h_source.xhtml">NEL2NormalizeLayerKernel.h</a>.</p>
382
383 <p>References <a class="el" href="classarm__compute_1_1_n_e_l2_normalize_layer_kernel.xhtml#a7b9a0d39ba4aa3e6feba587a149d69e5">NEL2NormalizeLayerKernel::configure()</a>, <a class="el" href="namespacearm__compute_1_1test_1_1validation.xhtml#a096668313a9a819d54a2e65ec21ff0cc">arm_compute::test::validation::info()</a>, <a class="el" href="classarm__compute_1_1_n_e_l2_normalize_layer_kernel.xhtml#a074123c53d349a9f418a7a269e331230">NEL2NormalizeLayerKernel::NEL2NormalizeLayerKernel()</a>, <a class="el" href="classarm__compute_1_1_n_e_l2_normalize_layer_kernel.xhtml#a8028a2c0f5d9fedccbaa8b10c91fcacc">NEL2NormalizeLayerKernel::operator=()</a>, <a class="el" href="classarm__compute_1_1_n_e_l2_normalize_layer_kernel.xhtml#a112b35dd205c62ea6ed1447ef226da82">NEL2NormalizeLayerKernel::run()</a>, <a class="el" href="reduction__operation_8cl_source.xhtml#l00052">sum()</a>, <a class="el" href="classarm__compute_1_1_n_e_l2_normalize_layer_kernel.xhtml#a95b11d7f930f7e1fd9924cd300457098">NEL2NormalizeLayerKernel::validate()</a>, <a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a3f5646133956f06348b310ccc3d36353">IKernel::window()</a>, and <a class="el" href="classarm__compute_1_1_n_e_l2_normalize_layer_kernel.xhtml#af780d4877cb699566c6dca8e695e3d84">NEL2NormalizeLayerKernel::~NEL2NormalizeLayerKernel()</a>.</p>
384 <div class="fragment"><div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;    {</div><div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;        <span class="keywordflow">return</span> <span class="stringliteral">&quot;NEL2NormalizeLayerKernel&quot;</span>;</div><div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;    }</div></div><!-- fragment -->
385 </div>
386 </div>
387 <a class="anchor" id="a8028a2c0f5d9fedccbaa8b10c91fcacc"></a>
388 <div class="memitem">
389 <div class="memproto">
390 <table class="mlabels">
391   <tr>
392   <td class="mlabels-left">
393       <table class="memname">
394         <tr>
395           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_l2_normalize_layer_kernel.xhtml">NEL2NormalizeLayerKernel</a>&amp; operator= </td>
396           <td>(</td>
397           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_n_e_l2_normalize_layer_kernel.xhtml">NEL2NormalizeLayerKernel</a> &amp;&#160;</td>
398           <td class="paramname"></td><td>)</td>
399           <td></td>
400         </tr>
401       </table>
402   </td>
403   <td class="mlabels-right">
404 <span class="mlabels"><span class="mlabel">delete</span></span>  </td>
405   </tr>
406 </table>
407 </div><div class="memdoc">
408
409 <p>Prevent instances of this class from being copied (As this class contains pointers) </p>
410
411 <p>Referenced by <a class="el" href="_n_e_l2_normalize_layer_kernel_8h_source.xhtml#l00037">NEL2NormalizeLayerKernel::name()</a>.</p>
412
413 </div>
414 </div>
415 <a class="anchor" id="a4cc3301a251cb2c41fba0752ea047781"></a>
416 <div class="memitem">
417 <div class="memproto">
418 <table class="mlabels">
419   <tr>
420   <td class="mlabels-left">
421       <table class="memname">
422         <tr>
423           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_l2_normalize_layer_kernel.xhtml">NEL2NormalizeLayerKernel</a>&amp; operator= </td>
424           <td>(</td>
425           <td class="paramtype"><a class="el" href="classarm__compute_1_1_n_e_l2_normalize_layer_kernel.xhtml">NEL2NormalizeLayerKernel</a> &amp;&amp;&#160;</td>
426           <td class="paramname"></td><td>)</td>
427           <td></td>
428         </tr>
429       </table>
430   </td>
431   <td class="mlabels-right">
432 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
433   </tr>
434 </table>
435 </div><div class="memdoc">
436
437 <p>Allow instances of this class to be moved. </p>
438
439 </div>
440 </div>
441 <a class="anchor" id="a112b35dd205c62ea6ed1447ef226da82"></a>
442 <div class="memitem">
443 <div class="memproto">
444 <table class="mlabels">
445   <tr>
446   <td class="mlabels-left">
447       <table class="memname">
448         <tr>
449           <td class="memname">void run </td>
450           <td>(</td>
451           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> &amp;&#160;</td>
452           <td class="paramname"><em>window</em>, </td>
453         </tr>
454         <tr>
455           <td class="paramkey"></td>
456           <td></td>
457           <td class="paramtype">const <a class="el" href="structarm__compute_1_1_thread_info.xhtml">ThreadInfo</a> &amp;&#160;</td>
458           <td class="paramname"><em>info</em>&#160;</td>
459         </tr>
460         <tr>
461           <td></td>
462           <td>)</td>
463           <td></td><td></td>
464         </tr>
465       </table>
466   </td>
467   <td class="mlabels-right">
468 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
469   </tr>
470 </table>
471 </div><div class="memdoc">
472
473 <p>Execute the kernel on the passed window. </p>
474 <dl class="section warning"><dt>Warning</dt><dd>If <a class="el" href="classarm__compute_1_1_i_kernel.xhtml#abfab8f0d4928e1081d9f65b77933e24a" title="Indicates whether or not the kernel is parallelisable. ">is_parallelisable()</a> returns false then the passed window must be equal to <a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a3f5646133956f06348b310ccc3d36353" title="The maximum window the kernel can be executed on. ">window()</a></dd></dl>
475 <dl class="section note"><dt>Note</dt><dd>The window has to be a region within the window returned by the <a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a3f5646133956f06348b310ccc3d36353" title="The maximum window the kernel can be executed on. ">window()</a> method</dd>
476 <dd>
477 The width of the window has to be a multiple of num_elems_processed_per_iteration().</dd></dl>
478 <dl class="params"><dt>Parameters</dt><dd>
479   <table class="params">
480     <tr><td class="paramdir">[in]</td><td class="paramname">window</td><td>Region on which to execute the kernel. (Must be a region of the window returned by <a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a3f5646133956f06348b310ccc3d36353" title="The maximum window the kernel can be executed on. ">window()</a>) </td></tr>
481     <tr><td class="paramdir">[in]</td><td class="paramname">info</td><td>Info about executing thread and CPU. </td></tr>
482   </table>
483   </dd>
484 </dl>
485
486 <p>Implements <a class="el" href="classarm__compute_1_1_i_c_p_p_kernel.xhtml#af814ff5e96f40f1cccf809b2b4ee19ef">ICPPKernel</a>.</p>
487
488 <p>Referenced by <a class="el" href="_n_e_l2_normalize_layer_kernel_8h_source.xhtml#l00037">NEL2NormalizeLayerKernel::name()</a>.</p>
489
490 </div>
491 </div>
492 <a class="anchor" id="a95b11d7f930f7e1fd9924cd300457098"></a>
493 <div class="memitem">
494 <div class="memproto">
495 <table class="mlabels">
496   <tr>
497   <td class="mlabels-left">
498       <table class="memname">
499         <tr>
500           <td class="memname">static <a class="el" href="classarm__compute_1_1_status.xhtml">Status</a> validate </td>
501           <td>(</td>
502           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_tensor_info.xhtml">ITensorInfo</a> *&#160;</td>
503           <td class="paramname"><em>input</em>, </td>
504         </tr>
505         <tr>
506           <td class="paramkey"></td>
507           <td></td>
508           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_tensor_info.xhtml">ITensorInfo</a> *&#160;</td>
509           <td class="paramname"><em>sum</em>, </td>
510         </tr>
511         <tr>
512           <td class="paramkey"></td>
513           <td></td>
514           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_tensor_info.xhtml">ITensorInfo</a> *&#160;</td>
515           <td class="paramname"><em>output</em>, </td>
516         </tr>
517         <tr>
518           <td class="paramkey"></td>
519           <td></td>
520           <td class="paramtype">unsigned int&#160;</td>
521           <td class="paramname"><em>axis</em>, </td>
522         </tr>
523         <tr>
524           <td class="paramkey"></td>
525           <td></td>
526           <td class="paramtype">float&#160;</td>
527           <td class="paramname"><em>epsilon</em>&#160;</td>
528         </tr>
529         <tr>
530           <td></td>
531           <td>)</td>
532           <td></td><td></td>
533         </tr>
534       </table>
535   </td>
536   <td class="mlabels-right">
537 <span class="mlabels"><span class="mlabel">static</span></span>  </td>
538   </tr>
539 </table>
540 </div><div class="memdoc">
541
542 <p>Static function to check if given info will lead to a valid configuration of <a class="el" href="classarm__compute_1_1_n_e_l2_normalize_layer_kernel.xhtml">NEL2NormalizeLayerKernel</a>. </p>
543 <dl class="params"><dt>Parameters</dt><dd>
544   <table class="params">
545     <tr><td class="paramdir">[in]</td><td class="paramname">input</td><td>Source tensor info. Data types supported: F32. Data layouts supported: NCHW. </td></tr>
546     <tr><td class="paramdir">[in]</td><td class="paramname">sum</td><td>Sum values tensor info. Data types supported: same as <code>input</code>. Sum will have the same number of dimensions as input. </td></tr>
547     <tr><td class="paramdir">[in]</td><td class="paramname">output</td><td>Destination tensor info. Data types and data layouts supported: same as <code>input</code>. Output will have the same number of dimensions as input. </td></tr>
548     <tr><td class="paramdir">[in]</td><td class="paramname">axis</td><td>Dimension along which to reduce. Supported reduction axis : 0 </td></tr>
549     <tr><td class="paramdir">[in]</td><td class="paramname">epsilon</td><td>Lower bound value for the normalization.</td></tr>
550   </table>
551   </dd>
552 </dl>
553 <dl class="section return"><dt>Returns</dt><dd>a status </dd></dl>
554
555 <p>Referenced by <a class="el" href="_n_e_l2_normalize_layer_kernel_8h_source.xhtml#l00037">NEL2NormalizeLayerKernel::name()</a>.</p>
556
557 </div>
558 </div>
559 <hr/>The documentation for this class was generated from the following file:<ul>
560 <li>arm_compute/core/NEON/kernels/<a class="el" href="_n_e_l2_normalize_layer_kernel_8h_source.xhtml">NEL2NormalizeLayerKernel.h</a></li>
561 </ul>
562 </div><!-- contents -->
563 </div><!-- doc-content -->
564 <!-- start footer part -->
565 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
566   <ul>
567     <li class="navelem"><a class="el" href="namespacearm__compute.xhtml">arm_compute</a></li><li class="navelem"><a class="el" href="classarm__compute_1_1_n_e_l2_normalize_layer_kernel.xhtml">NEL2NormalizeLayerKernel</a></li>
568     <li class="footer">Generated on Wed May 23 2018 11:36:42 for Compute Library by
569     <a href="http://www.doxygen.org/index.html">
570     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
571   </ul>
572 </div>
573 </body>
574 </html>