documentation/classarm__compute_1_1test_1_1_i_array_accessor.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: IArrayAccessor&lt; T &gt; Class Template 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.02</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_1test_1_1_i_array_accessor.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-types">Public Types</a> &#124;
 120 <a href="#pub-methods">Public Member Functions</a>  </div>
 121   <div class="headertitle">
 122 <div class="title">IArrayAccessor&lt; T &gt; Class Template Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
 123 </div><!--header-->
 124 <div class="contents">
 125
 126 <p>Common interface to provide information and access to array like structures.
 127  <a href="classarm__compute_1_1test_1_1_i_array_accessor.xhtml#details">More...</a></p>
 128
 129 <p><code>#include &lt;<a class="el" href="_i_array_accessor_8h_source.xhtml">IArrayAccessor.h</a>&gt;</code></p>
 130 <table class="memberdecls">
 131 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
 132 Public Types</h2></td></tr>
 133 <tr class="memitem:afb9ded5f49336ae503bb9f2035ea902b"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1test_1_1_i_array_accessor.xhtml#afb9ded5f49336ae503bb9f2035ea902b">value_type</a> = T</td></tr>
 134 <tr class="separator:afb9ded5f49336ae503bb9f2035ea902b"><td class="memSeparator" colspan="2">&#160;</td></tr>
 135 </table><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:aab5e9c61ab48807226cd3187db35c9ba"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1test_1_1_i_array_accessor.xhtml#aab5e9c61ab48807226cd3187db35c9ba">~IArrayAccessor</a> ()=default</td></tr>
 139 <tr class="memdesc:aab5e9c61ab48807226cd3187db35c9ba"><td class="mdescLeft">&#160;</td><td class="mdescRight">Virtual destructor.  <a href="#aab5e9c61ab48807226cd3187db35c9ba">More...</a><br /></td></tr>
 140 <tr class="separator:aab5e9c61ab48807226cd3187db35c9ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
 141 <tr class="memitem:a19ecfde9ec6b2dda6d06cc79dd8d956c"><td class="memItemLeft" align="right" valign="top">virtual size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1test_1_1_i_array_accessor.xhtml#a19ecfde9ec6b2dda6d06cc79dd8d956c">num_values</a> () const =0</td></tr>
 142 <tr class="memdesc:a19ecfde9ec6b2dda6d06cc79dd8d956c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of elements of the tensor.  <a href="#a19ecfde9ec6b2dda6d06cc79dd8d956c">More...</a><br /></td></tr>
 143 <tr class="separator:a19ecfde9ec6b2dda6d06cc79dd8d956c"><td class="memSeparator" colspan="2">&#160;</td></tr>
 144 <tr class="memitem:a4e1979433c9e97e4797fdb060ca5e3ad"><td class="memItemLeft" align="right" valign="top">virtual T *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1test_1_1_i_array_accessor.xhtml#a4e1979433c9e97e4797fdb060ca5e3ad">buffer</a> ()=0</td></tr>
 145 <tr class="memdesc:a4e1979433c9e97e4797fdb060ca5e3ad"><td class="mdescLeft">&#160;</td><td class="mdescRight">Access to the buffer.  <a href="#a4e1979433c9e97e4797fdb060ca5e3ad">More...</a><br /></td></tr>
 146 <tr class="separator:a4e1979433c9e97e4797fdb060ca5e3ad"><td class="memSeparator" colspan="2">&#160;</td></tr>
 147 <tr class="memitem:aa3243d314953e018ebcaf98128068110"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1test_1_1_i_array_accessor.xhtml#aa3243d314953e018ebcaf98128068110">resize</a> (size_t num)=0</td></tr>
 148 <tr class="memdesc:aa3243d314953e018ebcaf98128068110"><td class="mdescLeft">&#160;</td><td class="mdescRight">Resize array.  <a href="#aa3243d314953e018ebcaf98128068110">More...</a><br /></td></tr>
 149 <tr class="separator:aa3243d314953e018ebcaf98128068110"><td class="memSeparator" colspan="2">&#160;</td></tr>
 150 <tr class="memitem:ad1d196a1f89d9889461e6920b92d4db5"><td class="memItemLeft" align="right" valign="top">virtual T &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1test_1_1_i_array_accessor.xhtml#ad1d196a1f89d9889461e6920b92d4db5">at</a> (size_t index) const =0</td></tr>
 151 <tr class="memdesc:ad1d196a1f89d9889461e6920b92d4db5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reference to the element of the array located at the given index.  <a href="#ad1d196a1f89d9889461e6920b92d4db5">More...</a><br /></td></tr>
 152 <tr class="separator:ad1d196a1f89d9889461e6920b92d4db5"><td class="memSeparator" colspan="2">&#160;</td></tr>
 153 </table>
 154 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 155 <div class="textblock"><h3>template&lt;typename T&gt;<br />
 156 class arm_compute::test::IArrayAccessor&lt; T &gt;</h3>
 157
 158 <p>Common interface to provide information and access to array like structures. </p>
 159
 160 <p>Definition at line <a class="el" href="_i_array_accessor_8h_source.xhtml#l00035">35</a> of file <a class="el" href="_i_array_accessor_8h_source.xhtml">IArrayAccessor.h</a>.</p>
 161 </div><h2 class="groupheader">Member Typedef Documentation</h2>
 162 <a class="anchor" id="afb9ded5f49336ae503bb9f2035ea902b"></a>
 163 <div class="memitem">
 164 <div class="memproto">
 165       <table class="memname">
 166         <tr>
 167           <td class="memname">using <a class="el" href="classarm__compute_1_1test_1_1_i_array_accessor.xhtml#afb9ded5f49336ae503bb9f2035ea902b">value_type</a> =  T</td>
 168         </tr>
 169       </table>
 170 </div><div class="memdoc">
 171
 172 <p>Definition at line <a class="el" href="_i_array_accessor_8h_source.xhtml#l00038">38</a> of file <a class="el" href="_i_array_accessor_8h_source.xhtml">IArrayAccessor.h</a>.</p>
 173
 174 </div>
 175 </div>
 176 <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 177 <a class="anchor" id="aab5e9c61ab48807226cd3187db35c9ba"></a>
 178 <div class="memitem">
 179 <div class="memproto">
 180 <table class="mlabels">
 181   <tr>
 182   <td class="mlabels-left">
 183       <table class="memname">
 184         <tr>
 185           <td class="memname">virtual ~<a class="el" href="classarm__compute_1_1test_1_1_i_array_accessor.xhtml">IArrayAccessor</a> </td>
 186           <td>(</td>
 187           <td class="paramname"></td><td>)</td>
 188           <td></td>
 189         </tr>
 190       </table>
 191   </td>
 192   <td class="mlabels-right">
 193 <span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">default</span></span>  </td>
 194   </tr>
 195 </table>
 196 </div><div class="memdoc">
 197
 198 <p>Virtual destructor. </p>
 199
 200 </div>
 201 </div>
 202 <h2 class="groupheader">Member Function Documentation</h2>
 203 <a class="anchor" id="ad1d196a1f89d9889461e6920b92d4db5"></a>
 204 <div class="memitem">
 205 <div class="memproto">
 206 <table class="mlabels">
 207   <tr>
 208   <td class="mlabels-left">
 209       <table class="memname">
 210         <tr>
 211           <td class="memname">virtual T&amp; at </td>
 212           <td>(</td>
 213           <td class="paramtype">size_t&#160;</td>
 214           <td class="paramname"><em>index</em></td><td>)</td>
 215           <td> const</td>
 216         </tr>
 217       </table>
 218   </td>
 219   <td class="mlabels-right">
 220 <span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
 221   </tr>
 222 </table>
 223 </div><div class="memdoc">
 224
 225 <p>Reference to the element of the array located at the given index. </p>
 226 <dl class="params"><dt>Parameters</dt><dd>
 227   <table class="params">
 228     <tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>Index of the element</td></tr>
 229   </table>
 230   </dd>
 231 </dl>
 232 <dl class="section return"><dt>Returns</dt><dd>A reference to the element of the array located at the given index. </dd></dl>
 233
 234 <p>Implemented in <a class="el" href="classarm__compute_1_1test_1_1_c_l_array_accessor.xhtml#aa733629a56800aca0b5cb4608069718b">CLArrayAccessor&lt; T &gt;</a>, and <a class="el" href="classarm__compute_1_1test_1_1_array_accessor.xhtml#aa733629a56800aca0b5cb4608069718b">ArrayAccessor&lt; T &gt;</a>.</p>
 235
 236 </div>
 237 </div>
 238 <a class="anchor" id="a4e1979433c9e97e4797fdb060ca5e3ad"></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">virtual T* buffer </td>
 247           <td>(</td>
 248           <td class="paramname"></td><td>)</td>
 249           <td></td>
 250         </tr>
 251       </table>
 252   </td>
 253   <td class="mlabels-right">
 254 <span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
 255   </tr>
 256 </table>
 257 </div><div class="memdoc">
 258
 259 <p>Access to the buffer. </p>
 260 <dl class="section return"><dt>Returns</dt><dd>A pointer to the first element in the buffer. </dd></dl>
 261
 262 <p>Implemented in <a class="el" href="classarm__compute_1_1test_1_1_c_l_array_accessor.xhtml#a32e914dbe65c0591501e44790957bb0f">CLArrayAccessor&lt; T &gt;</a>, and <a class="el" href="classarm__compute_1_1test_1_1_array_accessor.xhtml#a32e914dbe65c0591501e44790957bb0f">ArrayAccessor&lt; T &gt;</a>.</p>
 263
 264 </div>
 265 </div>
 266 <a class="anchor" id="a19ecfde9ec6b2dda6d06cc79dd8d956c"></a>
 267 <div class="memitem">
 268 <div class="memproto">
 269 <table class="mlabels">
 270   <tr>
 271   <td class="mlabels-left">
 272       <table class="memname">
 273         <tr>
 274           <td class="memname">virtual size_t num_values </td>
 275           <td>(</td>
 276           <td class="paramname"></td><td>)</td>
 277           <td> const</td>
 278         </tr>
 279       </table>
 280   </td>
 281   <td class="mlabels-right">
 282 <span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
 283   </tr>
 284 </table>
 285 </div><div class="memdoc">
 286
 287 <p>Number of elements of the tensor. </p>
 288
 289 <p>Implemented in <a class="el" href="classarm__compute_1_1test_1_1_c_l_array_accessor.xhtml#ade9461ca253dd956d2d08f89dd04c6eb">CLArrayAccessor&lt; T &gt;</a>, and <a class="el" href="classarm__compute_1_1test_1_1_array_accessor.xhtml#ade9461ca253dd956d2d08f89dd04c6eb">ArrayAccessor&lt; T &gt;</a>.</p>
 290
 291 </div>
 292 </div>
 293 <a class="anchor" id="aa3243d314953e018ebcaf98128068110"></a>
 294 <div class="memitem">
 295 <div class="memproto">
 296 <table class="mlabels">
 297   <tr>
 298   <td class="mlabels-left">
 299       <table class="memname">
 300         <tr>
 301           <td class="memname">virtual void resize </td>
 302           <td>(</td>
 303           <td class="paramtype">size_t&#160;</td>
 304           <td class="paramname"><em>num</em></td><td>)</td>
 305           <td></td>
 306         </tr>
 307       </table>
 308   </td>
 309   <td class="mlabels-right">
 310 <span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
 311   </tr>
 312 </table>
 313 </div><div class="memdoc">
 314
 315 <p>Resize array. </p>
 316 <dl class="params"><dt>Parameters</dt><dd>
 317   <table class="params">
 318     <tr><td class="paramdir">[in]</td><td class="paramname">num</td><td>The new array size in number of elements </td></tr>
 319   </table>
 320   </dd>
 321 </dl>
 322
 323 <p>Implemented in <a class="el" href="classarm__compute_1_1test_1_1_c_l_array_accessor.xhtml#a0cafaca7cb86d89b5f20f987448c341c">CLArrayAccessor&lt; T &gt;</a>, and <a class="el" href="classarm__compute_1_1test_1_1_array_accessor.xhtml#a0cafaca7cb86d89b5f20f987448c341c">ArrayAccessor&lt; T &gt;</a>.</p>
 324
 325 </div>
 326 </div>
 327 <hr/>The documentation for this class was generated from the following file:<ul>
 328 <li>tests/<a class="el" href="_i_array_accessor_8h_source.xhtml">IArrayAccessor.h</a></li>
 329 </ul>
 330 </div><!-- contents -->
 331 </div><!-- doc-content -->
 332 <!-- start footer part -->
 333 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 334   <ul>
 335     <li class="navelem"><a class="el" href="namespacearm__compute.xhtml">arm_compute</a></li><li class="navelem"><a class="el" href="namespacearm__compute_1_1test.xhtml">test</a></li><li class="navelem"><a class="el" href="classarm__compute_1_1test_1_1_i_array_accessor.xhtml">IArrayAccessor</a></li>
 336     <li class="footer">Generated on Thu Feb 22 2018 15:45:26 for Compute Library by
 337     <a href="http://www.doxygen.org/index.html">
 338     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
 339   </ul>
 340 </div>
 341 </body>
 342 </html>