| <!-- HTML header for doxygen 1.8.15--> |
| <!-- Remember to use version doxygen 1.8.15 +--> |
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| <meta name="generator" content="Doxygen 1.8.15"/> |
| <meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines --> |
| <title>Compute Library: IAllocator Class Reference</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="jquery.js"></script> |
| <script type="text/javascript" src="dynsections.js"></script> |
| <link href="navtree.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="resize.js"></script> |
| <script type="text/javascript" src="navtreedata.js"></script> |
| <script type="text/javascript" src="navtree.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(document).ready(initResizable); |
| /* @license-end */</script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="search/searchdata.js"></script> |
| <script type="text/javascript" src="search/search.js"></script> |
| <script type="text/x-mathjax-config"> |
| MathJax.Hub.Config({ |
| extensions: ["tex2jax.js"], |
| jax: ["input/TeX","output/HTML-CSS"], |
| }); |
| </script><script type="text/javascript" async="async" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| <link href="stylesheet.css" rel="stylesheet" type="text/css"/> |
| </head> |
| <body> |
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| <div id="titlearea"> |
| <table cellspacing="0" cellpadding="0"> |
| <tbody> |
| <tr style="height: 56px;"> |
| <img alt="Compute Library" src="https://raw.githubusercontent.com/ARM-software/ComputeLibrary/gh-pages/ACL_logo.png" style="max-width: 100%;margin-top: 15px;margin-left: 10px"/> |
| <td style="padding-left: 0.5em;"> |
| <div id="projectname"> |
|  <span id="projectnumber">19.08</span> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.15 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| /* @license-end */ |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| /* @license-end */</script> |
| <div id="main-nav"></div> |
| </div><!-- top --> |
| <div id="side-nav" class="ui-resizable side-nav-resizable"> |
| <div id="nav-tree"> |
| <div id="nav-tree-contents"> |
| <div id="nav-sync" class="sync"></div> |
| </div> |
| </div> |
| <div id="splitbar" style="-moz-user-select:none;" |
| class="ui-resizable-handle"> |
| </div> |
| </div> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(document).ready(function(){initNavTree('classarm__compute_1_1_i_allocator.xhtml','');}); |
| /* @license-end */ |
| </script> |
| <div id="doc-content"> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| </div> |
| |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <iframe src="javascript:void(0)" frameborder="0" |
| name="MSearchResults" id="MSearchResults"> |
| </iframe> |
| </div> |
| |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> </div> |
| <div class="headertitle"> |
| <div class="title">IAllocator Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p><a class="el" href="classarm__compute_1_1_allocator.xhtml" title="Default malloc allocator implementation.">Allocator</a> interface. |
| <a href="classarm__compute_1_1_i_allocator.xhtml#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="_i_allocator_8h_source.xhtml">IAllocator.h</a>></code></p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr class="memitem:a961a3c35d2c2652499f722ea14775122"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_allocator.xhtml#a961a3c35d2c2652499f722ea14775122">~IAllocator</a> ()=default</td></tr> |
| <tr class="memdesc:a961a3c35d2c2652499f722ea14775122"><td class="mdescLeft"> </td><td class="mdescRight">Default virtual destructor. <a href="#a961a3c35d2c2652499f722ea14775122">More...</a><br /></td></tr> |
| <tr class="separator:a961a3c35d2c2652499f722ea14775122"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6ce9dda753afa9abb498f3d6b673e595"><td class="memItemLeft" align="right" valign="top">virtual void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_allocator.xhtml#a6ce9dda753afa9abb498f3d6b673e595">allocate</a> (size_t size, size_t alignment)=0</td></tr> |
| <tr class="memdesc:a6ce9dda753afa9abb498f3d6b673e595"><td class="mdescLeft"> </td><td class="mdescRight">Interface to be implemented by the child class to allocate bytes. <a href="#a6ce9dda753afa9abb498f3d6b673e595">More...</a><br /></td></tr> |
| <tr class="separator:a6ce9dda753afa9abb498f3d6b673e595"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7dbeba9295a3f52ea54698c31e555dff"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_allocator.xhtml#a7dbeba9295a3f52ea54698c31e555dff">free</a> (void *ptr)=0</td></tr> |
| <tr class="memdesc:a7dbeba9295a3f52ea54698c31e555dff"><td class="mdescLeft"> </td><td class="mdescRight">Interface to be implemented by the child class to free the allocated tensor. <a href="#a7dbeba9295a3f52ea54698c31e555dff">More...</a><br /></td></tr> |
| <tr class="separator:a7dbeba9295a3f52ea54698c31e555dff"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9cff197f588f77bba9055f0baa690370"><td class="memItemLeft" align="right" valign="top">virtual std::unique_ptr< <a class="el" href="classarm__compute_1_1_i_memory_region.xhtml">IMemoryRegion</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_allocator.xhtml#a9cff197f588f77bba9055f0baa690370">make_region</a> (size_t size, size_t alignment)=0</td></tr> |
| <tr class="memdesc:a9cff197f588f77bba9055f0baa690370"><td class="mdescLeft"> </td><td class="mdescRight">Create self-managed memory region. <a href="#a9cff197f588f77bba9055f0baa690370">More...</a><br /></td></tr> |
| <tr class="separator:a9cff197f588f77bba9055f0baa690370"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p><a class="el" href="classarm__compute_1_1_allocator.xhtml" title="Default malloc allocator implementation.">Allocator</a> interface. </p> |
| |
| <p class="definition">Definition at line <a class="el" href="_i_allocator_8h_source.xhtml#l00035">35</a> of file <a class="el" href="_i_allocator_8h_source.xhtml">IAllocator.h</a>.</p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="a961a3c35d2c2652499f722ea14775122"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a961a3c35d2c2652499f722ea14775122">◆ </a></span>~IAllocator()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual ~<a class="el" href="classarm__compute_1_1_i_allocator.xhtml">IAllocator</a> </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">default</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Default virtual destructor. </p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a6ce9dda753afa9abb498f3d6b673e595"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a6ce9dda753afa9abb498f3d6b673e595">◆ </a></span>allocate()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual void* allocate </td> |
| <td>(</td> |
| <td class="paramtype">size_t </td> |
| <td class="paramname"><em>size</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">size_t </td> |
| <td class="paramname"><em>alignment</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Interface to be implemented by the child class to allocate bytes. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>Size to allocate </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">alignment</td><td>Alignment that the returned pointer should comply with</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>A pointer to the allocated memory </dd></dl> |
| |
| <p>Implemented in <a class="el" href="classarm__compute_1_1_c_l_buffer_allocator.xhtml#a4d12a487a34bbcc481147eac34c7a3a1">CLBufferAllocator</a>, <a class="el" href="classarm__compute_1_1_g_c_buffer_allocator.xhtml#a4d12a487a34bbcc481147eac34c7a3a1">GCBufferAllocator</a>, and <a class="el" href="classarm__compute_1_1_allocator.xhtml#a4d12a487a34bbcc481147eac34c7a3a1">Allocator</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a7dbeba9295a3f52ea54698c31e555dff"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a7dbeba9295a3f52ea54698c31e555dff">◆ </a></span>free()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual void free </td> |
| <td>(</td> |
| <td class="paramtype">void * </td> |
| <td class="paramname"><em>ptr</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Interface to be implemented by the child class to free the allocated tensor. </p> |
| |
| <p>Implemented in <a class="el" href="classarm__compute_1_1_c_l_buffer_allocator.xhtml#abbd17af5b3fbeff226e4051433c1b929">CLBufferAllocator</a>, <a class="el" href="classarm__compute_1_1_g_c_buffer_allocator.xhtml#abbd17af5b3fbeff226e4051433c1b929">GCBufferAllocator</a>, and <a class="el" href="classarm__compute_1_1_allocator.xhtml#abbd17af5b3fbeff226e4051433c1b929">Allocator</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a9cff197f588f77bba9055f0baa690370"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a9cff197f588f77bba9055f0baa690370">◆ </a></span>make_region()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual std::unique_ptr<<a class="el" href="classarm__compute_1_1_i_memory_region.xhtml">IMemoryRegion</a>> make_region </td> |
| <td>(</td> |
| <td class="paramtype">size_t </td> |
| <td class="paramname"><em>size</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">size_t </td> |
| <td class="paramname"><em>alignment</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Create self-managed memory region. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>Size of the memory region </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">alignment</td><td>Alignment of the memory region</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>The memory region object </dd></dl> |
| |
| <p>Implemented in <a class="el" href="classarm__compute_1_1_c_l_buffer_allocator.xhtml#a58e48dc69a5ad7e1d55d03e1ff894da7">CLBufferAllocator</a>, <a class="el" href="classarm__compute_1_1_g_c_buffer_allocator.xhtml#a58e48dc69a5ad7e1d55d03e1ff894da7">GCBufferAllocator</a>, and <a class="el" href="classarm__compute_1_1_allocator.xhtml#a58e48dc69a5ad7e1d55d03e1ff894da7">Allocator</a>.</p> |
| |
| <p class="reference">Referenced by <a class="el" href="_offset_memory_pool_8cpp_source.xhtml#l00037">OffsetMemoryPool::OffsetMemoryPool()</a>.</p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>arm_compute/runtime/<a class="el" href="_i_allocator_8h_source.xhtml">IAllocator.h</a></li> |
| </ul> |
| </div><!-- contents --> |
| </div><!-- doc-content --> |
| <!-- start footer part --> |
| <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> |
| <ul> |
| <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_allocator.xhtml">IAllocator</a></li> |
| <li class="footer">Generated on Mon Sep 2 2019 11:47:35 for Compute Library by |
| <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.15 </li> |
| </ul> |
| </div> |
| </body> |
| </html> |