PooledAllocator< T > Class Template Reference

A STL-compliant pooled memory allocator. Much more efficient for lists of small data structures.

Data Structures

• struct rebind

  A struct to construct an allocator for a different type. More...
  

Public Types

• typedef size_t size_type

  A type that can represent the size of the largest object in the allocation model.
  

• typedef ptrdiff_t difference_type

  A type that can represent the difference between any two pointers in the allocation model.
  

• typedef T value_type

  Identical to T.
  

• typedef T * pointer

  Pointer to T;.
  

• typedef T const * const_pointer

  Pointer to const T.
  

• typedef T & reference

  Reference to T.
  

• typedef T const & const_reference

  Reference to const T.
  

Public Member Functions

• PooledAllocator (Pool *pool=0)

  Creates a pooled allocator to the given pool.
  

• template<typename U > PooledAllocator (PooledAllocator< U > const &arg)

  Creates a pooled allocator to the argument's pool.
  

• size_type max_size () const

  The largest value that can meaningfully passed to allocate.
  

• pointer allocate (size_type count, std::allocator< void >::const_pointer=0) const

  Memory is allocated for count objects of type T but objects are not constructed.
  

• void deallocate (pointer block, size_type count) const throw ()

  Deallocates memory allocated by allocate.
  

• void construct (pointer element, T const &arg)

  Constructs an element of T at the given pointer.
  

• void destroy (pointer element)

  Destroys an element of T at the given pointer.
  

• pointer address (reference element) const

  Returns the address of the given reference.
  

• const_pointer address (const_reference element) const

  Returns the address of the given reference.
  

Data Fields

• Pool * m_pool

  The pool for this allocator.
  

template<typename T>
class PooledAllocator< T >

---

Member Typedef Documentation

template<typename T>

typedef size_t PooledAllocator< T >::size_type

template<typename T>

typedef ptrdiff_t PooledAllocator< T >::difference_type

template<typename T>

typedef T PooledAllocator< T >::value_type

template<typename T>

typedef T* PooledAllocator< T >::pointer

template<typename T>

typedef T const* PooledAllocator< T >::const_pointer

template<typename T>

typedef T& PooledAllocator< T >::reference

template<typename T>

typedef T const& PooledAllocator< T >::const_reference

---

Constructor & Destructor Documentation

template<typename T>

PooledAllocator< T >::PooledAllocator

(

Pool *

pool = 0

)

[inline]

This is non-explicit for ease of use.

References Pool::GetElemSize(), and PooledAllocator< T >::m_pool.

template<typename T>

template<typename U >

PooledAllocator< T >::PooledAllocator

(

PooledAllocator< U > const &

arg

)

[inline]

If the argument has no pool, then this allocator will allocate off the heap.

References Pool::GetElemSize(), and PooledAllocator< T >::m_pool.

---

Member Function Documentation

template<typename T>

size_type PooledAllocator< T >::max_size

(

)

const [inline]

template<typename T>

pointer PooledAllocator< T >::allocate	(	size_type	count,
		std::allocator< void >::const_pointer	= 0
	)			const [inline]

This function may raise an appropriate exception. The result is a random access iterator.

References Pool::Allocate(), and PooledAllocator< T >::m_pool.

template<typename T>

void PooledAllocator< T >::deallocate	(	pointer	block,
		size_type	count
	)			const throw () [inline]

All count objects in the area pointed by block must be destroyed prior to this call. count must match the value passed to allocate to obtain this memory. Does not throw exceptions. block must not be null.

References Pool::Deallocate(), and PooledAllocator< T >::m_pool.

template<typename T>

void PooledAllocator< T >::construct	(	pointer	element,
		T const &	arg
	)			[inline]

Effect: new( element ) T( arg )

template<typename T>

void PooledAllocator< T >::destroy

(

pointer

element

)

[inline]

Effect: element->~T()

template<typename T>

pointer PooledAllocator< T >::address

(

reference

element

)

const [inline]

template<typename T>

const_pointer PooledAllocator< T >::address

(

const_reference

element

)

const [inline]

---

Field Documentation

template<typename T>

Pool* PooledAllocator< T >::m_pool

Referenced by PooledAllocator< T >::allocate(), PooledAllocator< T >::deallocate(), operator!=(), operator==(), and PooledAllocator< T >::PooledAllocator().