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: ILut 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.03.1</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_i_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">ILut Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
122 <div class="contents">
124 <p>Lookup Table object interface.
125 <a href="classarm__compute_1_1_i_lut.xhtml#details">More...</a></p>
127 <p><code>#include <<a class="el" href="_i_lut_8h_source.xhtml">ILut.h</a>></code></p>
128 <table class="memberdecls">
129 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
130 Public Member Functions</h2></td></tr>
131 <tr class="memitem:ab90dd1556851ce4b6b1529dfb9107f68"><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>
132 <tr class="memdesc:ab90dd1556851ce4b6b1529dfb9107f68"><td class="mdescLeft"> </td><td class="mdescRight">Default virtual destructor. <a href="#ab90dd1556851ce4b6b1529dfb9107f68">More...</a><br /></td></tr>
133 <tr class="separator:ab90dd1556851ce4b6b1529dfb9107f68"><td class="memSeparator" colspan="2"> </td></tr>
134 <tr class="memitem:a7a826fbb4f639c556352d1ede69187d7"><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_lut.xhtml#a7a826fbb4f639c556352d1ede69187d7">num_elements</a> () const =0</td></tr>
135 <tr class="memdesc:a7a826fbb4f639c556352d1ede69187d7"><td class="mdescLeft"> </td><td class="mdescRight">Returns the total number of elements in the LUT. <a href="#a7a826fbb4f639c556352d1ede69187d7">More...</a><br /></td></tr>
136 <tr class="separator:a7a826fbb4f639c556352d1ede69187d7"><td class="memSeparator" colspan="2"> </td></tr>
137 <tr class="memitem:a786de36dda3773c5fb35d6700e64621e"><td class="memItemLeft" align="right" valign="top">virtual uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_lut.xhtml#a786de36dda3773c5fb35d6700e64621e">index_offset</a> () const =0</td></tr>
138 <tr class="memdesc:a786de36dda3773c5fb35d6700e64621e"><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="#a786de36dda3773c5fb35d6700e64621e">More...</a><br /></td></tr>
139 <tr class="separator:a786de36dda3773c5fb35d6700e64621e"><td class="memSeparator" colspan="2"> </td></tr>
140 <tr class="memitem:a6314b1e589ffe32277858c018ac3c630"><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_lut.xhtml#a6314b1e589ffe32277858c018ac3c630">size_in_bytes</a> () const =0</td></tr>
141 <tr class="memdesc:a6314b1e589ffe32277858c018ac3c630"><td class="mdescLeft"> </td><td class="mdescRight">Returns the total size in bytes of the LUT. <a href="#a6314b1e589ffe32277858c018ac3c630">More...</a><br /></td></tr>
142 <tr class="separator:a6314b1e589ffe32277858c018ac3c630"><td class="memSeparator" colspan="2"> </td></tr>
143 <tr class="memitem:aa1917b40b57ce0a0f1c69722b46f3f46"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespacearm__compute.xhtml#ad8ed01ff3ff33333d8e19db4d2818bb6">DataType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_lut.xhtml#aa1917b40b57ce0a0f1c69722b46f3f46">type</a> () const =0</td></tr>
144 <tr class="memdesc:aa1917b40b57ce0a0f1c69722b46f3f46"><td class="mdescLeft"> </td><td class="mdescRight">Returns the type of the LUT. <a href="#aa1917b40b57ce0a0f1c69722b46f3f46">More...</a><br /></td></tr>
145 <tr class="separator:aa1917b40b57ce0a0f1c69722b46f3f46"><td class="memSeparator" colspan="2"> </td></tr>
146 <tr class="memitem:ab988210662dbd3bf32fd563c7dd1bdbf"><td class="memItemLeft" align="right" valign="top">virtual uint8_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_lut.xhtml#ab988210662dbd3bf32fd563c7dd1bdbf">buffer</a> () const =0</td></tr>
147 <tr class="memdesc:ab988210662dbd3bf32fd563c7dd1bdbf"><td class="mdescLeft"> </td><td class="mdescRight">Returns a pointer to the start of the LUT. <a href="#ab988210662dbd3bf32fd563c7dd1bdbf">More...</a><br /></td></tr>
148 <tr class="separator:ab988210662dbd3bf32fd563c7dd1bdbf"><td class="memSeparator" colspan="2"> </td></tr>
149 <tr class="memitem:a5eeb94d22b8366d1b68d0614384802fe"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_lut.xhtml#a5eeb94d22b8366d1b68d0614384802fe">clear</a> ()=0</td></tr>
150 <tr class="memdesc:a5eeb94d22b8366d1b68d0614384802fe"><td class="mdescLeft"> </td><td class="mdescRight">Clears the LUT by setting every element to zero. <a href="#a5eeb94d22b8366d1b68d0614384802fe">More...</a><br /></td></tr>
151 <tr class="separator:a5eeb94d22b8366d1b68d0614384802fe"><td class="memSeparator" colspan="2"> </td></tr>
153 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
154 <div class="textblock"><p>Lookup Table object interface. </p>
156 <p>Definition at line <a class="el" href="_i_lut_8h_source.xhtml#l00034">34</a> of file <a class="el" href="_i_lut_8h_source.xhtml">ILut.h</a>.</p>
157 </div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
158 <a class="anchor" id="ab90dd1556851ce4b6b1529dfb9107f68"></a>
159 <div class="memitem">
160 <div class="memproto">
161 <table class="mlabels">
163 <td class="mlabels-left">
164 <table class="memname">
166 <td class="memname">virtual ~<a class="el" href="classarm__compute_1_1_i_lut.xhtml">ILut</a> </td>
168 <td class="paramname"></td><td>)</td>
173 <td class="mlabels-right">
174 <span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">default</span></span> </td>
177 </div><div class="memdoc">
179 <p>Default virtual destructor. </p>
183 <h2 class="groupheader">Member Function Documentation</h2>
184 <a class="anchor" id="ab988210662dbd3bf32fd563c7dd1bdbf"></a>
185 <div class="memitem">
186 <div class="memproto">
187 <table class="mlabels">
189 <td class="mlabels-left">
190 <table class="memname">
192 <td class="memname">virtual uint8_t* buffer </td>
194 <td class="paramname"></td><td>)</td>
199 <td class="mlabels-right">
200 <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
203 </div><div class="memdoc">
205 <p>Returns a pointer to the start of the LUT. </p>
206 <p>Other elements of the LUT can be accessed using <a class="el" href="classarm__compute_1_1_i_lut.xhtml#ab988210662dbd3bf32fd563c7dd1bdbf" title="Returns a pointer to the start of the LUT. ">buffer()</a>[idx] for 0 <= idx < <a class="el" href="classarm__compute_1_1_i_lut.xhtml#a7a826fbb4f639c556352d1ede69187d7" title="Returns the total number of elements in the LUT. ">num_elements()</a>.</p>
207 <dl class="section return"><dt>Returns</dt><dd>Pointer to the start of the lut. </dd></dl>
209 <p>Implemented in <a class="el" href="classarm__compute_1_1_i_c_l_lut.xhtml#ace7b855e3c647d29cc37a1ce147901dc">ICLLut</a>, and <a class="el" href="classarm__compute_1_1_lut.xhtml#ace7b855e3c647d29cc37a1ce147901dc">Lut</a>.</p>
213 <a class="anchor" id="a5eeb94d22b8366d1b68d0614384802fe"></a>
214 <div class="memitem">
215 <div class="memproto">
216 <table class="mlabels">
218 <td class="mlabels-left">
219 <table class="memname">
221 <td class="memname">virtual void clear </td>
223 <td class="paramname"></td><td>)</td>
228 <td class="mlabels-right">
229 <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
232 </div><div class="memdoc">
234 <p>Clears the LUT by setting every element to zero. </p>
236 <p>Implemented in <a class="el" href="classarm__compute_1_1_c_l_lut.xhtml#aee7cb2065b88d21ac4ad05bc997ecf82">CLLut</a>, and <a class="el" href="classarm__compute_1_1_lut.xhtml#aee7cb2065b88d21ac4ad05bc997ecf82">Lut</a>.</p>
240 <a class="anchor" id="a786de36dda3773c5fb35d6700e64621e"></a>
241 <div class="memitem">
242 <div class="memproto">
243 <table class="mlabels">
245 <td class="mlabels-left">
246 <table class="memname">
248 <td class="memname">virtual uint32_t index_offset </td>
250 <td class="paramname"></td><td>)</td>
255 <td class="mlabels-right">
256 <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
259 </div><div class="memdoc">
261 <p>Indicates the offset that needs to be applied to the raw index before performing a lookup in the LUT. </p>
262 <dl class="section return"><dt>Returns</dt><dd>The normalization offset. </dd></dl>
264 <p>Implemented in <a class="el" href="classarm__compute_1_1_c_l_lut.xhtml#aaf3f51cd25e1651cccf04064a9888f4e">CLLut</a>, and <a class="el" href="classarm__compute_1_1_lut.xhtml#aaf3f51cd25e1651cccf04064a9888f4e">Lut</a>.</p>
268 <a class="anchor" id="a7a826fbb4f639c556352d1ede69187d7"></a>
269 <div class="memitem">
270 <div class="memproto">
271 <table class="mlabels">
273 <td class="mlabels-left">
274 <table class="memname">
276 <td class="memname">virtual size_t num_elements </td>
278 <td class="paramname"></td><td>)</td>
283 <td class="mlabels-right">
284 <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
287 </div><div class="memdoc">
289 <p>Returns the total number of elements in the LUT. </p>
290 <dl class="section return"><dt>Returns</dt><dd>Total number of elements. </dd></dl>
292 <p>Implemented in <a class="el" href="classarm__compute_1_1_c_l_lut.xhtml#a6dac829b4ddf4a5729ac090e73696958">CLLut</a>, and <a class="el" href="classarm__compute_1_1_lut.xhtml#a6dac829b4ddf4a5729ac090e73696958">Lut</a>.</p>
296 <a class="anchor" id="a6314b1e589ffe32277858c018ac3c630"></a>
297 <div class="memitem">
298 <div class="memproto">
299 <table class="mlabels">
301 <td class="mlabels-left">
302 <table class="memname">
304 <td class="memname">virtual size_t size_in_bytes </td>
306 <td class="paramname"></td><td>)</td>
311 <td class="mlabels-right">
312 <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
315 </div><div class="memdoc">
317 <p>Returns the total size in bytes of the LUT. </p>
318 <dl class="section return"><dt>Returns</dt><dd>Total size of the LUT in bytes. </dd></dl>
320 <p>Implemented in <a class="el" href="classarm__compute_1_1_c_l_lut.xhtml#a68f33e9afee896dc24b32093d25c6766">CLLut</a>, and <a class="el" href="classarm__compute_1_1_lut.xhtml#a68f33e9afee896dc24b32093d25c6766">Lut</a>.</p>
324 <a class="anchor" id="aa1917b40b57ce0a0f1c69722b46f3f46"></a>
325 <div class="memitem">
326 <div class="memproto">
327 <table class="mlabels">
329 <td class="mlabels-left">
330 <table class="memname">
332 <td class="memname">virtual <a class="el" href="namespacearm__compute.xhtml#ad8ed01ff3ff33333d8e19db4d2818bb6">DataType</a> type </td>
334 <td class="paramname"></td><td>)</td>
339 <td class="mlabels-right">
340 <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
343 </div><div class="memdoc">
345 <p>Returns the type of the LUT. </p>
346 <dl class="section return"><dt>Returns</dt><dd>The type of the LUT. </dd></dl>
348 <p>Implemented in <a class="el" href="classarm__compute_1_1_c_l_lut.xhtml#a6dc9c052a2732f899adccfaeee468364">CLLut</a>, and <a class="el" href="classarm__compute_1_1_lut.xhtml#a6dc9c052a2732f899adccfaeee468364">Lut</a>.</p>
352 <hr/>The documentation for this class was generated from the following file:<ul>
353 <li>arm_compute/core/<a class="el" href="_i_lut_8h_source.xhtml">ILut.h</a></li>
355 </div><!-- contents -->
356 </div><!-- doc-content -->
357 <!-- start footer part -->
358 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
360 <li class="navelem"><a class="el" href="namespacearm__compute.xhtml">arm_compute</a></li><li class="navelem"><a class="el" href="classarm__compute_1_1_i_lut.xhtml">ILut</a></li>
361 <li class="footer">Generated on Fri Mar 24 2017 17:23:50 for ARM Compute Library by
362 <a href="http://www.doxygen.org/index.html">
363 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>