documentation/classarm__compute_1_1_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: Allocator 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.05</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_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">Allocator Class Reference<span class="mlabels"><span class="mlabel">final</span></span></div>  </div>
 122 </div><!--header-->
 123 <div class="contents">
 124
 125 <p>Default malloc allocator implementation.
 126  <a href="classarm__compute_1_1_allocator.xhtml#details">More...</a></p>
 127
 128 <p><code>#include &lt;<a class="el" href="_allocator_8h_source.xhtml">Allocator.h</a>&gt;</code></p>
 129 <div class="dynheader">
 130 Collaboration diagram for Allocator:</div>
 131 <div class="dyncontent">
 132 <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_allocator__coll__graph.svg" width="92" 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:a20ec13b471d9434e1c3dd9d93c004e07"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_allocator.xhtml#a20ec13b471d9434e1c3dd9d93c004e07">Allocator</a> ()=default</td></tr>
 139 <tr class="memdesc:a20ec13b471d9434e1c3dd9d93c004e07"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor.  <a href="#a20ec13b471d9434e1c3dd9d93c004e07">More...</a><br /></td></tr>
 140 <tr class="separator:a20ec13b471d9434e1c3dd9d93c004e07"><td class="memSeparator" colspan="2">&#160;</td></tr>
 141 <tr class="memitem:aae0c9f2cf99b1724ec4a6d4e292327d2"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_allocator.xhtml#aae0c9f2cf99b1724ec4a6d4e292327d2">allocate</a> (size_t size, size_t alignment) override</td></tr>
 142 <tr class="memdesc:aae0c9f2cf99b1724ec4a6d4e292327d2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Interface to be implemented by the child class to allocate bytes.  <a href="#aae0c9f2cf99b1724ec4a6d4e292327d2">More...</a><br /></td></tr>
 143 <tr class="separator:aae0c9f2cf99b1724ec4a6d4e292327d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
 144 <tr class="memitem:abbd17af5b3fbeff226e4051433c1b929"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_allocator.xhtml#abbd17af5b3fbeff226e4051433c1b929">free</a> (void *ptr) override</td></tr>
 145 <tr class="memdesc:abbd17af5b3fbeff226e4051433c1b929"><td class="mdescLeft">&#160;</td><td class="mdescRight">Interface to be implemented by the child class to free the allocated tensor.  <a href="#abbd17af5b3fbeff226e4051433c1b929">More...</a><br /></td></tr>
 146 <tr class="separator:abbd17af5b3fbeff226e4051433c1b929"><td class="memSeparator" colspan="2">&#160;</td></tr>
 147 <tr class="memitem:a648cdc4602e8c7ec89180da37892db31"><td class="memItemLeft" align="right" valign="top">std::unique_ptr&lt; <a class="el" href="classarm__compute_1_1_i_memory_region.xhtml">IMemoryRegion</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_allocator.xhtml#a648cdc4602e8c7ec89180da37892db31">make_region</a> (size_t size, size_t alignment) override</td></tr>
 148 <tr class="memdesc:a648cdc4602e8c7ec89180da37892db31"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create self-managed memory region.  <a href="#a648cdc4602e8c7ec89180da37892db31">More...</a><br /></td></tr>
 149 <tr class="separator:a648cdc4602e8c7ec89180da37892db31"><td class="memSeparator" colspan="2">&#160;</td></tr>
 150 <tr class="inherit_header pub_methods_classarm__compute_1_1_i_allocator"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarm__compute_1_1_i_allocator')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classarm__compute_1_1_i_allocator.xhtml">IAllocator</a></td></tr>
 151 <tr class="memitem:a961a3c35d2c2652499f722ea14775122 inherit pub_methods_classarm__compute_1_1_i_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_allocator.xhtml#a961a3c35d2c2652499f722ea14775122">~IAllocator</a> ()=default</td></tr>
 152 <tr class="memdesc:a961a3c35d2c2652499f722ea14775122 inherit pub_methods_classarm__compute_1_1_i_allocator"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default virtual destructor.  <a href="#a961a3c35d2c2652499f722ea14775122">More...</a><br /></td></tr>
 153 <tr class="separator:a961a3c35d2c2652499f722ea14775122 inherit pub_methods_classarm__compute_1_1_i_allocator"><td class="memSeparator" colspan="2">&#160;</td></tr>
 154 </table>
 155 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 156 <div class="textblock"><p>Default malloc allocator implementation. </p>
 157
 158 <p>Definition at line <a class="el" href="_allocator_8h_source.xhtml#l00036">36</a> of file <a class="el" href="_allocator_8h_source.xhtml">Allocator.h</a>.</p>
 159 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 160 <a class="anchor" id="a20ec13b471d9434e1c3dd9d93c004e07"></a>
 161 <div class="memitem">
 162 <div class="memproto">
 163 <table class="mlabels">
 164   <tr>
 165   <td class="mlabels-left">
 166       <table class="memname">
 167         <tr>
 168           <td class="memname"><a class="el" href="classarm__compute_1_1_allocator.xhtml">Allocator</a> </td>
 169           <td>(</td>
 170           <td class="paramname"></td><td>)</td>
 171           <td></td>
 172         </tr>
 173       </table>
 174   </td>
 175   <td class="mlabels-right">
 176 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
 177   </tr>
 178 </table>
 179 </div><div class="memdoc">
 180
 181 <p>Default constructor. </p>
 182
 183 </div>
 184 </div>
 185 <h2 class="groupheader">Member Function Documentation</h2>
 186 <a class="anchor" id="aae0c9f2cf99b1724ec4a6d4e292327d2"></a>
 187 <div class="memitem">
 188 <div class="memproto">
 189 <table class="mlabels">
 190   <tr>
 191   <td class="mlabels-left">
 192       <table class="memname">
 193         <tr>
 194           <td class="memname">void* allocate </td>
 195           <td>(</td>
 196           <td class="paramtype">size_t&#160;</td>
 197           <td class="paramname"><em>size</em>, </td>
 198         </tr>
 199         <tr>
 200           <td class="paramkey"></td>
 201           <td></td>
 202           <td class="paramtype">size_t&#160;</td>
 203           <td class="paramname"><em>alignment</em>&#160;</td>
 204         </tr>
 205         <tr>
 206           <td></td>
 207           <td>)</td>
 208           <td></td><td></td>
 209         </tr>
 210       </table>
 211   </td>
 212   <td class="mlabels-right">
 213 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
 214   </tr>
 215 </table>
 216 </div><div class="memdoc">
 217
 218 <p>Interface to be implemented by the child class to allocate bytes. </p>
 219 <dl class="params"><dt>Parameters</dt><dd>
 220   <table class="params">
 221     <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>Size to allocate </td></tr>
 222     <tr><td class="paramdir">[in]</td><td class="paramname">alignment</td><td>Alignment that the returned pointer should comply with</td></tr>
 223   </table>
 224   </dd>
 225 </dl>
 226 <dl class="section return"><dt>Returns</dt><dd>A pointer to the allocated memory </dd></dl>
 227
 228 <p>Implements <a class="el" href="classarm__compute_1_1_i_allocator.xhtml#a6ce9dda753afa9abb498f3d6b673e595">IAllocator</a>.</p>
 229
 230 </div>
 231 </div>
 232 <a class="anchor" id="abbd17af5b3fbeff226e4051433c1b929"></a>
 233 <div class="memitem">
 234 <div class="memproto">
 235 <table class="mlabels">
 236   <tr>
 237   <td class="mlabels-left">
 238       <table class="memname">
 239         <tr>
 240           <td class="memname">void free </td>
 241           <td>(</td>
 242           <td class="paramtype">void *&#160;</td>
 243           <td class="paramname"><em>ptr</em></td><td>)</td>
 244           <td></td>
 245         </tr>
 246       </table>
 247   </td>
 248   <td class="mlabels-right">
 249 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
 250   </tr>
 251 </table>
 252 </div><div class="memdoc">
 253
 254 <p>Interface to be implemented by the child class to free the allocated tensor. </p>
 255
 256 <p>Implements <a class="el" href="classarm__compute_1_1_i_allocator.xhtml#a7dbeba9295a3f52ea54698c31e555dff">IAllocator</a>.</p>
 257
 258 </div>
 259 </div>
 260 <a class="anchor" id="a648cdc4602e8c7ec89180da37892db31"></a>
 261 <div class="memitem">
 262 <div class="memproto">
 263 <table class="mlabels">
 264   <tr>
 265   <td class="mlabels-left">
 266       <table class="memname">
 267         <tr>
 268           <td class="memname">std::unique_ptr&lt;<a class="el" href="classarm__compute_1_1_i_memory_region.xhtml">IMemoryRegion</a>&gt; make_region </td>
 269           <td>(</td>
 270           <td class="paramtype">size_t&#160;</td>
 271           <td class="paramname"><em>size</em>, </td>
 272         </tr>
 273         <tr>
 274           <td class="paramkey"></td>
 275           <td></td>
 276           <td class="paramtype">size_t&#160;</td>
 277           <td class="paramname"><em>alignment</em>&#160;</td>
 278         </tr>
 279         <tr>
 280           <td></td>
 281           <td>)</td>
 282           <td></td><td></td>
 283         </tr>
 284       </table>
 285   </td>
 286   <td class="mlabels-right">
 287 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
 288   </tr>
 289 </table>
 290 </div><div class="memdoc">
 291
 292 <p>Create self-managed memory region. </p>
 293 <dl class="params"><dt>Parameters</dt><dd>
 294   <table class="params">
 295     <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>Size of the memory region </td></tr>
 296     <tr><td class="paramdir">[in]</td><td class="paramname">alignment</td><td>Alignment of the memory region</td></tr>
 297   </table>
 298   </dd>
 299 </dl>
 300 <dl class="section return"><dt>Returns</dt><dd>The memory region object </dd></dl>
 301
 302 <p>Implements <a class="el" href="classarm__compute_1_1_i_allocator.xhtml#a9cff197f588f77bba9055f0baa690370">IAllocator</a>.</p>
 303
 304 </div>
 305 </div>
 306 <hr/>The documentation for this class was generated from the following file:<ul>
 307 <li>arm_compute/runtime/<a class="el" href="_allocator_8h_source.xhtml">Allocator.h</a></li>
 308 </ul>
 309 </div><!-- contents -->
 310 </div><!-- doc-content -->
 311 <!-- start footer part -->
 312 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 313   <ul>
 314     <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_allocator.xhtml">Allocator</a></li>
 315     <li class="footer">Generated on Wed May 23 2018 11:36:40 for Compute Library by
 316     <a href="http://www.doxygen.org/index.html">
 317     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
 318   </ul>
 319 </div>
 320 </body>
 321 </html>