arm_compute v18.05
[platform/upstream/armcl.git] / documentation / classarm__compute_1_1_access_window_vertical.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: AccessWindowVertical 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_vertical.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">AccessWindowVertical Class Reference</div>  </div>
122 </div><!--header-->
123 <div class="contents">
124
125 <p>Implementation of a column access pattern.  
126  <a href="classarm__compute_1_1_access_window_vertical.xhtml#details">More...</a></p>
127
128 <p><code>#include &lt;<a class="el" href="_i_access_window_8h_source.xhtml">IAccessWindow.h</a>&gt;</code></p>
129 <div class="dynheader">
130 Collaboration diagram for AccessWindowVertical:</div>
131 <div class="dyncontent">
132 <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_access_window_vertical__coll__graph.svg" width="187" height="187"><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:af470e59c429be56a65a66e806816246d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_access_window_vertical.xhtml#af470e59c429be56a65a66e806816246d">AccessWindowVertical</a> (<a class="el" href="classarm__compute_1_1_i_tensor_info.xhtml">ITensorInfo</a> *info, int y, int height, float scale_y=1.f)</td></tr>
139 <tr class="memdesc:af470e59c429be56a65a66e806816246d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor for a column access pattern.  <a href="#af470e59c429be56a65a66e806816246d">More...</a><br /></td></tr>
140 <tr class="separator:af470e59c429be56a65a66e806816246d"><td class="memSeparator" colspan="2">&#160;</td></tr>
141 <tr class="inherit_header pub_methods_classarm__compute_1_1_access_window_rectangle"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarm__compute_1_1_access_window_rectangle')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classarm__compute_1_1_access_window_rectangle.xhtml">AccessWindowRectangle</a></td></tr>
142 <tr class="memitem:ae89409b4c8b08f06ab694e829223932b inherit pub_methods_classarm__compute_1_1_access_window_rectangle"><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#ae89409b4c8b08f06ab694e829223932b">AccessWindowRectangle</a> (<a class="el" href="classarm__compute_1_1_i_tensor_info.xhtml">ITensorInfo</a> *info, int x, int y, int width, int height)</td></tr>
143 <tr class="memdesc:ae89409b4c8b08f06ab694e829223932b inherit pub_methods_classarm__compute_1_1_access_window_rectangle"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor for a rectangular access pattern.  <a href="#ae89409b4c8b08f06ab694e829223932b">More...</a><br /></td></tr>
144 <tr class="separator:ae89409b4c8b08f06ab694e829223932b inherit pub_methods_classarm__compute_1_1_access_window_rectangle"><td class="memSeparator" colspan="2">&#160;</td></tr>
145 <tr class="memitem:aa8bd157ea64c2b37dec8b035b1b78a07 inherit pub_methods_classarm__compute_1_1_access_window_rectangle"><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#aa8bd157ea64c2b37dec8b035b1b78a07">AccessWindowRectangle</a> (<a class="el" href="classarm__compute_1_1_i_tensor_info.xhtml">ITensorInfo</a> *info, int x, int y, int width, int height, float scale_x, float scale_y)</td></tr>
146 <tr class="memdesc:aa8bd157ea64c2b37dec8b035b1b78a07 inherit pub_methods_classarm__compute_1_1_access_window_rectangle"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor for a rectangular access pattern.  <a href="#aa8bd157ea64c2b37dec8b035b1b78a07">More...</a><br /></td></tr>
147 <tr class="separator:aa8bd157ea64c2b37dec8b035b1b78a07 inherit pub_methods_classarm__compute_1_1_access_window_rectangle"><td class="memSeparator" colspan="2">&#160;</td></tr>
148 <tr class="memitem:a4c22b1f2583d9a660f7bb13e0b07fa1f inherit pub_methods_classarm__compute_1_1_access_window_rectangle"><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>
149 <tr class="memdesc:a4c22b1f2583d9a660f7bb13e0b07fa1f inherit pub_methods_classarm__compute_1_1_access_window_rectangle"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent instances of this class from being copied (As this class contains pointers)  <a href="#a4c22b1f2583d9a660f7bb13e0b07fa1f">More...</a><br /></td></tr>
150 <tr class="separator:a4c22b1f2583d9a660f7bb13e0b07fa1f inherit pub_methods_classarm__compute_1_1_access_window_rectangle"><td class="memSeparator" colspan="2">&#160;</td></tr>
151 <tr class="memitem:a4e61df99b87b429b0f8a7a1dfbc10139 inherit pub_methods_classarm__compute_1_1_access_window_rectangle"><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>
152 <tr class="memdesc:a4e61df99b87b429b0f8a7a1dfbc10139 inherit pub_methods_classarm__compute_1_1_access_window_rectangle"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be move constructed.  <a href="#a4e61df99b87b429b0f8a7a1dfbc10139">More...</a><br /></td></tr>
153 <tr class="separator:a4e61df99b87b429b0f8a7a1dfbc10139 inherit pub_methods_classarm__compute_1_1_access_window_rectangle"><td class="memSeparator" colspan="2">&#160;</td></tr>
154 <tr class="memitem:abdf21e65ee4cc7cf79a43e3de64dcc7e inherit pub_methods_classarm__compute_1_1_access_window_rectangle"><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>
155 <tr class="memdesc:abdf21e65ee4cc7cf79a43e3de64dcc7e inherit pub_methods_classarm__compute_1_1_access_window_rectangle"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent instances of this class from being copied (As this class contains pointers)  <a href="#abdf21e65ee4cc7cf79a43e3de64dcc7e">More...</a><br /></td></tr>
156 <tr class="separator:abdf21e65ee4cc7cf79a43e3de64dcc7e inherit pub_methods_classarm__compute_1_1_access_window_rectangle"><td class="memSeparator" colspan="2">&#160;</td></tr>
157 <tr class="memitem:a21ab33d8ab185c1321f4c213335e6802 inherit pub_methods_classarm__compute_1_1_access_window_rectangle"><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>
158 <tr class="memdesc:a21ab33d8ab185c1321f4c213335e6802 inherit pub_methods_classarm__compute_1_1_access_window_rectangle"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be moved.  <a href="#a21ab33d8ab185c1321f4c213335e6802">More...</a><br /></td></tr>
159 <tr class="separator:a21ab33d8ab185c1321f4c213335e6802 inherit pub_methods_classarm__compute_1_1_access_window_rectangle"><td class="memSeparator" colspan="2">&#160;</td></tr>
160 <tr class="memitem:a32733393d362ac5cd19a588bb248e5c6 inherit pub_methods_classarm__compute_1_1_access_window_rectangle"><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>
161 <tr class="memdesc:a32733393d362ac5cd19a588bb248e5c6 inherit pub_methods_classarm__compute_1_1_access_window_rectangle"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default destructor.  <a href="#a32733393d362ac5cd19a588bb248e5c6">More...</a><br /></td></tr>
162 <tr class="separator:a32733393d362ac5cd19a588bb248e5c6 inherit pub_methods_classarm__compute_1_1_access_window_rectangle"><td class="memSeparator" colspan="2">&#160;</td></tr>
163 <tr class="memitem:a718cd06814abc688b1abdc729ed3a71b inherit pub_methods_classarm__compute_1_1_access_window_rectangle"><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#a718cd06814abc688b1abdc729ed3a71b">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, bool border_undefined=false, const <a class="el" href="structarm__compute_1_1_border_size.xhtml">BorderSize</a> &amp;border_size=<a class="el" href="structarm__compute_1_1_border_size.xhtml">BorderSize</a>(0))</td></tr>
164 <tr class="memdesc:a718cd06814abc688b1abdc729ed3a71b inherit pub_methods_classarm__compute_1_1_access_window_rectangle"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the valid region based on access pattern, valid region of the inputs and border mode.  <a href="#a718cd06814abc688b1abdc729ed3a71b">More...</a><br /></td></tr>
165 <tr class="separator:a718cd06814abc688b1abdc729ed3a71b inherit pub_methods_classarm__compute_1_1_access_window_rectangle"><td class="memSeparator" colspan="2">&#160;</td></tr>
166 <tr class="memitem:a982d6e438dabc0d759d01464fe939cfd inherit pub_methods_classarm__compute_1_1_access_window_rectangle"><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_rectangle.xhtml#a982d6e438dabc0d759d01464fe939cfd">compute_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) const </td></tr>
167 <tr class="memdesc:a982d6e438dabc0d759d01464fe939cfd inherit pub_methods_classarm__compute_1_1_access_window_rectangle"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compute the valid region based on access pattern, valid region of the inputs and border mode.  <a href="#a982d6e438dabc0d759d01464fe939cfd">More...</a><br /></td></tr>
168 <tr class="separator:a982d6e438dabc0d759d01464fe939cfd inherit pub_methods_classarm__compute_1_1_access_window_rectangle"><td class="memSeparator" colspan="2">&#160;</td></tr>
169 <tr class="memitem:ae80edc371ba9f02d756aed720040878b inherit pub_methods_classarm__compute_1_1_access_window_rectangle"><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_rectangle.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>
170 <tr class="memdesc:ae80edc371ba9f02d756aed720040878b inherit pub_methods_classarm__compute_1_1_access_window_rectangle"><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>
171 <tr class="separator:ae80edc371ba9f02d756aed720040878b inherit pub_methods_classarm__compute_1_1_access_window_rectangle"><td class="memSeparator" colspan="2">&#160;</td></tr>
172 <tr class="memitem:a7ad9fe991410dc3550f6c4fd6e87a708 inherit pub_methods_classarm__compute_1_1_access_window_rectangle"><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>
173 <tr class="memdesc:a7ad9fe991410dc3550f6c4fd6e87a708 inherit pub_methods_classarm__compute_1_1_access_window_rectangle"><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>
174 <tr class="separator:a7ad9fe991410dc3550f6c4fd6e87a708 inherit pub_methods_classarm__compute_1_1_access_window_rectangle"><td class="memSeparator" colspan="2">&#160;</td></tr>
175 <tr class="memitem:a69cb887416c766f20cbec0677b3c8e88 inherit pub_methods_classarm__compute_1_1_access_window_rectangle"><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#a69cb887416c766f20cbec0677b3c8e88">update_padding_if_needed</a> (const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> &amp;window) override</td></tr>
176 <tr class="memdesc:a69cb887416c766f20cbec0677b3c8e88 inherit pub_methods_classarm__compute_1_1_access_window_rectangle"><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>
177 <tr class="separator:a69cb887416c766f20cbec0677b3c8e88 inherit pub_methods_classarm__compute_1_1_access_window_rectangle"><td class="memSeparator" colspan="2">&#160;</td></tr>
178 <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>
179 <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>
180 <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>
181 <tr class="separator:abc3996ab36cfa27811d661debfca5b5f inherit pub_methods_classarm__compute_1_1_i_access_window"><td class="memSeparator" colspan="2">&#160;</td></tr>
182 </table>
183 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
184 <div class="textblock"><p>Implementation of a column access pattern. </p>
185
186 <p>Definition at line <a class="el" href="_i_access_window_8h_source.xhtml#l00208">208</a> of file <a class="el" href="_i_access_window_8h_source.xhtml">IAccessWindow.h</a>.</p>
187 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
188 <a class="anchor" id="af470e59c429be56a65a66e806816246d"></a>
189 <div class="memitem">
190 <div class="memproto">
191 <table class="mlabels">
192   <tr>
193   <td class="mlabels-left">
194       <table class="memname">
195         <tr>
196           <td class="memname"><a class="el" href="classarm__compute_1_1_access_window_vertical.xhtml">AccessWindowVertical</a> </td>
197           <td>(</td>
198           <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_tensor_info.xhtml">ITensorInfo</a> *&#160;</td>
199           <td class="paramname"><em>info</em>, </td>
200         </tr>
201         <tr>
202           <td class="paramkey"></td>
203           <td></td>
204           <td class="paramtype">int&#160;</td>
205           <td class="paramname"><em>y</em>, </td>
206         </tr>
207         <tr>
208           <td class="paramkey"></td>
209           <td></td>
210           <td class="paramtype">int&#160;</td>
211           <td class="paramname"><em>height</em>, </td>
212         </tr>
213         <tr>
214           <td class="paramkey"></td>
215           <td></td>
216           <td class="paramtype">float&#160;</td>
217           <td class="paramname"><em>scale_y</em> = <code>1.f</code>&#160;</td>
218         </tr>
219         <tr>
220           <td></td>
221           <td>)</td>
222           <td></td><td></td>
223         </tr>
224       </table>
225   </td>
226   <td class="mlabels-right">
227 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
228   </tr>
229 </table>
230 </div><div class="memdoc">
231
232 <p>Constructor for a column access pattern. </p>
233 <dl class="section note"><dt>Note</dt><dd>Height has to be non-negative.</dd></dl>
234 <dl class="params"><dt>Parameters</dt><dd>
235   <table class="params">
236     <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>
237     <tr><td class="paramdir">[in]</td><td class="paramname">y</td><td>Offset of the access in Y direction. </td></tr>
238     <tr><td class="paramdir">[in]</td><td class="paramname">height</td><td>Number of elements that are accessed in Y direction. </td></tr>
239     <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>
240   </table>
241   </dd>
242 </dl>
243
244 <p>Definition at line <a class="el" href="_i_access_window_8h_source.xhtml#l00220">220</a> of file <a class="el" href="_i_access_window_8h_source.xhtml">IAccessWindow.h</a>.</p>
245
246 <p>References <a class="el" href="_error_8h_source.xhtml#l00328">ARM_COMPUTE_ERROR_ON</a>.</p>
247 <div class="fragment"><div class="line"><a name="l00221"></a><span class="lineno">  221</span>&#160;        : <a class="code" href="classarm__compute_1_1_access_window_rectangle.xhtml#ae89409b4c8b08f06ab694e829223932b">AccessWindowRectangle</a>(<a class="code" href="namespacearm__compute_1_1test_1_1validation.xhtml#a096668313a9a819d54a2e65ec21ff0cc">info</a>, 0, y, 1, height, 1.f, scale_y)</div><div class="line"><a name="l00222"></a><span class="lineno">  222</span>&#160;    {</div><div class="line"><a name="l00223"></a><span class="lineno">  223</span>&#160;        <a class="code" href="_error_8h.xhtml#a54a6080c9f4df1f908e57a9bbb46f5da">ARM_COMPUTE_ERROR_ON</a>(height &lt; 0);</div><div class="line"><a name="l00224"></a><span class="lineno">  224</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="l00225"></a><span class="lineno">  225</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#l00328">Error.h:328</a></div></div>
248 <div class="ttc" id="namespacearm__compute_1_1test_1_1validation_xhtml_a096668313a9a819d54a2e65ec21ff0cc"><div class="ttname"><a href="namespacearm__compute_1_1test_1_1validation.xhtml#a096668313a9a819d54a2e65ec21ff0cc">arm_compute::test::validation::info</a></div><div class="ttdeci">src info() -&gt; set_format(Format::S16)</div></div>
249 <div class="ttc" id="classarm__compute_1_1_access_window_rectangle_xhtml_ae89409b4c8b08f06ab694e829223932b"><div class="ttname"><a href="classarm__compute_1_1_access_window_rectangle.xhtml#ae89409b4c8b08f06ab694e829223932b">arm_compute::AccessWindowRectangle::AccessWindowRectangle</a></div><div class="ttdeci">AccessWindowRectangle(ITensorInfo *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#l00120">IAccessWindow.h:120</a></div></div>
250 </div><!-- fragment -->
251 </div>
252 </div>
253 <hr/>The documentation for this class was generated from the following file:<ul>
254 <li>arm_compute/core/<a class="el" href="_i_access_window_8h_source.xhtml">IAccessWindow.h</a></li>
255 </ul>
256 </div><!-- contents -->
257 </div><!-- doc-content -->
258 <!-- start footer part -->
259 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
260   <ul>
261     <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_vertical.xhtml">AccessWindowVertical</a></li>
262     <li class="footer">Generated on Wed May 23 2018 11:36:40 for Compute Library by
263     <a href="http://www.doxygen.org/index.html">
264     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
265   </ul>
266 </div>
267 </body>
268 </html>