arm_compute v18.03
[platform/upstream/armcl.git] / documentation / classarm__compute_1_1_c_l_lut_allocator.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: CLLutAllocator 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_allocator.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">CLLutAllocator Class Reference</div>  </div>
122 </div><!--header-->
123 <div class="contents">
124
125 <p>Basic implementation of a CL memory LUT allocator.  
126  <a href="classarm__compute_1_1_c_l_lut_allocator.xhtml#details">More...</a></p>
127
128 <p><code>#include &lt;<a class="el" href="_c_l_lut_allocator_8h_source.xhtml">CLLutAllocator.h</a>&gt;</code></p>
129 <div class="dynheader">
130 Collaboration diagram for CLLutAllocator:</div>
131 <div class="dyncontent">
132 <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_c_l_lut_allocator__coll__graph.svg" width="126" height="112"><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:aa1e425aebd0805be1916fddde364aaa1"><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_allocator.xhtml#aa1e425aebd0805be1916fddde364aaa1">CLLutAllocator</a> ()</td></tr>
139 <tr class="memdesc:aa1e425aebd0805be1916fddde364aaa1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor.  <a href="#aa1e425aebd0805be1916fddde364aaa1">More...</a><br /></td></tr>
140 <tr class="separator:aa1e425aebd0805be1916fddde364aaa1"><td class="memSeparator" colspan="2">&#160;</td></tr>
141 <tr class="memitem:a864b976ba255c0cd2e1e2a848c89f4a3"><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_allocator.xhtml#a864b976ba255c0cd2e1e2a848c89f4a3">~CLLutAllocator</a> ()=default</td></tr>
142 <tr class="memdesc:a864b976ba255c0cd2e1e2a848c89f4a3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default destructor.  <a href="#a864b976ba255c0cd2e1e2a848c89f4a3">More...</a><br /></td></tr>
143 <tr class="separator:a864b976ba255c0cd2e1e2a848c89f4a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
144 <tr class="memitem:a65d09435ca3956fb0c4409e622bfd5da"><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_allocator.xhtml#a65d09435ca3956fb0c4409e622bfd5da">CLLutAllocator</a> (const <a class="el" href="classarm__compute_1_1_c_l_lut_allocator.xhtml">CLLutAllocator</a> &amp;)=delete</td></tr>
145 <tr class="memdesc:a65d09435ca3956fb0c4409e622bfd5da"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent instances of this class from being copied (As this class contains pointers).  <a href="#a65d09435ca3956fb0c4409e622bfd5da">More...</a><br /></td></tr>
146 <tr class="separator:a65d09435ca3956fb0c4409e622bfd5da"><td class="memSeparator" colspan="2">&#160;</td></tr>
147 <tr class="memitem:a2de13c6fbd9dd5506f12627b87415a51"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classarm__compute_1_1_c_l_lut_allocator.xhtml">CLLutAllocator</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_lut_allocator.xhtml#a2de13c6fbd9dd5506f12627b87415a51">operator=</a> (const <a class="el" href="classarm__compute_1_1_c_l_lut_allocator.xhtml">CLLutAllocator</a> &amp;)=delete</td></tr>
148 <tr class="memdesc:a2de13c6fbd9dd5506f12627b87415a51"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent instances of this class from being copy assigned (As this class contains pointers).  <a href="#a2de13c6fbd9dd5506f12627b87415a51">More...</a><br /></td></tr>
149 <tr class="separator:a2de13c6fbd9dd5506f12627b87415a51"><td class="memSeparator" colspan="2">&#160;</td></tr>
150 <tr class="memitem:a6a731c70d12750586b67c6cde637b650"><td class="memItemLeft" align="right" valign="top">uint8_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_lut_allocator.xhtml#a6a731c70d12750586b67c6cde637b650">data</a> ()</td></tr>
151 <tr class="memdesc:a6a731c70d12750586b67c6cde637b650"><td class="mdescLeft">&#160;</td><td class="mdescRight">Interface to be implemented by the child class to return the pointer to the mapped data.  <a href="#a6a731c70d12750586b67c6cde637b650">More...</a><br /></td></tr>
152 <tr class="separator:a6a731c70d12750586b67c6cde637b650"><td class="memSeparator" colspan="2">&#160;</td></tr>
153 <tr class="memitem:a7f4714c4a9320d1760102ef78a984241"><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_allocator.xhtml#a7f4714c4a9320d1760102ef78a984241">cl_data</a> () const </td></tr>
154 <tr class="memdesc:a7f4714c4a9320d1760102ef78a984241"><td class="mdescLeft">&#160;</td><td class="mdescRight">Interface to be implemented by the child class to return the pointer to the CL data.  <a href="#a7f4714c4a9320d1760102ef78a984241">More...</a><br /></td></tr>
155 <tr class="separator:a7f4714c4a9320d1760102ef78a984241"><td class="memSeparator" colspan="2">&#160;</td></tr>
156 <tr class="memitem:a460f371bafd64854b2332d96697939b3"><td class="memItemLeft" align="right" valign="top">uint8_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_lut_allocator.xhtml#a460f371bafd64854b2332d96697939b3">map</a> (cl::CommandQueue &amp;q, bool blocking)</td></tr>
157 <tr class="memdesc:a460f371bafd64854b2332d96697939b3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enqueue a map operation of the allocated buffer on the given queue.  <a href="#a460f371bafd64854b2332d96697939b3">More...</a><br /></td></tr>
158 <tr class="separator:a460f371bafd64854b2332d96697939b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
159 <tr class="memitem:a34b854d640d247bd7422f60ca2f3a05c"><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_allocator.xhtml#a34b854d640d247bd7422f60ca2f3a05c">unmap</a> (cl::CommandQueue &amp;q, uint8_t *mapping)</td></tr>
160 <tr class="memdesc:a34b854d640d247bd7422f60ca2f3a05c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enqueue an unmap operation of the allocated buffer on the given queue.  <a href="#a34b854d640d247bd7422f60ca2f3a05c">More...</a><br /></td></tr>
161 <tr class="separator:a34b854d640d247bd7422f60ca2f3a05c"><td class="memSeparator" colspan="2">&#160;</td></tr>
162 <tr class="inherit_header pub_methods_classarm__compute_1_1_i_lut_allocator"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarm__compute_1_1_i_lut_allocator')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classarm__compute_1_1_i_lut_allocator.xhtml">ILutAllocator</a></td></tr>
163 <tr class="memitem:acb80847d132eba25605f9fc43a42f652 inherit pub_methods_classarm__compute_1_1_i_lut_allocator"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_lut_allocator.xhtml#acb80847d132eba25605f9fc43a42f652">ILutAllocator</a> ()</td></tr>
164 <tr class="memdesc:acb80847d132eba25605f9fc43a42f652 inherit pub_methods_classarm__compute_1_1_i_lut_allocator"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor.  <a href="#acb80847d132eba25605f9fc43a42f652">More...</a><br /></td></tr>
165 <tr class="separator:acb80847d132eba25605f9fc43a42f652 inherit pub_methods_classarm__compute_1_1_i_lut_allocator"><td class="memSeparator" colspan="2">&#160;</td></tr>
166 <tr class="memitem:a9c34313e5cddaebce855b939e42efc32 inherit pub_methods_classarm__compute_1_1_i_lut_allocator"><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_allocator.xhtml#a9c34313e5cddaebce855b939e42efc32">~ILutAllocator</a> ()=default</td></tr>
167 <tr class="memdesc:a9c34313e5cddaebce855b939e42efc32 inherit pub_methods_classarm__compute_1_1_i_lut_allocator"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default virtual destructor.  <a href="#a9c34313e5cddaebce855b939e42efc32">More...</a><br /></td></tr>
168 <tr class="separator:a9c34313e5cddaebce855b939e42efc32 inherit pub_methods_classarm__compute_1_1_i_lut_allocator"><td class="memSeparator" colspan="2">&#160;</td></tr>
169 <tr class="memitem:a07b8c40feb14af938204e68d8c2e5759 inherit pub_methods_classarm__compute_1_1_i_lut_allocator"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_lut_allocator.xhtml#a07b8c40feb14af938204e68d8c2e5759">ILutAllocator</a> (<a class="el" href="classarm__compute_1_1_i_lut_allocator.xhtml">ILutAllocator</a> &amp;&amp;)=default</td></tr>
170 <tr class="memdesc:a07b8c40feb14af938204e68d8c2e5759 inherit pub_methods_classarm__compute_1_1_i_lut_allocator"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be move constructed.  <a href="#a07b8c40feb14af938204e68d8c2e5759">More...</a><br /></td></tr>
171 <tr class="separator:a07b8c40feb14af938204e68d8c2e5759 inherit pub_methods_classarm__compute_1_1_i_lut_allocator"><td class="memSeparator" colspan="2">&#160;</td></tr>
172 <tr class="memitem:afc1c53ed4dcc1a723b9b9dcf67c578a1 inherit pub_methods_classarm__compute_1_1_i_lut_allocator"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_i_lut_allocator.xhtml">ILutAllocator</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_lut_allocator.xhtml#afc1c53ed4dcc1a723b9b9dcf67c578a1">operator=</a> (<a class="el" href="classarm__compute_1_1_i_lut_allocator.xhtml">ILutAllocator</a> &amp;&amp;)=default</td></tr>
173 <tr class="memdesc:afc1c53ed4dcc1a723b9b9dcf67c578a1 inherit pub_methods_classarm__compute_1_1_i_lut_allocator"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be moved.  <a href="#afc1c53ed4dcc1a723b9b9dcf67c578a1">More...</a><br /></td></tr>
174 <tr class="separator:afc1c53ed4dcc1a723b9b9dcf67c578a1 inherit pub_methods_classarm__compute_1_1_i_lut_allocator"><td class="memSeparator" colspan="2">&#160;</td></tr>
175 <tr class="memitem:a4ef157737b45c46f115e14b425512800 inherit pub_methods_classarm__compute_1_1_i_lut_allocator"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_lut_allocator.xhtml#a4ef157737b45c46f115e14b425512800">init</a> (size_t <a class="el" href="classarm__compute_1_1_i_lut_allocator.xhtml#a3f7ed6a14a98f283aa700342b9cc2a01">num_elements</a>, <a class="el" href="namespacearm__compute.xhtml#ad8ed01ff3ff33333d8e19db4d2818bb6">DataType</a> data_type)</td></tr>
176 <tr class="memdesc:a4ef157737b45c46f115e14b425512800 inherit pub_methods_classarm__compute_1_1_i_lut_allocator"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allocate an LUT of the requested number of elements and data_type.  <a href="#a4ef157737b45c46f115e14b425512800">More...</a><br /></td></tr>
177 <tr class="separator:a4ef157737b45c46f115e14b425512800 inherit pub_methods_classarm__compute_1_1_i_lut_allocator"><td class="memSeparator" colspan="2">&#160;</td></tr>
178 <tr class="memitem:a3f7ed6a14a98f283aa700342b9cc2a01 inherit pub_methods_classarm__compute_1_1_i_lut_allocator"><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_lut_allocator.xhtml#a3f7ed6a14a98f283aa700342b9cc2a01">num_elements</a> () const </td></tr>
179 <tr class="memdesc:a3f7ed6a14a98f283aa700342b9cc2a01 inherit pub_methods_classarm__compute_1_1_i_lut_allocator"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the total number of elements in the LUT.  <a href="#a3f7ed6a14a98f283aa700342b9cc2a01">More...</a><br /></td></tr>
180 <tr class="separator:a3f7ed6a14a98f283aa700342b9cc2a01 inherit pub_methods_classarm__compute_1_1_i_lut_allocator"><td class="memSeparator" colspan="2">&#160;</td></tr>
181 <tr class="memitem:a8522d89f5f58b6c744e230b6b0641a4b inherit pub_methods_classarm__compute_1_1_i_lut_allocator"><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_i_lut_allocator.xhtml#a8522d89f5f58b6c744e230b6b0641a4b">type</a> () const </td></tr>
182 <tr class="memdesc:a8522d89f5f58b6c744e230b6b0641a4b inherit pub_methods_classarm__compute_1_1_i_lut_allocator"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the type of the LUT.  <a href="#a8522d89f5f58b6c744e230b6b0641a4b">More...</a><br /></td></tr>
183 <tr class="separator:a8522d89f5f58b6c744e230b6b0641a4b inherit pub_methods_classarm__compute_1_1_i_lut_allocator"><td class="memSeparator" colspan="2">&#160;</td></tr>
184 <tr class="memitem:aac782da1f912bceb5d8ad00c8dc892ac inherit pub_methods_classarm__compute_1_1_i_lut_allocator"><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_lut_allocator.xhtml#aac782da1f912bceb5d8ad00c8dc892ac">size</a> () const </td></tr>
185 <tr class="memdesc:aac782da1f912bceb5d8ad00c8dc892ac inherit pub_methods_classarm__compute_1_1_i_lut_allocator"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the total size in bytes of the LUT.  <a href="#aac782da1f912bceb5d8ad00c8dc892ac">More...</a><br /></td></tr>
186 <tr class="separator:aac782da1f912bceb5d8ad00c8dc892ac inherit pub_methods_classarm__compute_1_1_i_lut_allocator"><td class="memSeparator" colspan="2">&#160;</td></tr>
187 </table>
188 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
189 <div class="textblock"><p>Basic implementation of a CL memory LUT allocator. </p>
190
191 <p>Definition at line <a class="el" href="_c_l_lut_allocator_8h_source.xhtml#l00036">36</a> of file <a class="el" href="_c_l_lut_allocator_8h_source.xhtml">CLLutAllocator.h</a>.</p>
192 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
193 <a class="anchor" id="aa1e425aebd0805be1916fddde364aaa1"></a>
194 <div class="memitem">
195 <div class="memproto">
196       <table class="memname">
197         <tr>
198           <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_lut_allocator.xhtml">CLLutAllocator</a> </td>
199           <td>(</td>
200           <td class="paramname"></td><td>)</td>
201           <td></td>
202         </tr>
203       </table>
204 </div><div class="memdoc">
205
206 <p>Default constructor. </p>
207
208 </div>
209 </div>
210 <a class="anchor" id="a864b976ba255c0cd2e1e2a848c89f4a3"></a>
211 <div class="memitem">
212 <div class="memproto">
213 <table class="mlabels">
214   <tr>
215   <td class="mlabels-left">
216       <table class="memname">
217         <tr>
218           <td class="memname">~<a class="el" href="classarm__compute_1_1_c_l_lut_allocator.xhtml">CLLutAllocator</a> </td>
219           <td>(</td>
220           <td class="paramname"></td><td>)</td>
221           <td></td>
222         </tr>
223       </table>
224   </td>
225   <td class="mlabels-right">
226 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
227   </tr>
228 </table>
229 </div><div class="memdoc">
230
231 <p>Default destructor. </p>
232
233 </div>
234 </div>
235 <a class="anchor" id="a65d09435ca3956fb0c4409e622bfd5da"></a>
236 <div class="memitem">
237 <div class="memproto">
238 <table class="mlabels">
239   <tr>
240   <td class="mlabels-left">
241       <table class="memname">
242         <tr>
243           <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_lut_allocator.xhtml">CLLutAllocator</a> </td>
244           <td>(</td>
245           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_c_l_lut_allocator.xhtml">CLLutAllocator</a> &amp;&#160;</td>
246           <td class="paramname"></td><td>)</td>
247           <td></td>
248         </tr>
249       </table>
250   </td>
251   <td class="mlabels-right">
252 <span class="mlabels"><span class="mlabel">delete</span></span>  </td>
253   </tr>
254 </table>
255 </div><div class="memdoc">
256
257 <p>Prevent instances of this class from being copied (As this class contains pointers). </p>
258
259 </div>
260 </div>
261 <h2 class="groupheader">Member Function Documentation</h2>
262 <a class="anchor" id="a7f4714c4a9320d1760102ef78a984241"></a>
263 <div class="memitem">
264 <div class="memproto">
265       <table class="memname">
266         <tr>
267           <td class="memname">const cl::Buffer&amp; cl_data </td>
268           <td>(</td>
269           <td class="paramname"></td><td>)</td>
270           <td> const</td>
271         </tr>
272       </table>
273 </div><div class="memdoc">
274
275 <p>Interface to be implemented by the child class to return the pointer to the CL data. </p>
276
277 </div>
278 </div>
279 <a class="anchor" id="a6a731c70d12750586b67c6cde637b650"></a>
280 <div class="memitem">
281 <div class="memproto">
282       <table class="memname">
283         <tr>
284           <td class="memname">uint8_t* data </td>
285           <td>(</td>
286           <td class="paramname"></td><td>)</td>
287           <td></td>
288         </tr>
289       </table>
290 </div><div class="memdoc">
291
292 <p>Interface to be implemented by the child class to return the pointer to the mapped data. </p>
293
294 </div>
295 </div>
296 <a class="anchor" id="a460f371bafd64854b2332d96697939b3"></a>
297 <div class="memitem">
298 <div class="memproto">
299       <table class="memname">
300         <tr>
301           <td class="memname">uint8_t* map </td>
302           <td>(</td>
303           <td class="paramtype">cl::CommandQueue &amp;&#160;</td>
304           <td class="paramname"><em>q</em>, </td>
305         </tr>
306         <tr>
307           <td class="paramkey"></td>
308           <td></td>
309           <td class="paramtype">bool&#160;</td>
310           <td class="paramname"><em>blocking</em>&#160;</td>
311         </tr>
312         <tr>
313           <td></td>
314           <td>)</td>
315           <td></td><td></td>
316         </tr>
317       </table>
318 </div><div class="memdoc">
319
320 <p>Enqueue a map operation of the allocated buffer on the given queue. </p>
321 <dl class="params"><dt>Parameters</dt><dd>
322   <table class="params">
323     <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>
324     <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>
325   </table>
326   </dd>
327 </dl>
328 <dl class="section return"><dt>Returns</dt><dd>The mapping address. </dd></dl>
329
330 </div>
331 </div>
332 <a class="anchor" id="a2de13c6fbd9dd5506f12627b87415a51"></a>
333 <div class="memitem">
334 <div class="memproto">
335 <table class="mlabels">
336   <tr>
337   <td class="mlabels-left">
338       <table class="memname">
339         <tr>
340           <td class="memname">const <a class="el" href="classarm__compute_1_1_c_l_lut_allocator.xhtml">CLLutAllocator</a>&amp; operator= </td>
341           <td>(</td>
342           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_c_l_lut_allocator.xhtml">CLLutAllocator</a> &amp;&#160;</td>
343           <td class="paramname"></td><td>)</td>
344           <td></td>
345         </tr>
346       </table>
347   </td>
348   <td class="mlabels-right">
349 <span class="mlabels"><span class="mlabel">delete</span></span>  </td>
350   </tr>
351 </table>
352 </div><div class="memdoc">
353
354 <p>Prevent instances of this class from being copy assigned (As this class contains pointers). </p>
355
356 </div>
357 </div>
358 <a class="anchor" id="a34b854d640d247bd7422f60ca2f3a05c"></a>
359 <div class="memitem">
360 <div class="memproto">
361       <table class="memname">
362         <tr>
363           <td class="memname">void unmap </td>
364           <td>(</td>
365           <td class="paramtype">cl::CommandQueue &amp;&#160;</td>
366           <td class="paramname"><em>q</em>, </td>
367         </tr>
368         <tr>
369           <td class="paramkey"></td>
370           <td></td>
371           <td class="paramtype">uint8_t *&#160;</td>
372           <td class="paramname"><em>mapping</em>&#160;</td>
373         </tr>
374         <tr>
375           <td></td>
376           <td>)</td>
377           <td></td><td></td>
378         </tr>
379       </table>
380 </div><div class="memdoc">
381
382 <p>Enqueue an unmap operation of the allocated buffer on the given queue. </p>
383 <dl class="section note"><dt>Note</dt><dd>This method simply enqueue 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>
384 <dl class="params"><dt>Parameters</dt><dd>
385   <table class="params">
386     <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>
387     <tr><td class="paramdir">[in]</td><td class="paramname">mapping</td><td>The cpu mapping to unmap. </td></tr>
388   </table>
389   </dd>
390 </dl>
391
392 </div>
393 </div>
394 <hr/>The documentation for this class was generated from the following file:<ul>
395 <li>arm_compute/runtime/CL/<a class="el" href="_c_l_lut_allocator_8h_source.xhtml">CLLutAllocator.h</a></li>
396 </ul>
397 </div><!-- contents -->
398 </div><!-- doc-content -->
399 <!-- start footer part -->
400 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
401   <ul>
402     <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_allocator.xhtml">CLLutAllocator</a></li>
403     <li class="footer">Generated on Fri Mar 2 2018 12:37:57 for Compute Library by
404     <a href="http://www.doxygen.org/index.html">
405     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
406   </ul>
407 </div>
408 </body>
409 </html>