CrystalSpace

Public API Reference

Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

csBlockAllocator< T > Class Template Reference

This class implements a memory allocator which can efficiently allocate objects that all have the same size. More...

#include <blockallocator.h>

List of all members.

Public Methods

 csBlockAllocator (int s)
 Construct a new block allocator which uses 'size' elements per block.

 ~csBlockAllocator ()
 Destruct all.

T * Alloc ()
 Allocate a new element.

void Free (T *el)
 Deallocate an element.

void Dump ()
 For debugging: dump contents.


Detailed Description

template<class T>
class csBlockAllocator< T >

This class implements a memory allocator which can efficiently allocate objects that all have the same size.

It has NO memory overhead per allocation (unless the objects are smaller than 8 bytes) and is extremely fast, both for Alloc and Free. Only restriction is it can only be used for the same type of object.

Note that the objects are properly constructed and destructed.

WARNING: This class does VERY little error checking!

Defining the macro CS_BLOCKALLOC_DEBUG will cause freed objects to be overwritten with '0xfb' bytes. This can be useful to track use of already freed objects, as they can be more easily recognized (as some members will be likely bogus.)

Definition at line 47 of file blockallocator.h.


Constructor & Destructor Documentation

template<class T>
csBlockAllocator< T >::csBlockAllocator int    s [inline]
 

Construct a new block allocator which uses 'size' elements per block.

Using a bigger 'size' means there is more memory 'wasted' but it makes performance faster.

Definition at line 121 of file blockallocator.h.

template<class T>
csBlockAllocator< T >::~csBlockAllocator   [inline]
 

Destruct all.

Note that objects have to be freed properly before the block allocator is called, otherwise the destructors will not be called! In debug mode this destructor will also check that all objects are freed correctly.

Definition at line 144 of file blockallocator.h.


Member Function Documentation

template<class T>
T* csBlockAllocator< T >::Alloc   [inline]
 

Allocate a new element.

Definition at line 161 of file blockallocator.h.

Referenced by csTree< T >::csTree().

template<class T>
void csBlockAllocator< T >::Dump   [inline]
 

For debugging: dump contents.

Definition at line 317 of file blockallocator.h.

template<class T>
void csBlockAllocator< T >::Free T *    el [inline]
 

Deallocate an element.

It is ok to give a 0 pointer here.

Definition at line 192 of file blockallocator.h.

Referenced by csTree< T >::Delete().


The documentation for this class was generated from the following file:
Generated for Crystal Space by doxygen 1.2.18