Main MRPT website > C++ reference for MRPT 1.5.6
Classes | Macros | Functions
Memory utilities (in #include <mrpt/system/memory.h>)

Detailed Description

Collaboration diagram for Memory utilities (in #include <mrpt/system/memory.h>):

Classes

class  mrpt::system::CGenericMemoryPool< DATA_PARAMS, POOLABLE_DATA >
 A generic system for versatile memory pooling. More...
 

Macros

#define mrpt_alloca(nBytes)   ::malloc( nBytes )
 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. More...
 
#define mrpt_alloca_free(mem_block)   free(mem_block)
 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. More...
 

Functions

unsigned long BASE_IMPEXP mrpt::system::getMemoryUsage ()
 Returns the memory occupied by this process, in bytes. More...
 
void BASE_IMPEXPmrpt::system::os::aligned_malloc (size_t bytes, size_t alignment)
 Returns an aligned memory block. More...
 
voidmrpt::system::os::aligned_calloc (size_t bytes, size_t alignment)
 Identical to aligned_malloc, but it zeroes the reserved memory block. More...
 
void BASE_IMPEXPmrpt::system::os::aligned_realloc (void *old_ptr, size_t bytes, size_t alignment)
 Frees a memory block reserved by aligned_malloc. More...
 
void BASE_IMPEXP mrpt::system::os::aligned_free (void *p)
 Frees a memory block reserved by aligned_malloc. More...
 
template<typename _Tp >
_Tp * mrpt::system::os::align_ptr (_Tp *ptr, int n=(int) sizeof(_Tp))
 Returns a pointer a bit forward in memory so it's aligned for the given boundary size. More...
 
template<int bytes>
bool mrpt::system::is_aligned (const void *ptr)
 
template<>
bool mrpt::system::is_aligned< 8 > (const void *ptr)
 
template<>
bool mrpt::system::is_aligned< 16 > (const void *ptr)
 

Macro Definition Documentation

#define mrpt_alloca (   nBytes)    ::malloc( nBytes )

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.

This method MUST BE a macro rather than a function in order to operate on the caller's stack.

See Also
mrpt_alloca_free

Definition at line 38 of file memory.h.

Referenced by mrpt::maps::COccupancyGridMap2D::internal_insertObservation(), and mrpt::vision::CFeatureTracker_KL::trackFeatures_impl_templ().

#define mrpt_alloca_free (   mem_block)    free(mem_block)

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.

This method MUST BE a macro rather than a function in order to operate on the caller's stack.

See Also
mrpt_alloca

Definition at line 53 of file memory.h.

Referenced by mrpt::maps::COccupancyGridMap2D::internal_insertObservation(), and mrpt::vision::CFeatureTracker_KL::trackFeatures_impl_templ().

Function Documentation

template<typename _Tp >
_Tp* mrpt::system::os::align_ptr ( _Tp *  ptr,
int  n = (int)sizeof(_Tp) 
)
inline

Returns a pointer a bit forward in memory so it's aligned for the given boundary size.

Note
Function copied from OpenCV with a different name to avoid conflicts.

Definition at line 93 of file memory.h.

void* mrpt::system::os::aligned_calloc ( size_t  bytes,
size_t  alignment 
)
inline

Identical to aligned_malloc, but it zeroes the reserved memory block.

Definition at line 71 of file memory.h.

References mrpt::system::os::aligned_malloc().

Referenced by mrpt::math::CMatrixTemplate< mrpt::math::TPoint3D >::realloc().

void mrpt::system::os::aligned_free ( void p)

Frees a memory block reserved by aligned_malloc.

See Also
aligned_malloc

Definition at line 82 of file memory.cpp.

Referenced by mrpt::math::CMatrixTemplate< mrpt::math::TPoint3D >::realloc().

void * mrpt::system::os::aligned_malloc ( size_t  bytes,
size_t  alignment 
)

Returns an aligned memory block.

Parameters
alignmentThe desired alignment, typ. 8 or 16 bytes. 1 means no alignment required. It must be a power of two.
See Also
aligned_free, aligned_realloc, aligned_calloc
Note
Based on code by William Chan
Parameters
alignmentThe desired alignment, typ. 8 or 16 bytes. 1 means no alignment required. It must be a power of two.
See Also
aligned_free, aligned_realloc
Note
Based on code by William Chan

Definition at line 37 of file memory.cpp.

References THROW_EXCEPTION.

Referenced by mrpt::system::os::aligned_calloc().

void * mrpt::system::os::aligned_realloc ( void old_ptr,
size_t  bytes,
size_t  alignment 
)

Frees a memory block reserved by aligned_malloc.

Parameters
alignmentThe 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.
See Also
aligned_malloc, aligned_free

Definition at line 61 of file memory.cpp.

References MRPT_UNUSED_PARAM.

Referenced by mrpt::math::CMatrixTemplate< mrpt::math::TPoint3D >::realloc().

unsigned long mrpt::system::getMemoryUsage ( )

Returns the memory occupied by this process, in bytes.

Definition at line 182 of file memory.cpp.

References mrpt::system::os::fclose(), mrpt::system::os::fopen(), info, MEM, MRPT_END, and MRPT_START.

Referenced by mrpt::hmtslam::CHMTSLAM::generateLogFiles().

template<int bytes>
bool mrpt::system::is_aligned ( const void ptr)
template<>
bool mrpt::system::is_aligned< 16 > ( const void ptr)
inline
template<>
bool mrpt::system::is_aligned< 8 > ( const void ptr)
inline

Definition at line 106 of file memory.h.




Page generated by Doxygen 1.8.6 for MRPT 1.5.6 Git: 4c65e84 Tue Apr 24 08:18:17 2018 +0200 at mar abr 24 08:26:17 CEST 2018