libMesh
Classes | Public Member Functions | Static Public Member Functions | List of all members
libMesh::FastPoolAllocator< T > Class Template Reference

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

#include <pool_allocator.h>

Inheritance diagram for libMesh::FastPoolAllocator< T >:
[legend]

Classes

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

Public Member Functions

 FastPoolAllocator ()
 
 FastPoolAllocator (const FastPoolAllocator &o)
 
 FastPoolAllocator ()
 
 FastPoolAllocator (const FastPoolAllocator &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::FastPoolAllocator< 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 FastPoolAllocator is std::allocator when Boost is not available.

Definition at line 111 of file pool_allocator.h.

Constructor & Destructor Documentation

template<typename T >
libMesh::FastPoolAllocator< T >::FastPoolAllocator ( )

Definition at line 124 of file pool_allocator.h.

124  :
125  boost::fast_pool_allocator<T>()
126  {}
template<typename T >
libMesh::FastPoolAllocator< T >::FastPoolAllocator ( const FastPoolAllocator< T > &  o)
explicit

Definition at line 128 of file pool_allocator.h.

128  :
129  boost::fast_pool_allocator<T>(o)
130  {}
template<typename T >
libMesh::FastPoolAllocator< T >::FastPoolAllocator ( )

Definition at line 224 of file pool_allocator.h.

224  :
225  std::allocator<T>()
226  {}
template<typename T >
libMesh::FastPoolAllocator< T >::FastPoolAllocator ( const FastPoolAllocator< T > &  o)
explicit

Definition at line 228 of file pool_allocator.h.

228  :
229  std::allocator<T>(o)
230  {}

Member Function Documentation

template<typename T >
static bool libMesh::FastPoolAllocator< T >::purge_memory ( )
static

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 148 of file pool_allocator.h.

149  {
150  return boost::singleton_pool<boost::fast_pool_allocator_tag, sizeof(T)>::purge_memory();
151  }
template<typename T >
static bool libMesh::FastPoolAllocator< T >::purge_memory ( )
static

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 244 of file pool_allocator.h.

244 { /* no-op for std::allocator<> - already freed. */ return false; }
template<typename T >
static bool libMesh::FastPoolAllocator< T >::release_memory ( )
static

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

Returns
true if at least one memory block was freed.

Definition at line 137 of file pool_allocator.h.

138  {
139  return boost::singleton_pool<boost::fast_pool_allocator_tag, sizeof(T)>::release_memory();
140  }
template<typename T >
static bool libMesh::FastPoolAllocator< T >::release_memory ( )
static

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

Returns
true if at least one memory block was freed.

Definition at line 236 of file pool_allocator.h.

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

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