TAllocatorFixedSizeFreeList< AllocationSize, BlockSize > Class Template Reference

#include <AllocatorFixedSizeFreeList.h>

Public Member Functions
	TAllocatorFixedSizeFreeList (uint32 InitialBlockSize=0)
	~TAllocatorFixedSizeFreeList ()
void *	Allocate ()
void	Free (void *Element)
uint32	GetAllocatedSize () const
void	Grow (uint32 NumElements)

Detailed Description

template<uint32 AllocationSize, uint32 BlockSize>
class TAllocatorFixedSizeFreeList< AllocationSize, BlockSize >

Fixed-sized allocator that uses a free list to cache allocations. Initial allocation block can be specified in the ctor to warm the cache. Subsequent allocations are in multiples of the given blocksize.

Grow can be called at any time to warm the cache with a single block allocation. Initial allocation will want to be a reasonable guess as to how big the pool might grow. BlockSize should be small enough to cut down on allocations but not overcommit memory.

NOTE: Currently there is not way to flush the pool because it doesn't track each block's allocation status.

Not threadsafe <could be implemented using a ThreadingPolicy template parameter>.

Template params: AllocationSize - size of each allocation (must be at least as large as a pointer) BlockSize - number of allocations to reserve room for when a new block needs to be allocated.

Constructor & Destructor Documentation

TAllocatorFixedSizeFreeList()

template<uint32 AllocationSize, uint32 BlockSize>

TAllocatorFixedSizeFreeList< AllocationSize, BlockSize >::TAllocatorFixedSizeFreeList ( uint32  InitialBlockSize = 0 )

inline

Ctor

Parameters

InitialBlockSize

- number of allocations to warm the cache with

~TAllocatorFixedSizeFreeList()

template<uint32 AllocationSize, uint32 BlockSize>

TAllocatorFixedSizeFreeList< AllocationSize, BlockSize >::~TAllocatorFixedSizeFreeList ( )

inline

Destructor. Can't free memory, so only checks that allocations have been returned.

Member Function Documentation

Allocate()

template<uint32 AllocationSize, uint32 BlockSize>

void * TAllocatorFixedSizeFreeList< AllocationSize, BlockSize >::Allocate ( )

inline

Allocates one element from the free list. Return it by calling Free.

Free()

template<uint32 AllocationSize, uint32 BlockSize>

void TAllocatorFixedSizeFreeList< AllocationSize, BlockSize >::Free ( void *  Element )

inline

Returns one element from the free list. Must have been acquired previously by Allocate.

GetAllocatedSize()

template<uint32 AllocationSize, uint32 BlockSize>

uint32 TAllocatorFixedSizeFreeList< AllocationSize, BlockSize >::GetAllocatedSize ( ) const

inline

Get total memory allocated. Only returns the size of allocations made directly by the allocator, not the elements themselves.

Grow()

template<uint32 AllocationSize, uint32 BlockSize>

void TAllocatorFixedSizeFreeList< AllocationSize, BlockSize >::Grow ( uint32  NumElements )

inline

Grows the free list by a specific number of elements. Does one allocation for all elements. Safe to call at any time to warm the cache with a single block allocation.

---

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

• Engine/Source/Runtime/Core/Public/Containers/AllocatorFixedSizeFreeList.h