documentation/classarm__compute_1_1_i_c_l_tensor.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: ICLTensor 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_i_c_l_tensor.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">ICLTensor Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
 121 </div><!--header-->
 122 <div class="contents">
 123
 124 <p>Interface for OpenCL tensor.
 125  <a href="classarm__compute_1_1_i_c_l_tensor.xhtml#details">More...</a></p>
 126
 127 <p><code>#include &lt;<a class="el" href="_i_c_l_tensor_8h_source.xhtml">ICLTensor.h</a>&gt;</code></p>
 128 <div class="dynheader">
 129 Collaboration diagram for ICLTensor:</div>
 130 <div class="dyncontent">
 131 <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_i_c_l_tensor__coll__graph.svg" width="94" height="112"><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:a64399eb327ea2e4ecd2c8086a8dc01ce"><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_tensor.xhtml#a64399eb327ea2e4ecd2c8086a8dc01ce">ICLTensor</a> ()</td></tr>
 138 <tr class="separator:a64399eb327ea2e4ecd2c8086a8dc01ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
 139 <tr class="memitem:ad49b11e9c7276ca78046ad4c339cd7c6"><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_tensor.xhtml#ad49b11e9c7276ca78046ad4c339cd7c6">ICLTensor</a> (const <a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> &amp;)=delete</td></tr>
 140 <tr class="separator:ad49b11e9c7276ca78046ad4c339cd7c6"><td class="memSeparator" colspan="2">&#160;</td></tr>
 141 <tr class="memitem:af72219f9b5e8803950eb8863a23c076e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml#af72219f9b5e8803950eb8863a23c076e">operator=</a> (const <a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> &amp;)=delete</td></tr>
 142 <tr class="separator:af72219f9b5e8803950eb8863a23c076e"><td class="memSeparator" colspan="2">&#160;</td></tr>
 143 <tr class="memitem:a1fb4c50755a0ef424652246838ed91a6"><td class="memItemLeft" align="right" valign="top">virtual const cl::Buffer &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml#a1fb4c50755a0ef424652246838ed91a6">cl_buffer</a> () const =0</td></tr>
 144 <tr class="memdesc:a1fb4c50755a0ef424652246838ed91a6"><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 image's data.  <a href="#a1fb4c50755a0ef424652246838ed91a6">More...</a><br /></td></tr>
 145 <tr class="separator:a1fb4c50755a0ef424652246838ed91a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
 146 <tr class="memitem:ac0abc7a5c0d172947f0e6a0c0dde3df0"><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_tensor.xhtml#ac0abc7a5c0d172947f0e6a0c0dde3df0">map</a> (cl::CommandQueue &amp;q, bool blocking=true)</td></tr>
 147 <tr class="memdesc:ac0abc7a5c0d172947f0e6a0c0dde3df0"><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>
 148 <tr class="separator:ac0abc7a5c0d172947f0e6a0c0dde3df0"><td class="memSeparator" colspan="2">&#160;</td></tr>
 149 <tr class="memitem:af974a2360069c2ef8df4496d00e4f6cc"><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_tensor.xhtml#af974a2360069c2ef8df4496d00e4f6cc">unmap</a> (cl::CommandQueue &amp;q)</td></tr>
 150 <tr class="memdesc:af974a2360069c2ef8df4496d00e4f6cc"><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>
 151 <tr class="separator:af974a2360069c2ef8df4496d00e4f6cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
 152 <tr class="memitem:a7b94593f2b06f00d380ec3a3e6abccb2"><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_tensor.xhtml#a7b94593f2b06f00d380ec3a3e6abccb2">clear</a> (cl::CommandQueue &amp;q)</td></tr>
 153 <tr class="memdesc:a7b94593f2b06f00d380ec3a3e6abccb2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clear the contents of the tensor synchronously.  <a href="#a7b94593f2b06f00d380ec3a3e6abccb2">More...</a><br /></td></tr>
 154 <tr class="separator:a7b94593f2b06f00d380ec3a3e6abccb2"><td class="memSeparator" colspan="2">&#160;</td></tr>
 155 <tr class="memitem:ace7b855e3c647d29cc37a1ce147901dc"><td class="memItemLeft" align="right" valign="top">uint8_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml#ace7b855e3c647d29cc37a1ce147901dc">buffer</a> () const override</td></tr>
 156 <tr class="memdesc:ace7b855e3c647d29cc37a1ce147901dc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Interface to be implemented by the child class to return a pointer to CPU memory.  <a href="#ace7b855e3c647d29cc37a1ce147901dc">More...</a><br /></td></tr>
 157 <tr class="separator:ace7b855e3c647d29cc37a1ce147901dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
 158 <tr class="inherit_header pub_methods_classarm__compute_1_1_i_tensor"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarm__compute_1_1_i_tensor')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a></td></tr>
 159 <tr class="memitem:a8df2a8ec8fcd4258450270f15651b6c9 inherit pub_methods_classarm__compute_1_1_i_tensor"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classarm__compute_1_1_tensor_info.xhtml">TensorInfo</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_tensor.xhtml#a8df2a8ec8fcd4258450270f15651b6c9">info</a> () const =0</td></tr>
 160 <tr class="memdesc:a8df2a8ec8fcd4258450270f15651b6c9 inherit pub_methods_classarm__compute_1_1_i_tensor"><td class="mdescLeft">&#160;</td><td class="mdescRight">Interface to be implemented by the child class to return the tensor's metadata.  <a href="#a8df2a8ec8fcd4258450270f15651b6c9">More...</a><br /></td></tr>
 161 <tr class="separator:a8df2a8ec8fcd4258450270f15651b6c9 inherit pub_methods_classarm__compute_1_1_i_tensor"><td class="memSeparator" colspan="2">&#160;</td></tr>
 162 <tr class="memitem:a4d0ad991bc87d99aa39ca1ba6df15469 inherit pub_methods_classarm__compute_1_1_i_tensor"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classarm__compute_1_1_tensor_info.xhtml">TensorInfo</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_tensor.xhtml#a4d0ad991bc87d99aa39ca1ba6df15469">info</a> ()=0</td></tr>
 163 <tr class="memdesc:a4d0ad991bc87d99aa39ca1ba6df15469 inherit pub_methods_classarm__compute_1_1_i_tensor"><td class="mdescLeft">&#160;</td><td class="mdescRight">Interface to be implemented by the child class to return the tensor's metadata.  <a href="#a4d0ad991bc87d99aa39ca1ba6df15469">More...</a><br /></td></tr>
 164 <tr class="separator:a4d0ad991bc87d99aa39ca1ba6df15469 inherit pub_methods_classarm__compute_1_1_i_tensor"><td class="memSeparator" colspan="2">&#160;</td></tr>
 165 <tr class="memitem:a4aa2df36743089ac6814d83e7d4b7ffc inherit pub_methods_classarm__compute_1_1_i_tensor"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_tensor.xhtml#a4aa2df36743089ac6814d83e7d4b7ffc">~ITensor</a> ()=default</td></tr>
 166 <tr class="memdesc:a4aa2df36743089ac6814d83e7d4b7ffc inherit pub_methods_classarm__compute_1_1_i_tensor"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default virtual destructor.  <a href="#a4aa2df36743089ac6814d83e7d4b7ffc">More...</a><br /></td></tr>
 167 <tr class="separator:a4aa2df36743089ac6814d83e7d4b7ffc inherit pub_methods_classarm__compute_1_1_i_tensor"><td class="memSeparator" colspan="2">&#160;</td></tr>
 168 <tr class="memitem:a48c7a05cc63f541d732250e39339cee2 inherit pub_methods_classarm__compute_1_1_i_tensor"><td class="memItemLeft" align="right" valign="top">uint8_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_tensor.xhtml#a48c7a05cc63f541d732250e39339cee2">ptr_to_element</a> (const <a class="el" href="classarm__compute_1_1_coordinates.xhtml">Coordinates</a> &amp;id) const </td></tr>
 169 <tr class="memdesc:a48c7a05cc63f541d732250e39339cee2 inherit pub_methods_classarm__compute_1_1_i_tensor"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a pointer to the element at the passed coordinates.  <a href="#a48c7a05cc63f541d732250e39339cee2">More...</a><br /></td></tr>
 170 <tr class="separator:a48c7a05cc63f541d732250e39339cee2 inherit pub_methods_classarm__compute_1_1_i_tensor"><td class="memSeparator" colspan="2">&#160;</td></tr>
 171 <tr class="memitem:a4a774ad8d5f4837f3d7de1876d367c5b inherit pub_methods_classarm__compute_1_1_i_tensor"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_tensor.xhtml#a4a774ad8d5f4837f3d7de1876d367c5b">copy_from</a> (const <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> &amp;src)</td></tr>
 172 <tr class="memdesc:a4a774ad8d5f4837f3d7de1876d367c5b inherit pub_methods_classarm__compute_1_1_i_tensor"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy the content of another tensor.  <a href="#a4a774ad8d5f4837f3d7de1876d367c5b">More...</a><br /></td></tr>
 173 <tr class="separator:a4a774ad8d5f4837f3d7de1876d367c5b inherit pub_methods_classarm__compute_1_1_i_tensor"><td class="memSeparator" colspan="2">&#160;</td></tr>
 174 <tr class="memitem:a0b092c86d6e0fb8a114281565953a02a inherit pub_methods_classarm__compute_1_1_i_tensor"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_tensor.xhtml#a0b092c86d6e0fb8a114281565953a02a">print</a> (std::ostream &amp;s, <a class="el" href="structarm__compute_1_1_i_o_format_info.xhtml">IOFormatInfo</a> io_fmt=<a class="el" href="structarm__compute_1_1_i_o_format_info.xhtml">IOFormatInfo</a>()) const </td></tr>
 175 <tr class="memdesc:a0b092c86d6e0fb8a114281565953a02a inherit pub_methods_classarm__compute_1_1_i_tensor"><td class="mdescLeft">&#160;</td><td class="mdescRight">Print a tensor to a given stream using user defined formatting information.  <a href="#a0b092c86d6e0fb8a114281565953a02a">More...</a><br /></td></tr>
 176 <tr class="separator:a0b092c86d6e0fb8a114281565953a02a inherit pub_methods_classarm__compute_1_1_i_tensor"><td class="memSeparator" colspan="2">&#160;</td></tr>
 177 </table>
 178 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 179 <div class="textblock"><p>Interface for OpenCL tensor. </p>
 180
 181 <p>Definition at line <a class="el" href="_i_c_l_tensor_8h_source.xhtml#l00040">40</a> of file <a class="el" href="_i_c_l_tensor_8h_source.xhtml">ICLTensor.h</a>.</p>
 182 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 183 <a class="anchor" id="a64399eb327ea2e4ecd2c8086a8dc01ce"></a>
 184 <div class="memitem">
 185 <div class="memproto">
 186       <table class="memname">
 187         <tr>
 188           <td class="memname"><a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> </td>
 189           <td>(</td>
 190           <td class="paramname"></td><td>)</td>
 191           <td></td>
 192         </tr>
 193       </table>
 194 </div><div class="memdoc">
 195
 196 </div>
 197 </div>
 198 <a class="anchor" id="ad49b11e9c7276ca78046ad4c339cd7c6"></a>
 199 <div class="memitem">
 200 <div class="memproto">
 201 <table class="mlabels">
 202   <tr>
 203   <td class="mlabels-left">
 204       <table class="memname">
 205         <tr>
 206           <td class="memname"><a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> </td>
 207           <td>(</td>
 208           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> &amp;&#160;</td>
 209           <td class="paramname"></td><td>)</td>
 210           <td></td>
 211         </tr>
 212       </table>
 213   </td>
 214   <td class="mlabels-right">
 215 <span class="mlabels"><span class="mlabel">delete</span></span>  </td>
 216   </tr>
 217 </table>
 218 </div><div class="memdoc">
 219
 220 </div>
 221 </div>
 222 <h2 class="groupheader">Member Function Documentation</h2>
 223 <a class="anchor" id="ace7b855e3c647d29cc37a1ce147901dc"></a>
 224 <div class="memitem">
 225 <div class="memproto">
 226 <table class="mlabels">
 227   <tr>
 228   <td class="mlabels-left">
 229       <table class="memname">
 230         <tr>
 231           <td class="memname">uint8_t* buffer </td>
 232           <td>(</td>
 233           <td class="paramname"></td><td>)</td>
 234           <td> const</td>
 235         </tr>
 236       </table>
 237   </td>
 238   <td class="mlabels-right">
 239 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
 240   </tr>
 241 </table>
 242 </div><div class="memdoc">
 243
 244 <p>Interface to be implemented by the child class to return a pointer to CPU memory. </p>
 245 <dl class="section return"><dt>Returns</dt><dd>A CPU pointer to the beginning of the image's allocation. </dd></dl>
 246
 247 <p>Implements <a class="el" href="classarm__compute_1_1_i_tensor.xhtml#ab988210662dbd3bf32fd563c7dd1bdbf">ITensor</a>.</p>
 248
 249 </div>
 250 </div>
 251 <a class="anchor" id="a1fb4c50755a0ef424652246838ed91a6"></a>
 252 <div class="memitem">
 253 <div class="memproto">
 254 <table class="mlabels">
 255   <tr>
 256   <td class="mlabels-left">
 257       <table class="memname">
 258         <tr>
 259           <td class="memname">virtual const cl::Buffer&amp; cl_buffer </td>
 260           <td>(</td>
 261           <td class="paramname"></td><td>)</td>
 262           <td> const</td>
 263         </tr>
 264       </table>
 265   </td>
 266   <td class="mlabels-right">
 267 <span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
 268   </tr>
 269 </table>
 270 </div><div class="memdoc">
 271
 272 <p>Interface to be implemented by the child class to return a reference to the OpenCL buffer containing the image's data. </p>
 273 <dl class="section return"><dt>Returns</dt><dd>A reference to an OpenCL buffer containing the image's data. </dd></dl>
 274
 275 <p>Implemented in <a class="el" href="classarm__compute_1_1_c_l_tensor.xhtml#afd44a3d7dad6d984b1b87bc9f1b4fa02">CLTensor</a>.</p>
 276
 277 </div>
 278 </div>
 279 <a class="anchor" id="a7b94593f2b06f00d380ec3a3e6abccb2"></a>
 280 <div class="memitem">
 281 <div class="memproto">
 282       <table class="memname">
 283         <tr>
 284           <td class="memname">void clear </td>
 285           <td>(</td>
 286           <td class="paramtype">cl::CommandQueue &amp;&#160;</td>
 287           <td class="paramname"><em>q</em></td><td>)</td>
 288           <td></td>
 289         </tr>
 290       </table>
 291 </div><div class="memdoc">
 292
 293 <p>Clear the contents of the tensor synchronously. </p>
 294 <dl class="params"><dt>Parameters</dt><dd>
 295   <table class="params">
 296     <tr><td class="paramdir">[in,out]</td><td class="paramname">q</td><td>The CL command queue to use for the clear operation. </td></tr>
 297   </table>
 298   </dd>
 299 </dl>
 300
 301 </div>
 302 </div>
 303 <a class="anchor" id="ac0abc7a5c0d172947f0e6a0c0dde3df0"></a>
 304 <div class="memitem">
 305 <div class="memproto">
 306       <table class="memname">
 307         <tr>
 308           <td class="memname">void map </td>
 309           <td>(</td>
 310           <td class="paramtype">cl::CommandQueue &amp;&#160;</td>
 311           <td class="paramname"><em>q</em>, </td>
 312         </tr>
 313         <tr>
 314           <td class="paramkey"></td>
 315           <td></td>
 316           <td class="paramtype">bool&#160;</td>
 317           <td class="paramname"><em>blocking</em> = <code>true</code>&#160;</td>
 318         </tr>
 319         <tr>
 320           <td></td>
 321           <td>)</td>
 322           <td></td><td></td>
 323         </tr>
 324       </table>
 325 </div><div class="memdoc">
 326
 327 <p>Enqueue a map operation of the allocated buffer on the given queue. </p>
 328 <dl class="params"><dt>Parameters</dt><dd>
 329   <table class="params">
 330     <tr><td class="paramdir">[in,out]</td><td class="paramname">q</td><td>The CL command queue to use for the mapping operation. </td></tr>
 331     <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 before using the returned mapping pointer.</td></tr>
 332   </table>
 333   </dd>
 334 </dl>
 335 <dl class="section return"><dt>Returns</dt><dd>The mapping address. </dd></dl>
 336
 337 </div>
 338 </div>
 339 <a class="anchor" id="af72219f9b5e8803950eb8863a23c076e"></a>
 340 <div class="memitem">
 341 <div class="memproto">
 342 <table class="mlabels">
 343   <tr>
 344   <td class="mlabels-left">
 345       <table class="memname">
 346         <tr>
 347           <td class="memname"><a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a>&amp; operator= </td>
 348           <td>(</td>
 349           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> &amp;&#160;</td>
 350           <td class="paramname"></td><td>)</td>
 351           <td></td>
 352         </tr>
 353       </table>
 354   </td>
 355   <td class="mlabels-right">
 356 <span class="mlabels"><span class="mlabel">delete</span></span>  </td>
 357   </tr>
 358 </table>
 359 </div><div class="memdoc">
 360
 361 </div>
 362 </div>
 363 <a class="anchor" id="af974a2360069c2ef8df4496d00e4f6cc"></a>
 364 <div class="memitem">
 365 <div class="memproto">
 366       <table class="memname">
 367         <tr>
 368           <td class="memname">void unmap </td>
 369           <td>(</td>
 370           <td class="paramtype">cl::CommandQueue &amp;&#160;</td>
 371           <td class="paramname"><em>q</em></td><td>)</td>
 372           <td></td>
 373         </tr>
 374       </table>
 375 </div><div class="memdoc">
 376
 377 <p>Enqueue an unmap operation of the allocated and mapped buffer on the given queue. </p>
 378 <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>
 379 <dl class="params"><dt>Parameters</dt><dd>
 380   <table class="params">
 381     <tr><td class="paramdir">[in,out]</td><td class="paramname">q</td><td>The CL command queue to use for the mapping operation. </td></tr>
 382   </table>
 383   </dd>
 384 </dl>
 385
 386 </div>
 387 </div>
 388 <hr/>The documentation for this class was generated from the following file:<ul>
 389 <li>arm_compute/core/CL/<a class="el" href="_i_c_l_tensor_8h_source.xhtml">ICLTensor.h</a></li>
 390 </ul>
 391 </div><!-- contents -->
 392 </div><!-- doc-content -->
 393 <!-- start footer part -->
 394 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 395   <ul>
 396     <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_i_c_l_tensor.xhtml">ICLTensor</a></li>
 397     <li class="footer">Generated on Wed Apr 12 2017 14:26:06 for ARM Compute Library by
 398     <a href="http://www.doxygen.org/index.html">
 399     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
 400   </ul>
 401 </div>
 402 </body>
 403 </html>