Provides a base class for small objects using a custom memory management. More...

#include <pearl/SmallObject.h>

Inheritance diagram for pearl::SmallObject:

Static Public Member Functions
Memory allocation operators
static void *	operator new (std::size_t objectSize)
	Allocate storage space. More...

static void	operator delete (void *deadObject, std::size_t objectSize)
	Deallocate storage space. More...

Protected Member Functions
Constructors & destructor
	~SmallObject ()
	Destructor. More...

Detailed Description

Each dynamically allocated memory block usually requires some extra memory for bookkeeping purposes. However, this can be quite space inefficient if a large number of small objects is allocated, as the per-object overhead is significant.

The SmallObject class serves as a base class that can be used for these kind of small objects, providing a customized memory management that allocates memory in larger chunks rather than individually for each object. This specialized memory management is restricted to objects of not more than 64 bytes, however, if objects grow larger (e.g., objects of a derived class) the default memory allocation routines are used transparently. Note that array allocations of small objects are always handled by the default operator new allocator.

Constructor & Destructor Documentation

◆ ~SmallObject()

pearl::SmallObject::~SmallObject ( )

protected

Releases all allocated resources and destroys the instance.

Member Function Documentation

◆ operator delete()

static void pearl::SmallObject::operator delete	(	void *	deadObject,
		std::size_t	objectSize
	)

static

Deallocates the memory block pointed to by deadObject if it is non-null, releasing memory previously allocated by a call to SmallObject::operator new. If deadObject is nullptr, this operator is a no-op.

Parameters

deadObject	Pointer to memory block to be released
objectSize	Size of the memory block in bytes

◆ operator new()

static void* pearl::SmallObject::operator new ( std::size_t objectSize )

static

Allocates objectSize bytes of storage space and returns a non-null pointer to the first byte of the block. An optimized allocator is used for small objects less than 64 bytes, the default memory allocator otherwise.

Parameters

objectSize Size of the requested memory block in bytes

Exceptions

bad_alloc on failure to allocate the object memory or any of the internally required data structures

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

SmallObject.h