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">
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: IAccessWindow 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);
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(); });
27 <script type="text/x-mathjax-config">
29 extensions: ["tex2jax.js"],
30 jax: ["input/TeX","output/HTML-CSS"],
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" />
36 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
38 <table cellspacing="0" cellpadding="0">
40 <tr style="height: 56px;">
41 <td style="padding-left: 0.5em;">
42 <div id="projectname">Compute Library
43  <span id="projectnumber">18.05</span>
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');
55 <div id="navrow1" class="tabs">
57 <li><a href="index.xhtml"><span>Main Page</span></a></li>
58 <li><a href="pages.xhtml"><span>Related 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 Structures</span></a></li>
61 <li><a href="files.xhtml"><span>Files</span></a></li>
63 <div id="MSearchBox" class="MSearchBoxInactive">
65 <img id="MSearchSelect" src="search/mag_sel.png"
66 onmouseover="return searchBox.OnSearchSelectShow()"
67 onmouseout="return searchBox.OnSearchSelectHide()"
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>
80 <div id="navrow2" class="tabs2">
82 <li><a href="annotated.xhtml"><span>Data Structures</span></a></li>
83 <li><a href="classes.xhtml"><span>Data Structure Index</span></a></li>
84 <li><a href="inherits.xhtml"><span>Class Hierarchy</span></a></li>
85 <li><a href="functions.xhtml"><span>Data Fields</span></a></li>
89 <div id="side-nav" class="ui-resizable side-nav-resizable">
91 <div id="nav-tree-contents">
92 <div id="nav-sync" class="sync"></div>
95 <div id="splitbar" style="-moz-user-select:none;"
96 class="ui-resizable-handle">
99 <script type="text/javascript">
100 $(document).ready(function(){initNavTree('classarm__compute_1_1_i_access_window.xhtml','');});
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)">
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">
118 <div class="summary">
119 <a href="#pub-methods">Public Member Functions</a> </div>
120 <div class="headertitle">
121 <div class="title">IAccessWindow Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
123 <div class="contents">
125 <p>Interface describing methods to update access window and padding based on kernel parameters.
126 <a href="classarm__compute_1_1_i_access_window.xhtml#details">More...</a></p>
128 <p><code>#include <<a class="el" href="_i_access_window_8h_source.xhtml">IAccessWindow.h</a>></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:abc3996ab36cfa27811d661debfca5b5f"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_access_window.xhtml#abc3996ab36cfa27811d661debfca5b5f">~IAccessWindow</a> ()=default</td></tr>
133 <tr class="memdesc:abc3996ab36cfa27811d661debfca5b5f"><td class="mdescLeft"> </td><td class="mdescRight">Default virtual destructor. <a href="#abc3996ab36cfa27811d661debfca5b5f">More...</a><br /></td></tr>
134 <tr class="separator:abc3996ab36cfa27811d661debfca5b5f"><td class="memSeparator" colspan="2"> </td></tr>
135 <tr class="memitem:a5b6940395e0168f3f00da892ded537aa"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_access_window.xhtml#a5b6940395e0168f3f00da892ded537aa">update_window_if_needed</a> (<a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> &window) const =0</td></tr>
136 <tr class="memdesc:a5b6940395e0168f3f00da892ded537aa"><td class="mdescLeft"> </td><td class="mdescRight">Shrink the window if padding is not large enough. <a href="#a5b6940395e0168f3f00da892ded537aa">More...</a><br /></td></tr>
137 <tr class="separator:a5b6940395e0168f3f00da892ded537aa"><td class="memSeparator" colspan="2"> </td></tr>
138 <tr class="memitem:a5a5f3d4d4461121db2e4e3b4d3ee587f"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_access_window.xhtml#a5a5f3d4d4461121db2e4e3b4d3ee587f">update_padding_if_needed</a> (const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> &window)=0</td></tr>
139 <tr class="memdesc:a5a5f3d4d4461121db2e4e3b4d3ee587f"><td class="mdescLeft"> </td><td class="mdescRight">Increase the padding to be large enough for the window. <a href="#a5a5f3d4d4461121db2e4e3b4d3ee587f">More...</a><br /></td></tr>
140 <tr class="separator:a5a5f3d4d4461121db2e4e3b4d3ee587f"><td class="memSeparator" colspan="2"> </td></tr>
141 <tr class="memitem:ae2b4aabf2a14dce92e04c0eeb0ab73b9"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="structarm__compute_1_1_valid_region.xhtml">ValidRegion</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_access_window.xhtml#ae2b4aabf2a14dce92e04c0eeb0ab73b9">compute_valid_region</a> (const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> &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 =0</td></tr>
142 <tr class="memdesc:ae2b4aabf2a14dce92e04c0eeb0ab73b9"><td class="mdescLeft"> </td><td class="mdescRight">Compute the valid region based on access pattern and valid region of the inputs. <a href="#ae2b4aabf2a14dce92e04c0eeb0ab73b9">More...</a><br /></td></tr>
143 <tr class="separator:ae2b4aabf2a14dce92e04c0eeb0ab73b9"><td class="memSeparator" colspan="2"> </td></tr>
145 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
146 <div class="textblock"><p>Interface describing methods to update access window and padding based on kernel parameters. </p>
148 <p>Definition at line <a class="el" href="_i_access_window_8h_source.xhtml#l00071">71</a> of file <a class="el" href="_i_access_window_8h_source.xhtml">IAccessWindow.h</a>.</p>
149 </div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
150 <a class="anchor" id="abc3996ab36cfa27811d661debfca5b5f"></a>
151 <div class="memitem">
152 <div class="memproto">
153 <table class="mlabels">
155 <td class="mlabels-left">
156 <table class="memname">
158 <td class="memname">virtual ~<a class="el" href="classarm__compute_1_1_i_access_window.xhtml">IAccessWindow</a> </td>
160 <td class="paramname"></td><td>)</td>
165 <td class="mlabels-right">
166 <span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">default</span></span> </td>
169 </div><div class="memdoc">
171 <p>Default virtual destructor. </p>
175 <h2 class="groupheader">Member Function Documentation</h2>
176 <a class="anchor" id="ae2b4aabf2a14dce92e04c0eeb0ab73b9"></a>
177 <div class="memitem">
178 <div class="memproto">
179 <table class="mlabels">
181 <td class="mlabels-left">
182 <table class="memname">
184 <td class="memname">virtual <a class="el" href="structarm__compute_1_1_valid_region.xhtml">ValidRegion</a> compute_valid_region </td>
186 <td class="paramtype">const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> & </td>
187 <td class="paramname"><em>window</em>, </td>
190 <td class="paramkey"></td>
192 <td class="paramtype"><a class="el" href="structarm__compute_1_1_valid_region.xhtml">ValidRegion</a> </td>
193 <td class="paramname"><em>input_valid_region</em>, </td>
196 <td class="paramkey"></td>
198 <td class="paramtype">bool </td>
199 <td class="paramname"><em>border_undefined</em>, </td>
202 <td class="paramkey"></td>
204 <td class="paramtype"><a class="el" href="structarm__compute_1_1_border_size.xhtml">BorderSize</a> </td>
205 <td class="paramname"><em>border_size</em> </td>
210 <td></td><td> const</td>
214 <td class="mlabels-right">
215 <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
218 </div><div class="memdoc">
220 <p>Compute the valid region based on access pattern and valid region of the inputs. </p>
221 <dl class="section note"><dt>Note</dt><dd>This method assumes that there is no border.</dd></dl>
222 <dl class="params"><dt>Parameters</dt><dd>
223 <table class="params">
224 <tr><td class="paramdir">[in]</td><td class="paramname">window</td><td>Execution window of the kernel. </td></tr>
225 <tr><td class="paramdir">[in]</td><td class="paramname">input_valid_region</td><td>Combined valid region of all inputs. </td></tr>
226 <tr><td class="paramdir">[in]</td><td class="paramname">border_undefined</td><td>Undefined borders are excluded from the valid region. </td></tr>
227 <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>
231 <dl class="section return"><dt>Returns</dt><dd>a valid region. </dd></dl>
233 <p>Implemented in <a class="el" href="classarm__compute_1_1_access_window_rectangle.xhtml#ae80edc371ba9f02d756aed720040878b">AccessWindowRectangle</a>, <a class="el" href="classarm__compute_1_1_access_window_static.xhtml#ae80edc371ba9f02d756aed720040878b">AccessWindowStatic</a>, <a class="el" href="classarm__compute_1_1_access_window_auto_padding.xhtml#ae80edc371ba9f02d756aed720040878b">AccessWindowAutoPadding</a>, and <a class="el" href="classarm__compute_1_1_access_window_transpose.xhtml#ae80edc371ba9f02d756aed720040878b">AccessWindowTranspose</a>.</p>
235 <p>Referenced by <a class="el" href="_i_access_window_8h_source.xhtml#l00137">AccessWindowRectangle::AccessWindowRectangle()</a>.</p>
239 <a class="anchor" id="a5a5f3d4d4461121db2e4e3b4d3ee587f"></a>
240 <div class="memitem">
241 <div class="memproto">
242 <table class="mlabels">
244 <td class="mlabels-left">
245 <table class="memname">
247 <td class="memname">virtual bool update_padding_if_needed </td>
249 <td class="paramtype">const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> & </td>
250 <td class="paramname"><em>window</em></td><td>)</td>
255 <td class="mlabels-right">
256 <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
259 </div><div class="memdoc">
261 <p>Increase the padding to be large enough for the window. </p>
262 <dl class="params"><dt>Parameters</dt><dd>
263 <table class="params">
264 <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>
268 <dl class="section return"><dt>Returns</dt><dd>True if the padding has been changed. </dd></dl>
270 <p>Implemented in <a class="el" href="classarm__compute_1_1_access_window_rectangle.xhtml#a69cb887416c766f20cbec0677b3c8e88">AccessWindowRectangle</a>, <a class="el" href="classarm__compute_1_1_access_window_static.xhtml#a69cb887416c766f20cbec0677b3c8e88">AccessWindowStatic</a>, <a class="el" href="classarm__compute_1_1_access_window_auto_padding.xhtml#a69cb887416c766f20cbec0677b3c8e88">AccessWindowAutoPadding</a>, and <a class="el" href="classarm__compute_1_1_access_window_transpose.xhtml#a69cb887416c766f20cbec0677b3c8e88">AccessWindowTranspose</a>.</p>
272 <p>Referenced by <a class="el" href="_i_access_window_8h_source.xhtml#l00137">AccessWindowRectangle::AccessWindowRectangle()</a>, and <a class="el" href="arm__compute_2core_2_helpers_8h_source.xhtml#l00368">arm_compute::update_window_and_padding()</a>.</p>
276 <a class="anchor" id="a5b6940395e0168f3f00da892ded537aa"></a>
277 <div class="memitem">
278 <div class="memproto">
279 <table class="mlabels">
281 <td class="mlabels-left">
282 <table class="memname">
284 <td class="memname">virtual bool update_window_if_needed </td>
286 <td class="paramtype"><a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> & </td>
287 <td class="paramname"><em>window</em></td><td>)</td>
292 <td class="mlabels-right">
293 <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
296 </div><div class="memdoc">
298 <p>Shrink the window if padding is not large enough. </p>
299 <dl class="params"><dt>Parameters</dt><dd>
300 <table class="params">
301 <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>
305 <dl class="section return"><dt>Returns</dt><dd>True if the window has been changed. </dd></dl>
307 <p>Implemented in <a class="el" href="classarm__compute_1_1_access_window_rectangle.xhtml#a7ad9fe991410dc3550f6c4fd6e87a708">AccessWindowRectangle</a>, <a class="el" href="classarm__compute_1_1_access_window_static.xhtml#a7ad9fe991410dc3550f6c4fd6e87a708">AccessWindowStatic</a>, <a class="el" href="classarm__compute_1_1_access_window_auto_padding.xhtml#a7ad9fe991410dc3550f6c4fd6e87a708">AccessWindowAutoPadding</a>, and <a class="el" href="classarm__compute_1_1_access_window_transpose.xhtml#a7ad9fe991410dc3550f6c4fd6e87a708">AccessWindowTranspose</a>.</p>
309 <p>Referenced by <a class="el" href="_i_access_window_8h_source.xhtml#l00137">AccessWindowRectangle::AccessWindowRectangle()</a>, and <a class="el" href="arm__compute_2core_2_helpers_8h_source.xhtml#l00368">arm_compute::update_window_and_padding()</a>.</p>
313 <hr/>The documentation for this class was generated from the following file:<ul>
314 <li>arm_compute/core/<a class="el" href="_i_access_window_8h_source.xhtml">IAccessWindow.h</a></li>
316 </div><!-- contents -->
317 </div><!-- doc-content -->
318 <!-- start footer part -->
319 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
321 <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_i_access_window.xhtml">IAccessWindow</a></li>
322 <li class="footer">Generated on Wed May 23 2018 11:36:41 for Compute Library by
323 <a href="http://www.doxygen.org/index.html">
324 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>