documentation/classarm__compute_1_1_pad_stride_info.xhtml

   1 <!-- HTML header for doxygen 1.8.9.1-->
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml">
   4 <head>
   5 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   6 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
   7 <meta name="generator" content="Doxygen 1.8.11"/>
   8 <meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
   9 <title>ARM Compute Library: 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);
  20 </script>
  21 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  22 <script type="text/javascript" src="search/searchdata.js"></script>
  23 <script type="text/javascript" src="search/search.js"></script>
  24 <script type="text/javascript">
  25   $(document).ready(function() { init_search(); });
  26 </script>
  27 <script type="text/x-mathjax-config">
  28   MathJax.Hub.Config({
  29     extensions: ["tex2jax.js"],
  30     jax: ["input/TeX","output/HTML-CSS"],
  31 });
  32 </script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
  33 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  34 </head>
  35 <body>
  36 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  37 <div id="titlearea">
  38 <table cellspacing="0" cellpadding="0">
  39  <tbody>
  40  <tr style="height: 56px;">
  41   <td style="padding-left: 0.5em;">
  42    <div id="projectname">ARM Compute Library
  43    &#160;<span id="projectnumber">17.04</span>
  44    </div>
  45   </td>
  46  </tr>
  47  </tbody>
  48 </table>
  49 </div>
  50 <!-- end header part -->
  51 <!-- Generated by Doxygen 1.8.11 -->
  52 <script type="text/javascript">
  53 var searchBox = new SearchBox("searchBox", "search",false,'Search');
  54 </script>
  55   <div id="navrow1" class="tabs">
  56     <ul class="tablist">
  57       <li><a href="index.xhtml"><span>Main&#160;Page</span></a></li>
  58       <li><a href="namespaces.xhtml"><span>Namespaces</span></a></li>
  59       <li class="current"><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
  60       <li><a href="files.xhtml"><span>Files</span></a></li>
  61       <li>
  62         <div id="MSearchBox" class="MSearchBoxInactive">
  63         <span class="left">
  64           <img id="MSearchSelect" src="search/mag_sel.png"
  65                onmouseover="return searchBox.OnSearchSelectShow()"
  66                onmouseout="return searchBox.OnSearchSelectHide()"
  67                alt=""/>
  68           <input type="text" id="MSearchField" value="Search" accesskey="S"
  69                onfocus="searchBox.OnSearchFieldFocus(true)"
  70                onblur="searchBox.OnSearchFieldFocus(false)"
  71                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  72           </span><span class="right">
  73             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  74           </span>
  75         </div>
  76       </li>
  77     </ul>
  78   </div>
  79   <div id="navrow2" class="tabs2">
  80     <ul class="tablist">
  81       <li><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
  82       <li><a href="classes.xhtml"><span>Data&#160;Structure&#160;Index</span></a></li>
  83       <li><a href="inherits.xhtml"><span>Class&#160;Hierarchy</span></a></li>
  84       <li><a href="functions.xhtml"><span>Data&#160;Fields</span></a></li>
  85     </ul>
  86   </div>
  87 </div><!-- top -->
  88 <div id="side-nav" class="ui-resizable side-nav-resizable">
  89   <div id="nav-tree">
  90     <div id="nav-tree-contents">
  91       <div id="nav-sync" class="sync"></div>
  92     </div>
  93   </div>
  94   <div id="splitbar" style="-moz-user-select:none;"
  95        class="ui-resizable-handle">
  96   </div>
  97 </div>
  98 <script type="text/javascript">
  99 $(document).ready(function(){initNavTree('classarm__compute_1_1_pad_stride_info.xhtml','');});
 100 </script>
 101 <div id="doc-content">
 102 <!-- window showing the filter options -->
 103 <div id="MSearchSelectWindow"
 104      onmouseover="return searchBox.OnSearchSelectShow()"
 105      onmouseout="return searchBox.OnSearchSelectHide()"
 106      onkeydown="return searchBox.OnSearchSelectKey(event)">
 107 </div>
 108
 109 <!-- iframe showing the search results (closed by default) -->
 110 <div id="MSearchResultsWindow">
 111 <iframe src="javascript:void(0)" frameborder="0"
 112         name="MSearchResults" id="MSearchResults">
 113 </iframe>
 114 </div>
 115
 116 <div class="header">
 117   <div class="summary">
 118 <a href="#pub-methods">Public Member Functions</a>  </div>
 119   <div class="headertitle">
 120 <div class="title">PadStrideInfo Class Reference</div>  </div>
 121 </div><!--header-->
 122 <div class="contents">
 123
 124 <p>Padding and stride information class.
 125  <a href="classarm__compute_1_1_pad_stride_info.xhtml#details">More...</a></p>
 126
 127 <p><code>#include &lt;<a class="el" href="_types_8h_source.xhtml">Types.h</a>&gt;</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">&#160;</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">&#160;</td><td class="mdescRight">Constructor.  <a href="#aebf88ce57c0ad3d796ca66edb8a43e1a">More...</a><br /></td></tr>
 133 <tr class="separator:aebf88ce57c0ad3d796ca66edb8a43e1a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 134 <tr class="memitem:ad2f1ea50a9e215ad8ef612a724a4866a"><td class="memItemLeft" align="right" valign="top">std::pair&lt; unsigned int, unsigned int &gt;&#160;</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">&#160;</td></tr>
 136 <tr class="memitem:a9a9d6d62752247f733a3466b484e08b9"><td class="memItemLeft" align="right" valign="top">std::pair&lt; unsigned int, unsigned int &gt;&#160;</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">&#160;</td></tr>
 138 <tr class="memitem:a3d7de69b5d597f77362f3279c6ec1c44"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacearm__compute.xhtml#a1fece1bd804e64f39f602d1c3969849a">DimensionRoundingType</a>&#160;</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">&#160;</td></tr>
 140 </table>
 141 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 142 <div class="textblock"><p>Padding and stride information class. </p>
 143
 144 <p>Definition at line <a class="el" href="_types_8h_source.xhtml#l00362">362</a> of file <a class="el" href="_types_8h_source.xhtml">Types.h</a>.</p>
 145 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 146 <a class="anchor" id="aebf88ce57c0ad3d796ca66edb8a43e1a"></a>
 147 <div class="memitem">
 148 <div class="memproto">
 149 <table class="mlabels">
 150   <tr>
 151   <td class="mlabels-left">
 152       <table class="memname">
 153         <tr>
 154           <td class="memname"><a class="el" href="classarm__compute_1_1_pad_stride_info.xhtml">PadStrideInfo</a> </td>
 155           <td>(</td>
 156           <td class="paramtype">unsigned int&#160;</td>
 157           <td class="paramname"><em>stride_x</em> = <code>1</code>, </td>
 158         </tr>
 159         <tr>
 160           <td class="paramkey"></td>
 161           <td></td>
 162           <td class="paramtype">unsigned int&#160;</td>
 163           <td class="paramname"><em>stride_y</em> = <code>1</code>, </td>
 164         </tr>
 165         <tr>
 166           <td class="paramkey"></td>
 167           <td></td>
 168           <td class="paramtype">unsigned int&#160;</td>
 169           <td class="paramname"><em>pad_x</em> = <code>0</code>, </td>
 170         </tr>
 171         <tr>
 172           <td class="paramkey"></td>
 173           <td></td>
 174           <td class="paramtype">unsigned int&#160;</td>
 175           <td class="paramname"><em>pad_y</em> = <code>0</code>, </td>
 176         </tr>
 177         <tr>
 178           <td class="paramkey"></td>
 179           <td></td>
 180           <td class="paramtype"><a class="el" href="namespacearm__compute.xhtml#a1fece1bd804e64f39f602d1c3969849a">DimensionRoundingType</a>&#160;</td>
 181           <td class="paramname"><em>round</em> = <code><a class="el" href="namespacearm__compute.xhtml#a1fece1bd804e64f39f602d1c3969849aa56c1e354d36beb85b0d881c5b2e24cbe">DimensionRoundingType::FLOOR</a></code>&#160;</td>
 182         </tr>
 183         <tr>
 184           <td></td>
 185           <td>)</td>
 186           <td></td><td></td>
 187         </tr>
 188       </table>
 189   </td>
 190   <td class="mlabels-right">
 191 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 192   </tr>
 193 </table>
 194 </div><div class="memdoc">
 195
 196 <p>Constructor. </p>
 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>
 204   </table>
 205   </dd>
 206 </dl>
 207
 208 <p>Definition at line <a class="el" href="_types_8h_source.xhtml#l00373">373</a> of file <a class="el" href="_types_8h_source.xhtml">Types.h</a>.</p>
 209 <div class="fragment"><div class="line"><a name="l00376"></a><span class="lineno">  376</span>&#160;        : _stride(std::make_pair(stride_x, stride_y)),</div><div class="line"><a name="l00377"></a><span class="lineno">  377</span>&#160;          _pad(std::make_pair(pad_x, pad_y)),</div><div class="line"><a name="l00378"></a><span class="lineno">  378</span>&#160;          _round_type(<a class="code" href="classarm__compute_1_1_pad_stride_info.xhtml#a3d7de69b5d597f77362f3279c6ec1c44">round</a>)</div><div class="line"><a name="l00379"></a><span class="lineno">  379</span>&#160;    {</div><div class="line"><a name="l00380"></a><span class="lineno">  380</span>&#160;    }</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#l00389">Types.h:389</a></div></div>
 210 </div><!-- fragment -->
 211 </div>
 212 </div>
 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">
 218   <tr>
 219   <td class="mlabels-left">
 220       <table class="memname">
 221         <tr>
 222           <td class="memname">std::pair&lt;unsigned int, unsigned int&gt; pad </td>
 223           <td>(</td>
 224           <td class="paramname"></td><td>)</td>
 225           <td> const</td>
 226         </tr>
 227       </table>
 228   </td>
 229   <td class="mlabels-right">
 230 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 231   </tr>
 232 </table>
 233 </div><div class="memdoc">
 234
 235 <p>Definition at line <a class="el" href="_types_8h_source.xhtml#l00385">385</a> of file <a class="el" href="_types_8h_source.xhtml">Types.h</a>.</p>
 236 <div class="fragment"><div class="line"><a name="l00386"></a><span class="lineno">  386</span>&#160;    {</div><div class="line"><a name="l00387"></a><span class="lineno">  387</span>&#160;        <span class="keywordflow">return</span> _pad;</div><div class="line"><a name="l00388"></a><span class="lineno">  388</span>&#160;    }</div></div><!-- fragment -->
 237 </div>
 238 </div>
 239 <a class="anchor" id="a3d7de69b5d597f77362f3279c6ec1c44"></a>
 240 <div class="memitem">
 241 <div class="memproto">
 242 <table class="mlabels">
 243   <tr>
 244   <td class="mlabels-left">
 245       <table class="memname">
 246         <tr>
 247           <td class="memname"><a class="el" href="namespacearm__compute.xhtml#a1fece1bd804e64f39f602d1c3969849a">DimensionRoundingType</a> round </td>
 248           <td>(</td>
 249           <td class="paramname"></td><td>)</td>
 250           <td> const</td>
 251         </tr>
 252       </table>
 253   </td>
 254   <td class="mlabels-right">
 255 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 256   </tr>
 257 </table>
 258 </div><div class="memdoc">
 259
 260 <p>Definition at line <a class="el" href="_types_8h_source.xhtml#l00389">389</a> of file <a class="el" href="_types_8h_source.xhtml">Types.h</a>.</p>
 261 <div class="fragment"><div class="line"><a name="l00390"></a><span class="lineno">  390</span>&#160;    {</div><div class="line"><a name="l00391"></a><span class="lineno">  391</span>&#160;        <span class="keywordflow">return</span> _round_type;</div><div class="line"><a name="l00392"></a><span class="lineno">  392</span>&#160;    }</div></div><!-- fragment -->
 262 </div>
 263 </div>
 264 <a class="anchor" id="ad2f1ea50a9e215ad8ef612a724a4866a"></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">std::pair&lt;unsigned int, unsigned int&gt; stride </td>
 273           <td>(</td>
 274           <td class="paramname"></td><td>)</td>
 275           <td> const</td>
 276         </tr>
 277       </table>
 278   </td>
 279   <td class="mlabels-right">
 280 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 281   </tr>
 282 </table>
 283 </div><div class="memdoc">
 284
 285 <p>Definition at line <a class="el" href="_types_8h_source.xhtml#l00381">381</a> of file <a class="el" href="_types_8h_source.xhtml">Types.h</a>.</p>
 286 <div class="fragment"><div class="line"><a name="l00382"></a><span class="lineno">  382</span>&#160;    {</div><div class="line"><a name="l00383"></a><span class="lineno">  383</span>&#160;        <span class="keywordflow">return</span> _stride;</div><div class="line"><a name="l00384"></a><span class="lineno">  384</span>&#160;    }</div></div><!-- fragment -->
 287 </div>
 288 </div>
 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>
 291 </ul>
 292 </div><!-- contents -->
 293 </div><!-- doc-content -->
 294 <!-- start footer part -->
 295 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 296   <ul>
 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 Apr 12 2017 14:26:06 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>
 301   </ul>
 302 </div>
 303 </body>
 304 </html>