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">
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: Lut 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);
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(); });
27 <script type="text/x-mathjax-config">
29 extensions: ["tex2jax.js"],
30 jax: ["input/TeX","output/HTML-CSS"],
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" />
36 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
38 <table cellspacing="0" cellpadding="0">
40 <tr style="height: 56px;">
41 <td style="padding-left: 0.5em;">
42 <div id="projectname">ARM Compute Library
43  <span id="projectnumber">17.05</span>
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');
55 <div id="navrow1" class="tabs">
57 <li><a href="index.xhtml"><span>Main 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 Structures</span></a></li>
60 <li><a href="files.xhtml"><span>Files</span></a></li>
62 <div id="MSearchBox" class="MSearchBoxInactive">
64 <img id="MSearchSelect" src="search/mag_sel.png"
65 onmouseover="return searchBox.OnSearchSelectShow()"
66 onmouseout="return searchBox.OnSearchSelectHide()"
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>
79 <div id="navrow2" class="tabs2">
81 <li><a href="annotated.xhtml"><span>Data Structures</span></a></li>
82 <li><a href="classes.xhtml"><span>Data Structure Index</span></a></li>
83 <li><a href="inherits.xhtml"><span>Class Hierarchy</span></a></li>
84 <li><a href="functions.xhtml"><span>Data Fields</span></a></li>
88 <div id="side-nav" class="ui-resizable side-nav-resizable">
90 <div id="nav-tree-contents">
91 <div id="nav-sync" class="sync"></div>
94 <div id="splitbar" style="-moz-user-select:none;"
95 class="ui-resizable-handle">
98 <script type="text/javascript">
99 $(document).ready(function(){initNavTree('classarm__compute_1_1_lut.xhtml','');});
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)">
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">
117 <div class="summary">
118 <a href="#pub-methods">Public Member Functions</a> </div>
119 <div class="headertitle">
120 <div class="title">Lut Class Reference</div> </div>
122 <div class="contents">
124 <p>Basic implementation of the LUT interface.
125 <a href="classarm__compute_1_1_lut.xhtml#details">More...</a></p>
127 <p><code>#include <<a class="el" href="_lut_8h_source.xhtml">Lut.h</a>></code></p>
128 <div class="dynheader">
129 Collaboration diagram for Lut:</div>
130 <div class="dyncontent">
131 <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_lut__coll__graph.svg" width="55" height="112"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
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:a0f61968969758af458b1bb644445cb4d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_lut.xhtml#a0f61968969758af458b1bb644445cb4d">Lut</a> ()</td></tr>
138 <tr class="memdesc:a0f61968969758af458b1bb644445cb4d"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a0f61968969758af458b1bb644445cb4d">More...</a><br /></td></tr>
139 <tr class="separator:a0f61968969758af458b1bb644445cb4d"><td class="memSeparator" colspan="2"> </td></tr>
140 <tr class="memitem:adad4e75f50babe21da02638fa2cfb9d1"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_lut.xhtml#adad4e75f50babe21da02638fa2cfb9d1">Lut</a> (size_t <a class="el" href="classarm__compute_1_1_lut.xhtml#a6dac829b4ddf4a5729ac090e73696958">num_elements</a>, <a class="el" href="namespacearm__compute.xhtml#ad8ed01ff3ff33333d8e19db4d2818bb6">DataType</a> data_type)</td></tr>
141 <tr class="memdesc:adad4e75f50babe21da02638fa2cfb9d1"><td class="mdescLeft"> </td><td class="mdescRight">Constructor: initializes a LUT which can contain num_values values of data_type type. <a href="#adad4e75f50babe21da02638fa2cfb9d1">More...</a><br /></td></tr>
142 <tr class="separator:adad4e75f50babe21da02638fa2cfb9d1"><td class="memSeparator" colspan="2"> </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> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_lut.xhtml#a5330adc6ef4a662806ec236e2be07bbe">allocator</a> ()</td></tr>
144 <tr class="memdesc:a5330adc6ef4a662806ec236e2be07bbe"><td class="mdescLeft"> </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"> </td></tr>
146 <tr class="memitem:a6dac829b4ddf4a5729ac090e73696958"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_lut.xhtml#a6dac829b4ddf4a5729ac090e73696958">num_elements</a> () const override</td></tr>
147 <tr class="memdesc:a6dac829b4ddf4a5729ac090e73696958"><td class="mdescLeft"> </td><td class="mdescRight">Returns the total number of elements in the LUT. <a href="#a6dac829b4ddf4a5729ac090e73696958">More...</a><br /></td></tr>
148 <tr class="separator:a6dac829b4ddf4a5729ac090e73696958"><td class="memSeparator" colspan="2"> </td></tr>
149 <tr class="memitem:aaf3f51cd25e1651cccf04064a9888f4e"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_lut.xhtml#aaf3f51cd25e1651cccf04064a9888f4e">index_offset</a> () const override</td></tr>
150 <tr class="memdesc:aaf3f51cd25e1651cccf04064a9888f4e"><td class="mdescLeft"> </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>
151 <tr class="separator:aaf3f51cd25e1651cccf04064a9888f4e"><td class="memSeparator" colspan="2"> </td></tr>
152 <tr class="memitem:a68f33e9afee896dc24b32093d25c6766"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_lut.xhtml#a68f33e9afee896dc24b32093d25c6766">size_in_bytes</a> () const override</td></tr>
153 <tr class="memdesc:a68f33e9afee896dc24b32093d25c6766"><td class="mdescLeft"> </td><td class="mdescRight">Returns the total size in bytes of the LUT. <a href="#a68f33e9afee896dc24b32093d25c6766">More...</a><br /></td></tr>
154 <tr class="separator:a68f33e9afee896dc24b32093d25c6766"><td class="memSeparator" colspan="2"> </td></tr>
155 <tr class="memitem:a6dc9c052a2732f899adccfaeee468364"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacearm__compute.xhtml#ad8ed01ff3ff33333d8e19db4d2818bb6">DataType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_lut.xhtml#a6dc9c052a2732f899adccfaeee468364">type</a> () const override</td></tr>
156 <tr class="memdesc:a6dc9c052a2732f899adccfaeee468364"><td class="mdescLeft"> </td><td class="mdescRight">Returns the type of the LUT. <a href="#a6dc9c052a2732f899adccfaeee468364">More...</a><br /></td></tr>
157 <tr class="separator:a6dc9c052a2732f899adccfaeee468364"><td class="memSeparator" colspan="2"> </td></tr>
158 <tr class="memitem:ace7b855e3c647d29cc37a1ce147901dc"><td class="memItemLeft" align="right" valign="top">uint8_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_lut.xhtml#ace7b855e3c647d29cc37a1ce147901dc">buffer</a> () const override</td></tr>
159 <tr class="memdesc:ace7b855e3c647d29cc37a1ce147901dc"><td class="mdescLeft"> </td><td class="mdescRight">Returns a pointer to the start of the LUT. <a href="#ace7b855e3c647d29cc37a1ce147901dc">More...</a><br /></td></tr>
160 <tr class="separator:ace7b855e3c647d29cc37a1ce147901dc"><td class="memSeparator" colspan="2"> </td></tr>
161 <tr class="memitem:aee7cb2065b88d21ac4ad05bc997ecf82"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_lut.xhtml#aee7cb2065b88d21ac4ad05bc997ecf82">clear</a> () override</td></tr>
162 <tr class="memdesc:aee7cb2065b88d21ac4ad05bc997ecf82"><td class="mdescLeft"> </td><td class="mdescRight">Clears the LUT by setting every element to zero. <a href="#aee7cb2065b88d21ac4ad05bc997ecf82">More...</a><br /></td></tr>
163 <tr class="separator:aee7cb2065b88d21ac4ad05bc997ecf82"><td class="memSeparator" colspan="2"> </td></tr>
164 <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="-"/> Public Member Functions inherited from <a class="el" href="classarm__compute_1_1_i_lut.xhtml">ILut</a></td></tr>
165 <tr class="memitem:ab90dd1556851ce4b6b1529dfb9107f68 inherit pub_methods_classarm__compute_1_1_i_lut"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_lut.xhtml#ab90dd1556851ce4b6b1529dfb9107f68">~ILut</a> ()=default</td></tr>
166 <tr class="memdesc:ab90dd1556851ce4b6b1529dfb9107f68 inherit pub_methods_classarm__compute_1_1_i_lut"><td class="mdescLeft"> </td><td class="mdescRight">Default virtual destructor. <a href="#ab90dd1556851ce4b6b1529dfb9107f68">More...</a><br /></td></tr>
167 <tr class="separator:ab90dd1556851ce4b6b1529dfb9107f68 inherit pub_methods_classarm__compute_1_1_i_lut"><td class="memSeparator" colspan="2"> </td></tr>
169 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
170 <div class="textblock"><p>Basic implementation of the LUT interface. </p>
172 <p>Definition at line <a class="el" href="_lut_8h_source.xhtml#l00039">39</a> of file <a class="el" href="_lut_8h_source.xhtml">Lut.h</a>.</p>
173 </div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
174 <a class="anchor" id="a0f61968969758af458b1bb644445cb4d"></a>
175 <div class="memitem">
176 <div class="memproto">
177 <table class="memname">
179 <td class="memname"><a class="el" href="classarm__compute_1_1_lut.xhtml">Lut</a> </td>
181 <td class="paramname"></td><td>)</td>
185 </div><div class="memdoc">
191 <a class="anchor" id="adad4e75f50babe21da02638fa2cfb9d1"></a>
192 <div class="memitem">
193 <div class="memproto">
194 <table class="memname">
196 <td class="memname"><a class="el" href="classarm__compute_1_1_lut.xhtml">Lut</a> </td>
198 <td class="paramtype">size_t </td>
199 <td class="paramname"><em>num_elements</em>, </td>
202 <td class="paramkey"></td>
204 <td class="paramtype"><a class="el" href="namespacearm__compute.xhtml#ad8ed01ff3ff33333d8e19db4d2818bb6">DataType</a> </td>
205 <td class="paramname"><em>data_type</em> </td>
213 </div><div class="memdoc">
215 <p>Constructor: initializes a LUT which can contain num_values values of data_type type. </p>
216 <dl class="params"><dt>Parameters</dt><dd>
217 <table class="params">
218 <tr><td class="paramdir">[in]</td><td class="paramname">num_elements</td><td>Number of elements of the LUT. </td></tr>
219 <tr><td class="paramdir">[in]</td><td class="paramname">data_type</td><td>Data type of each element. </td></tr>
226 <h2 class="groupheader">Member Function Documentation</h2>
227 <a class="anchor" id="a5330adc6ef4a662806ec236e2be07bbe"></a>
228 <div class="memitem">
229 <div class="memproto">
230 <table class="memname">
232 <td class="memname"><a class="el" href="classarm__compute_1_1_i_lut_allocator.xhtml">ILutAllocator</a>* allocator </td>
234 <td class="paramname"></td><td>)</td>
238 </div><div class="memdoc">
240 <p>Return a pointer to the lut's allocator. </p>
241 <dl class="section return"><dt>Returns</dt><dd>A pointer to the lut's allocator </dd></dl>
245 <a class="anchor" id="ace7b855e3c647d29cc37a1ce147901dc"></a>
246 <div class="memitem">
247 <div class="memproto">
248 <table class="mlabels">
250 <td class="mlabels-left">
251 <table class="memname">
253 <td class="memname">uint8_t* buffer </td>
255 <td class="paramname"></td><td>)</td>
260 <td class="mlabels-right">
261 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
264 </div><div class="memdoc">
266 <p>Returns a pointer to the start of the LUT. </p>
267 <p>Other elements of the LUT can be accessed using <a class="el" href="classarm__compute_1_1_lut.xhtml#ace7b855e3c647d29cc37a1ce147901dc" title="Returns a pointer to the start of the LUT. ">buffer()</a>[idx] for 0 <= idx < <a class="el" href="classarm__compute_1_1_lut.xhtml#a6dac829b4ddf4a5729ac090e73696958" title="Returns the total number of elements in the LUT. ">num_elements()</a>.</p>
268 <dl class="section return"><dt>Returns</dt><dd>Pointer to the start of the lut. </dd></dl>
270 <p>Implements <a class="el" href="classarm__compute_1_1_i_lut.xhtml#ab988210662dbd3bf32fd563c7dd1bdbf">ILut</a>.</p>
274 <a class="anchor" id="aee7cb2065b88d21ac4ad05bc997ecf82"></a>
275 <div class="memitem">
276 <div class="memproto">
277 <table class="mlabels">
279 <td class="mlabels-left">
280 <table class="memname">
282 <td class="memname">void clear </td>
284 <td class="paramname"></td><td>)</td>
289 <td class="mlabels-right">
290 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
293 </div><div class="memdoc">
295 <p>Clears the LUT by setting every element to zero. </p>
297 <p>Implements <a class="el" href="classarm__compute_1_1_i_lut.xhtml#a5eeb94d22b8366d1b68d0614384802fe">ILut</a>.</p>
301 <a class="anchor" id="aaf3f51cd25e1651cccf04064a9888f4e"></a>
302 <div class="memitem">
303 <div class="memproto">
304 <table class="mlabels">
306 <td class="mlabels-left">
307 <table class="memname">
309 <td class="memname">uint32_t index_offset </td>
311 <td class="paramname"></td><td>)</td>
316 <td class="mlabels-right">
317 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
320 </div><div class="memdoc">
322 <p>Indicates the offset that needs to be applied to the raw index before performing a lookup in the LUT. </p>
323 <dl class="section return"><dt>Returns</dt><dd>The normalization offset. </dd></dl>
325 <p>Implements <a class="el" href="classarm__compute_1_1_i_lut.xhtml#a786de36dda3773c5fb35d6700e64621e">ILut</a>.</p>
329 <a class="anchor" id="a6dac829b4ddf4a5729ac090e73696958"></a>
330 <div class="memitem">
331 <div class="memproto">
332 <table class="mlabels">
334 <td class="mlabels-left">
335 <table class="memname">
337 <td class="memname">size_t num_elements </td>
339 <td class="paramname"></td><td>)</td>
344 <td class="mlabels-right">
345 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
348 </div><div class="memdoc">
350 <p>Returns the total number of elements in the LUT. </p>
351 <dl class="section return"><dt>Returns</dt><dd>Total number of elements. </dd></dl>
353 <p>Implements <a class="el" href="classarm__compute_1_1_i_lut.xhtml#a7a826fbb4f639c556352d1ede69187d7">ILut</a>.</p>
357 <a class="anchor" id="a68f33e9afee896dc24b32093d25c6766"></a>
358 <div class="memitem">
359 <div class="memproto">
360 <table class="mlabels">
362 <td class="mlabels-left">
363 <table class="memname">
365 <td class="memname">size_t size_in_bytes </td>
367 <td class="paramname"></td><td>)</td>
372 <td class="mlabels-right">
373 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
376 </div><div class="memdoc">
378 <p>Returns the total size in bytes of the LUT. </p>
379 <dl class="section return"><dt>Returns</dt><dd>Total size of the LUT in bytes. </dd></dl>
381 <p>Implements <a class="el" href="classarm__compute_1_1_i_lut.xhtml#a6314b1e589ffe32277858c018ac3c630">ILut</a>.</p>
385 <a class="anchor" id="a6dc9c052a2732f899adccfaeee468364"></a>
386 <div class="memitem">
387 <div class="memproto">
388 <table class="mlabels">
390 <td class="mlabels-left">
391 <table class="memname">
393 <td class="memname"><a class="el" href="namespacearm__compute.xhtml#ad8ed01ff3ff33333d8e19db4d2818bb6">DataType</a> type </td>
395 <td class="paramname"></td><td>)</td>
400 <td class="mlabels-right">
401 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
404 </div><div class="memdoc">
406 <p>Returns the type of the LUT. </p>
407 <dl class="section return"><dt>Returns</dt><dd>The type of the LUT. </dd></dl>
409 <p>Implements <a class="el" href="classarm__compute_1_1_i_lut.xhtml#aa1917b40b57ce0a0f1c69722b46f3f46">ILut</a>.</p>
413 <hr/>The documentation for this class was generated from the following file:<ul>
414 <li>arm_compute/runtime/<a class="el" href="_lut_8h_source.xhtml">Lut.h</a></li>
416 </div><!-- contents -->
417 </div><!-- doc-content -->
418 <!-- start footer part -->
419 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
421 <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_lut.xhtml">Lut</a></li>
422 <li class="footer">Generated on Wed May 3 2017 17:20:05 for ARM Compute Library by
423 <a href="http://www.doxygen.org/index.html">
424 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>