documentation/l2__normalize_8cl_source.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.6"/>
   8 <meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
   9 <title>Compute Library: src/core/CL/cl_kernels/l2_normalize.cl 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="navtree.js"></script>
  16 <script type="text/javascript">
  17   $(document).ready(initResizable);
  18   $(window).load(resizeHeight);
  19 </script>
  20 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  21 <script type="text/javascript" src="search/search.js"></script>
  22 <script type="text/javascript">
  23   $(document).ready(function() { searchBox.OnSelectItem(0); });
  24 </script>
  25 <script type="text/x-mathjax-config">
  26   MathJax.Hub.Config({
  27     extensions: ["tex2jax.js"],
  28     jax: ["input/TeX","output/HTML-CSS"],
  29 });
  30 </script><script src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
  31 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  32 </head>
  33 <body>
  34 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  35 <div id="titlearea">
  36 <table cellspacing="0" cellpadding="0">
  37  <tbody>
  38  <tr style="height: 56px;">
  39   <td style="padding-left: 0.5em;">
  40    <div id="projectname">Compute Library
  41    &#160;<span id="projectnumber">17.09</span>
  42    </div>
  43   </td>
  44  </tr>
  45  </tbody>
  46 </table>
  47 </div>
  48 <!-- end header part -->
  49 <!-- Generated by Doxygen 1.8.6 -->
  50 <script type="text/javascript">
  51 var searchBox = new SearchBox("searchBox", "search",false,'Search');
  52 </script>
  53   <div id="navrow1" class="tabs">
  54     <ul class="tablist">
  55       <li><a href="index.xhtml"><span>Main&#160;Page</span></a></li>
  56       <li><a href="pages.xhtml"><span>Related&#160;Pages</span></a></li>
  57       <li><a href="namespaces.xhtml"><span>Namespaces</span></a></li>
  58       <li><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
  59       <li class="current"><a href="files.xhtml"><span>Files</span></a></li>
  60       <li>
  61         <div id="MSearchBox" class="MSearchBoxInactive">
  62         <span class="left">
  63           <img id="MSearchSelect" src="search/mag_sel.png"
  64                onmouseover="return searchBox.OnSearchSelectShow()"
  65                onmouseout="return searchBox.OnSearchSelectHide()"
  66                alt=""/>
  67           <input type="text" id="MSearchField" value="Search" accesskey="S"
  68                onfocus="searchBox.OnSearchFieldFocus(true)"
  69                onblur="searchBox.OnSearchFieldFocus(false)"
  70                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  71           </span><span class="right">
  72             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  73           </span>
  74         </div>
  75       </li>
  76     </ul>
  77   </div>
  78   <div id="navrow2" class="tabs2">
  79     <ul class="tablist">
  80       <li><a href="files.xhtml"><span>File&#160;List</span></a></li>
  81       <li><a href="globals.xhtml"><span>Globals</span></a></li>
  82     </ul>
  83   </div>
  84 </div><!-- top -->
  85 <div id="side-nav" class="ui-resizable side-nav-resizable">
  86   <div id="nav-tree">
  87     <div id="nav-tree-contents">
  88       <div id="nav-sync" class="sync"></div>
  89     </div>
  90   </div>
  91   <div id="splitbar" style="-moz-user-select:none;"
  92        class="ui-resizable-handle">
  93   </div>
  94 </div>
  95 <script type="text/javascript">
  96 $(document).ready(function(){initNavTree('l2__normalize_8cl_source.xhtml','');});
  97 </script>
  98 <div id="doc-content">
  99 <!-- window showing the filter options -->
 100 <div id="MSearchSelectWindow"
 101      onmouseover="return searchBox.OnSearchSelectShow()"
 102      onmouseout="return searchBox.OnSearchSelectHide()"
 103      onkeydown="return searchBox.OnSearchSelectKey(event)">
 104 <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark">&#160;</span>Pages</a></div>
 105
 106 <!-- iframe showing the search results (closed by default) -->
 107 <div id="MSearchResultsWindow">
 108 <iframe src="javascript:void(0)" frameborder="0"
 109         name="MSearchResults" id="MSearchResults">
 110 </iframe>
 111 </div>
 112
 113 <div class="header">
 114   <div class="headertitle">
 115 <div class="title">l2_normalize.cl</div>  </div>
 116 </div><!--header-->
 117 <div class="contents">
 118 <a href="l2__normalize_8cl.xhtml">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/*</span></div>
 119 <div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> * Copyright (c) 2016, 2017 ARM Limited.</span></div>
 120 <div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> *</span></div>
 121 <div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> * SPDX-License-Identifier: MIT</span></div>
 122 <div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> *</span></div>
 123 <div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"> * Permission is hereby granted, free of charge, to any person obtaining a copy</span></div>
 124 <div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment"> * of this software and associated documentation files (the &quot;Software&quot;), to</span></div>
 125 <div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment"> * deal in the Software without restriction, including without limitation the</span></div>
 126 <div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment"> * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or</span></div>
 127 <div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment"> * sell copies of the Software, and to permit persons to whom the Software is</span></div>
 128 <div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment"> * furnished to do so, subject to the following conditions:</span></div>
 129 <div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment"> *</span></div>
 130 <div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment"> * The above copyright notice and this permission notice shall be included in all</span></div>
 131 <div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment"> * copies or substantial portions of the Software.</span></div>
 132 <div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment"> *</span></div>
 133 <div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="comment"> * THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span></div>
 134 <div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment"> * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span></div>
 135 <div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="comment"> * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span></div>
 136 <div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="comment"> * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span></div>
 137 <div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="comment"> * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,</span></div>
 138 <div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="comment"> * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE</span></div>
 139 <div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="comment"> * SOFTWARE.</span></div>
 140 <div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="comment"> */</span></div>
 141 <div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="helpers_8h.xhtml">helpers.h</a>&quot;</span></div>
 142 <div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;</div>
 143 <div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="l2__normalize_8cl.xhtml#ab09ea0cc113c0aed126f90b6de71eb2d">   45</a></span>&#160;__kernel <span class="keywordtype">void</span> <a class="code" href="l2__normalize_8cl.xhtml#ab09ea0cc113c0aed126f90b6de71eb2d">l2_normalize</a>(</div>
 144 <div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;    <a class="code" href="helpers_8h.xhtml#a40a6eb9f2a7712f08d6bb8ff6c9e6ca7">VECTOR_DECLARATION</a>(src),</div>
 145 <div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;    <a class="code" href="helpers_8h.xhtml#a40a6eb9f2a7712f08d6bb8ff6c9e6ca7">VECTOR_DECLARATION</a>(<a class="code" href="reduction__operation_8cl.xhtml#ab0df00f5333da51860deb93deb44a782">sum</a>),</div>
 146 <div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;    <a class="code" href="helpers_8h.xhtml#a40a6eb9f2a7712f08d6bb8ff6c9e6ca7">VECTOR_DECLARATION</a>(dst),</div>
 147 <div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;    <a class="code" href="convolution3x3_8cl.xhtml#afb8c72ce35c4a1f4a2588d6573e54aa1">DATA_TYPE</a> epsilon)</div>
 148 <div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;{</div>
 149 <div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;    <a class="code" href="struct_vector.xhtml">Vector</a> src = <a class="code" href="helpers_8h.xhtml#a527bfdf5eeb306f1cf01c4a8e29f38e0">CONVERT_TO_VECTOR_STRUCT</a>(src);</div>
 150 <div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;    <a class="code" href="struct_vector.xhtml">Vector</a> <a class="code" href="reduction__operation_8cl.xhtml#ab0df00f5333da51860deb93deb44a782">sum</a> = <a class="code" href="helpers_8h.xhtml#a527bfdf5eeb306f1cf01c4a8e29f38e0">CONVERT_TO_VECTOR_STRUCT</a>(sum);</div>
 151 <div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;    <a class="code" href="struct_vector.xhtml">Vector</a> dst = <a class="code" href="helpers_8h.xhtml#a527bfdf5eeb306f1cf01c4a8e29f38e0">CONVERT_TO_VECTOR_STRUCT</a>(dst);</div>
 152 <div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;</div>
 153 <div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;    <a class="code" href="fixed__point_8h.xhtml#a36f754c05b6fddf6df0d8d0a74f8159f">VEC_DATA_TYPE</a>(<a class="code" href="convolution3x3_8cl.xhtml#afb8c72ce35c4a1f4a2588d6573e54aa1">DATA_TYPE</a>, 16)</div>
 154 <div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;    in = vload16(0, (__global <a class="code" href="convolution3x3_8cl.xhtml#afb8c72ce35c4a1f4a2588d6573e54aa1">DATA_TYPE</a> *)src.<a class="code" href="struct_vector.xhtml#acf52c23cbd7424606c10a606524e3e32">ptr</a>);</div>
 155 <div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;    <a class="code" href="fixed__point_8h.xhtml#a36f754c05b6fddf6df0d8d0a74f8159f">VEC_DATA_TYPE</a>(<a class="code" href="convolution3x3_8cl.xhtml#afb8c72ce35c4a1f4a2588d6573e54aa1">DATA_TYPE</a>, 16)</div>
 156 <div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;    normalize_value = (<a class="code" href="fixed__point_8h.xhtml#a36f754c05b6fddf6df0d8d0a74f8159f">VEC_DATA_TYPE</a>(<a class="code" href="convolution3x3_8cl.xhtml#afb8c72ce35c4a1f4a2588d6573e54aa1">DATA_TYPE</a>, 16))native_rsqrt(fmax(((__global <a class="code" href="convolution3x3_8cl.xhtml#afb8c72ce35c4a1f4a2588d6573e54aa1">DATA_TYPE</a> *)sum.<a class="code" href="struct_vector.xhtml#acf52c23cbd7424606c10a606524e3e32">ptr</a>)[0], epsilon));</div>
 157 <div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;</div>
 158 <div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;    vstore16(in * normalize_value, 0, (__global <a class="code" href="convolution3x3_8cl.xhtml#afb8c72ce35c4a1f4a2588d6573e54aa1">DATA_TYPE</a> *)dst.<a class="code" href="struct_vector.xhtml#acf52c23cbd7424606c10a606524e3e32">ptr</a>);</div>
 159 <div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;}</div>
 160 <div class="ttc" id="struct_vector_xhtml"><div class="ttname"><a href="struct_vector.xhtml">Vector</a></div><div class="ttdoc">Structure to hold Vector information. </div><div class="ttdef"><b>Definition:</b> <a href="helpers_8h_source.xhtml#l00123">helpers.h:123</a></div></div>
 161 <div class="ttc" id="helpers_8h_xhtml_a527bfdf5eeb306f1cf01c4a8e29f38e0"><div class="ttname"><a href="helpers_8h.xhtml#a527bfdf5eeb306f1cf01c4a8e29f38e0">CONVERT_TO_VECTOR_STRUCT</a></div><div class="ttdeci">#define CONVERT_TO_VECTOR_STRUCT(name)</div><div class="ttdef"><b>Definition:</b> <a href="helpers_8h_source.xhtml#l00087">helpers.h:87</a></div></div>
 162 <div class="ttc" id="convolution3x3_8cl_xhtml_afb8c72ce35c4a1f4a2588d6573e54aa1"><div class="ttname"><a href="convolution3x3_8cl.xhtml#afb8c72ce35c4a1f4a2588d6573e54aa1">DATA_TYPE</a></div><div class="ttdeci">#define DATA_TYPE</div><div class="ttdef"><b>Definition:</b> <a href="convolution3x3_8cl_source.xhtml#l00027">convolution3x3.cl:27</a></div></div>
 163 <div class="ttc" id="reduction__operation_8cl_xhtml_ab0df00f5333da51860deb93deb44a782"><div class="ttname"><a href="reduction__operation_8cl.xhtml#ab0df00f5333da51860deb93deb44a782">sum</a></div><div class="ttdeci">DATA_TYPE sum(__global const DATA_TYPE *input)</div><div class="ttdoc">Calculate sum of a vector. </div><div class="ttdef"><b>Definition:</b> <a href="reduction__operation_8cl_source.xhtml#l00052">reduction_operation.cl:52</a></div></div>
 164 <div class="ttc" id="helpers_8h_xhtml"><div class="ttname"><a href="helpers_8h.xhtml">helpers.h</a></div></div>
 165 <div class="ttc" id="l2__normalize_8cl_xhtml_ab09ea0cc113c0aed126f90b6de71eb2d"><div class="ttname"><a href="l2__normalize_8cl.xhtml#ab09ea0cc113c0aed126f90b6de71eb2d">l2_normalize</a></div><div class="ttdeci">__kernel void l2_normalize(__global uchar *src_ptr, uint src_stride_x, uint src_step_x, uint src_offset_first_element_in_bytes, __global uchar *sum_ptr, uint sum_stride_x, uint sum_step_x, uint sum_offset_first_element_in_bytes, __global uchar *dst_ptr, uint dst_stride_x, uint dst_step_x, uint dst_offset_first_element_in_bytes, DATA_TYPE epsilon)</div><div class="ttdoc">This kernel performs reduction given an operation. </div><div class="ttdef"><b>Definition:</b> <a href="l2__normalize_8cl_source.xhtml#l00045">l2_normalize.cl:45</a></div></div>
 166 <div class="ttc" id="struct_vector_xhtml_acf52c23cbd7424606c10a606524e3e32"><div class="ttname"><a href="struct_vector.xhtml#acf52c23cbd7424606c10a606524e3e32">Vector::ptr</a></div><div class="ttdeci">__global uchar * ptr</div><div class="ttdoc">Pointer to the starting postion of the buffer. </div><div class="ttdef"><b>Definition:</b> <a href="helpers_8h_source.xhtml#l00125">helpers.h:125</a></div></div>
 167 <div class="ttc" id="helpers_8h_xhtml_a40a6eb9f2a7712f08d6bb8ff6c9e6ca7"><div class="ttname"><a href="helpers_8h.xhtml#a40a6eb9f2a7712f08d6bb8ff6c9e6ca7">VECTOR_DECLARATION</a></div><div class="ttdeci">#define VECTOR_DECLARATION(name)</div><div class="ttdef"><b>Definition:</b> <a href="helpers_8h_source.xhtml#l00051">helpers.h:51</a></div></div>
 168 <div class="ttc" id="fixed__point_8h_xhtml_a36f754c05b6fddf6df0d8d0a74f8159f"><div class="ttname"><a href="fixed__point_8h.xhtml#a36f754c05b6fddf6df0d8d0a74f8159f">VEC_DATA_TYPE</a></div><div class="ttdeci">#define VEC_DATA_TYPE(type, size)</div><div class="ttdef"><b>Definition:</b> <a href="fixed__point_8h_source.xhtml#l00093">fixed_point.h:93</a></div></div>
 169 </div><!-- fragment --></div><!-- contents -->
 170 </div><!-- doc-content -->
 171 <!-- start footer part -->
 172 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 173   <ul>
 174     <li class="navelem"><a class="el" href="dir_55b5a5006e943fb664ff8cff3cfe7768.xhtml">src</a></li><li class="navelem"><a class="el" href="dir_f6c3ae42d7e27145d0a3c3e38ca1c000.xhtml">core</a></li><li class="navelem"><a class="el" href="dir_1b7ae9123c88e650426d50d95c19d414.xhtml">CL</a></li><li class="navelem"><a class="el" href="dir_b7c3d80b0dadb2139bc73b7161751c12.xhtml">cl_kernels</a></li><li class="navelem"><a class="el" href="l2__normalize_8cl.xhtml">l2_normalize.cl</a></li>
 175     <li class="footer">Generated on Thu Sep 28 2017 14:37:50 for Compute Library by
 176     <a href="http://www.doxygen.org/index.html">
 177     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
 178   </ul>
 179 </div>
 180 </body>
 181 </html>