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