documentation/classarm__compute_1_1_access_window_rectangle.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: AccessWindowRectangle 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.03.1</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_access_window_rectangle.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="#pub-methods">Public Member Functions</a>  </div>
 119   <div class="headertitle">
 120 <div class="title">AccessWindowRectangle Class Reference</div>  </div>
 121 </div><!--header-->
 122 <div class="contents">
 123
 124 <p>Implementation of a rectangular access pattern.
 125  <a href="classarm__compute_1_1_access_window_rectangle.xhtml#details">More...</a></p>
 126
 127 <p><code>#include &lt;<a class="el" href="_i_access_window_8h_source.xhtml">IAccessWindow.h</a>&gt;</code></p>
 128 <div class="dynheader">
 129 Collaboration diagram for AccessWindowRectangle:</div>
 130 <div class="dyncontent">
 131 <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_access_window_rectangle__coll__graph.svg" width="183" height="112"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
 132 </div>
 133 <center><span class="legend">[<a target="top" href="graph_legend.xhtml">legend</a>]</span></center></div>
 134 <table class="memberdecls">
 135 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
 136 Public Member Functions</h2></td></tr>
 137 <tr class="memitem:ab188c1e89be24e1f21b045bc8818d706"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_access_window_rectangle.xhtml#ab188c1e89be24e1f21b045bc8818d706">AccessWindowRectangle</a> (<a class="el" href="classarm__compute_1_1_tensor_info.xhtml">TensorInfo</a> *info, int x, int y, int width, int height)</td></tr>
 138 <tr class="memdesc:ab188c1e89be24e1f21b045bc8818d706"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor for a rectangular access pattern.  <a href="#ab188c1e89be24e1f21b045bc8818d706">More...</a><br /></td></tr>
 139 <tr class="separator:ab188c1e89be24e1f21b045bc8818d706"><td class="memSeparator" colspan="2">&#160;</td></tr>
 140 <tr class="memitem:a8798dad6f6ace10ca2b814464d666ca0"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_access_window_rectangle.xhtml#a8798dad6f6ace10ca2b814464d666ca0">AccessWindowRectangle</a> (<a class="el" href="classarm__compute_1_1_tensor_info.xhtml">TensorInfo</a> *info, int x, int y, int width, int height, float scale_x, float scale_y)</td></tr>
 141 <tr class="memdesc:a8798dad6f6ace10ca2b814464d666ca0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor for a rectangular access pattern.  <a href="#a8798dad6f6ace10ca2b814464d666ca0">More...</a><br /></td></tr>
 142 <tr class="separator:a8798dad6f6ace10ca2b814464d666ca0"><td class="memSeparator" colspan="2">&#160;</td></tr>
 143 <tr class="memitem:a4c22b1f2583d9a660f7bb13e0b07fa1f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_access_window_rectangle.xhtml#a4c22b1f2583d9a660f7bb13e0b07fa1f">AccessWindowRectangle</a> (const <a class="el" href="classarm__compute_1_1_access_window_rectangle.xhtml">AccessWindowRectangle</a> &amp;)=delete</td></tr>
 144 <tr class="separator:a4c22b1f2583d9a660f7bb13e0b07fa1f"><td class="memSeparator" colspan="2">&#160;</td></tr>
 145 <tr class="memitem:abdf21e65ee4cc7cf79a43e3de64dcc7e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_access_window_rectangle.xhtml">AccessWindowRectangle</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_access_window_rectangle.xhtml#abdf21e65ee4cc7cf79a43e3de64dcc7e">operator=</a> (const <a class="el" href="classarm__compute_1_1_access_window_rectangle.xhtml">AccessWindowRectangle</a> &amp;)=delete</td></tr>
 146 <tr class="separator:abdf21e65ee4cc7cf79a43e3de64dcc7e"><td class="memSeparator" colspan="2">&#160;</td></tr>
 147 <tr class="memitem:a4e61df99b87b429b0f8a7a1dfbc10139"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_access_window_rectangle.xhtml#a4e61df99b87b429b0f8a7a1dfbc10139">AccessWindowRectangle</a> (<a class="el" href="classarm__compute_1_1_access_window_rectangle.xhtml">AccessWindowRectangle</a> &amp;&amp;)=default</td></tr>
 148 <tr class="separator:a4e61df99b87b429b0f8a7a1dfbc10139"><td class="memSeparator" colspan="2">&#160;</td></tr>
 149 <tr class="memitem:a21ab33d8ab185c1321f4c213335e6802"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_access_window_rectangle.xhtml">AccessWindowRectangle</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_access_window_rectangle.xhtml#a21ab33d8ab185c1321f4c213335e6802">operator=</a> (<a class="el" href="classarm__compute_1_1_access_window_rectangle.xhtml">AccessWindowRectangle</a> &amp;&amp;)=default</td></tr>
 150 <tr class="separator:a21ab33d8ab185c1321f4c213335e6802"><td class="memSeparator" colspan="2">&#160;</td></tr>
 151 <tr class="memitem:a32733393d362ac5cd19a588bb248e5c6"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_access_window_rectangle.xhtml#a32733393d362ac5cd19a588bb248e5c6">~AccessWindowRectangle</a> ()=default</td></tr>
 152 <tr class="separator:a32733393d362ac5cd19a588bb248e5c6"><td class="memSeparator" colspan="2">&#160;</td></tr>
 153 <tr class="memitem:a6609a604373f053cdba95d701dc22958"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_access_window_rectangle.xhtml#a6609a604373f053cdba95d701dc22958">set_valid_region</a> (const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> &amp;window, <a class="el" href="structarm__compute_1_1_valid_region.xhtml">ValidRegion</a> input_valid_region)</td></tr>
 154 <tr class="memdesc:a6609a604373f053cdba95d701dc22958"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the valid region based on access pattern and valid region of the inputs.  <a href="#a6609a604373f053cdba95d701dc22958">More...</a><br /></td></tr>
 155 <tr class="separator:a6609a604373f053cdba95d701dc22958"><td class="memSeparator" colspan="2">&#160;</td></tr>
 156 <tr class="memitem:a2164fd5c171ac4beb159f077210d369c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_access_window_rectangle.xhtml#a2164fd5c171ac4beb159f077210d369c">set_valid_region</a> (const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> &amp;window, <a class="el" href="structarm__compute_1_1_valid_region.xhtml">ValidRegion</a> input_valid_region, bool border_undefined, <a class="el" href="structarm__compute_1_1_border_size.xhtml">BorderSize</a> border_size) override</td></tr>
 157 <tr class="separator:a2164fd5c171ac4beb159f077210d369c"><td class="memSeparator" colspan="2">&#160;</td></tr>
 158 <tr class="memitem:a7ad9fe991410dc3550f6c4fd6e87a708"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_access_window_rectangle.xhtml#a7ad9fe991410dc3550f6c4fd6e87a708">update_window_if_needed</a> (<a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> &amp;window) const override</td></tr>
 159 <tr class="memdesc:a7ad9fe991410dc3550f6c4fd6e87a708"><td class="mdescLeft">&#160;</td><td class="mdescRight">Shrink the window if padding is not large enough.  <a href="#a7ad9fe991410dc3550f6c4fd6e87a708">More...</a><br /></td></tr>
 160 <tr class="separator:a7ad9fe991410dc3550f6c4fd6e87a708"><td class="memSeparator" colspan="2">&#160;</td></tr>
 161 <tr class="memitem:ab4b8f5a316fa4d33a1c600a3f27e590f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_access_window_rectangle.xhtml#ab4b8f5a316fa4d33a1c600a3f27e590f">update_padding_if_needed</a> (const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> &amp;window) const override</td></tr>
 162 <tr class="memdesc:ab4b8f5a316fa4d33a1c600a3f27e590f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Increase the padding to be large enough for the window.  <a href="#ab4b8f5a316fa4d33a1c600a3f27e590f">More...</a><br /></td></tr>
 163 <tr class="separator:ab4b8f5a316fa4d33a1c600a3f27e590f"><td class="memSeparator" colspan="2">&#160;</td></tr>
 164 <tr class="inherit_header pub_methods_classarm__compute_1_1_i_access_window"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarm__compute_1_1_i_access_window')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classarm__compute_1_1_i_access_window.xhtml">IAccessWindow</a></td></tr>
 165 <tr class="memitem:abc3996ab36cfa27811d661debfca5b5f inherit pub_methods_classarm__compute_1_1_i_access_window"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_access_window.xhtml#abc3996ab36cfa27811d661debfca5b5f">~IAccessWindow</a> ()=default</td></tr>
 166 <tr class="separator:abc3996ab36cfa27811d661debfca5b5f inherit pub_methods_classarm__compute_1_1_i_access_window"><td class="memSeparator" colspan="2">&#160;</td></tr>
 167 </table>
 168 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 169 <div class="textblock"><p>Implementation of a rectangular access pattern. </p>
 170
 171 <p>Definition at line <a class="el" href="_i_access_window_8h_source.xhtml#l00100">100</a> of file <a class="el" href="_i_access_window_8h_source.xhtml">IAccessWindow.h</a>.</p>
 172 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 173 <a class="anchor" id="ab188c1e89be24e1f21b045bc8818d706"></a>
 174 <div class="memitem">
 175 <div class="memproto">
 176 <table class="mlabels">
 177   <tr>
 178   <td class="mlabels-left">
 179       <table class="memname">
 180         <tr>
 181           <td class="memname"><a class="el" href="classarm__compute_1_1_access_window_rectangle.xhtml">AccessWindowRectangle</a> </td>
 182           <td>(</td>
 183           <td class="paramtype"><a class="el" href="classarm__compute_1_1_tensor_info.xhtml">TensorInfo</a> *&#160;</td>
 184           <td class="paramname"><em>info</em>, </td>
 185         </tr>
 186         <tr>
 187           <td class="paramkey"></td>
 188           <td></td>
 189           <td class="paramtype">int&#160;</td>
 190           <td class="paramname"><em>x</em>, </td>
 191         </tr>
 192         <tr>
 193           <td class="paramkey"></td>
 194           <td></td>
 195           <td class="paramtype">int&#160;</td>
 196           <td class="paramname"><em>y</em>, </td>
 197         </tr>
 198         <tr>
 199           <td class="paramkey"></td>
 200           <td></td>
 201           <td class="paramtype">int&#160;</td>
 202           <td class="paramname"><em>width</em>, </td>
 203         </tr>
 204         <tr>
 205           <td class="paramkey"></td>
 206           <td></td>
 207           <td class="paramtype">int&#160;</td>
 208           <td class="paramname"><em>height</em>&#160;</td>
 209         </tr>
 210         <tr>
 211           <td></td>
 212           <td>)</td>
 213           <td></td><td></td>
 214         </tr>
 215       </table>
 216   </td>
 217   <td class="mlabels-right">
 218 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 219   </tr>
 220 </table>
 221 </div><div class="memdoc">
 222
 223 <p>Constructor for a rectangular access pattern. </p>
 224 <dl class="section note"><dt>Note</dt><dd>Width and height have to be non-negative.</dd></dl>
 225 <dl class="params"><dt>Parameters</dt><dd>
 226   <table class="params">
 227     <tr><td class="paramdir">[in,out]</td><td class="paramname">info</td><td><a class="el" href="classarm__compute_1_1_tensor.xhtml" title="Basic implementation of the tensor interface. ">Tensor</a> info of the accessed kernel. </td></tr>
 228     <tr><td class="paramdir">[in]</td><td class="paramname">x</td><td>Offset of the access in X direction. </td></tr>
 229     <tr><td class="paramdir">[in]</td><td class="paramname">y</td><td>Offset of the access in Y direction. </td></tr>
 230     <tr><td class="paramdir">[in]</td><td class="paramname">width</td><td>Number of elements that are accessed in X direction. </td></tr>
 231     <tr><td class="paramdir">[in]</td><td class="paramname">height</td><td>Number of elements that are accessed in Y direction. </td></tr>
 232   </table>
 233   </dd>
 234 </dl>
 235
 236 <p>Definition at line <a class="el" href="_i_access_window_8h_source.xhtml#l00113">113</a> of file <a class="el" href="_i_access_window_8h_source.xhtml">IAccessWindow.h</a>.</p>
 237 <div class="fragment"><div class="line"><a name="l00114"></a><span class="lineno">  114</span>&#160;        : <a class="code" href="classarm__compute_1_1_access_window_rectangle.xhtml#ab188c1e89be24e1f21b045bc8818d706">AccessWindowRectangle</a>(info, x, y, width, height, 1.f, 1.f)</div><div class="line"><a name="l00115"></a><span class="lineno">  115</span>&#160;    {</div><div class="line"><a name="l00116"></a><span class="lineno">  116</span>&#160;    }</div><div class="ttc" id="classarm__compute_1_1_access_window_rectangle_xhtml_ab188c1e89be24e1f21b045bc8818d706"><div class="ttname"><a href="classarm__compute_1_1_access_window_rectangle.xhtml#ab188c1e89be24e1f21b045bc8818d706">arm_compute::AccessWindowRectangle::AccessWindowRectangle</a></div><div class="ttdeci">AccessWindowRectangle(TensorInfo *info, int x, int y, int width, int height)</div><div class="ttdoc">Constructor for a rectangular access pattern. </div><div class="ttdef"><b>Definition:</b> <a href="_i_access_window_8h_source.xhtml#l00113">IAccessWindow.h:113</a></div></div>
 238 </div><!-- fragment -->
 239 </div>
 240 </div>
 241 <a class="anchor" id="a8798dad6f6ace10ca2b814464d666ca0"></a>
 242 <div class="memitem">
 243 <div class="memproto">
 244 <table class="mlabels">
 245   <tr>
 246   <td class="mlabels-left">
 247       <table class="memname">
 248         <tr>
 249           <td class="memname"><a class="el" href="classarm__compute_1_1_access_window_rectangle.xhtml">AccessWindowRectangle</a> </td>
 250           <td>(</td>
 251           <td class="paramtype"><a class="el" href="classarm__compute_1_1_tensor_info.xhtml">TensorInfo</a> *&#160;</td>
 252           <td class="paramname"><em>info</em>, </td>
 253         </tr>
 254         <tr>
 255           <td class="paramkey"></td>
 256           <td></td>
 257           <td class="paramtype">int&#160;</td>
 258           <td class="paramname"><em>x</em>, </td>
 259         </tr>
 260         <tr>
 261           <td class="paramkey"></td>
 262           <td></td>
 263           <td class="paramtype">int&#160;</td>
 264           <td class="paramname"><em>y</em>, </td>
 265         </tr>
 266         <tr>
 267           <td class="paramkey"></td>
 268           <td></td>
 269           <td class="paramtype">int&#160;</td>
 270           <td class="paramname"><em>width</em>, </td>
 271         </tr>
 272         <tr>
 273           <td class="paramkey"></td>
 274           <td></td>
 275           <td class="paramtype">int&#160;</td>
 276           <td class="paramname"><em>height</em>, </td>
 277         </tr>
 278         <tr>
 279           <td class="paramkey"></td>
 280           <td></td>
 281           <td class="paramtype">float&#160;</td>
 282           <td class="paramname"><em>scale_x</em>, </td>
 283         </tr>
 284         <tr>
 285           <td class="paramkey"></td>
 286           <td></td>
 287           <td class="paramtype">float&#160;</td>
 288           <td class="paramname"><em>scale_y</em>&#160;</td>
 289         </tr>
 290         <tr>
 291           <td></td>
 292           <td>)</td>
 293           <td></td><td></td>
 294         </tr>
 295       </table>
 296   </td>
 297   <td class="mlabels-right">
 298 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 299   </tr>
 300 </table>
 301 </div><div class="memdoc">
 302
 303 <p>Constructor for a rectangular access pattern. </p>
 304 <dl class="section note"><dt>Note</dt><dd>Width, height and scale have to be non-negative.</dd></dl>
 305 <dl class="params"><dt>Parameters</dt><dd>
 306   <table class="params">
 307     <tr><td class="paramdir">[in,out]</td><td class="paramname">info</td><td><a class="el" href="classarm__compute_1_1_tensor.xhtml" title="Basic implementation of the tensor interface. ">Tensor</a> info of the accessed kernel. </td></tr>
 308     <tr><td class="paramdir">[in]</td><td class="paramname">x</td><td>Offset of the access in X direction. </td></tr>
 309     <tr><td class="paramdir">[in]</td><td class="paramname">y</td><td>Offset of the access in Y direction. </td></tr>
 310     <tr><td class="paramdir">[in]</td><td class="paramname">width</td><td>Number of elements that are accessed in X direction. </td></tr>
 311     <tr><td class="paramdir">[in]</td><td class="paramname">height</td><td>Number of elements that are accessed in Y direction. </td></tr>
 312     <tr><td class="paramdir">[in]</td><td class="paramname">scale_x</td><td>Ratio along the X direction between the window used by the execute_window_loop and the rectangular access pattern defined </td></tr>
 313     <tr><td class="paramdir">[in]</td><td class="paramname">scale_y</td><td>Ratio along the Y direction between the window used by the execute_window_loop and the rectangular access pattern defined </td></tr>
 314   </table>
 315   </dd>
 316 </dl>
 317
 318 <p>Definition at line <a class="el" href="_i_access_window_8h_source.xhtml#l00130">130</a> of file <a class="el" href="_i_access_window_8h_source.xhtml">IAccessWindow.h</a>.</p>
 319
 320 <p>References <a class="el" href="_error_8h_source.xhtml#l00100">ARM_COMPUTE_ERROR_ON</a>, <a class="el" href="classarm__compute_1_1_i_access_window.xhtml#a36a87c14652ac63c1b18b3873d148957">IAccessWindow::set_valid_region()</a>, <a class="el" href="classarm__compute_1_1_i_access_window.xhtml#abd645498a7cbaebd88b257083e459dd6">IAccessWindow::update_padding_if_needed()</a>, and <a class="el" href="classarm__compute_1_1_i_access_window.xhtml#a5b6940395e0168f3f00da892ded537aa">IAccessWindow::update_window_if_needed()</a>.</p>
 321 <div class="fragment"><div class="line"><a name="l00131"></a><span class="lineno">  131</span>&#160;        : _info(info), _x(x), _y(y), _width(width), _height(height), _scale_x(scale_x), _scale_y(scale_y)</div><div class="line"><a name="l00132"></a><span class="lineno">  132</span>&#160;    {</div><div class="line"><a name="l00133"></a><span class="lineno">  133</span>&#160;        <a class="code" href="_error_8h.xhtml#a54a6080c9f4df1f908e57a9bbb46f5da">ARM_COMPUTE_ERROR_ON</a>(width &lt; 0);</div><div class="line"><a name="l00134"></a><span class="lineno">  134</span>&#160;        <a class="code" href="_error_8h.xhtml#a54a6080c9f4df1f908e57a9bbb46f5da">ARM_COMPUTE_ERROR_ON</a>(height &lt; 0);</div><div class="line"><a name="l00135"></a><span class="lineno">  135</span>&#160;        <a class="code" href="_error_8h.xhtml#a54a6080c9f4df1f908e57a9bbb46f5da">ARM_COMPUTE_ERROR_ON</a>(scale_x &lt; 0);</div><div class="line"><a name="l00136"></a><span class="lineno">  136</span>&#160;        <a class="code" href="_error_8h.xhtml#a54a6080c9f4df1f908e57a9bbb46f5da">ARM_COMPUTE_ERROR_ON</a>(scale_y &lt; 0);</div><div class="line"><a name="l00137"></a><span class="lineno">  137</span>&#160;    }</div><div class="ttc" id="_error_8h_xhtml_a54a6080c9f4df1f908e57a9bbb46f5da"><div class="ttname"><a href="_error_8h.xhtml#a54a6080c9f4df1f908e57a9bbb46f5da">ARM_COMPUTE_ERROR_ON</a></div><div class="ttdeci">#define ARM_COMPUTE_ERROR_ON(cond)</div><div class="ttdoc">If the condition is true then an error message is printed and an exception thrown. </div><div class="ttdef"><b>Definition:</b> <a href="_error_8h_source.xhtml#l00100">Error.h:100</a></div></div>
 322 </div><!-- fragment -->
 323 </div>
 324 </div>
 325 <a class="anchor" id="a4c22b1f2583d9a660f7bb13e0b07fa1f"></a>
 326 <div class="memitem">
 327 <div class="memproto">
 328 <table class="mlabels">
 329   <tr>
 330   <td class="mlabels-left">
 331       <table class="memname">
 332         <tr>
 333           <td class="memname"><a class="el" href="classarm__compute_1_1_access_window_rectangle.xhtml">AccessWindowRectangle</a> </td>
 334           <td>(</td>
 335           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_access_window_rectangle.xhtml">AccessWindowRectangle</a> &amp;&#160;</td>
 336           <td class="paramname"></td><td>)</td>
 337           <td></td>
 338         </tr>
 339       </table>
 340   </td>
 341   <td class="mlabels-right">
 342 <span class="mlabels"><span class="mlabel">delete</span></span>  </td>
 343   </tr>
 344 </table>
 345 </div><div class="memdoc">
 346
 347 </div>
 348 </div>
 349 <a class="anchor" id="a4e61df99b87b429b0f8a7a1dfbc10139"></a>
 350 <div class="memitem">
 351 <div class="memproto">
 352 <table class="mlabels">
 353   <tr>
 354   <td class="mlabels-left">
 355       <table class="memname">
 356         <tr>
 357           <td class="memname"><a class="el" href="classarm__compute_1_1_access_window_rectangle.xhtml">AccessWindowRectangle</a> </td>
 358           <td>(</td>
 359           <td class="paramtype"><a class="el" href="classarm__compute_1_1_access_window_rectangle.xhtml">AccessWindowRectangle</a> &amp;&amp;&#160;</td>
 360           <td class="paramname"></td><td>)</td>
 361           <td></td>
 362         </tr>
 363       </table>
 364   </td>
 365   <td class="mlabels-right">
 366 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
 367   </tr>
 368 </table>
 369 </div><div class="memdoc">
 370
 371 </div>
 372 </div>
 373 <a class="anchor" id="a32733393d362ac5cd19a588bb248e5c6"></a>
 374 <div class="memitem">
 375 <div class="memproto">
 376 <table class="mlabels">
 377   <tr>
 378   <td class="mlabels-left">
 379       <table class="memname">
 380         <tr>
 381           <td class="memname">~<a class="el" href="classarm__compute_1_1_access_window_rectangle.xhtml">AccessWindowRectangle</a> </td>
 382           <td>(</td>
 383           <td class="paramname"></td><td>)</td>
 384           <td></td>
 385         </tr>
 386       </table>
 387   </td>
 388   <td class="mlabels-right">
 389 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
 390   </tr>
 391 </table>
 392 </div><div class="memdoc">
 393
 394 </div>
 395 </div>
 396 <h2 class="groupheader">Member Function Documentation</h2>
 397 <a class="anchor" id="abdf21e65ee4cc7cf79a43e3de64dcc7e"></a>
 398 <div class="memitem">
 399 <div class="memproto">
 400 <table class="mlabels">
 401   <tr>
 402   <td class="mlabels-left">
 403       <table class="memname">
 404         <tr>
 405           <td class="memname"><a class="el" href="classarm__compute_1_1_access_window_rectangle.xhtml">AccessWindowRectangle</a>&amp; operator= </td>
 406           <td>(</td>
 407           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_access_window_rectangle.xhtml">AccessWindowRectangle</a> &amp;&#160;</td>
 408           <td class="paramname"></td><td>)</td>
 409           <td></td>
 410         </tr>
 411       </table>
 412   </td>
 413   <td class="mlabels-right">
 414 <span class="mlabels"><span class="mlabel">delete</span></span>  </td>
 415   </tr>
 416 </table>
 417 </div><div class="memdoc">
 418
 419 </div>
 420 </div>
 421 <a class="anchor" id="a21ab33d8ab185c1321f4c213335e6802"></a>
 422 <div class="memitem">
 423 <div class="memproto">
 424 <table class="mlabels">
 425   <tr>
 426   <td class="mlabels-left">
 427       <table class="memname">
 428         <tr>
 429           <td class="memname"><a class="el" href="classarm__compute_1_1_access_window_rectangle.xhtml">AccessWindowRectangle</a>&amp; operator= </td>
 430           <td>(</td>
 431           <td class="paramtype"><a class="el" href="classarm__compute_1_1_access_window_rectangle.xhtml">AccessWindowRectangle</a> &amp;&amp;&#160;</td>
 432           <td class="paramname"></td><td>)</td>
 433           <td></td>
 434         </tr>
 435       </table>
 436   </td>
 437   <td class="mlabels-right">
 438 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
 439   </tr>
 440 </table>
 441 </div><div class="memdoc">
 442
 443 </div>
 444 </div>
 445 <a class="anchor" id="a6609a604373f053cdba95d701dc22958"></a>
 446 <div class="memitem">
 447 <div class="memproto">
 448       <table class="memname">
 449         <tr>
 450           <td class="memname">void set_valid_region </td>
 451           <td>(</td>
 452           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> &amp;&#160;</td>
 453           <td class="paramname"><em>window</em>, </td>
 454         </tr>
 455         <tr>
 456           <td class="paramkey"></td>
 457           <td></td>
 458           <td class="paramtype"><a class="el" href="structarm__compute_1_1_valid_region.xhtml">ValidRegion</a>&#160;</td>
 459           <td class="paramname"><em>input_valid_region</em>&#160;</td>
 460         </tr>
 461         <tr>
 462           <td></td>
 463           <td>)</td>
 464           <td></td><td></td>
 465         </tr>
 466       </table>
 467 </div><div class="memdoc">
 468
 469 <p>Set the valid region based on access pattern and valid region of the inputs. </p>
 470 <dl class="section note"><dt>Note</dt><dd>This method assumes that there is no border. </dd>
 471 <dd>
 472 This method assumes that all elements written by the kernel are valid.</dd></dl>
 473 <dl class="params"><dt>Parameters</dt><dd>
 474   <table class="params">
 475     <tr><td class="paramdir">[in]</td><td class="paramname">window</td><td>Execution window of the kernel. </td></tr>
 476     <tr><td class="paramdir">[in]</td><td class="paramname">input_valid_region</td><td>Combined valid region of all inputs. </td></tr>
 477   </table>
 478   </dd>
 479 </dl>
 480
 481 </div>
 482 </div>
 483 <a class="anchor" id="a2164fd5c171ac4beb159f077210d369c"></a>
 484 <div class="memitem">
 485 <div class="memproto">
 486 <table class="mlabels">
 487   <tr>
 488   <td class="mlabels-left">
 489       <table class="memname">
 490         <tr>
 491           <td class="memname">void set_valid_region </td>
 492           <td>(</td>
 493           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> &amp;&#160;</td>
 494           <td class="paramname"><em>window</em>, </td>
 495         </tr>
 496         <tr>
 497           <td class="paramkey"></td>
 498           <td></td>
 499           <td class="paramtype"><a class="el" href="structarm__compute_1_1_valid_region.xhtml">ValidRegion</a>&#160;</td>
 500           <td class="paramname"><em>input_valid_region</em>, </td>
 501         </tr>
 502         <tr>
 503           <td class="paramkey"></td>
 504           <td></td>
 505           <td class="paramtype">bool&#160;</td>
 506           <td class="paramname"><em>border_undefined</em>, </td>
 507         </tr>
 508         <tr>
 509           <td class="paramkey"></td>
 510           <td></td>
 511           <td class="paramtype"><a class="el" href="structarm__compute_1_1_border_size.xhtml">BorderSize</a>&#160;</td>
 512           <td class="paramname"><em>border_size</em>&#160;</td>
 513         </tr>
 514         <tr>
 515           <td></td>
 516           <td>)</td>
 517           <td></td><td></td>
 518         </tr>
 519       </table>
 520   </td>
 521   <td class="mlabels-right">
 522 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
 523   </tr>
 524 </table>
 525 </div><div class="memdoc">
 526 <dl class="section note"><dt>Note</dt><dd>This method assumes that all elements written by the kernel are valid. </dd></dl>
 527
 528 <p>Implements <a class="el" href="classarm__compute_1_1_i_access_window.xhtml#a36a87c14652ac63c1b18b3873d148957">IAccessWindow</a>.</p>
 529
 530 </div>
 531 </div>
 532 <a class="anchor" id="ab4b8f5a316fa4d33a1c600a3f27e590f"></a>
 533 <div class="memitem">
 534 <div class="memproto">
 535 <table class="mlabels">
 536   <tr>
 537   <td class="mlabels-left">
 538       <table class="memname">
 539         <tr>
 540           <td class="memname">bool update_padding_if_needed </td>
 541           <td>(</td>
 542           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> &amp;&#160;</td>
 543           <td class="paramname"><em>window</em></td><td>)</td>
 544           <td> const</td>
 545         </tr>
 546       </table>
 547   </td>
 548   <td class="mlabels-right">
 549 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
 550   </tr>
 551 </table>
 552 </div><div class="memdoc">
 553
 554 <p>Increase the padding to be large enough for the window. </p>
 555 <dl class="params"><dt>Parameters</dt><dd>
 556   <table class="params">
 557     <tr><td class="paramdir">[in]</td><td class="paramname">window</td><td><a class="el" href="classarm__compute_1_1_window.xhtml" title="Describe a multidimensional execution window. ">Window</a> used by the kernel.</td></tr>
 558   </table>
 559   </dd>
 560 </dl>
 561 <dl class="section return"><dt>Returns</dt><dd>True if the padding has been changed. </dd></dl>
 562
 563 <p>Implements <a class="el" href="classarm__compute_1_1_i_access_window.xhtml#abd645498a7cbaebd88b257083e459dd6">IAccessWindow</a>.</p>
 564
 565 </div>
 566 </div>
 567 <a class="anchor" id="a7ad9fe991410dc3550f6c4fd6e87a708"></a>
 568 <div class="memitem">
 569 <div class="memproto">
 570 <table class="mlabels">
 571   <tr>
 572   <td class="mlabels-left">
 573       <table class="memname">
 574         <tr>
 575           <td class="memname">bool update_window_if_needed </td>
 576           <td>(</td>
 577           <td class="paramtype"><a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> &amp;&#160;</td>
 578           <td class="paramname"><em>window</em></td><td>)</td>
 579           <td> const</td>
 580         </tr>
 581       </table>
 582   </td>
 583   <td class="mlabels-right">
 584 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
 585   </tr>
 586 </table>
 587 </div><div class="memdoc">
 588
 589 <p>Shrink the window if padding is not large enough. </p>
 590 <dl class="params"><dt>Parameters</dt><dd>
 591   <table class="params">
 592     <tr><td class="paramdir">[in]</td><td class="paramname">window</td><td><a class="el" href="classarm__compute_1_1_window.xhtml" title="Describe a multidimensional execution window. ">Window</a> used by the kernel.</td></tr>
 593   </table>
 594   </dd>
 595 </dl>
 596 <dl class="section return"><dt>Returns</dt><dd>True if the window has been changed. </dd></dl>
 597
 598 <p>Implements <a class="el" href="classarm__compute_1_1_i_access_window.xhtml#a5b6940395e0168f3f00da892ded537aa">IAccessWindow</a>.</p>
 599
 600 </div>
 601 </div>
 602 <hr/>The documentation for this class was generated from the following file:<ul>
 603 <li>arm_compute/core/<a class="el" href="_i_access_window_8h_source.xhtml">IAccessWindow.h</a></li>
 604 </ul>
 605 </div><!-- contents -->
 606 </div><!-- doc-content -->
 607 <!-- start footer part -->
 608 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 609   <ul>
 610     <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_access_window_rectangle.xhtml">AccessWindowRectangle</a></li>
 611     <li class="footer">Generated on Fri Mar 24 2017 17:23:50 for ARM Compute Library by
 612     <a href="http://www.doxygen.org/index.html">
 613     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
 614   </ul>
 615 </div>
 616 </body>
 617 </html>