libMesh::PoolAllocator< T > Class Template Reference

An allocator which can be used in standard containers. More...

#include <pool_allocator.h>

Inheritance diagram for libMesh::PoolAllocator< T >:

Classes
struct	rebind
	Methods required for copy construction of containers using this allocator. More...

Public Member Functions
	PoolAllocator ()
	PoolAllocator (const PoolAllocator &o)
	PoolAllocator ()
	PoolAllocator (const PoolAllocator &o)

Static Public Member Functions
static bool	release_memory ()
	Frees every memory block that doesn't have any allocated chunks. More...
static bool	purge_memory ()
	Frees every memory block. More...
static bool	release_memory ()
	Frees every memory block that doesn't have any allocated chunks. More...
static bool	purge_memory ()
	Frees every memory block. More...

Detailed Description

template<typename T>
class libMesh::PoolAllocator< T >

An allocator which can be used in standard containers.

Uses pool-based memory allocation to efficiently allocate many small objects.

Note

Object destruction returns memory to the pool rather than deallocate it. It must be explicitly deallocated prior to program termination.

Author

Benjamin S. Kirk

Date

2011

Boost-derived allocator that can be used with std::containers.

A wrapper for std::allocator<> when Boost is not available.

Author

Benjamin S. Kirk

Date

2011

PoolAllocator is std::allocator when Boost is not available.

Definition at line 53 of file pool_allocator.h.

Constructor & Destructor Documentation

PoolAllocator() [1/4]

template<typename T >

libMesh::PoolAllocator< T >::PoolAllocator ( )

inline

Definition at line 66 of file pool_allocator.h.

                  :
    boost::pool_allocator<T>()
  {}

PoolAllocator() [2/4]

template<typename T >

libMesh::PoolAllocator< T >::PoolAllocator ( const PoolAllocator< T > &  o )

inlineexplicit

Definition at line 70 of file pool_allocator.h.

                                                  :
    boost::pool_allocator<T>(o)
  {}

PoolAllocator() [3/4]

template<typename T >

libMesh::PoolAllocator< T >::PoolAllocator ( )

inline

Definition at line 178 of file pool_allocator.h.

                  :
    std::allocator<T>()
  {}

PoolAllocator() [4/4]

template<typename T >

libMesh::PoolAllocator< T >::PoolAllocator ( const PoolAllocator< T > &  o )

inlineexplicit

Definition at line 182 of file pool_allocator.h.

                                                  :
    std::allocator<T>(o)
  {}

Member Function Documentation

purge_memory() [1/2]

template<typename T >

static bool libMesh::PoolAllocator< T >::purge_memory ( )

inlinestatic

Frees every memory block.

This function invalidates any pointers previously returned by allocation functions.

Returns

true if at least one memory block was freed.

Definition at line 89 of file pool_allocator.h.

  {
    return boost::singleton_pool<boost::pool_allocator_tag, sizeof(T)>::purge_memory();
  }

purge_memory() [2/2]

template<typename T >

static bool libMesh::PoolAllocator< T >::purge_memory ( )

inlinestatic

Frees every memory block.

This function invalidates any pointers previously returned by allocation functions.

Returns

true if at least one memory block was freed.

Definition at line 198 of file pool_allocator.h.

{ /* no-op for std::allocator<> - already freed. */ return false; }

release_memory() [1/2]

template<typename T >

static bool libMesh::PoolAllocator< T >::release_memory ( )

inlinestatic

Frees every memory block that doesn't have any allocated chunks.

Returns

true if at least one memory block was freed.

Definition at line 78 of file pool_allocator.h.

  {
    return boost::singleton_pool<boost::pool_allocator_tag, sizeof(T)>::release_memory();
  }

release_memory() [2/2]

template<typename T >

static bool libMesh::PoolAllocator< T >::release_memory ( )

inlinestatic

Frees every memory block that doesn't have any allocated chunks.

Returns

true if at least one memory block was freed.

Definition at line 190 of file pool_allocator.h.

{ /* no-op for std::allocator<> - already freed. */ return false; }

---

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

• include/utils/pool_allocator.h