se::MemoryPool< NodeT, BlockT > Class Template Reference

Manages memory for se::Octree nodes and blocks in an efficient manner. More...

#include <memory_pool.hpp>

Public Member Functions
NodeT *	allocateRoot (const Eigen::Vector3i &coord, const int size)
	Allocate the root node with coordinates in voxels coord and edge length in voxels size.
NodeT *	allocateNode (NodeT *const parent_ptr, const int child_idx, const typename NodeT::DataType &init_data)
	Return a pointer to a newly allocated node that is the child with index child_idx of parent_ptr and initialize it with init_data.
BlockT *	allocateBlock (NodeT *const parent_ptr, const int child_idx, const typename BlockT::DataType &init_data)
	Return a pointer to a newly allocated block that is the child with index child_idx of parent_ptr and initialise it with init_data.
void	deleteNode (NodeT *const node_ptr)
	Destruct and deallocate the node pointed to by node_ptr.
void	deleteBlock (BlockT *const block_ptr)
	Destruct and deallocate the block pointed to by block_ptr.

Detailed Description

template<typename NodeT, typename BlockT>
class se::MemoryPool< NodeT, BlockT >

Manages memory for se::Octree nodes and blocks in an efficient manner.

The destructors of all still allocated nodes and blocks are called on destruction of the se::MemoryPool object. User code shouldn't use se::MemoryPool directly as all usage is internal in se::Octree.

Warning

Never deallocate nodes/blocks created through se::MemoryPool using delete.

Note

Since se::MemoryPool does its own memory management on top of large heap allocations, it can mask certain use-after-free or out-of-bounds-access bugs and make them undetectable to the address sanitizer (ASAN). If you suspect such issues, use se::NullMemoryPool instead.

Member Function Documentation

allocateRoot()

template<typename NodeT , typename BlockT >

NodeT * se::MemoryPool< NodeT, BlockT >::allocateRoot ( const Eigen::Vector3i &  coord, const int  size  )

inline

Allocate the root node with coordinates in voxels coord and edge length in voxels size.

allocateNode()

template<typename NodeT , typename BlockT >

NodeT * se::MemoryPool< NodeT, BlockT >::allocateNode ( NodeT *const  parent_ptr, const int  child_idx, const typename NodeT::DataType &  init_data  )

inline

Return a pointer to a newly allocated node that is the child with index child_idx of parent_ptr and initialize it with init_data.

allocateBlock()

template<typename NodeT , typename BlockT >

BlockT * se::MemoryPool< NodeT, BlockT >::allocateBlock ( NodeT *const  parent_ptr, const int  child_idx, const typename BlockT::DataType &  init_data  )

inline

Return a pointer to a newly allocated block that is the child with index child_idx of parent_ptr and initialise it with init_data.

deleteNode()

template<typename NodeT , typename BlockT >

void se::MemoryPool< NodeT, BlockT >::deleteNode ( NodeT *const  node_ptr )

inline

Destruct and deallocate the node pointed to by node_ptr.

deleteBlock()

template<typename NodeT , typename BlockT >

void se::MemoryPool< NodeT, BlockT >::deleteBlock ( BlockT *const  block_ptr )

inline

Destruct and deallocate the block pointed to by block_ptr.

---

The documentation for this class was generated from the following file:

• include/se/map/utils/memory_pool.hpp