documentation/classarm__compute_1_1_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.6"/>
   8 <meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
   9 <title>Compute Library: LutAllocator 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="navtree.js"></script>
  16 <script type="text/javascript">
  17   $(document).ready(initResizable);
  18   $(window).load(resizeHeight);
  19 </script>
  20 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  21 <script type="text/javascript" src="search/search.js"></script>
  22 <script type="text/javascript">
  23   $(document).ready(function() { searchBox.OnSelectItem(0); });
  24 </script>
  25 <script type="text/x-mathjax-config">
  26   MathJax.Hub.Config({
  27     extensions: ["tex2jax.js"],
  28     jax: ["input/TeX","output/HTML-CSS"],
  29 });
  30 </script><script src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
  31 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  32 </head>
  33 <body>
  34 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  35 <div id="titlearea">
  36 <table cellspacing="0" cellpadding="0">
  37  <tbody>
  38  <tr style="height: 56px;">
  39   <td style="padding-left: 0.5em;">
  40    <div id="projectname">Compute Library
  41    &#160;<span id="projectnumber">17.09</span>
  42    </div>
  43   </td>
  44  </tr>
  45  </tbody>
  46 </table>
  47 </div>
  48 <!-- end header part -->
  49 <!-- Generated by Doxygen 1.8.6 -->
  50 <script type="text/javascript">
  51 var searchBox = new SearchBox("searchBox", "search",false,'Search');
  52 </script>
  53   <div id="navrow1" class="tabs">
  54     <ul class="tablist">
  55       <li><a href="index.xhtml"><span>Main&#160;Page</span></a></li>
  56       <li><a href="pages.xhtml"><span>Related&#160;Pages</span></a></li>
  57       <li><a href="namespaces.xhtml"><span>Namespaces</span></a></li>
  58       <li class="current"><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
  59       <li><a href="files.xhtml"><span>Files</span></a></li>
  60       <li>
  61         <div id="MSearchBox" class="MSearchBoxInactive">
  62         <span class="left">
  63           <img id="MSearchSelect" src="search/mag_sel.png"
  64                onmouseover="return searchBox.OnSearchSelectShow()"
  65                onmouseout="return searchBox.OnSearchSelectHide()"
  66                alt=""/>
  67           <input type="text" id="MSearchField" value="Search" accesskey="S"
  68                onfocus="searchBox.OnSearchFieldFocus(true)"
  69                onblur="searchBox.OnSearchFieldFocus(false)"
  70                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  71           </span><span class="right">
  72             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  73           </span>
  74         </div>
  75       </li>
  76     </ul>
  77   </div>
  78   <div id="navrow2" class="tabs2">
  79     <ul class="tablist">
  80       <li><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
  81       <li><a href="classes.xhtml"><span>Data&#160;Structure&#160;Index</span></a></li>
  82       <li><a href="inherits.xhtml"><span>Class&#160;Hierarchy</span></a></li>
  83       <li><a href="functions.xhtml"><span>Data&#160;Fields</span></a></li>
  84     </ul>
  85   </div>
  86 </div><!-- top -->
  87 <div id="side-nav" class="ui-resizable side-nav-resizable">
  88   <div id="nav-tree">
  89     <div id="nav-tree-contents">
  90       <div id="nav-sync" class="sync"></div>
  91     </div>
  92   </div>
  93   <div id="splitbar" style="-moz-user-select:none;"
  94        class="ui-resizable-handle">
  95   </div>
  96 </div>
  97 <script type="text/javascript">
  98 $(document).ready(function(){initNavTree('classarm__compute_1_1_lut_allocator.xhtml','');});
  99 </script>
 100 <div id="doc-content">
 101 <!-- window showing the filter options -->
 102 <div id="MSearchSelectWindow"
 103      onmouseover="return searchBox.OnSearchSelectShow()"
 104      onmouseout="return searchBox.OnSearchSelectHide()"
 105      onkeydown="return searchBox.OnSearchSelectKey(event)">
 106 <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark">&#160;</span>Pages</a></div>
 107
 108 <!-- iframe showing the search results (closed by default) -->
 109 <div id="MSearchResultsWindow">
 110 <iframe src="javascript:void(0)" frameborder="0"
 111         name="MSearchResults" id="MSearchResults">
 112 </iframe>
 113 </div>
 114
 115 <div class="header">
 116   <div class="summary">
 117 <a href="#pub-methods">Public Member Functions</a>  </div>
 118   <div class="headertitle">
 119 <div class="title">LutAllocator Class Reference</div>  </div>
 120 </div><!--header-->
 121 <div class="contents">
 122
 123 <p>Basic implementation of a CPU memory LUT allocator.
 124  <a href="classarm__compute_1_1_lut_allocator.xhtml#details">More...</a></p>
 125
 126 <p><code>#include &lt;<a class="el" href="_lut_allocator_8h_source.xhtml">LutAllocator.h</a>&gt;</code></p>
 127 <div class="dynheader">
 128 Collaboration diagram for LutAllocator:</div>
 129 <div class="dyncontent">
 130 <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_lut_allocator__coll__graph.svg" width="106" height="112"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
 131 </div>
 132 <center><span class="legend">[<a target="top" href="graph_legend.xhtml">legend</a>]</span></center></div>
 133 <table class="memberdecls">
 134 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
 135 Public Member Functions</h2></td></tr>
 136 <tr class="memitem:a5fdb67ad7cf44fcbc5bf7bd0a7a1ca09"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_lut_allocator.xhtml#a5fdb67ad7cf44fcbc5bf7bd0a7a1ca09">LutAllocator</a> ()</td></tr>
 137 <tr class="memdesc:a5fdb67ad7cf44fcbc5bf7bd0a7a1ca09"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor.  <a href="#a5fdb67ad7cf44fcbc5bf7bd0a7a1ca09">More...</a><br/></td></tr>
 138 <tr class="separator:a5fdb67ad7cf44fcbc5bf7bd0a7a1ca09"><td class="memSeparator" colspan="2">&#160;</td></tr>
 139 <tr class="memitem:a738d0f4e90cfddb07316f368a855e50b"><td class="memItemLeft" align="right" valign="top">uint8_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_lut_allocator.xhtml#a738d0f4e90cfddb07316f368a855e50b">data</a> () const </td></tr>
 140 <tr class="memdesc:a738d0f4e90cfddb07316f368a855e50b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Interface to be implemented by the child class to return the pointer to the allocate data.  <a href="#a738d0f4e90cfddb07316f368a855e50b">More...</a><br/></td></tr>
 141 <tr class="separator:a738d0f4e90cfddb07316f368a855e50b"><td class="memSeparator" colspan="2">&#160;</td></tr>
 142 <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>
 143 <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>
 144 <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>
 145 <tr class="separator:acb80847d132eba25605f9fc43a42f652 inherit pub_methods_classarm__compute_1_1_i_lut_allocator"><td class="memSeparator" colspan="2">&#160;</td></tr>
 146 <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>
 147 <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>
 148 <tr class="separator:a9c34313e5cddaebce855b939e42efc32 inherit pub_methods_classarm__compute_1_1_i_lut_allocator"><td class="memSeparator" colspan="2">&#160;</td></tr>
 149 <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>
 150 <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>
 151 <tr class="separator:a07b8c40feb14af938204e68d8c2e5759 inherit pub_methods_classarm__compute_1_1_i_lut_allocator"><td class="memSeparator" colspan="2">&#160;</td></tr>
 152 <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>
 153 <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>
 154 <tr class="separator:afc1c53ed4dcc1a723b9b9dcf67c578a1 inherit pub_methods_classarm__compute_1_1_i_lut_allocator"><td class="memSeparator" colspan="2">&#160;</td></tr>
 155 <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>
 156 <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>
 157 <tr class="separator:a4ef157737b45c46f115e14b425512800 inherit pub_methods_classarm__compute_1_1_i_lut_allocator"><td class="memSeparator" colspan="2">&#160;</td></tr>
 158 <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>
 159 <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>
 160 <tr class="separator:a3f7ed6a14a98f283aa700342b9cc2a01 inherit pub_methods_classarm__compute_1_1_i_lut_allocator"><td class="memSeparator" colspan="2">&#160;</td></tr>
 161 <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>
 162 <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>
 163 <tr class="separator:a8522d89f5f58b6c744e230b6b0641a4b inherit pub_methods_classarm__compute_1_1_i_lut_allocator"><td class="memSeparator" colspan="2">&#160;</td></tr>
 164 <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>
 165 <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>
 166 <tr class="separator:aac782da1f912bceb5d8ad00c8dc892ac inherit pub_methods_classarm__compute_1_1_i_lut_allocator"><td class="memSeparator" colspan="2">&#160;</td></tr>
 167 </table>
 168 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 169 <div class="textblock"><p>Basic implementation of a CPU memory LUT allocator. </p>
 170
 171 <p>Definition at line <a class="el" href="_lut_allocator_8h_source.xhtml#l00035">35</a> of file <a class="el" href="_lut_allocator_8h_source.xhtml">LutAllocator.h</a>.</p>
 172 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 173 <a class="anchor" id="a5fdb67ad7cf44fcbc5bf7bd0a7a1ca09"></a>
 174 <div class="memitem">
 175 <div class="memproto">
 176       <table class="memname">
 177         <tr>
 178           <td class="memname"><a class="el" href="classarm__compute_1_1_lut_allocator.xhtml">LutAllocator</a> </td>
 179           <td>(</td>
 180           <td class="paramname"></td><td>)</td>
 181           <td></td>
 182         </tr>
 183       </table>
 184 </div><div class="memdoc">
 185
 186 <p>Default constructor. </p>
 187
 188 </div>
 189 </div>
 190 <h2 class="groupheader">Member Function Documentation</h2>
 191 <a class="anchor" id="a738d0f4e90cfddb07316f368a855e50b"></a>
 192 <div class="memitem">
 193 <div class="memproto">
 194       <table class="memname">
 195         <tr>
 196           <td class="memname">uint8_t* data </td>
 197           <td>(</td>
 198           <td class="paramname"></td><td>)</td>
 199           <td> const</td>
 200         </tr>
 201       </table>
 202 </div><div class="memdoc">
 203
 204 <p>Interface to be implemented by the child class to return the pointer to the allocate data. </p>
 205
 206 </div>
 207 </div>
 208 <hr/>The documentation for this class was generated from the following file:<ul>
 209 <li>arm_compute/runtime/<a class="el" href="_lut_allocator_8h_source.xhtml">LutAllocator.h</a></li>
 210 </ul>
 211 </div><!-- contents -->
 212 </div><!-- doc-content -->
 213 <!-- start footer part -->
 214 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 215   <ul>
 216     <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_allocator.xhtml">LutAllocator</a></li>
 217     <li class="footer">Generated on Thu Sep 28 2017 14:37:58 for Compute Library by
 218     <a href="http://www.doxygen.org/index.html">
 219     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
 220   </ul>
 221 </div>
 222 </body>
 223 </html>