documentation/classarm__compute_1_1_c_l_lut.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: CLLut 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">Compute Library
  43    &#160;<span id="projectnumber">18.03</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_1_c_l_lut.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-methods">Public Member Functions</a>  </div>
 120   <div class="headertitle">
 121 <div class="title">CLLut Class Reference</div>  </div>
 122 </div><!--header-->
 123 <div class="contents">
 124
 125 <p>Basic implementation of the OpenCL lut interface.
 126  <a href="classarm__compute_1_1_c_l_lut.xhtml#details">More...</a></p>
 127
 128 <p><code>#include &lt;<a class="el" href="_c_l_lut_8h_source.xhtml">CLLut.h</a>&gt;</code></p>
 129 <div class="dynheader">
 130 Collaboration diagram for CLLut:</div>
 131 <div class="dyncontent">
 132 <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_c_l_lut__coll__graph.svg" width="72" height="187"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
 133 </div>
 134 <center><span class="legend">[<a target="top" href="graph_legend.xhtml">legend</a>]</span></center></div>
 135 <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:a0d6c553d858ee767dfd8c13114353556"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_lut.xhtml#a0d6c553d858ee767dfd8c13114353556">CLLut</a> ()</td></tr>
 139 <tr class="memdesc:a0d6c553d858ee767dfd8c13114353556"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a0d6c553d858ee767dfd8c13114353556">More...</a><br /></td></tr>
 140 <tr class="separator:a0d6c553d858ee767dfd8c13114353556"><td class="memSeparator" colspan="2">&#160;</td></tr>
 141 <tr class="memitem:ad2b54d8d7daf7f067cda8ea9e8a795f3"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_lut.xhtml#ad2b54d8d7daf7f067cda8ea9e8a795f3">CLLut</a> (size_t <a class="el" href="classarm__compute_1_1_c_l_lut.xhtml#a6dac829b4ddf4a5729ac090e73696958">num_elements</a>, <a class="el" href="namespacearm__compute.xhtml#ad8ed01ff3ff33333d8e19db4d2818bb6">DataType</a> data_type)</td></tr>
 142 <tr class="memdesc:ad2b54d8d7daf7f067cda8ea9e8a795f3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor: initializes a LUT which can contain num_values values of data_type type.  <a href="#ad2b54d8d7daf7f067cda8ea9e8a795f3">More...</a><br /></td></tr>
 143 <tr class="separator:ad2b54d8d7daf7f067cda8ea9e8a795f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
 144 <tr class="memitem:a5330adc6ef4a662806ec236e2be07bbe"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_i_lut_allocator.xhtml">ILutAllocator</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_lut.xhtml#a5330adc6ef4a662806ec236e2be07bbe">allocator</a> ()</td></tr>
 145 <tr class="memdesc:a5330adc6ef4a662806ec236e2be07bbe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a pointer to the lut's allocator.  <a href="#a5330adc6ef4a662806ec236e2be07bbe">More...</a><br /></td></tr>
 146 <tr class="separator:a5330adc6ef4a662806ec236e2be07bbe"><td class="memSeparator" colspan="2">&#160;</td></tr>
 147 <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_lut.xhtml#a14c53d2d17be6fa8a2c9861527c7b002">map</a> (bool blocking=true)</td></tr>
 148 <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>
 149 <tr class="separator:a14c53d2d17be6fa8a2c9861527c7b002"><td class="memSeparator" colspan="2">&#160;</td></tr>
 150 <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_lut.xhtml#a1ffeb3b5abb3d61f62b58a391816201c">unmap</a> ()</td></tr>
 151 <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>
 152 <tr class="separator:a1ffeb3b5abb3d61f62b58a391816201c"><td class="memSeparator" colspan="2">&#160;</td></tr>
 153 <tr class="memitem:a6dac829b4ddf4a5729ac090e73696958"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_lut.xhtml#a6dac829b4ddf4a5729ac090e73696958">num_elements</a> () const override</td></tr>
 154 <tr class="memdesc:a6dac829b4ddf4a5729ac090e73696958"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the total number of elements in the LUT.  <a href="#a6dac829b4ddf4a5729ac090e73696958">More...</a><br /></td></tr>
 155 <tr class="separator:a6dac829b4ddf4a5729ac090e73696958"><td class="memSeparator" colspan="2">&#160;</td></tr>
 156 <tr class="memitem:aaf3f51cd25e1651cccf04064a9888f4e"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_lut.xhtml#aaf3f51cd25e1651cccf04064a9888f4e">index_offset</a> () const override</td></tr>
 157 <tr class="memdesc:aaf3f51cd25e1651cccf04064a9888f4e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Indicates the offset that needs to be applied to the raw index before performing a lookup in the LUT.  <a href="#aaf3f51cd25e1651cccf04064a9888f4e">More...</a><br /></td></tr>
 158 <tr class="separator:aaf3f51cd25e1651cccf04064a9888f4e"><td class="memSeparator" colspan="2">&#160;</td></tr>
 159 <tr class="memitem:a68f33e9afee896dc24b32093d25c6766"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_lut.xhtml#a68f33e9afee896dc24b32093d25c6766">size_in_bytes</a> () const override</td></tr>
 160 <tr class="memdesc:a68f33e9afee896dc24b32093d25c6766"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the total size in bytes of the LUT.  <a href="#a68f33e9afee896dc24b32093d25c6766">More...</a><br /></td></tr>
 161 <tr class="separator:a68f33e9afee896dc24b32093d25c6766"><td class="memSeparator" colspan="2">&#160;</td></tr>
 162 <tr class="memitem:a6dc9c052a2732f899adccfaeee468364"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacearm__compute.xhtml#ad8ed01ff3ff33333d8e19db4d2818bb6">DataType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_lut.xhtml#a6dc9c052a2732f899adccfaeee468364">type</a> () const override</td></tr>
 163 <tr class="memdesc:a6dc9c052a2732f899adccfaeee468364"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the type of the LUT.  <a href="#a6dc9c052a2732f899adccfaeee468364">More...</a><br /></td></tr>
 164 <tr class="separator:a6dc9c052a2732f899adccfaeee468364"><td class="memSeparator" colspan="2">&#160;</td></tr>
 165 <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_lut.xhtml#afd44a3d7dad6d984b1b87bc9f1b4fa02">cl_buffer</a> () const override</td></tr>
 166 <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 lut's data.  <a href="#afd44a3d7dad6d984b1b87bc9f1b4fa02">More...</a><br /></td></tr>
 167 <tr class="separator:afd44a3d7dad6d984b1b87bc9f1b4fa02"><td class="memSeparator" colspan="2">&#160;</td></tr>
 168 <tr class="memitem:aee7cb2065b88d21ac4ad05bc997ecf82"><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_lut.xhtml#aee7cb2065b88d21ac4ad05bc997ecf82">clear</a> () override</td></tr>
 169 <tr class="memdesc:aee7cb2065b88d21ac4ad05bc997ecf82"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clears the LUT by setting every element to zero.  <a href="#aee7cb2065b88d21ac4ad05bc997ecf82">More...</a><br /></td></tr>
 170 <tr class="separator:aee7cb2065b88d21ac4ad05bc997ecf82"><td class="memSeparator" colspan="2">&#160;</td></tr>
 171 <tr class="inherit_header pub_methods_classarm__compute_1_1_i_c_l_lut"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarm__compute_1_1_i_c_l_lut')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classarm__compute_1_1_i_c_l_lut.xhtml">ICLLut</a></td></tr>
 172 <tr class="memitem:abc0b83809a3a81a4dced0bdf7d4d5ed7 inherit pub_methods_classarm__compute_1_1_i_c_l_lut"><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_lut.xhtml#abc0b83809a3a81a4dced0bdf7d4d5ed7">ICLLut</a> ()</td></tr>
 173 <tr class="separator:abc0b83809a3a81a4dced0bdf7d4d5ed7 inherit pub_methods_classarm__compute_1_1_i_c_l_lut"><td class="memSeparator" colspan="2">&#160;</td></tr>
 174 <tr class="memitem:a783d0c1fadb33a4a6d0beca4d4d3ab81 inherit pub_methods_classarm__compute_1_1_i_c_l_lut"><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_lut.xhtml#a783d0c1fadb33a4a6d0beca4d4d3ab81">ICLLut</a> (const <a class="el" href="classarm__compute_1_1_i_c_l_lut.xhtml">ICLLut</a> &amp;)=delete</td></tr>
 175 <tr class="separator:a783d0c1fadb33a4a6d0beca4d4d3ab81 inherit pub_methods_classarm__compute_1_1_i_c_l_lut"><td class="memSeparator" colspan="2">&#160;</td></tr>
 176 <tr class="memitem:a8740c6498dafc80428e500a056135bf1 inherit pub_methods_classarm__compute_1_1_i_c_l_lut"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_i_c_l_lut.xhtml">ICLLut</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_l_lut.xhtml#a8740c6498dafc80428e500a056135bf1">operator=</a> (const <a class="el" href="classarm__compute_1_1_i_c_l_lut.xhtml">ICLLut</a> &amp;)=delete</td></tr>
 177 <tr class="separator:a8740c6498dafc80428e500a056135bf1 inherit pub_methods_classarm__compute_1_1_i_c_l_lut"><td class="memSeparator" colspan="2">&#160;</td></tr>
 178 <tr class="memitem:ac0abc7a5c0d172947f0e6a0c0dde3df0 inherit pub_methods_classarm__compute_1_1_i_c_l_lut"><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_lut.xhtml#ac0abc7a5c0d172947f0e6a0c0dde3df0">map</a> (cl::CommandQueue &amp;q, bool blocking=true)</td></tr>
 179 <tr class="memdesc:ac0abc7a5c0d172947f0e6a0c0dde3df0 inherit pub_methods_classarm__compute_1_1_i_c_l_lut"><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>
 180 <tr class="separator:ac0abc7a5c0d172947f0e6a0c0dde3df0 inherit pub_methods_classarm__compute_1_1_i_c_l_lut"><td class="memSeparator" colspan="2">&#160;</td></tr>
 181 <tr class="memitem:af974a2360069c2ef8df4496d00e4f6cc inherit pub_methods_classarm__compute_1_1_i_c_l_lut"><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_lut.xhtml#af974a2360069c2ef8df4496d00e4f6cc">unmap</a> (cl::CommandQueue &amp;q)</td></tr>
 182 <tr class="memdesc:af974a2360069c2ef8df4496d00e4f6cc inherit pub_methods_classarm__compute_1_1_i_c_l_lut"><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>
 183 <tr class="separator:af974a2360069c2ef8df4496d00e4f6cc inherit pub_methods_classarm__compute_1_1_i_c_l_lut"><td class="memSeparator" colspan="2">&#160;</td></tr>
 184 <tr class="memitem:ace7b855e3c647d29cc37a1ce147901dc inherit pub_methods_classarm__compute_1_1_i_c_l_lut"><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_lut.xhtml#ace7b855e3c647d29cc37a1ce147901dc">buffer</a> () const override</td></tr>
 185 <tr class="memdesc:ace7b855e3c647d29cc37a1ce147901dc inherit pub_methods_classarm__compute_1_1_i_c_l_lut"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a pointer to the start of the LUT.  <a href="#ace7b855e3c647d29cc37a1ce147901dc">More...</a><br /></td></tr>
 186 <tr class="separator:ace7b855e3c647d29cc37a1ce147901dc inherit pub_methods_classarm__compute_1_1_i_c_l_lut"><td class="memSeparator" colspan="2">&#160;</td></tr>
 187 <tr class="inherit_header pub_methods_classarm__compute_1_1_i_lut"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarm__compute_1_1_i_lut')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classarm__compute_1_1_i_lut.xhtml">ILut</a></td></tr>
 188 <tr class="memitem:ab90dd1556851ce4b6b1529dfb9107f68 inherit pub_methods_classarm__compute_1_1_i_lut"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_lut.xhtml#ab90dd1556851ce4b6b1529dfb9107f68">~ILut</a> ()=default</td></tr>
 189 <tr class="memdesc:ab90dd1556851ce4b6b1529dfb9107f68 inherit pub_methods_classarm__compute_1_1_i_lut"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default virtual destructor.  <a href="#ab90dd1556851ce4b6b1529dfb9107f68">More...</a><br /></td></tr>
 190 <tr class="separator:ab90dd1556851ce4b6b1529dfb9107f68 inherit pub_methods_classarm__compute_1_1_i_lut"><td class="memSeparator" colspan="2">&#160;</td></tr>
 191 </table>
 192 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 193 <div class="textblock"><p>Basic implementation of the OpenCL lut interface. </p>
 194
 195 <p>Definition at line <a class="el" href="_c_l_lut_8h_source.xhtml#l00040">40</a> of file <a class="el" href="_c_l_lut_8h_source.xhtml">CLLut.h</a>.</p>
 196 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 197 <a class="anchor" id="a0d6c553d858ee767dfd8c13114353556"></a>
 198 <div class="memitem">
 199 <div class="memproto">
 200       <table class="memname">
 201         <tr>
 202           <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_lut.xhtml">CLLut</a> </td>
 203           <td>(</td>
 204           <td class="paramname"></td><td>)</td>
 205           <td></td>
 206         </tr>
 207       </table>
 208 </div><div class="memdoc">
 209
 210 <p>Constructor. </p>
 211
 212 </div>
 213 </div>
 214 <a class="anchor" id="ad2b54d8d7daf7f067cda8ea9e8a795f3"></a>
 215 <div class="memitem">
 216 <div class="memproto">
 217       <table class="memname">
 218         <tr>
 219           <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_lut.xhtml">CLLut</a> </td>
 220           <td>(</td>
 221           <td class="paramtype">size_t&#160;</td>
 222           <td class="paramname"><em>num_elements</em>, </td>
 223         </tr>
 224         <tr>
 225           <td class="paramkey"></td>
 226           <td></td>
 227           <td class="paramtype"><a class="el" href="namespacearm__compute.xhtml#ad8ed01ff3ff33333d8e19db4d2818bb6">DataType</a>&#160;</td>
 228           <td class="paramname"><em>data_type</em>&#160;</td>
 229         </tr>
 230         <tr>
 231           <td></td>
 232           <td>)</td>
 233           <td></td><td></td>
 234         </tr>
 235       </table>
 236 </div><div class="memdoc">
 237
 238 <p>Constructor: initializes a LUT which can contain num_values values of data_type type. </p>
 239 <dl class="params"><dt>Parameters</dt><dd>
 240   <table class="params">
 241     <tr><td class="paramdir">[in]</td><td class="paramname">num_elements</td><td>Number of elements of the LUT. </td></tr>
 242     <tr><td class="paramdir">[in]</td><td class="paramname">data_type</td><td>Data type of each element. </td></tr>
 243   </table>
 244   </dd>
 245 </dl>
 246
 247 </div>
 248 </div>
 249 <h2 class="groupheader">Member Function Documentation</h2>
 250 <a class="anchor" id="a5330adc6ef4a662806ec236e2be07bbe"></a>
 251 <div class="memitem">
 252 <div class="memproto">
 253       <table class="memname">
 254         <tr>
 255           <td class="memname"><a class="el" href="classarm__compute_1_1_i_lut_allocator.xhtml">ILutAllocator</a>* allocator </td>
 256           <td>(</td>
 257           <td class="paramname"></td><td>)</td>
 258           <td></td>
 259         </tr>
 260       </table>
 261 </div><div class="memdoc">
 262
 263 <p>Return a pointer to the lut's allocator. </p>
 264 <dl class="section return"><dt>Returns</dt><dd>A pointer to the lut's allocator </dd></dl>
 265
 266 </div>
 267 </div>
 268 <a class="anchor" id="afd44a3d7dad6d984b1b87bc9f1b4fa02"></a>
 269 <div class="memitem">
 270 <div class="memproto">
 271 <table class="mlabels">
 272   <tr>
 273   <td class="mlabels-left">
 274       <table class="memname">
 275         <tr>
 276           <td class="memname">const cl::Buffer&amp; cl_buffer </td>
 277           <td>(</td>
 278           <td class="paramname"></td><td>)</td>
 279           <td> const</td>
 280         </tr>
 281       </table>
 282   </td>
 283   <td class="mlabels-right">
 284 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
 285   </tr>
 286 </table>
 287 </div><div class="memdoc">
 288
 289 <p>Interface to be implemented by the child class to return a reference to the OpenCL buffer containing the lut's data. </p>
 290 <dl class="section return"><dt>Returns</dt><dd>A reference to an OpenCL buffer containing the lut's data. </dd></dl>
 291
 292 <p>Implements <a class="el" href="classarm__compute_1_1_i_c_l_lut.xhtml#a1fb4c50755a0ef424652246838ed91a6">ICLLut</a>.</p>
 293
 294 </div>
 295 </div>
 296 <a class="anchor" id="aee7cb2065b88d21ac4ad05bc997ecf82"></a>
 297 <div class="memitem">
 298 <div class="memproto">
 299 <table class="mlabels">
 300   <tr>
 301   <td class="mlabels-left">
 302       <table class="memname">
 303         <tr>
 304           <td class="memname">void clear </td>
 305           <td>(</td>
 306           <td class="paramname"></td><td>)</td>
 307           <td></td>
 308         </tr>
 309       </table>
 310   </td>
 311   <td class="mlabels-right">
 312 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
 313   </tr>
 314 </table>
 315 </div><div class="memdoc">
 316
 317 <p>Clears the LUT by setting every element to zero. </p>
 318
 319 <p>Implements <a class="el" href="classarm__compute_1_1_i_lut.xhtml#a5eeb94d22b8366d1b68d0614384802fe">ILut</a>.</p>
 320
 321 </div>
 322 </div>
 323 <a class="anchor" id="aaf3f51cd25e1651cccf04064a9888f4e"></a>
 324 <div class="memitem">
 325 <div class="memproto">
 326 <table class="mlabels">
 327   <tr>
 328   <td class="mlabels-left">
 329       <table class="memname">
 330         <tr>
 331           <td class="memname">uint32_t index_offset </td>
 332           <td>(</td>
 333           <td class="paramname"></td><td>)</td>
 334           <td> const</td>
 335         </tr>
 336       </table>
 337   </td>
 338   <td class="mlabels-right">
 339 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
 340   </tr>
 341 </table>
 342 </div><div class="memdoc">
 343
 344 <p>Indicates the offset that needs to be applied to the raw index before performing a lookup in the LUT. </p>
 345 <dl class="section return"><dt>Returns</dt><dd>The normalization offset. </dd></dl>
 346
 347 <p>Implements <a class="el" href="classarm__compute_1_1_i_lut.xhtml#a786de36dda3773c5fb35d6700e64621e">ILut</a>.</p>
 348
 349 <p>Referenced by <a class="el" href="_c_l_lut_accessor_8h_source.xhtml#l00062">CLLutAccessor&lt; T &gt;::operator[]()</a>.</p>
 350
 351 </div>
 352 </div>
 353 <a class="anchor" id="a14c53d2d17be6fa8a2c9861527c7b002"></a>
 354 <div class="memitem">
 355 <div class="memproto">
 356       <table class="memname">
 357         <tr>
 358           <td class="memname">void map </td>
 359           <td>(</td>
 360           <td class="paramtype">bool&#160;</td>
 361           <td class="paramname"><em>blocking</em> = <code>true</code></td><td>)</td>
 362           <td></td>
 363         </tr>
 364       </table>
 365 </div><div class="memdoc">
 366
 367 <p>Enqueue a map operation of the allocated buffer. </p>
 368 <dl class="params"><dt>Parameters</dt><dd>
 369   <table class="params">
 370     <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>
 371   </table>
 372   </dd>
 373 </dl>
 374
 375 <p>Referenced by <a class="el" href="_c_l_lut_accessor_8h_source.xhtml#l00042">CLLutAccessor&lt; T &gt;::CLLutAccessor()</a>.</p>
 376
 377 </div>
 378 </div>
 379 <a class="anchor" id="a6dac829b4ddf4a5729ac090e73696958"></a>
 380 <div class="memitem">
 381 <div class="memproto">
 382 <table class="mlabels">
 383   <tr>
 384   <td class="mlabels-left">
 385       <table class="memname">
 386         <tr>
 387           <td class="memname">size_t num_elements </td>
 388           <td>(</td>
 389           <td class="paramname"></td><td>)</td>
 390           <td> const</td>
 391         </tr>
 392       </table>
 393   </td>
 394   <td class="mlabels-right">
 395 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
 396   </tr>
 397 </table>
 398 </div><div class="memdoc">
 399
 400 <p>Returns the total number of elements in the LUT. </p>
 401 <dl class="section return"><dt>Returns</dt><dd>Total number of elements. </dd></dl>
 402
 403 <p>Implements <a class="el" href="classarm__compute_1_1_i_lut.xhtml#a7a826fbb4f639c556352d1ede69187d7">ILut</a>.</p>
 404
 405 <p>Referenced by <a class="el" href="_c_l_lut_accessor_8h_source.xhtml#l00057">CLLutAccessor&lt; T &gt;::num_elements()</a>.</p>
 406
 407 </div>
 408 </div>
 409 <a class="anchor" id="a68f33e9afee896dc24b32093d25c6766"></a>
 410 <div class="memitem">
 411 <div class="memproto">
 412 <table class="mlabels">
 413   <tr>
 414   <td class="mlabels-left">
 415       <table class="memname">
 416         <tr>
 417           <td class="memname">size_t size_in_bytes </td>
 418           <td>(</td>
 419           <td class="paramname"></td><td>)</td>
 420           <td> const</td>
 421         </tr>
 422       </table>
 423   </td>
 424   <td class="mlabels-right">
 425 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
 426   </tr>
 427 </table>
 428 </div><div class="memdoc">
 429
 430 <p>Returns the total size in bytes of the LUT. </p>
 431 <dl class="section return"><dt>Returns</dt><dd>Total size of the LUT in bytes. </dd></dl>
 432
 433 <p>Implements <a class="el" href="classarm__compute_1_1_i_lut.xhtml#a6314b1e589ffe32277858c018ac3c630">ILut</a>.</p>
 434
 435 </div>
 436 </div>
 437 <a class="anchor" id="a6dc9c052a2732f899adccfaeee468364"></a>
 438 <div class="memitem">
 439 <div class="memproto">
 440 <table class="mlabels">
 441   <tr>
 442   <td class="mlabels-left">
 443       <table class="memname">
 444         <tr>
 445           <td class="memname"><a class="el" href="namespacearm__compute.xhtml#ad8ed01ff3ff33333d8e19db4d2818bb6">DataType</a> type </td>
 446           <td>(</td>
 447           <td class="paramname"></td><td>)</td>
 448           <td> const</td>
 449         </tr>
 450       </table>
 451   </td>
 452   <td class="mlabels-right">
 453 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
 454   </tr>
 455 </table>
 456 </div><div class="memdoc">
 457
 458 <p>Returns the type of the LUT. </p>
 459 <dl class="section return"><dt>Returns</dt><dd>The type of the LUT. </dd></dl>
 460
 461 <p>Implements <a class="el" href="classarm__compute_1_1_i_lut.xhtml#aa1917b40b57ce0a0f1c69722b46f3f46">ILut</a>.</p>
 462
 463 </div>
 464 </div>
 465 <a class="anchor" id="a1ffeb3b5abb3d61f62b58a391816201c"></a>
 466 <div class="memitem">
 467 <div class="memproto">
 468       <table class="memname">
 469         <tr>
 470           <td class="memname">void unmap </td>
 471           <td>(</td>
 472           <td class="paramname"></td><td>)</td>
 473           <td></td>
 474         </tr>
 475       </table>
 476 </div><div class="memdoc">
 477
 478 <p>Enqueue an unmap operation of the allocated and mapped buffer. </p>
 479 <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>
 480
 481 <p>Referenced by <a class="el" href="_c_l_lut_accessor_8h_source.xhtml#l00047">CLLutAccessor&lt; T &gt;::~CLLutAccessor()</a>.</p>
 482
 483 </div>
 484 </div>
 485 <hr/>The documentation for this class was generated from the following file:<ul>
 486 <li>arm_compute/runtime/CL/<a class="el" href="_c_l_lut_8h_source.xhtml">CLLut.h</a></li>
 487 </ul>
 488 </div><!-- contents -->
 489 </div><!-- doc-content -->
 490 <!-- start footer part -->
 491 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 492   <ul>
 493     <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_lut.xhtml">CLLut</a></li>
 494     <li class="footer">Generated on Fri Mar 2 2018 12:37:57 for Compute Library by
 495     <a href="http://www.doxygen.org/index.html">
 496     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
 497   </ul>
 498 </div>
 499 </body>
 500 </html>