arm_compute v18.05
[platform/upstream/armcl.git] / documentation / classarm__compute_1_1_access_window_static.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: AccessWindowStatic 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_access_window_static.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>  </div>
120   <div class="headertitle">
121 <div class="title">AccessWindowStatic Class Reference</div>  </div>
122 </div><!--header-->
123 <div class="contents">
124
125 <p>Implementation of a static rectangular access pattern.  
126  <a href="classarm__compute_1_1_access_window_static.xhtml#details">More...</a></p>
127
128 <p><code>#include &lt;<a class="el" href="_access_window_static_8h_source.xhtml">AccessWindowStatic.h</a>&gt;</code></p>
129 <div class="dynheader">
130 Collaboration diagram for AccessWindowStatic:</div>
131 <div class="dyncontent">
132 <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_access_window_static__coll__graph.svg" width="162" height="112"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
133 </div>
134 <center><span class="legend">[<a target="top" href="graph_legend.xhtml">legend</a>]</span></center></div>
135 <table class="memberdecls">
136 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
137 Public Member Functions</h2></td></tr>
138 <tr class="memitem:a9a7f835520e9f3b19b414f61c4f86f99"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_access_window_static.xhtml#a9a7f835520e9f3b19b414f61c4f86f99">AccessWindowStatic</a> (<a class="el" href="classarm__compute_1_1_i_tensor_info.xhtml">ITensorInfo</a> *info, int start_x, int start_y, int end_x, int end_y)</td></tr>
139 <tr class="memdesc:a9a7f835520e9f3b19b414f61c4f86f99"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor for a static access pattern.  <a href="#a9a7f835520e9f3b19b414f61c4f86f99">More...</a><br /></td></tr>
140 <tr class="separator:a9a7f835520e9f3b19b414f61c4f86f99"><td class="memSeparator" colspan="2">&#160;</td></tr>
141 <tr class="memitem:adbdf53818c3318f2f6700b15aa055b5d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_access_window_static.xhtml#adbdf53818c3318f2f6700b15aa055b5d">AccessWindowStatic</a> (const <a class="el" href="classarm__compute_1_1_access_window_static.xhtml">AccessWindowStatic</a> &amp;)=delete</td></tr>
142 <tr class="memdesc:adbdf53818c3318f2f6700b15aa055b5d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent instances of this class from being copied (As this class contains pointers)  <a href="#adbdf53818c3318f2f6700b15aa055b5d">More...</a><br /></td></tr>
143 <tr class="separator:adbdf53818c3318f2f6700b15aa055b5d"><td class="memSeparator" colspan="2">&#160;</td></tr>
144 <tr class="memitem:a5c6934ef061e9aeaa31fa952c05e2730"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_access_window_static.xhtml">AccessWindowStatic</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_access_window_static.xhtml#a5c6934ef061e9aeaa31fa952c05e2730">operator=</a> (const <a class="el" href="classarm__compute_1_1_access_window_static.xhtml">AccessWindowStatic</a> &amp;)=delete</td></tr>
145 <tr class="memdesc:a5c6934ef061e9aeaa31fa952c05e2730"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent instances of this class from being copied (As this class contains pointers)  <a href="#a5c6934ef061e9aeaa31fa952c05e2730">More...</a><br /></td></tr>
146 <tr class="separator:a5c6934ef061e9aeaa31fa952c05e2730"><td class="memSeparator" colspan="2">&#160;</td></tr>
147 <tr class="memitem:a39d00bd382d82a99f7b2055ff0a4c1e2"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_access_window_static.xhtml#a39d00bd382d82a99f7b2055ff0a4c1e2">AccessWindowStatic</a> (<a class="el" href="classarm__compute_1_1_access_window_static.xhtml">AccessWindowStatic</a> &amp;&amp;)=default</td></tr>
148 <tr class="memdesc:a39d00bd382d82a99f7b2055ff0a4c1e2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be move constructed.  <a href="#a39d00bd382d82a99f7b2055ff0a4c1e2">More...</a><br /></td></tr>
149 <tr class="separator:a39d00bd382d82a99f7b2055ff0a4c1e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
150 <tr class="memitem:af5312479f43d5fd6c46e4e8473049847"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_access_window_static.xhtml">AccessWindowStatic</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_access_window_static.xhtml#af5312479f43d5fd6c46e4e8473049847">operator=</a> (<a class="el" href="classarm__compute_1_1_access_window_static.xhtml">AccessWindowStatic</a> &amp;&amp;)=default</td></tr>
151 <tr class="memdesc:af5312479f43d5fd6c46e4e8473049847"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be moved.  <a href="#af5312479f43d5fd6c46e4e8473049847">More...</a><br /></td></tr>
152 <tr class="separator:af5312479f43d5fd6c46e4e8473049847"><td class="memSeparator" colspan="2">&#160;</td></tr>
153 <tr class="memitem:a657392da3805fde373c0cef557739d08"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_access_window_static.xhtml#a657392da3805fde373c0cef557739d08">~AccessWindowStatic</a> ()=default</td></tr>
154 <tr class="memdesc:a657392da3805fde373c0cef557739d08"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default destructor.  <a href="#a657392da3805fde373c0cef557739d08">More...</a><br /></td></tr>
155 <tr class="separator:a657392da3805fde373c0cef557739d08"><td class="memSeparator" colspan="2">&#160;</td></tr>
156 <tr class="memitem:a729ab9364d77a28c009732b497c3b835"><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_static.xhtml#a729ab9364d77a28c009732b497c3b835">set_valid_region</a> (const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> &amp;window, const <a class="el" href="structarm__compute_1_1_valid_region.xhtml">ValidRegion</a> &amp;input_valid_region)</td></tr>
157 <tr class="memdesc:a729ab9364d77a28c009732b497c3b835"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the valid region based on the static access pattern and valid region of the inputs.  <a href="#a729ab9364d77a28c009732b497c3b835">More...</a><br /></td></tr>
158 <tr class="separator:a729ab9364d77a28c009732b497c3b835"><td class="memSeparator" colspan="2">&#160;</td></tr>
159 <tr class="memitem:aab85c0fd0e72d231aad894f28f12528b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structarm__compute_1_1_valid_region.xhtml">ValidRegion</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_access_window_static.xhtml#aab85c0fd0e72d231aad894f28f12528b">compute_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) const </td></tr>
160 <tr class="memdesc:aab85c0fd0e72d231aad894f28f12528b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compute the valid region based on the static access pattern and valid region of the inputs.  <a href="#aab85c0fd0e72d231aad894f28f12528b">More...</a><br /></td></tr>
161 <tr class="separator:aab85c0fd0e72d231aad894f28f12528b"><td class="memSeparator" colspan="2">&#160;</td></tr>
162 <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_static.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>
163 <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>
164 <tr class="separator:a7ad9fe991410dc3550f6c4fd6e87a708"><td class="memSeparator" colspan="2">&#160;</td></tr>
165 <tr class="memitem:a69cb887416c766f20cbec0677b3c8e88"><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_static.xhtml#a69cb887416c766f20cbec0677b3c8e88">update_padding_if_needed</a> (const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> &amp;window) override</td></tr>
166 <tr class="memdesc:a69cb887416c766f20cbec0677b3c8e88"><td class="mdescLeft">&#160;</td><td class="mdescRight">Increase the padding to be large enough for the window.  <a href="#a69cb887416c766f20cbec0677b3c8e88">More...</a><br /></td></tr>
167 <tr class="separator:a69cb887416c766f20cbec0677b3c8e88"><td class="memSeparator" colspan="2">&#160;</td></tr>
168 <tr class="memitem:ae80edc371ba9f02d756aed720040878b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structarm__compute_1_1_valid_region.xhtml">ValidRegion</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_access_window_static.xhtml#ae80edc371ba9f02d756aed720040878b">compute_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) const override</td></tr>
169 <tr class="memdesc:ae80edc371ba9f02d756aed720040878b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compute the valid region based on access pattern and valid region of the inputs.  <a href="#ae80edc371ba9f02d756aed720040878b">More...</a><br /></td></tr>
170 <tr class="separator:ae80edc371ba9f02d756aed720040878b"><td class="memSeparator" colspan="2">&#160;</td></tr>
171 <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>
172 <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>
173 <tr class="memdesc:abc3996ab36cfa27811d661debfca5b5f inherit pub_methods_classarm__compute_1_1_i_access_window"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default virtual destructor.  <a href="#abc3996ab36cfa27811d661debfca5b5f">More...</a><br /></td></tr>
174 <tr class="separator:abc3996ab36cfa27811d661debfca5b5f inherit pub_methods_classarm__compute_1_1_i_access_window"><td class="memSeparator" colspan="2">&#160;</td></tr>
175 </table>
176 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
177 <div class="textblock"><p>Implementation of a static rectangular access pattern. </p>
178 <p>In this implementation the access offsets and sizes are not relative to the current element. Instead they are considered to be absolute coordinates within the accessed tensor's shape. </p>
179
180 <p>Definition at line <a class="el" href="_access_window_static_8h_source.xhtml#l00046">46</a> of file <a class="el" href="_access_window_static_8h_source.xhtml">AccessWindowStatic.h</a>.</p>
181 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
182 <a class="anchor" id="a9a7f835520e9f3b19b414f61c4f86f99"></a>
183 <div class="memitem">
184 <div class="memproto">
185       <table class="memname">
186         <tr>
187           <td class="memname"><a class="el" href="classarm__compute_1_1_access_window_static.xhtml">AccessWindowStatic</a> </td>
188           <td>(</td>
189           <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_tensor_info.xhtml">ITensorInfo</a> *&#160;</td>
190           <td class="paramname"><em>info</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>start_x</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>start_y</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>end_x</em>, </td>
209         </tr>
210         <tr>
211           <td class="paramkey"></td>
212           <td></td>
213           <td class="paramtype">int&#160;</td>
214           <td class="paramname"><em>end_y</em>&#160;</td>
215         </tr>
216         <tr>
217           <td></td>
218           <td>)</td>
219           <td></td><td></td>
220         </tr>
221       </table>
222 </div><div class="memdoc">
223
224 <p>Constructor for a static access pattern. </p>
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">start_x</td><td>Start of the access in X direction. </td></tr>
229     <tr><td class="paramdir">[in]</td><td class="paramname">start_y</td><td>Start of the access in Y direction. </td></tr>
230     <tr><td class="paramdir">[in]</td><td class="paramname">end_x</td><td>End of the access in X direction. </td></tr>
231     <tr><td class="paramdir">[in]</td><td class="paramname">end_y</td><td>End of the access in Y direction. </td></tr>
232   </table>
233   </dd>
234 </dl>
235
236 </div>
237 </div>
238 <a class="anchor" id="adbdf53818c3318f2f6700b15aa055b5d"></a>
239 <div class="memitem">
240 <div class="memproto">
241 <table class="mlabels">
242   <tr>
243   <td class="mlabels-left">
244       <table class="memname">
245         <tr>
246           <td class="memname"><a class="el" href="classarm__compute_1_1_access_window_static.xhtml">AccessWindowStatic</a> </td>
247           <td>(</td>
248           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_access_window_static.xhtml">AccessWindowStatic</a> &amp;&#160;</td>
249           <td class="paramname"></td><td>)</td>
250           <td></td>
251         </tr>
252       </table>
253   </td>
254   <td class="mlabels-right">
255 <span class="mlabels"><span class="mlabel">delete</span></span>  </td>
256   </tr>
257 </table>
258 </div><div class="memdoc">
259
260 <p>Prevent instances of this class from being copied (As this class contains pointers) </p>
261
262 </div>
263 </div>
264 <a class="anchor" id="a39d00bd382d82a99f7b2055ff0a4c1e2"></a>
265 <div class="memitem">
266 <div class="memproto">
267 <table class="mlabels">
268   <tr>
269   <td class="mlabels-left">
270       <table class="memname">
271         <tr>
272           <td class="memname"><a class="el" href="classarm__compute_1_1_access_window_static.xhtml">AccessWindowStatic</a> </td>
273           <td>(</td>
274           <td class="paramtype"><a class="el" href="classarm__compute_1_1_access_window_static.xhtml">AccessWindowStatic</a> &amp;&amp;&#160;</td>
275           <td class="paramname"></td><td>)</td>
276           <td></td>
277         </tr>
278       </table>
279   </td>
280   <td class="mlabels-right">
281 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
282   </tr>
283 </table>
284 </div><div class="memdoc">
285
286 <p>Allow instances of this class to be move constructed. </p>
287
288 </div>
289 </div>
290 <a class="anchor" id="a657392da3805fde373c0cef557739d08"></a>
291 <div class="memitem">
292 <div class="memproto">
293 <table class="mlabels">
294   <tr>
295   <td class="mlabels-left">
296       <table class="memname">
297         <tr>
298           <td class="memname">~<a class="el" href="classarm__compute_1_1_access_window_static.xhtml">AccessWindowStatic</a> </td>
299           <td>(</td>
300           <td class="paramname"></td><td>)</td>
301           <td></td>
302         </tr>
303       </table>
304   </td>
305   <td class="mlabels-right">
306 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
307   </tr>
308 </table>
309 </div><div class="memdoc">
310
311 <p>Default destructor. </p>
312
313 </div>
314 </div>
315 <h2 class="groupheader">Member Function Documentation</h2>
316 <a class="anchor" id="aab85c0fd0e72d231aad894f28f12528b"></a>
317 <div class="memitem">
318 <div class="memproto">
319       <table class="memname">
320         <tr>
321           <td class="memname"><a class="el" href="structarm__compute_1_1_valid_region.xhtml">ValidRegion</a> compute_valid_region </td>
322           <td>(</td>
323           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> &amp;&#160;</td>
324           <td class="paramname"><em>window</em>, </td>
325         </tr>
326         <tr>
327           <td class="paramkey"></td>
328           <td></td>
329           <td class="paramtype"><a class="el" href="structarm__compute_1_1_valid_region.xhtml">ValidRegion</a>&#160;</td>
330           <td class="paramname"><em>input_valid_region</em>&#160;</td>
331         </tr>
332         <tr>
333           <td></td>
334           <td>)</td>
335           <td></td><td> const</td>
336         </tr>
337       </table>
338 </div><div class="memdoc">
339
340 <p>Compute the valid region based on the static access pattern and valid region of the inputs. </p>
341 <dl class="params"><dt>Parameters</dt><dd>
342   <table class="params">
343     <tr><td class="paramdir">[in]</td><td class="paramname">window</td><td>Execution window of the kernel. </td></tr>
344     <tr><td class="paramdir">[in]</td><td class="paramname">input_valid_region</td><td>Combined valid region of all inputs.</td></tr>
345   </table>
346   </dd>
347 </dl>
348 <dl class="section return"><dt>Returns</dt><dd>a valid region. </dd></dl>
349
350 </div>
351 </div>
352 <a class="anchor" id="ae80edc371ba9f02d756aed720040878b"></a>
353 <div class="memitem">
354 <div class="memproto">
355 <table class="mlabels">
356   <tr>
357   <td class="mlabels-left">
358       <table class="memname">
359         <tr>
360           <td class="memname"><a class="el" href="structarm__compute_1_1_valid_region.xhtml">ValidRegion</a> compute_valid_region </td>
361           <td>(</td>
362           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> &amp;&#160;</td>
363           <td class="paramname"><em>window</em>, </td>
364         </tr>
365         <tr>
366           <td class="paramkey"></td>
367           <td></td>
368           <td class="paramtype"><a class="el" href="structarm__compute_1_1_valid_region.xhtml">ValidRegion</a>&#160;</td>
369           <td class="paramname"><em>input_valid_region</em>, </td>
370         </tr>
371         <tr>
372           <td class="paramkey"></td>
373           <td></td>
374           <td class="paramtype">bool&#160;</td>
375           <td class="paramname"><em>border_undefined</em>, </td>
376         </tr>
377         <tr>
378           <td class="paramkey"></td>
379           <td></td>
380           <td class="paramtype"><a class="el" href="structarm__compute_1_1_border_size.xhtml">BorderSize</a>&#160;</td>
381           <td class="paramname"><em>border_size</em>&#160;</td>
382         </tr>
383         <tr>
384           <td></td>
385           <td>)</td>
386           <td></td><td> const</td>
387         </tr>
388       </table>
389   </td>
390   <td class="mlabels-right">
391 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
392   </tr>
393 </table>
394 </div><div class="memdoc">
395
396 <p>Compute the valid region based on access pattern and valid region of the inputs. </p>
397 <dl class="section note"><dt>Note</dt><dd>This method assumes that there is no border.</dd></dl>
398 <dl class="params"><dt>Parameters</dt><dd>
399   <table class="params">
400     <tr><td class="paramdir">[in]</td><td class="paramname">window</td><td>Execution window of the kernel. </td></tr>
401     <tr><td class="paramdir">[in]</td><td class="paramname">input_valid_region</td><td>Combined valid region of all inputs. </td></tr>
402     <tr><td class="paramdir">[in]</td><td class="paramname">border_undefined</td><td>Undefined borders are excluded from the valid region. </td></tr>
403     <tr><td class="paramdir">[in]</td><td class="paramname">border_size</td><td>Size of the border around the XY-plane of the tensor.</td></tr>
404   </table>
405   </dd>
406 </dl>
407 <dl class="section return"><dt>Returns</dt><dd>a valid region. </dd></dl>
408
409 <p>Implements <a class="el" href="classarm__compute_1_1_i_access_window.xhtml#ae2b4aabf2a14dce92e04c0eeb0ab73b9">IAccessWindow</a>.</p>
410
411 </div>
412 </div>
413 <a class="anchor" id="a5c6934ef061e9aeaa31fa952c05e2730"></a>
414 <div class="memitem">
415 <div class="memproto">
416 <table class="mlabels">
417   <tr>
418   <td class="mlabels-left">
419       <table class="memname">
420         <tr>
421           <td class="memname"><a class="el" href="classarm__compute_1_1_access_window_static.xhtml">AccessWindowStatic</a>&amp; operator= </td>
422           <td>(</td>
423           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_access_window_static.xhtml">AccessWindowStatic</a> &amp;&#160;</td>
424           <td class="paramname"></td><td>)</td>
425           <td></td>
426         </tr>
427       </table>
428   </td>
429   <td class="mlabels-right">
430 <span class="mlabels"><span class="mlabel">delete</span></span>  </td>
431   </tr>
432 </table>
433 </div><div class="memdoc">
434
435 <p>Prevent instances of this class from being copied (As this class contains pointers) </p>
436
437 </div>
438 </div>
439 <a class="anchor" id="af5312479f43d5fd6c46e4e8473049847"></a>
440 <div class="memitem">
441 <div class="memproto">
442 <table class="mlabels">
443   <tr>
444   <td class="mlabels-left">
445       <table class="memname">
446         <tr>
447           <td class="memname"><a class="el" href="classarm__compute_1_1_access_window_static.xhtml">AccessWindowStatic</a>&amp; operator= </td>
448           <td>(</td>
449           <td class="paramtype"><a class="el" href="classarm__compute_1_1_access_window_static.xhtml">AccessWindowStatic</a> &amp;&amp;&#160;</td>
450           <td class="paramname"></td><td>)</td>
451           <td></td>
452         </tr>
453       </table>
454   </td>
455   <td class="mlabels-right">
456 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
457   </tr>
458 </table>
459 </div><div class="memdoc">
460
461 <p>Allow instances of this class to be moved. </p>
462
463 </div>
464 </div>
465 <a class="anchor" id="a729ab9364d77a28c009732b497c3b835"></a>
466 <div class="memitem">
467 <div class="memproto">
468       <table class="memname">
469         <tr>
470           <td class="memname">void set_valid_region </td>
471           <td>(</td>
472           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> &amp;&#160;</td>
473           <td class="paramname"><em>window</em>, </td>
474         </tr>
475         <tr>
476           <td class="paramkey"></td>
477           <td></td>
478           <td class="paramtype">const <a class="el" href="structarm__compute_1_1_valid_region.xhtml">ValidRegion</a> &amp;&#160;</td>
479           <td class="paramname"><em>input_valid_region</em>&#160;</td>
480         </tr>
481         <tr>
482           <td></td>
483           <td>)</td>
484           <td></td><td></td>
485         </tr>
486       </table>
487 </div><div class="memdoc">
488
489 <p>Set the valid region based on the static access pattern and valid region of the inputs. </p>
490 <dl class="params"><dt>Parameters</dt><dd>
491   <table class="params">
492     <tr><td class="paramdir">[in]</td><td class="paramname">window</td><td>Execution window of the kernel. </td></tr>
493     <tr><td class="paramdir">[in]</td><td class="paramname">input_valid_region</td><td>Combined valid region of all inputs. </td></tr>
494   </table>
495   </dd>
496 </dl>
497
498 </div>
499 </div>
500 <a class="anchor" id="a69cb887416c766f20cbec0677b3c8e88"></a>
501 <div class="memitem">
502 <div class="memproto">
503 <table class="mlabels">
504   <tr>
505   <td class="mlabels-left">
506       <table class="memname">
507         <tr>
508           <td class="memname">bool update_padding_if_needed </td>
509           <td>(</td>
510           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> &amp;&#160;</td>
511           <td class="paramname"><em>window</em></td><td>)</td>
512           <td></td>
513         </tr>
514       </table>
515   </td>
516   <td class="mlabels-right">
517 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
518   </tr>
519 </table>
520 </div><div class="memdoc">
521
522 <p>Increase the padding to be large enough for the window. </p>
523 <dl class="params"><dt>Parameters</dt><dd>
524   <table class="params">
525     <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>
526   </table>
527   </dd>
528 </dl>
529 <dl class="section return"><dt>Returns</dt><dd>True if the padding has been changed. </dd></dl>
530
531 <p>Implements <a class="el" href="classarm__compute_1_1_i_access_window.xhtml#a5a5f3d4d4461121db2e4e3b4d3ee587f">IAccessWindow</a>.</p>
532
533 </div>
534 </div>
535 <a class="anchor" id="a7ad9fe991410dc3550f6c4fd6e87a708"></a>
536 <div class="memitem">
537 <div class="memproto">
538 <table class="mlabels">
539   <tr>
540   <td class="mlabels-left">
541       <table class="memname">
542         <tr>
543           <td class="memname">bool update_window_if_needed </td>
544           <td>(</td>
545           <td class="paramtype"><a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> &amp;&#160;</td>
546           <td class="paramname"><em>window</em></td><td>)</td>
547           <td> const</td>
548         </tr>
549       </table>
550   </td>
551   <td class="mlabels-right">
552 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
553   </tr>
554 </table>
555 </div><div class="memdoc">
556
557 <p>Shrink the window if padding is not large enough. </p>
558 <dl class="params"><dt>Parameters</dt><dd>
559   <table class="params">
560     <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>
561   </table>
562   </dd>
563 </dl>
564 <dl class="section return"><dt>Returns</dt><dd>True if the window has been changed. </dd></dl>
565
566 <p>Implements <a class="el" href="classarm__compute_1_1_i_access_window.xhtml#a5b6940395e0168f3f00da892ded537aa">IAccessWindow</a>.</p>
567
568 </div>
569 </div>
570 <hr/>The documentation for this class was generated from the following file:<ul>
571 <li>arm_compute/core/<a class="el" href="_access_window_static_8h_source.xhtml">AccessWindowStatic.h</a></li>
572 </ul>
573 </div><!-- contents -->
574 </div><!-- doc-content -->
575 <!-- start footer part -->
576 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
577   <ul>
578     <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_static.xhtml">AccessWindowStatic</a></li>
579     <li class="footer">Generated on Wed May 23 2018 11:36:40 for Compute Library by
580     <a href="http://www.doxygen.org/index.html">
581     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
582   </ul>
583 </div>
584 </body>
585 </html>