documentation/classarm__compute_1_1_iterator.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>ARM Compute Library: Iterator 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">ARM Compute Library
  43    &#160;<span id="projectnumber">17.04</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="namespaces.xhtml"><span>Namespaces</span></a></li>
  59       <li class="current"><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
  60       <li><a href="files.xhtml"><span>Files</span></a></li>
  61       <li>
  62         <div id="MSearchBox" class="MSearchBoxInactive">
  63         <span class="left">
  64           <img id="MSearchSelect" src="search/mag_sel.png"
  65                onmouseover="return searchBox.OnSearchSelectShow()"
  66                onmouseout="return searchBox.OnSearchSelectHide()"
  67                alt=""/>
  68           <input type="text" id="MSearchField" value="Search" accesskey="S"
  69                onfocus="searchBox.OnSearchFieldFocus(true)"
  70                onblur="searchBox.OnSearchFieldFocus(false)"
  71                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  72           </span><span class="right">
  73             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  74           </span>
  75         </div>
  76       </li>
  77     </ul>
  78   </div>
  79   <div id="navrow2" class="tabs2">
  80     <ul class="tablist">
  81       <li><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
  82       <li><a href="classes.xhtml"><span>Data&#160;Structure&#160;Index</span></a></li>
  83       <li><a href="inherits.xhtml"><span>Class&#160;Hierarchy</span></a></li>
  84       <li><a href="functions.xhtml"><span>Data&#160;Fields</span></a></li>
  85     </ul>
  86   </div>
  87 </div><!-- top -->
  88 <div id="side-nav" class="ui-resizable side-nav-resizable">
  89   <div id="nav-tree">
  90     <div id="nav-tree-contents">
  91       <div id="nav-sync" class="sync"></div>
  92     </div>
  93   </div>
  94   <div id="splitbar" style="-moz-user-select:none;"
  95        class="ui-resizable-handle">
  96   </div>
  97 </div>
  98 <script type="text/javascript">
  99 $(document).ready(function(){initNavTree('classarm__compute_1_1_iterator.xhtml','');});
 100 </script>
 101 <div id="doc-content">
 102 <!-- window showing the filter options -->
 103 <div id="MSearchSelectWindow"
 104      onmouseover="return searchBox.OnSearchSelectShow()"
 105      onmouseout="return searchBox.OnSearchSelectHide()"
 106      onkeydown="return searchBox.OnSearchSelectKey(event)">
 107 </div>
 108
 109 <!-- iframe showing the search results (closed by default) -->
 110 <div id="MSearchResultsWindow">
 111 <iframe src="javascript:void(0)" frameborder="0"
 112         name="MSearchResults" id="MSearchResults">
 113 </iframe>
 114 </div>
 115
 116 <div class="header">
 117   <div class="summary">
 118 <a href="#nested-classes">Data Structures</a> &#124;
 119 <a href="#pub-methods">Public Member Functions</a>  </div>
 120   <div class="headertitle">
 121 <div class="title">Iterator Class Reference</div>  </div>
 122 </div><!--header-->
 123 <div class="contents">
 124
 125 <p><a class="el" href="classarm__compute_1_1_iterator.xhtml" title="Iterator updated by execute_window_loop for each window element. ">Iterator</a> updated by <a class="el" href="namespacearm__compute.xhtml#a78fd1c0056e9add7ab01b8e118c0038d">execute_window_loop</a> for each window element.
 126  <a href="classarm__compute_1_1_iterator.xhtml#details">More...</a></p>
 127
 128 <p><code>#include &lt;<a class="el" href="_helpers_8h_source.xhtml">Helpers.h</a>&gt;</code></p>
 129 <table class="memberdecls">
 130 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
 131 Public Member Functions</h2></td></tr>
 132 <tr class="memitem:a45381773d6cba2ad9e9d2d04515fa40b"><td class="memItemLeft" align="right" valign="top">constexpr&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_iterator.xhtml#a45381773d6cba2ad9e9d2d04515fa40b">Iterator</a> ()</td></tr>
 133 <tr class="memdesc:a45381773d6cba2ad9e9d2d04515fa40b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor to create an empty iterator.  <a href="#a45381773d6cba2ad9e9d2d04515fa40b">More...</a><br /></td></tr>
 134 <tr class="separator:a45381773d6cba2ad9e9d2d04515fa40b"><td class="memSeparator" colspan="2">&#160;</td></tr>
 135 <tr class="memitem:a92d6469b972ef1e52b55b1ad7da70b02"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_iterator.xhtml#a92d6469b972ef1e52b55b1ad7da70b02">Iterator</a> (const <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *tensor, const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> &amp;window)</td></tr>
 136 <tr class="memdesc:a92d6469b972ef1e52b55b1ad7da70b02"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a container iterator for the metadata and allocation contained in the <a class="el" href="classarm__compute_1_1_i_tensor.xhtml" title="Interface for NEON tensor. ">ITensor</a>.  <a href="#a92d6469b972ef1e52b55b1ad7da70b02">More...</a><br /></td></tr>
 137 <tr class="separator:a92d6469b972ef1e52b55b1ad7da70b02"><td class="memSeparator" colspan="2">&#160;</td></tr>
 138 <tr class="memitem:a6e507a84d19ad08bb0f7fc1558ec429a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_iterator.xhtml#a6e507a84d19ad08bb0f7fc1558ec429a">increment</a> (size_t dimension)</td></tr>
 139 <tr class="memdesc:a6e507a84d19ad08bb0f7fc1558ec429a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Increment the iterator along the specified dimension of the step value associated to the dimension.  <a href="#a6e507a84d19ad08bb0f7fc1558ec429a">More...</a><br /></td></tr>
 140 <tr class="separator:a6e507a84d19ad08bb0f7fc1558ec429a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 141 <tr class="memitem:a8760d21bd43ac13bd26489b7736245b3"><td class="memItemLeft" align="right" valign="top">constexpr int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_iterator.xhtml#a8760d21bd43ac13bd26489b7736245b3">offset</a> () const </td></tr>
 142 <tr class="memdesc:a8760d21bd43ac13bd26489b7736245b3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the offset in bytes from the first element to the current position of the iterator.  <a href="#a8760d21bd43ac13bd26489b7736245b3">More...</a><br /></td></tr>
 143 <tr class="separator:a8760d21bd43ac13bd26489b7736245b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
 144 <tr class="memitem:a2f0d6383162e1af2df323c456a9335d3"><td class="memItemLeft" align="right" valign="top">constexpr uint8_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_iterator.xhtml#a2f0d6383162e1af2df323c456a9335d3">ptr</a> () const </td></tr>
 145 <tr class="memdesc:a2f0d6383162e1af2df323c456a9335d3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a pointer to the current pixel.  <a href="#a2f0d6383162e1af2df323c456a9335d3">More...</a><br /></td></tr>
 146 <tr class="separator:a2f0d6383162e1af2df323c456a9335d3"><td class="memSeparator" colspan="2">&#160;</td></tr>
 147 <tr class="memitem:a599f5025b7e6b8bfead740a88e56d5bc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_iterator.xhtml#a599f5025b7e6b8bfead740a88e56d5bc">reset</a> (size_t dimension)</td></tr>
 148 <tr class="memdesc:a599f5025b7e6b8bfead740a88e56d5bc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Move the iterator back to the beginning of the specified dimension.  <a href="#a599f5025b7e6b8bfead740a88e56d5bc">More...</a><br /></td></tr>
 149 <tr class="separator:a599f5025b7e6b8bfead740a88e56d5bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
 150 </table>
 151 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 152 <div class="textblock"><p><a class="el" href="classarm__compute_1_1_iterator.xhtml" title="Iterator updated by execute_window_loop for each window element. ">Iterator</a> updated by <a class="el" href="namespacearm__compute.xhtml#a78fd1c0056e9add7ab01b8e118c0038d">execute_window_loop</a> for each window element. </p>
 153
 154 <p>Definition at line <a class="el" href="_helpers_8h_source.xhtml#l00210">210</a> of file <a class="el" href="_helpers_8h_source.xhtml">Helpers.h</a>.</p>
 155 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 156 <a class="anchor" id="a45381773d6cba2ad9e9d2d04515fa40b"></a>
 157 <div class="memitem">
 158 <div class="memproto">
 159       <table class="memname">
 160         <tr>
 161           <td class="memname">constexpr <a class="el" href="classarm__compute_1_1_iterator.xhtml">Iterator</a> </td>
 162           <td>(</td>
 163           <td class="paramname"></td><td>)</td>
 164           <td></td>
 165         </tr>
 166       </table>
 167 </div><div class="memdoc">
 168
 169 <p>Default constructor to create an empty iterator. </p>
 170
 171 </div>
 172 </div>
 173 <a class="anchor" id="a92d6469b972ef1e52b55b1ad7da70b02"></a>
 174 <div class="memitem">
 175 <div class="memproto">
 176       <table class="memname">
 177         <tr>
 178           <td class="memname"><a class="el" href="classarm__compute_1_1_iterator.xhtml">Iterator</a> </td>
 179           <td>(</td>
 180           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *&#160;</td>
 181           <td class="paramname"><em>tensor</em>, </td>
 182         </tr>
 183         <tr>
 184           <td class="paramkey"></td>
 185           <td></td>
 186           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> &amp;&#160;</td>
 187           <td class="paramname"><em>window</em>&#160;</td>
 188         </tr>
 189         <tr>
 190           <td></td>
 191           <td>)</td>
 192           <td></td><td></td>
 193         </tr>
 194       </table>
 195 </div><div class="memdoc">
 196
 197 <p>Create a container iterator for the metadata and allocation contained in the <a class="el" href="classarm__compute_1_1_i_tensor.xhtml" title="Interface for NEON tensor. ">ITensor</a>. </p>
 198 <dl class="params"><dt>Parameters</dt><dd>
 199   <table class="params">
 200     <tr><td class="paramdir">[in]</td><td class="paramname">tensor</td><td>The tensor to associate to the iterator. </td></tr>
 201     <tr><td class="paramdir">[in]</td><td class="paramname">window</td><td>The window which will be used to iterate over the tensor. </td></tr>
 202   </table>
 203   </dd>
 204 </dl>
 205
 206 </div>
 207 </div>
 208 <h2 class="groupheader">Member Function Documentation</h2>
 209 <a class="anchor" id="a6e507a84d19ad08bb0f7fc1558ec429a"></a>
 210 <div class="memitem">
 211 <div class="memproto">
 212       <table class="memname">
 213         <tr>
 214           <td class="memname">void increment </td>
 215           <td>(</td>
 216           <td class="paramtype">size_t&#160;</td>
 217           <td class="paramname"><em>dimension</em></td><td>)</td>
 218           <td></td>
 219         </tr>
 220       </table>
 221 </div><div class="memdoc">
 222
 223 <p>Increment the iterator along the specified dimension of the step value associated to the dimension. </p>
 224 <dl class="section warning"><dt>Warning</dt><dd>It is the caller's responsibility to call increment(dimension+1) when reaching the end of a dimension, the iterator will not check for overflow.</dd></dl>
 225 <dl class="section note"><dt>Note</dt><dd>When incrementing a dimension 'n' the coordinates of all the dimensions in the range (0,n-1) are reset. For example if you iterate over a 2D image, everytime you change row (dimension 1), the iterator for the width (dimension 0) is reset to its start.</dd></dl>
 226 <dl class="params"><dt>Parameters</dt><dd>
 227   <table class="params">
 228     <tr><td class="paramdir">[in]</td><td class="paramname">dimension</td><td>Dimension to increment </td></tr>
 229   </table>
 230   </dd>
 231 </dl>
 232
 233 </div>
 234 </div>
 235 <a class="anchor" id="a8760d21bd43ac13bd26489b7736245b3"></a>
 236 <div class="memitem">
 237 <div class="memproto">
 238       <table class="memname">
 239         <tr>
 240           <td class="memname">constexpr int offset </td>
 241           <td>(</td>
 242           <td class="paramname"></td><td>)</td>
 243           <td> const</td>
 244         </tr>
 245       </table>
 246 </div><div class="memdoc">
 247
 248 <p>Return the offset in bytes from the first element to the current position of the iterator. </p>
 249 <dl class="section return"><dt>Returns</dt><dd>The current position of the iterator in bytes relative to the first element. </dd></dl>
 250
 251 </div>
 252 </div>
 253 <a class="anchor" id="a2f0d6383162e1af2df323c456a9335d3"></a>
 254 <div class="memitem">
 255 <div class="memproto">
 256       <table class="memname">
 257         <tr>
 258           <td class="memname">constexpr uint8_t* ptr </td>
 259           <td>(</td>
 260           <td class="paramname"></td><td>)</td>
 261           <td> const</td>
 262         </tr>
 263       </table>
 264 </div><div class="memdoc">
 265
 266 <p>Return a pointer to the current pixel. </p>
 267 <dl class="section warning"><dt>Warning</dt><dd>Only works if the iterator was created with an <a class="el" href="classarm__compute_1_1_i_tensor.xhtml" title="Interface for NEON tensor. ">ITensor</a>.</dd></dl>
 268 <dl class="section return"><dt>Returns</dt><dd>equivalent to buffer() + <a class="el" href="classarm__compute_1_1_iterator.xhtml#a8760d21bd43ac13bd26489b7736245b3" title="Return the offset in bytes from the first element to the current position of the iterator. ">offset()</a> </dd></dl>
 269
 270 <p>Referenced by <a class="el" href="_n_e_color_convert_helper_8inl_source.xhtml#l00825">arm_compute::colorconvert_rgb_to_iyuv()</a>, <a class="el" href="_n_e_color_convert_helper_8inl_source.xhtml#l00789">arm_compute::colorconvert_rgb_to_nv12()</a>, <a class="el" href="_n_e_color_convert_helper_8inl_source.xhtml#l00303">arm_compute::colorconvert_rgb_to_rgbx()</a>, <a class="el" href="_n_e_color_convert_helper_8inl_source.xhtml#l00862">arm_compute::colorconvert_rgb_to_yuv4()</a>, <a class="el" href="_n_e_color_convert_helper_8inl_source.xhtml#l00327">arm_compute::colorconvert_rgbx_to_rgb()</a>, <a class="el" href="_n_e_color_convert_helper_8inl_source.xhtml#l00633">arm_compute::colorconvert_yuyv_to_iyuv()</a>, <a class="el" href="_n_e_color_convert_helper_8inl_source.xhtml#l00502">arm_compute::colorconvert_yuyv_to_nv12()</a>, <a class="el" href="_n_e_color_convert_helper_8inl_source.xhtml#l00351">arm_compute::colorconvert_yuyv_to_rgb()</a>, <a class="el" href="test__helpers_2_utils_8h_source.xhtml#l00142">PPMLoader::fill_image()</a>, <a class="el" href="neon__copy__objects_8cpp_source.xhtml#l00035">main_neon_copy_objects()</a>, and <a class="el" href="test__helpers_2_utils_8h_source.xhtml#l00245">test_helpers::save_to_ppm()</a>.</p>
 271
 272 </div>
 273 </div>
 274 <a class="anchor" id="a599f5025b7e6b8bfead740a88e56d5bc"></a>
 275 <div class="memitem">
 276 <div class="memproto">
 277       <table class="memname">
 278         <tr>
 279           <td class="memname">void reset </td>
 280           <td>(</td>
 281           <td class="paramtype">size_t&#160;</td>
 282           <td class="paramname"><em>dimension</em></td><td>)</td>
 283           <td></td>
 284         </tr>
 285       </table>
 286 </div><div class="memdoc">
 287
 288 <p>Move the iterator back to the beginning of the specified dimension. </p>
 289 <dl class="params"><dt>Parameters</dt><dd>
 290   <table class="params">
 291     <tr><td class="paramdir">[in]</td><td class="paramname">dimension</td><td>Dimension to reset </td></tr>
 292   </table>
 293   </dd>
 294 </dl>
 295
 296 </div>
 297 </div>
 298 <hr/>The documentation for this class was generated from the following file:<ul>
 299 <li>arm_compute/core/<a class="el" href="_helpers_8h_source.xhtml">Helpers.h</a></li>
 300 </ul>
 301 </div><!-- contents -->
 302 </div><!-- doc-content -->
 303 <!-- start footer part -->
 304 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 305   <ul>
 306     <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_iterator.xhtml">Iterator</a></li>
 307     <li class="footer">Generated on Wed Apr 12 2017 14:26:06 for ARM Compute Library by
 308     <a href="http://www.doxygen.org/index.html">
 309     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
 310   </ul>
 311 </div>
 312 </body>
 313 </html>