<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Memory utilities</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<div align="left"><a href="http://www.mrpt.org/">Main MRPT website</a> > <b>C++ reference</b> </div>
<div align="right">
<a href="index.html"><img border="0" src="mrpt_logo.png" alt="MRPT logo"></a>
</div>
<!-- Generated by Doxygen 1.7.5 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<div class="left">
<form id="FSearchBox" action="search.php" method="get">
<img id="MSearchSelect" src="search/mag.png" alt=""/>
<input type="text" id="MSearchField" name="query" value="Search" size="20" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"/>
</form>
</div><div class="right"></div>
</div>
</li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#define-members">Defines</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Memory utilities</div> </div>
<div class="ingroups"><a class="el" href="group__mrpt__base__grp.html">[mrpt-base]</a></div></div>
<div class="contents">
<div class="dynheader">
Collaboration diagram for Memory utilities:</div>
<div class="dyncontent">
<center><table><tr><td><img src="group__mrpt__memory.png" border="0" alt="" usemap="#group____mrpt____memory"/>
<map name="group____mrpt____memory" id="group____mrpt____memory">
<area shape="rect" id="node2" href="group__mrpt__base__grp.html" title=" Back to list of all libraries | See all modules   " alt="" coords="5,5,93,32"/></map>
</td></tr></table></center>
</div>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1system_1_1_c_generic_memory_pool.html">mrpt::system::CGenericMemoryPool</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A generic system for versatile memory pooling. <a href="classmrpt_1_1system_1_1_c_generic_memory_pool.html#details">More...</a><br/></td></tr>
<tr><td colspan="2"><h2><a name="define-members"></a>
Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mrpt__memory.html#ga773b27da13cd1f6538e738b7a84e38af">mrpt_alloca</a>(nBytes)   ::malloc( nBytes )</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">In platforms and compilers with support to "alloca", allocate a memory block on the stack; if alloca is not supported, it is emulated as a normal "malloc" - NOTICE: Since in some platforms alloca will be emulated with malloc, alloca_free MUST BE ALWAYS CALLED to avoid memory leaks. <a href="#ga773b27da13cd1f6538e738b7a84e38af"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mrpt__memory.html#ga12a8436a4cf3392c2f09a72348e7493c">mrpt_alloca_free</a>(mem_block)   free(mem_block)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This method must be called to "free" each memory block allocated with "system::alloca": If the block was really allocated in the stack, no operation is actually performed, otherwise it will be freed from the heap. <a href="#ga12a8436a4cf3392c2f09a72348e7493c"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned long BASE_IMPEXP </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mrpt__memory.html#ga7a11bc87455d4f9872ec600738984bdb">mrpt::system::getMemoryUsage</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the memory occupied by this process, in bytes. <a href="#ga7a11bc87455d4f9872ec600738984bdb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void BASE_IMPEXP * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mrpt__memory.html#ga40295c41a02e957fdfb7af5a747fec4e">mrpt::system::os::aligned_malloc</a> (size_t bytes, size_t alignment)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns an aligned memory block. <a href="#ga40295c41a02e957fdfb7af5a747fec4e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mrpt__memory.html#ga1f0f740a33507bf943af5bac26e3abb0">mrpt::system::os::aligned_calloc</a> (size_t bytes, size_t alignment)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Identical to aligned_malloc, but it zeroes the reserved memory block. <a href="#ga1f0f740a33507bf943af5bac26e3abb0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void BASE_IMPEXP * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mrpt__memory.html#gaa0dd8ec272a9f40a191342057c185bd9">mrpt::system::os::aligned_realloc</a> (void *old_ptr, size_t bytes, size_t alignment)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Frees a memory block reserved by aligned_malloc. <a href="#gaa0dd8ec272a9f40a191342057c185bd9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void BASE_IMPEXP </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mrpt__memory.html#gab6aa729988ee1bd79ce4922b0bfc1f54">mrpt::system::os::aligned_free</a> (void *p)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Frees a memory block reserved by aligned_malloc. <a href="#gab6aa729988ee1bd79ce4922b0bfc1f54"></a><br/></td></tr>
<tr><td class="memTemplParams" colspan="2">template<typename _Tp > </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">_Tp * </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__mrpt__memory.html#ga372ba514a63401a3640a6192f862d505">mrpt::system::os::align_ptr</a> (_Tp *ptr, int n=(int) sizeof(_Tp))</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a pointer a bit forward in memory so it's aligned for the given boundary size. <a href="#ga372ba514a63401a3640a6192f862d505"></a><br/></td></tr>
<tr><td class="memTemplParams" colspan="2">template<int bytes> </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__mrpt__memory.html#gaefbd4b4d009c6f9c1f6854a2e8427f7f">mrpt::system::is_aligned</a> (const void *ptr)</td></tr>
<tr><td class="memTemplParams" colspan="2">template<> </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__mrpt__memory.html#ga1aed56ab90771422af91b43cffa87fca">mrpt::system::is_aligned< 8 ></a> (const void *ptr)</td></tr>
<tr><td class="memTemplParams" colspan="2">template<> </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__mrpt__memory.html#ga30bdcea01a57d36fbcb4f8f7c595e840">mrpt::system::is_aligned< 16 ></a> (const void *ptr)</td></tr>
</table>
<hr/><h2>Define Documentation</h2>
<a class="anchor" id="ga773b27da13cd1f6538e738b7a84e38af"></a><!-- doxytag: member="memory.h::mrpt_alloca" ref="ga773b27da13cd1f6538e738b7a84e38af" args="(nBytes)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define mrpt_alloca</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">nBytes</td><td>)</td>
<td>   ::malloc( nBytes )</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>In platforms and compilers with support to "alloca", allocate a memory block on the stack; if alloca is not supported, it is emulated as a normal "malloc" - NOTICE: Since in some platforms alloca will be emulated with malloc, alloca_free MUST BE ALWAYS CALLED to avoid memory leaks. </p>
<p>This method MUST BE a macro rather than a function in order to operate on the caller's stack. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="group__mrpt__memory.html#ga12a8436a4cf3392c2f09a72348e7493c" title="This method must be called to "free" each memory block allocated with "system::alloca": If the block ...">mrpt_alloca_free</a> </dd></dl>
<p>Definition at line <a class="el" href="memory_8h_source.html#l00056">56</a> of file <a class="el" href="memory_8h_source.html">memory.h</a>.</p>
</div>
</div>
<a class="anchor" id="ga12a8436a4cf3392c2f09a72348e7493c"></a><!-- doxytag: member="memory.h::mrpt_alloca_free" ref="ga12a8436a4cf3392c2f09a72348e7493c" args="(mem_block)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define mrpt_alloca_free</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">mem_block</td><td>)</td>
<td>   free(mem_block)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This method must be called to "free" each memory block allocated with "system::alloca": If the block was really allocated in the stack, no operation is actually performed, otherwise it will be freed from the heap. </p>
<p>This method MUST BE a macro rather than a function in order to operate on the caller's stack. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="group__mrpt__memory.html#ga773b27da13cd1f6538e738b7a84e38af" title="In platforms and compilers with support to "alloca", allocate a memory block on the stack; if alloca ...">mrpt_alloca</a> </dd></dl>
<p>Definition at line <a class="el" href="memory_8h_source.html#l00071">71</a> of file <a class="el" href="memory_8h_source.html">memory.h</a>.</p>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga372ba514a63401a3640a6192f862d505"></a><!-- doxytag: member="mrpt::system::os::align_ptr" ref="ga372ba514a63401a3640a6192f862d505" args="(_Tp *ptr, int n=(int) sizeof(_Tp))" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename _Tp > </div>
<table class="memname">
<tr>
<td class="memname">_Tp* mrpt::system::os::align_ptr </td>
<td>(</td>
<td class="paramtype">_Tp * </td>
<td class="paramname"><em>ptr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>n</em> = <code>(int)sizeof(_Tp)</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a pointer a bit forward in memory so it's aligned for the given boundary size. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>Function copied from OpenCV with a different name to avoid conflicts. </dd></dl>
<p>Definition at line <a class="el" href="memory_8h_source.html#l00111">111</a> of file <a class="el" href="memory_8h_source.html">memory.h</a>.</p>
</div>
</div>
<a class="anchor" id="ga1f0f740a33507bf943af5bac26e3abb0"></a><!-- doxytag: member="mrpt::system::os::aligned_calloc" ref="ga1f0f740a33507bf943af5bac26e3abb0" args="(size_t bytes, size_t alignment)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* mrpt::system::os::aligned_calloc </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>bytes</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><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Identical to aligned_malloc, but it zeroes the reserved memory block. </p>
<p>Definition at line <a class="el" href="memory_8h_source.html#l00089">89</a> of file <a class="el" href="memory_8h_source.html">memory.h</a>.</p>
<p>References <a class="el" href="group__mrpt__memory.html#ga40295c41a02e957fdfb7af5a747fec4e">mrpt::system::os::aligned_malloc()</a>.</p>
<p>Referenced by <a class="el" href="_c_matrix_template_8h_source.html#l00077">mrpt::math::CMatrixTemplate< TPoint3D >::realloc()</a>.</p>
</div>
</div>
<a class="anchor" id="gab6aa729988ee1bd79ce4922b0bfc1f54"></a><!-- doxytag: member="mrpt::system::os::aligned_free" ref="gab6aa729988ee1bd79ce4922b0bfc1f54" args="(void *p)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void BASE_IMPEXP mrpt::system::os::aligned_free </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>p</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Frees a memory block reserved by aligned_malloc. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="group__mrpt__memory.html#ga40295c41a02e957fdfb7af5a747fec4e" title="Returns an aligned memory block.">aligned_malloc</a> </dd></dl>
<p>Definition at line <a class="el" href="_core_source.html#l00225">225</a> of file <a class="el" href="_core_source.html">Core</a>.</p>
<p>Referenced by <a class="el" href="_c_matrix_template_8h_source.html#l00077">mrpt::math::CMatrixTemplate< TPoint3D >::realloc()</a>.</p>
</div>
</div>
<a class="anchor" id="ga40295c41a02e957fdfb7af5a747fec4e"></a><!-- doxytag: member="mrpt::system::os::aligned_malloc" ref="ga40295c41a02e957fdfb7af5a747fec4e" args="(size_t bytes, size_t alignment)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void BASE_IMPEXP* mrpt::system::os::aligned_malloc </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>bytes</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>
</div>
<div class="memdoc">
<p>Returns an aligned memory block. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">alignment</td><td>The desired alignment, typ. 8 or 16 bytes. 1 means no alignment required. It must be a power of two. </td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="group__mrpt__memory.html#gab6aa729988ee1bd79ce4922b0bfc1f54" title="Frees a memory block reserved by aligned_malloc.">aligned_free</a>, <a class="el" href="group__mrpt__memory.html#gaa0dd8ec272a9f40a191342057c185bd9" title="Frees a memory block reserved by aligned_malloc.">aligned_realloc</a>, <a class="el" href="group__mrpt__memory.html#ga1f0f740a33507bf943af5bac26e3abb0" title="Identical to aligned_malloc, but it zeroes the reserved memory block.">aligned_calloc</a> </dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>Based on code by William Chan </dd></dl>
<p>Referenced by <a class="el" href="memory_8h_source.html#l00089">mrpt::system::os::aligned_calloc()</a>.</p>
</div>
</div>
<a class="anchor" id="gaa0dd8ec272a9f40a191342057c185bd9"></a><!-- doxytag: member="mrpt::system::os::aligned_realloc" ref="gaa0dd8ec272a9f40a191342057c185bd9" args="(void *old_ptr, size_t bytes, size_t alignment)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void BASE_IMPEXP* mrpt::system::os::aligned_realloc </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>old_ptr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>bytes</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><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Frees a memory block reserved by aligned_malloc. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">alignment</td><td>The desired alignment, typ. 8 or 16 bytes. 1 means no alignment required. If old_ptr is NULL, a new block will be reserved from scratch. </td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="group__mrpt__memory.html#ga40295c41a02e957fdfb7af5a747fec4e" title="Returns an aligned memory block.">aligned_malloc</a>, <a class="el" href="group__mrpt__memory.html#gab6aa729988ee1bd79ce4922b0bfc1f54" title="Frees a memory block reserved by aligned_malloc.">aligned_free</a> </dd></dl>
<p>Definition at line <a class="el" href="_core_source.html#l00247">247</a> of file <a class="el" href="_core_source.html">Core</a>.</p>
<p>Referenced by <a class="el" href="_c_matrix_template_8h_source.html#l00077">mrpt::math::CMatrixTemplate< TPoint3D >::realloc()</a>.</p>
</div>
</div>
<a class="anchor" id="ga7a11bc87455d4f9872ec600738984bdb"></a><!-- doxytag: member="mrpt::system::getMemoryUsage" ref="ga7a11bc87455d4f9872ec600738984bdb" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned long BASE_IMPEXP mrpt::system::getMemoryUsage </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the memory occupied by this process, in bytes. </p>
</div>
</div>
<a class="anchor" id="gaefbd4b4d009c6f9c1f6854a2e8427f7f"></a><!-- doxytag: member="mrpt::system::is_aligned" ref="gaefbd4b4d009c6f9c1f6854a2e8427f7f" args="(const void *ptr)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<int bytes> </div>
<table class="memname">
<tr>
<td class="memname">bool mrpt::system::is_aligned </td>
<td>(</td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>ptr</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ga30bdcea01a57d36fbcb4f8f7c595e840"></a><!-- doxytag: member="mrpt::system::is_aligned< 16 >" ref="ga30bdcea01a57d36fbcb4f8f7c595e840" args="(const void *ptr)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<> </div>
<table class="memname">
<tr>
<td class="memname">bool mrpt::system::is_aligned< 16 > </td>
<td>(</td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>ptr</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="memory_8h_source.html#l00125">125</a> of file <a class="el" href="memory_8h_source.html">memory.h</a>.</p>
</div>
</div>
<a class="anchor" id="ga1aed56ab90771422af91b43cffa87fca"></a><!-- doxytag: member="mrpt::system::is_aligned< 8 >" ref="ga1aed56ab90771422af91b43cffa87fca" args="(const void *ptr)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<> </div>
<table class="memname">
<tr>
<td class="memname">bool mrpt::system::is_aligned< 8 > </td>
<td>(</td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>ptr</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="memory_8h_source.html#l00124">124</a> of file <a class="el" href="memory_8h_source.html">memory.h</a>.</p>
</div>
</div>
</div>
<br><hr><br> <table border="0" width="100%"> <tr> <td> Page generated by <a href="http://www.doxygen.org" target="_blank">Doxygen 1.7.5</a> for MRPT 0.9.5 SVN: at Sun Sep 25 17:20:18 UTC 2011</td><td></td> <td width="100"> </td> <td width="150"> </td></tr> </table> </body></html>
