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>ARM Compute Library: PadStrideInfo 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">ARM Compute Library
43  <span id="projectnumber">17.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="namespaces.xhtml"><span>Namespaces</span></a></li>
59 <li class="current"><a href="annotated.xhtml"><span>Data Structures</span></a></li>
60 <li><a href="files.xhtml"><span>Files</span></a></li>
62 <div id="MSearchBox" class="MSearchBoxInactive">
64 <img id="MSearchSelect" src="search/mag_sel.png"
65 onmouseover="return searchBox.OnSearchSelectShow()"
66 onmouseout="return searchBox.OnSearchSelectHide()"
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>
79 <div id="navrow2" class="tabs2">
81 <li><a href="annotated.xhtml"><span>Data Structures</span></a></li>
82 <li><a href="classes.xhtml"><span>Data Structure Index</span></a></li>
83 <li><a href="inherits.xhtml"><span>Class Hierarchy</span></a></li>
84 <li><a href="functions.xhtml"><span>Data Fields</span></a></li>
88 <div id="side-nav" class="ui-resizable side-nav-resizable">
90 <div id="nav-tree-contents">
91 <div id="nav-sync" class="sync"></div>
94 <div id="splitbar" style="-moz-user-select:none;"
95 class="ui-resizable-handle">
98 <script type="text/javascript">
99 $(document).ready(function(){initNavTree('classarm__compute_1_1_pad_stride_info.xhtml','');});
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)">
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">
117 <div class="summary">
118 <a href="#pub-methods">Public Member Functions</a> </div>
119 <div class="headertitle">
120 <div class="title">PadStrideInfo Class Reference</div> </div>
122 <div class="contents">
124 <p>Padding and stride information class.
125 <a href="classarm__compute_1_1_pad_stride_info.xhtml#details">More...</a></p>
127 <p><code>#include <<a class="el" href="_types_8h_source.xhtml">Types.h</a>></code></p>
128 <table class="memberdecls">
129 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
130 Public Member Functions</h2></td></tr>
131 <tr class="memitem:aebf88ce57c0ad3d796ca66edb8a43e1a"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_pad_stride_info.xhtml#aebf88ce57c0ad3d796ca66edb8a43e1a">PadStrideInfo</a> (unsigned int stride_x=1, unsigned int stride_y=1, unsigned int pad_x=0, unsigned int pad_y=0, <a class="el" href="namespacearm__compute.xhtml#a1fece1bd804e64f39f602d1c3969849a">DimensionRoundingType</a> <a class="el" href="classarm__compute_1_1_pad_stride_info.xhtml#a3d7de69b5d597f77362f3279c6ec1c44">round</a>=<a class="el" href="namespacearm__compute.xhtml#a1fece1bd804e64f39f602d1c3969849aa56c1e354d36beb85b0d881c5b2e24cbe">DimensionRoundingType::FLOOR</a>)</td></tr>
132 <tr class="memdesc:aebf88ce57c0ad3d796ca66edb8a43e1a"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#aebf88ce57c0ad3d796ca66edb8a43e1a">More...</a><br /></td></tr>
133 <tr class="separator:aebf88ce57c0ad3d796ca66edb8a43e1a"><td class="memSeparator" colspan="2"> </td></tr>
134 <tr class="memitem:ad2f1ea50a9e215ad8ef612a724a4866a"><td class="memItemLeft" align="right" valign="top">std::pair< unsigned int, unsigned int > </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_pad_stride_info.xhtml#ad2f1ea50a9e215ad8ef612a724a4866a">stride</a> () const </td></tr>
135 <tr class="separator:ad2f1ea50a9e215ad8ef612a724a4866a"><td class="memSeparator" colspan="2"> </td></tr>
136 <tr class="memitem:a9a9d6d62752247f733a3466b484e08b9"><td class="memItemLeft" align="right" valign="top">std::pair< unsigned int, unsigned int > </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_pad_stride_info.xhtml#a9a9d6d62752247f733a3466b484e08b9">pad</a> () const </td></tr>
137 <tr class="separator:a9a9d6d62752247f733a3466b484e08b9"><td class="memSeparator" colspan="2"> </td></tr>
138 <tr class="memitem:a3d7de69b5d597f77362f3279c6ec1c44"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacearm__compute.xhtml#a1fece1bd804e64f39f602d1c3969849a">DimensionRoundingType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_pad_stride_info.xhtml#a3d7de69b5d597f77362f3279c6ec1c44">round</a> () const </td></tr>
139 <tr class="separator:a3d7de69b5d597f77362f3279c6ec1c44"><td class="memSeparator" colspan="2"> </td></tr>
141 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
142 <div class="textblock"><p>Padding and stride information class. </p>
144 <p>Definition at line <a class="el" href="_types_8h_source.xhtml#l00375">375</a> of file <a class="el" href="_types_8h_source.xhtml">Types.h</a>.</p>
145 </div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
146 <a class="anchor" id="aebf88ce57c0ad3d796ca66edb8a43e1a"></a>
147 <div class="memitem">
148 <div class="memproto">
149 <table class="mlabels">
151 <td class="mlabels-left">
152 <table class="memname">
154 <td class="memname"><a class="el" href="classarm__compute_1_1_pad_stride_info.xhtml">PadStrideInfo</a> </td>
156 <td class="paramtype">unsigned int </td>
157 <td class="paramname"><em>stride_x</em> = <code>1</code>, </td>
160 <td class="paramkey"></td>
162 <td class="paramtype">unsigned int </td>
163 <td class="paramname"><em>stride_y</em> = <code>1</code>, </td>
166 <td class="paramkey"></td>
168 <td class="paramtype">unsigned int </td>
169 <td class="paramname"><em>pad_x</em> = <code>0</code>, </td>
172 <td class="paramkey"></td>
174 <td class="paramtype">unsigned int </td>
175 <td class="paramname"><em>pad_y</em> = <code>0</code>, </td>
178 <td class="paramkey"></td>
180 <td class="paramtype"><a class="el" href="namespacearm__compute.xhtml#a1fece1bd804e64f39f602d1c3969849a">DimensionRoundingType</a> </td>
181 <td class="paramname"><em>round</em> = <code><a class="el" href="namespacearm__compute.xhtml#a1fece1bd804e64f39f602d1c3969849aa56c1e354d36beb85b0d881c5b2e24cbe">DimensionRoundingType::FLOOR</a></code> </td>
190 <td class="mlabels-right">
191 <span class="mlabels"><span class="mlabel">inline</span></span> </td>
194 </div><div class="memdoc">
197 <dl class="params"><dt>Parameters</dt><dd>
198 <table class="params">
199 <tr><td class="paramdir">[in]</td><td class="paramname">stride_x</td><td>(Optional) Stride, in elements, across x. Defaults to 1. </td></tr>
200 <tr><td class="paramdir">[in]</td><td class="paramname">stride_y</td><td>(Optional) Stride, in elements, across y. Defaults to 1. </td></tr>
201 <tr><td class="paramdir">[in]</td><td class="paramname">pad_x</td><td>(Optional) Padding, in elements, across x. Defaults to 0. </td></tr>
202 <tr><td class="paramdir">[in]</td><td class="paramname">pad_y</td><td>(Optional) Padding, in elements, across y. Defaults to 0. </td></tr>
203 <tr><td class="paramdir">[in]</td><td class="paramname">round</td><td>(Optional) <a class="el" href="classarm__compute_1_1_dimensions.xhtml" title="Dimensions with dimensionality. ">Dimensions</a> rounding. Defaults to <a class="el" href="namespacearm__compute.xhtml#a1fece1bd804e64f39f602d1c3969849aa56c1e354d36beb85b0d881c5b2e24cbe">FLOOR</a>. </td></tr>
208 <p>Definition at line <a class="el" href="_types_8h_source.xhtml#l00386">386</a> of file <a class="el" href="_types_8h_source.xhtml">Types.h</a>.</p>
209 <div class="fragment"><div class="line"><a name="l00389"></a><span class="lineno"> 389</span>  : _stride(std::make_pair(stride_x, stride_y)),</div><div class="line"><a name="l00390"></a><span class="lineno"> 390</span>  _pad(std::make_pair(pad_x, pad_y)),</div><div class="line"><a name="l00391"></a><span class="lineno"> 391</span>  _round_type(<a class="code" href="classarm__compute_1_1_pad_stride_info.xhtml#a3d7de69b5d597f77362f3279c6ec1c44">round</a>)</div><div class="line"><a name="l00392"></a><span class="lineno"> 392</span>  {</div><div class="line"><a name="l00393"></a><span class="lineno"> 393</span>  }</div><div class="ttc" id="classarm__compute_1_1_pad_stride_info_xhtml_a3d7de69b5d597f77362f3279c6ec1c44"><div class="ttname"><a href="classarm__compute_1_1_pad_stride_info.xhtml#a3d7de69b5d597f77362f3279c6ec1c44">arm_compute::PadStrideInfo::round</a></div><div class="ttdeci">DimensionRoundingType round() const </div><div class="ttdef"><b>Definition:</b> <a href="_types_8h_source.xhtml#l00402">Types.h:402</a></div></div>
210 </div><!-- fragment -->
213 <h2 class="groupheader">Member Function Documentation</h2>
214 <a class="anchor" id="a9a9d6d62752247f733a3466b484e08b9"></a>
215 <div class="memitem">
216 <div class="memproto">
217 <table class="mlabels">
219 <td class="mlabels-left">
220 <table class="memname">
222 <td class="memname">std::pair<unsigned int, unsigned int> pad </td>
224 <td class="paramname"></td><td>)</td>
229 <td class="mlabels-right">
230 <span class="mlabels"><span class="mlabel">inline</span></span> </td>
233 </div><div class="memdoc">
235 <p>Definition at line <a class="el" href="_types_8h_source.xhtml#l00398">398</a> of file <a class="el" href="_types_8h_source.xhtml">Types.h</a>.</p>
236 <div class="fragment"><div class="line"><a name="l00399"></a><span class="lineno"> 399</span>  {</div><div class="line"><a name="l00400"></a><span class="lineno"> 400</span>  <span class="keywordflow">return</span> _pad;</div><div class="line"><a name="l00401"></a><span class="lineno"> 401</span>  }</div></div><!-- fragment -->
239 <a class="anchor" id="a3d7de69b5d597f77362f3279c6ec1c44"></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"><a class="el" href="namespacearm__compute.xhtml#a1fece1bd804e64f39f602d1c3969849a">DimensionRoundingType</a> round </td>
249 <td class="paramname"></td><td>)</td>
254 <td class="mlabels-right">
255 <span class="mlabels"><span class="mlabel">inline</span></span> </td>
258 </div><div class="memdoc">
260 <p>Definition at line <a class="el" href="_types_8h_source.xhtml#l00402">402</a> of file <a class="el" href="_types_8h_source.xhtml">Types.h</a>.</p>
261 <div class="fragment"><div class="line"><a name="l00403"></a><span class="lineno"> 403</span>  {</div><div class="line"><a name="l00404"></a><span class="lineno"> 404</span>  <span class="keywordflow">return</span> _round_type;</div><div class="line"><a name="l00405"></a><span class="lineno"> 405</span>  }</div></div><!-- fragment -->
264 <a class="anchor" id="ad2f1ea50a9e215ad8ef612a724a4866a"></a>
265 <div class="memitem">
266 <div class="memproto">
267 <table class="mlabels">
269 <td class="mlabels-left">
270 <table class="memname">
272 <td class="memname">std::pair<unsigned int, unsigned int> stride </td>
274 <td class="paramname"></td><td>)</td>
279 <td class="mlabels-right">
280 <span class="mlabels"><span class="mlabel">inline</span></span> </td>
283 </div><div class="memdoc">
285 <p>Definition at line <a class="el" href="_types_8h_source.xhtml#l00394">394</a> of file <a class="el" href="_types_8h_source.xhtml">Types.h</a>.</p>
286 <div class="fragment"><div class="line"><a name="l00395"></a><span class="lineno"> 395</span>  {</div><div class="line"><a name="l00396"></a><span class="lineno"> 396</span>  <span class="keywordflow">return</span> _stride;</div><div class="line"><a name="l00397"></a><span class="lineno"> 397</span>  }</div></div><!-- fragment -->
289 <hr/>The documentation for this class was generated from the following file:<ul>
290 <li>arm_compute/core/<a class="el" href="_types_8h_source.xhtml">Types.h</a></li>
292 </div><!-- contents -->
293 </div><!-- doc-content -->
294 <!-- start footer part -->
295 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
297 <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_pad_stride_info.xhtml">PadStrideInfo</a></li>
298 <li class="footer">Generated on Wed May 3 2017 17:20:05 for ARM Compute Library by
299 <a href="http://www.doxygen.org/index.html">
300 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>