documentation/classarm__compute_1_1_c_l_array.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: CLArray&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">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_c_l_array.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">CLArray&lt; T &gt; Class Template Reference</div>  </div>
 121 </div><!--header-->
 122 <div class="contents">
 123
 124 <p><a class="el" href="classarm__compute_1_1_c_l_array.xhtml" title="CLArray implementation. ">CLArray</a> implementation.
 125  <a href="classarm__compute_1_1_c_l_array.xhtml#details">More...</a></p>
 126
 127 <p><code>#include &lt;<a class="el" href="_c_l_array_8h_source.xhtml">CLArray.h</a>&gt;</code></p>
 128 <div class="dynheader">
 129 Collaboration diagram for CLArray&lt; T &gt;:</div>
 130 <div class="dyncontent">
 131 <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_c_l_array__coll__graph.svg" width="118" height="187"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
 132 </div>
 133 <center><span class="legend">[<a target="top" href="graph_legend.xhtml">legend</a>]</span></center></div>
 134 <table class="memberdecls">
 135 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
 136 Public Member Functions</h2></td></tr>
 137 <tr class="memitem:aa5da2a7afb0be8e26c7159bce08bd897"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_array.xhtml#aa5da2a7afb0be8e26c7159bce08bd897">CLArray</a> (const <a class="el" href="classarm__compute_1_1_c_l_array.xhtml">CLArray</a> &amp;)=delete</td></tr>
 138 <tr class="memdesc:aa5da2a7afb0be8e26c7159bce08bd897"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent instances of this class from being copied (As this class contains pointers)  <a href="#aa5da2a7afb0be8e26c7159bce08bd897">More...</a><br /></td></tr>
 139 <tr class="separator:aa5da2a7afb0be8e26c7159bce08bd897"><td class="memSeparator" colspan="2">&#160;</td></tr>
 140 <tr class="memitem:a30c5bc8ac7572a16644c3c88daa90f49"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classarm__compute_1_1_c_l_array.xhtml">CLArray</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_array.xhtml#a30c5bc8ac7572a16644c3c88daa90f49">operator=</a> (const <a class="el" href="classarm__compute_1_1_c_l_array.xhtml">CLArray</a> &amp;)=delete</td></tr>
 141 <tr class="memdesc:a30c5bc8ac7572a16644c3c88daa90f49"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent instances of this class from being copied (As this class contains pointers)  <a href="#a30c5bc8ac7572a16644c3c88daa90f49">More...</a><br /></td></tr>
 142 <tr class="separator:a30c5bc8ac7572a16644c3c88daa90f49"><td class="memSeparator" colspan="2">&#160;</td></tr>
 143 <tr class="memitem:aaa923d0abf2a3a5722a728f39411ad07"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_array.xhtml#aaa923d0abf2a3a5722a728f39411ad07">CLArray</a> (size_t <a class="el" href="classarm__compute_1_1_i_array.xhtml#a2ff0fb106d58091d2b4363e808f200a3">max_num_values</a>)</td></tr>
 144 <tr class="memdesc:aaa923d0abf2a3a5722a728f39411ad07"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor: initializes an array which can contain up to max_num_points values.  <a href="#aaa923d0abf2a3a5722a728f39411ad07">More...</a><br /></td></tr>
 145 <tr class="separator:aaa923d0abf2a3a5722a728f39411ad07"><td class="memSeparator" colspan="2">&#160;</td></tr>
 146 <tr class="memitem:a14c53d2d17be6fa8a2c9861527c7b002"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_array.xhtml#a14c53d2d17be6fa8a2c9861527c7b002">map</a> (bool blocking=true)</td></tr>
 147 <tr class="memdesc:a14c53d2d17be6fa8a2c9861527c7b002"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enqueue a map operation of the allocated buffer.  <a href="#a14c53d2d17be6fa8a2c9861527c7b002">More...</a><br /></td></tr>
 148 <tr class="separator:a14c53d2d17be6fa8a2c9861527c7b002"><td class="memSeparator" colspan="2">&#160;</td></tr>
 149 <tr class="memitem:a1ffeb3b5abb3d61f62b58a391816201c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_array.xhtml#a1ffeb3b5abb3d61f62b58a391816201c">unmap</a> ()</td></tr>
 150 <tr class="memdesc:a1ffeb3b5abb3d61f62b58a391816201c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enqueue an unmap operation of the allocated and mapped buffer.  <a href="#a1ffeb3b5abb3d61f62b58a391816201c">More...</a><br /></td></tr>
 151 <tr class="separator:a1ffeb3b5abb3d61f62b58a391816201c"><td class="memSeparator" colspan="2">&#160;</td></tr>
 152 <tr class="memitem:afd44a3d7dad6d984b1b87bc9f1b4fa02"><td class="memItemLeft" align="right" valign="top">const cl::Buffer &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_array.xhtml#afd44a3d7dad6d984b1b87bc9f1b4fa02">cl_buffer</a> () const override</td></tr>
 153 <tr class="memdesc:afd44a3d7dad6d984b1b87bc9f1b4fa02"><td class="mdescLeft">&#160;</td><td class="mdescRight">Interface to be implemented by the child class to return a reference to the OpenCL buffer containing the array's data.  <a href="#afd44a3d7dad6d984b1b87bc9f1b4fa02">More...</a><br /></td></tr>
 154 <tr class="separator:afd44a3d7dad6d984b1b87bc9f1b4fa02"><td class="memSeparator" colspan="2">&#160;</td></tr>
 155 <tr class="inherit_header pub_methods_classarm__compute_1_1_i_c_l_array"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarm__compute_1_1_i_c_l_array')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classarm__compute_1_1_i_c_l_array.xhtml">ICLArray&lt; T &gt;</a></td></tr>
 156 <tr class="memitem:a52adc23eae121bce4ce2f3febaf77566 inherit pub_methods_classarm__compute_1_1_i_c_l_array"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_l_array.xhtml#a52adc23eae121bce4ce2f3febaf77566">ICLArray</a> (size_t <a class="el" href="classarm__compute_1_1_i_array.xhtml#a2ff0fb106d58091d2b4363e808f200a3">max_num_values</a>)</td></tr>
 157 <tr class="separator:a52adc23eae121bce4ce2f3febaf77566 inherit pub_methods_classarm__compute_1_1_i_c_l_array"><td class="memSeparator" colspan="2">&#160;</td></tr>
 158 <tr class="memitem:a0cf073a23250bc74f0481a2747245e09 inherit pub_methods_classarm__compute_1_1_i_c_l_array"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_l_array.xhtml#a0cf073a23250bc74f0481a2747245e09">ICLArray</a> (const <a class="el" href="classarm__compute_1_1_i_c_l_array.xhtml">ICLArray</a> &amp;)=delete</td></tr>
 159 <tr class="separator:a0cf073a23250bc74f0481a2747245e09 inherit pub_methods_classarm__compute_1_1_i_c_l_array"><td class="memSeparator" colspan="2">&#160;</td></tr>
 160 <tr class="memitem:aefdb6cfe839aa0835406d5adcd37de5b inherit pub_methods_classarm__compute_1_1_i_c_l_array"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_i_c_l_array.xhtml">ICLArray</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_l_array.xhtml#aefdb6cfe839aa0835406d5adcd37de5b">operator=</a> (const <a class="el" href="classarm__compute_1_1_i_c_l_array.xhtml">ICLArray</a> &amp;)=delete</td></tr>
 161 <tr class="separator:aefdb6cfe839aa0835406d5adcd37de5b inherit pub_methods_classarm__compute_1_1_i_c_l_array"><td class="memSeparator" colspan="2">&#160;</td></tr>
 162 <tr class="memitem:a0c95f444049eea7c7d14f6fd57ef40a1 inherit pub_methods_classarm__compute_1_1_i_c_l_array"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_l_array.xhtml#a0c95f444049eea7c7d14f6fd57ef40a1">~ICLArray</a> ()=default</td></tr>
 163 <tr class="separator:a0c95f444049eea7c7d14f6fd57ef40a1 inherit pub_methods_classarm__compute_1_1_i_c_l_array"><td class="memSeparator" colspan="2">&#160;</td></tr>
 164 <tr class="memitem:ac0abc7a5c0d172947f0e6a0c0dde3df0 inherit pub_methods_classarm__compute_1_1_i_c_l_array"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_l_array.xhtml#ac0abc7a5c0d172947f0e6a0c0dde3df0">map</a> (cl::CommandQueue &amp;q, bool blocking=true)</td></tr>
 165 <tr class="memdesc:ac0abc7a5c0d172947f0e6a0c0dde3df0 inherit pub_methods_classarm__compute_1_1_i_c_l_array"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enqueue a map operation of the allocated buffer on the given queue.  <a href="#ac0abc7a5c0d172947f0e6a0c0dde3df0">More...</a><br /></td></tr>
 166 <tr class="separator:ac0abc7a5c0d172947f0e6a0c0dde3df0 inherit pub_methods_classarm__compute_1_1_i_c_l_array"><td class="memSeparator" colspan="2">&#160;</td></tr>
 167 <tr class="memitem:af974a2360069c2ef8df4496d00e4f6cc inherit pub_methods_classarm__compute_1_1_i_c_l_array"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_l_array.xhtml#af974a2360069c2ef8df4496d00e4f6cc">unmap</a> (cl::CommandQueue &amp;q)</td></tr>
 168 <tr class="memdesc:af974a2360069c2ef8df4496d00e4f6cc inherit pub_methods_classarm__compute_1_1_i_c_l_array"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enqueue an unmap operation of the allocated and mapped buffer on the given queue.  <a href="#af974a2360069c2ef8df4496d00e4f6cc">More...</a><br /></td></tr>
 169 <tr class="separator:af974a2360069c2ef8df4496d00e4f6cc inherit pub_methods_classarm__compute_1_1_i_c_l_array"><td class="memSeparator" colspan="2">&#160;</td></tr>
 170 <tr class="memitem:a46fdef12397c4404e7706cba3568b42d inherit pub_methods_classarm__compute_1_1_i_c_l_array"><td class="memItemLeft" align="right" valign="top">T *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_l_array.xhtml#a46fdef12397c4404e7706cba3568b42d">buffer</a> () const override</td></tr>
 171 <tr class="memdesc:a46fdef12397c4404e7706cba3568b42d inherit pub_methods_classarm__compute_1_1_i_c_l_array"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to the first element of the array.  <a href="#a46fdef12397c4404e7706cba3568b42d">More...</a><br /></td></tr>
 172 <tr class="separator:a46fdef12397c4404e7706cba3568b42d inherit pub_methods_classarm__compute_1_1_i_c_l_array"><td class="memSeparator" colspan="2">&#160;</td></tr>
 173 <tr class="inherit_header pub_methods_classarm__compute_1_1_i_array"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarm__compute_1_1_i_array')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classarm__compute_1_1_i_array.xhtml">IArray&lt; T &gt;</a></td></tr>
 174 <tr class="memitem:a409cec620a7e56a535b079a0fe37695a inherit pub_methods_classarm__compute_1_1_i_array"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_array.xhtml#a409cec620a7e56a535b079a0fe37695a">IArray</a> ()</td></tr>
 175 <tr class="memdesc:a409cec620a7e56a535b079a0fe37695a inherit pub_methods_classarm__compute_1_1_i_array"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor.  <a href="#a409cec620a7e56a535b079a0fe37695a">More...</a><br /></td></tr>
 176 <tr class="separator:a409cec620a7e56a535b079a0fe37695a inherit pub_methods_classarm__compute_1_1_i_array"><td class="memSeparator" colspan="2">&#160;</td></tr>
 177 <tr class="memitem:a7ddd3791f151a0ad74b270776ff3726c inherit pub_methods_classarm__compute_1_1_i_array"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_array.xhtml#a7ddd3791f151a0ad74b270776ff3726c">IArray</a> (size_t <a class="el" href="classarm__compute_1_1_i_array.xhtml#a2ff0fb106d58091d2b4363e808f200a3">max_num_values</a>)</td></tr>
 178 <tr class="memdesc:a7ddd3791f151a0ad74b270776ff3726c inherit pub_methods_classarm__compute_1_1_i_array"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor: initializes an array which can contain up to max_num_points values.  <a href="#a7ddd3791f151a0ad74b270776ff3726c">More...</a><br /></td></tr>
 179 <tr class="separator:a7ddd3791f151a0ad74b270776ff3726c inherit pub_methods_classarm__compute_1_1_i_array"><td class="memSeparator" colspan="2">&#160;</td></tr>
 180 <tr class="memitem:a2ff0fb106d58091d2b4363e808f200a3 inherit pub_methods_classarm__compute_1_1_i_array"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_array.xhtml#a2ff0fb106d58091d2b4363e808f200a3">max_num_values</a> () const </td></tr>
 181 <tr class="memdesc:a2ff0fb106d58091d2b4363e808f200a3 inherit pub_methods_classarm__compute_1_1_i_array"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximum number of values which can be stored in this array.  <a href="#a2ff0fb106d58091d2b4363e808f200a3">More...</a><br /></td></tr>
 182 <tr class="separator:a2ff0fb106d58091d2b4363e808f200a3 inherit pub_methods_classarm__compute_1_1_i_array"><td class="memSeparator" colspan="2">&#160;</td></tr>
 183 <tr class="memitem:acaeb87c4bcccaf15bb25bd2c8e44658a inherit pub_methods_classarm__compute_1_1_i_array"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_array.xhtml#acaeb87c4bcccaf15bb25bd2c8e44658a">~IArray</a> ()=default</td></tr>
 184 <tr class="memdesc:acaeb87c4bcccaf15bb25bd2c8e44658a inherit pub_methods_classarm__compute_1_1_i_array"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default virtual destructor.  <a href="#acaeb87c4bcccaf15bb25bd2c8e44658a">More...</a><br /></td></tr>
 185 <tr class="separator:acaeb87c4bcccaf15bb25bd2c8e44658a inherit pub_methods_classarm__compute_1_1_i_array"><td class="memSeparator" colspan="2">&#160;</td></tr>
 186 <tr class="memitem:a6dc031c18a14371984493b25a4230f59 inherit pub_methods_classarm__compute_1_1_i_array"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_array.xhtml#a6dc031c18a14371984493b25a4230f59">num_values</a> () const </td></tr>
 187 <tr class="memdesc:a6dc031c18a14371984493b25a4230f59 inherit pub_methods_classarm__compute_1_1_i_array"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of values currently stored in the array.  <a href="#a6dc031c18a14371984493b25a4230f59">More...</a><br /></td></tr>
 188 <tr class="separator:a6dc031c18a14371984493b25a4230f59 inherit pub_methods_classarm__compute_1_1_i_array"><td class="memSeparator" colspan="2">&#160;</td></tr>
 189 <tr class="memitem:a9031bfcabdaae3ac3e6e349446e282ff inherit pub_methods_classarm__compute_1_1_i_array"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_array.xhtml#a9031bfcabdaae3ac3e6e349446e282ff">push_back</a> (const T &amp;val)</td></tr>
 190 <tr class="memdesc:a9031bfcabdaae3ac3e6e349446e282ff inherit pub_methods_classarm__compute_1_1_i_array"><td class="mdescLeft">&#160;</td><td class="mdescRight">Append the passed argument to the end of the array if there is room.  <a href="#a9031bfcabdaae3ac3e6e349446e282ff">More...</a><br /></td></tr>
 191 <tr class="separator:a9031bfcabdaae3ac3e6e349446e282ff inherit pub_methods_classarm__compute_1_1_i_array"><td class="memSeparator" colspan="2">&#160;</td></tr>
 192 <tr class="memitem:ac8bb3912a3ce86b15842e79d0b421204 inherit pub_methods_classarm__compute_1_1_i_array"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_array.xhtml#ac8bb3912a3ce86b15842e79d0b421204">clear</a> ()</td></tr>
 193 <tr class="memdesc:ac8bb3912a3ce86b15842e79d0b421204 inherit pub_methods_classarm__compute_1_1_i_array"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clear all the points from the array.  <a href="#ac8bb3912a3ce86b15842e79d0b421204">More...</a><br /></td></tr>
 194 <tr class="separator:ac8bb3912a3ce86b15842e79d0b421204 inherit pub_methods_classarm__compute_1_1_i_array"><td class="memSeparator" colspan="2">&#160;</td></tr>
 195 <tr class="memitem:afd912c5902331232c8a806fcb2d6eaad inherit pub_methods_classarm__compute_1_1_i_array"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_array.xhtml#afd912c5902331232c8a806fcb2d6eaad">overflow</a> () const </td></tr>
 196 <tr class="memdesc:afd912c5902331232c8a806fcb2d6eaad inherit pub_methods_classarm__compute_1_1_i_array"><td class="mdescLeft">&#160;</td><td class="mdescRight">Did we lose some values because the array is too small?  <a href="#afd912c5902331232c8a806fcb2d6eaad">More...</a><br /></td></tr>
 197 <tr class="separator:afd912c5902331232c8a806fcb2d6eaad inherit pub_methods_classarm__compute_1_1_i_array"><td class="memSeparator" colspan="2">&#160;</td></tr>
 198 <tr class="memitem:a861d8aa0fbeb6a0a33ec8d556b7e8657 inherit pub_methods_classarm__compute_1_1_i_array"><td class="memItemLeft" align="right" valign="top">virtual T &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_array.xhtml#a861d8aa0fbeb6a0a33ec8d556b7e8657">at</a> (size_t index) const </td></tr>
 199 <tr class="memdesc:a861d8aa0fbeb6a0a33ec8d556b7e8657 inherit pub_methods_classarm__compute_1_1_i_array"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reference to the element of the array located at the given index.  <a href="#a861d8aa0fbeb6a0a33ec8d556b7e8657">More...</a><br /></td></tr>
 200 <tr class="separator:a861d8aa0fbeb6a0a33ec8d556b7e8657 inherit pub_methods_classarm__compute_1_1_i_array"><td class="memSeparator" colspan="2">&#160;</td></tr>
 201 <tr class="memitem:ae21b0e95ded2dcfb5e62848ea0193828 inherit pub_methods_classarm__compute_1_1_i_array"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_array.xhtml#ae21b0e95ded2dcfb5e62848ea0193828">resize</a> (size_t num)</td></tr>
 202 <tr class="memdesc:ae21b0e95ded2dcfb5e62848ea0193828 inherit pub_methods_classarm__compute_1_1_i_array"><td class="mdescLeft">&#160;</td><td class="mdescRight">Resizes the array to contain "num" elements.  <a href="#ae21b0e95ded2dcfb5e62848ea0193828">More...</a><br /></td></tr>
 203 <tr class="separator:ae21b0e95ded2dcfb5e62848ea0193828 inherit pub_methods_classarm__compute_1_1_i_array"><td class="memSeparator" colspan="2">&#160;</td></tr>
 204 </table>
 205 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 206 <div class="textblock"><h3>template&lt;class T&gt;<br />
 207 class arm_compute::CLArray&lt; T &gt;</h3>
 208
 209 <p><a class="el" href="classarm__compute_1_1_c_l_array.xhtml" title="CLArray implementation. ">CLArray</a> implementation. </p>
 210
 211 <p>Definition at line <a class="el" href="_c_l_array_8h_source.xhtml#l00037">37</a> of file <a class="el" href="_c_l_array_8h_source.xhtml">CLArray.h</a>.</p>
 212 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 213 <a class="anchor" id="aa5da2a7afb0be8e26c7159bce08bd897"></a>
 214 <div class="memitem">
 215 <div class="memproto">
 216 <table class="mlabels">
 217   <tr>
 218   <td class="mlabels-left">
 219       <table class="memname">
 220         <tr>
 221           <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_array.xhtml">CLArray</a> </td>
 222           <td>(</td>
 223           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_c_l_array.xhtml">CLArray</a>&lt; T &gt; &amp;&#160;</td>
 224           <td class="paramname"></td><td>)</td>
 225           <td></td>
 226         </tr>
 227       </table>
 228   </td>
 229   <td class="mlabels-right">
 230 <span class="mlabels"><span class="mlabel">delete</span></span>  </td>
 231   </tr>
 232 </table>
 233 </div><div class="memdoc">
 234
 235 <p>Prevent instances of this class from being copied (As this class contains pointers) </p>
 236
 237 </div>
 238 </div>
 239 <a class="anchor" id="aaa923d0abf2a3a5722a728f39411ad07"></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="classarm__compute_1_1_c_l_array.xhtml">CLArray</a> </td>
 248           <td>(</td>
 249           <td class="paramtype">size_t&#160;</td>
 250           <td class="paramname"><em>max_num_values</em></td><td>)</td>
 251           <td></td>
 252         </tr>
 253       </table>
 254   </td>
 255   <td class="mlabels-right">
 256 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 257   </tr>
 258 </table>
 259 </div><div class="memdoc">
 260
 261 <p>Constructor: initializes an array which can contain up to max_num_points values. </p>
 262 <dl class="params"><dt>Parameters</dt><dd>
 263   <table class="params">
 264     <tr><td class="paramdir">[in]</td><td class="paramname">max_num_values</td><td>Maximum number of values the array will be able to stored </td></tr>
 265   </table>
 266   </dd>
 267 </dl>
 268
 269 <p>Definition at line <a class="el" href="_c_l_array_8h_source.xhtml#l00048">48</a> of file <a class="el" href="_c_l_array_8h_source.xhtml">CLArray.h</a>.</p>
 270 <div class="fragment"><div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;        : ICLArray&lt;T&gt;(<a class="code" href="classarm__compute_1_1_i_array.xhtml#a2ff0fb106d58091d2b4363e808f200a3">max_num_values</a>), _buffer(cl::Buffer(<a class="code" href="classarm__compute_1_1_c_l_scheduler.xhtml#a60f9a6836b628a7171914c4afe43b4a7">CLScheduler::get</a>().context(), CL_MEM_ALLOC_HOST_PTR | CL_MEM_READ_WRITE, <a class="code" href="classarm__compute_1_1_i_array.xhtml#a2ff0fb106d58091d2b4363e808f200a3">max_num_values</a> * <span class="keyword">sizeof</span>(T)))</div><div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;    {</div><div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;    }</div><div class="ttc" id="classarm__compute_1_1_c_l_scheduler_xhtml_a60f9a6836b628a7171914c4afe43b4a7"><div class="ttname"><a href="classarm__compute_1_1_c_l_scheduler.xhtml#a60f9a6836b628a7171914c4afe43b4a7">arm_compute::CLScheduler::get</a></div><div class="ttdeci">static CLScheduler &amp; get()</div><div class="ttdoc">Access the scheduler singleton. </div></div>
 271 <div class="ttc" id="classarm__compute_1_1_i_array_xhtml_a2ff0fb106d58091d2b4363e808f200a3"><div class="ttname"><a href="classarm__compute_1_1_i_array.xhtml#a2ff0fb106d58091d2b4363e808f200a3">arm_compute::IArray::max_num_values</a></div><div class="ttdeci">size_t max_num_values() const </div><div class="ttdoc">Maximum number of values which can be stored in this array. </div><div class="ttdef"><b>Definition:</b> <a href="_i_array_8h_source.xhtml#l00058">IArray.h:58</a></div></div>
 272 </div><!-- fragment -->
 273 </div>
 274 </div>
 275 <h2 class="groupheader">Member Function Documentation</h2>
 276 <a class="anchor" id="afd44a3d7dad6d984b1b87bc9f1b4fa02"></a>
 277 <div class="memitem">
 278 <div class="memproto">
 279 <table class="mlabels">
 280   <tr>
 281   <td class="mlabels-left">
 282       <table class="memname">
 283         <tr>
 284           <td class="memname">const cl::Buffer&amp; cl_buffer </td>
 285           <td>(</td>
 286           <td class="paramname"></td><td>)</td>
 287           <td> const</td>
 288         </tr>
 289       </table>
 290   </td>
 291   <td class="mlabels-right">
 292 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
 293   </tr>
 294 </table>
 295 </div><div class="memdoc">
 296
 297 <p>Interface to be implemented by the child class to return a reference to the OpenCL buffer containing the array's data. </p>
 298 <dl class="section return"><dt>Returns</dt><dd>A reference to an OpenCL buffer containing the array's data. </dd></dl>
 299
 300 <p>Implements <a class="el" href="classarm__compute_1_1_i_c_l_array.xhtml#a1fb4c50755a0ef424652246838ed91a6">ICLArray&lt; T &gt;</a>.</p>
 301
 302 <p>Definition at line <a class="el" href="_c_l_array_8h_source.xhtml#l00075">75</a> of file <a class="el" href="_c_l_array_8h_source.xhtml">CLArray.h</a>.</p>
 303
 304 <p>References <a class="el" href="_error_8h_source.xhtml#l00100">ARM_COMPUTE_ERROR_ON</a>, and <a class="el" href="_i_array_8h_source.xhtml#l00058">IArray&lt; T &gt;::max_num_values()</a>.</p>
 305 <div class="fragment"><div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;    {</div><div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;        <span class="keywordflow">return</span> _buffer;</div><div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;    }</div></div><!-- fragment -->
 306 </div>
 307 </div>
 308 <a class="anchor" id="a14c53d2d17be6fa8a2c9861527c7b002"></a>
 309 <div class="memitem">
 310 <div class="memproto">
 311 <table class="mlabels">
 312   <tr>
 313   <td class="mlabels-left">
 314       <table class="memname">
 315         <tr>
 316           <td class="memname">void map </td>
 317           <td>(</td>
 318           <td class="paramtype">bool&#160;</td>
 319           <td class="paramname"><em>blocking</em> = <code>true</code></td><td>)</td>
 320           <td></td>
 321         </tr>
 322       </table>
 323   </td>
 324   <td class="mlabels-right">
 325 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 326   </tr>
 327 </table>
 328 </div><div class="memdoc">
 329
 330 <p>Enqueue a map operation of the allocated buffer. </p>
 331 <dl class="params"><dt>Parameters</dt><dd>
 332   <table class="params">
 333     <tr><td class="paramdir">[in]</td><td class="paramname">blocking</td><td>If true, then the mapping will be ready to use by the time this method returns, else it is the caller's responsibility to flush the queue and wait for the mapping operation to have completed. </td></tr>
 334   </table>
 335   </dd>
 336 </dl>
 337
 338 <p>Definition at line <a class="el" href="_c_l_array_8h_source.xhtml#l00058">58</a> of file <a class="el" href="_c_l_array_8h_source.xhtml">CLArray.h</a>.</p>
 339
 340 <p>References <a class="el" href="classarm__compute_1_1_c_l_scheduler.xhtml#a60f9a6836b628a7171914c4afe43b4a7">CLScheduler::get()</a>, and <a class="el" href="_i_c_l_array_8h_source.xhtml#l00061">ICLArray&lt; T &gt;::map()</a>.</p>
 341 <div class="fragment"><div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;    {</div><div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;        <a class="code" href="classarm__compute_1_1_i_c_l_array.xhtml#ac0abc7a5c0d172947f0e6a0c0dde3df0">ICLArray&lt;T&gt;::map</a>(<a class="code" href="classarm__compute_1_1_c_l_scheduler.xhtml#a60f9a6836b628a7171914c4afe43b4a7">CLScheduler::get</a>().queue(), blocking);</div><div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;    }</div><div class="ttc" id="classarm__compute_1_1_i_c_l_array_xhtml_ac0abc7a5c0d172947f0e6a0c0dde3df0"><div class="ttname"><a href="classarm__compute_1_1_i_c_l_array.xhtml#ac0abc7a5c0d172947f0e6a0c0dde3df0">arm_compute::ICLArray::map</a></div><div class="ttdeci">void map(cl::CommandQueue &amp;q, bool blocking=true)</div><div class="ttdoc">Enqueue a map operation of the allocated buffer on the given queue. </div><div class="ttdef"><b>Definition:</b> <a href="_i_c_l_array_8h_source.xhtml#l00061">ICLArray.h:61</a></div></div>
 342 <div class="ttc" id="classarm__compute_1_1_c_l_scheduler_xhtml_a60f9a6836b628a7171914c4afe43b4a7"><div class="ttname"><a href="classarm__compute_1_1_c_l_scheduler.xhtml#a60f9a6836b628a7171914c4afe43b4a7">arm_compute::CLScheduler::get</a></div><div class="ttdeci">static CLScheduler &amp; get()</div><div class="ttdoc">Access the scheduler singleton. </div></div>
 343 </div><!-- fragment -->
 344 </div>
 345 </div>
 346 <a class="anchor" id="a30c5bc8ac7572a16644c3c88daa90f49"></a>
 347 <div class="memitem">
 348 <div class="memproto">
 349 <table class="mlabels">
 350   <tr>
 351   <td class="mlabels-left">
 352       <table class="memname">
 353         <tr>
 354           <td class="memname">const <a class="el" href="classarm__compute_1_1_c_l_array.xhtml">CLArray</a>&amp; operator= </td>
 355           <td>(</td>
 356           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_c_l_array.xhtml">CLArray</a>&lt; T &gt; &amp;&#160;</td>
 357           <td class="paramname"></td><td>)</td>
 358           <td></td>
 359         </tr>
 360       </table>
 361   </td>
 362   <td class="mlabels-right">
 363 <span class="mlabels"><span class="mlabel">delete</span></span>  </td>
 364   </tr>
 365 </table>
 366 </div><div class="memdoc">
 367
 368 <p>Prevent instances of this class from being copied (As this class contains pointers) </p>
 369
 370 </div>
 371 </div>
 372 <a class="anchor" id="a1ffeb3b5abb3d61f62b58a391816201c"></a>
 373 <div class="memitem">
 374 <div class="memproto">
 375 <table class="mlabels">
 376   <tr>
 377   <td class="mlabels-left">
 378       <table class="memname">
 379         <tr>
 380           <td class="memname">void unmap </td>
 381           <td>(</td>
 382           <td class="paramname"></td><td>)</td>
 383           <td></td>
 384         </tr>
 385       </table>
 386   </td>
 387   <td class="mlabels-right">
 388 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 389   </tr>
 390 </table>
 391 </div><div class="memdoc">
 392
 393 <p>Enqueue an unmap operation of the allocated and mapped buffer. </p>
 394 <dl class="section note"><dt>Note</dt><dd>This method simply enqueues the unmap operation, it is the caller's responsibility to flush the queue and make sure the unmap is finished before the memory is accessed by the device. </dd></dl>
 395
 396 <p>Definition at line <a class="el" href="_c_l_array_8h_source.xhtml#l00068">68</a> of file <a class="el" href="_c_l_array_8h_source.xhtml">CLArray.h</a>.</p>
 397
 398 <p>References <a class="el" href="classarm__compute_1_1_c_l_scheduler.xhtml#a60f9a6836b628a7171914c4afe43b4a7">CLScheduler::get()</a>, and <a class="el" href="_i_c_l_array_8h_source.xhtml#l00072">ICLArray&lt; T &gt;::unmap()</a>.</p>
 399 <div class="fragment"><div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;    {</div><div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;        <a class="code" href="classarm__compute_1_1_i_c_l_array.xhtml#af974a2360069c2ef8df4496d00e4f6cc">ICLArray&lt;T&gt;::unmap</a>(<a class="code" href="classarm__compute_1_1_c_l_scheduler.xhtml#a60f9a6836b628a7171914c4afe43b4a7">CLScheduler::get</a>().queue());</div><div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;    }</div><div class="ttc" id="classarm__compute_1_1_c_l_scheduler_xhtml_a60f9a6836b628a7171914c4afe43b4a7"><div class="ttname"><a href="classarm__compute_1_1_c_l_scheduler.xhtml#a60f9a6836b628a7171914c4afe43b4a7">arm_compute::CLScheduler::get</a></div><div class="ttdeci">static CLScheduler &amp; get()</div><div class="ttdoc">Access the scheduler singleton. </div></div>
 400 <div class="ttc" id="classarm__compute_1_1_i_c_l_array_xhtml_af974a2360069c2ef8df4496d00e4f6cc"><div class="ttname"><a href="classarm__compute_1_1_i_c_l_array.xhtml#af974a2360069c2ef8df4496d00e4f6cc">arm_compute::ICLArray::unmap</a></div><div class="ttdeci">void unmap(cl::CommandQueue &amp;q)</div><div class="ttdoc">Enqueue an unmap operation of the allocated and mapped buffer on the given queue. ...</div><div class="ttdef"><b>Definition:</b> <a href="_i_c_l_array_8h_source.xhtml#l00072">ICLArray.h:72</a></div></div>
 401 </div><!-- fragment -->
 402 </div>
 403 </div>
 404 <hr/>The documentation for this class was generated from the following file:<ul>
 405 <li>arm_compute/runtime/CL/<a class="el" href="_c_l_array_8h_source.xhtml">CLArray.h</a></li>
 406 </ul>
 407 </div><!-- contents -->
 408 </div><!-- doc-content -->
 409 <!-- start footer part -->
 410 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 411   <ul>
 412     <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_c_l_array.xhtml">CLArray</a></li>
 413     <li class="footer">Generated on Wed Apr 12 2017 14:26:05 for ARM Compute Library by
 414     <a href="http://www.doxygen.org/index.html">
 415     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
 416   </ul>
 417 </div>
 418 </body>
 419 </html>