Template Class FixedPool

Nested Relationships

Inheritance Relationships

Base Type

Class Documentation

template <typename T, int NP = 64, typename IA = StdAllocator>
class FixedPool : public umpire::strategy::AllocationStrategy

Pool for fixed size allocations.

This AllocationStrategy provides an efficient pool for fixed size allocations of size T. Pools of NP objects of type T are constructed, and used to quickly allocate and deallocate objects.

Public Functions

FixedPool(const std::string &name, int id, Allocator allocator)
~FixedPool()
void *allocate(size_t bytes)

Allocate bytes of memory.

Return
Pointer to start of allocated bytes.
Parameters
  • bytes: Number of bytes to allocate.

void deallocate(void *ptr)

Free the memory at ptr.

Parameters
  • ptr: Pointer to free.

long getCurrentSize() const

Get current (total) size of the allocated memory.

This is the total size of all allocation currently ‘live’ that have been made by this AllocationStrategy object.

Return
Current total size of allocations.

long getHighWatermark() const

Get the high watermark of the total allocated size.

This is equivalent to the highest observed value of getCurrentSize.

Return
High watermark allocation size.

long getActualSize() const

Get the current amount of memory allocated by this allocator.

Note that this can be larger than getCurrentSize(), particularly if the AllocationStrategy implements some kind of pooling.

Return
The total size of all the memory this object has allocated.

Platform getPlatform()

Get the platform associated with this AllocationStrategy.

The Platform distinguishes the appropriate place to execute operations on memory allocated by this AllocationStrategy.

Return
The platform associated with this AllocationStrategy.

void release()

Release any and all unused memory held by this AllocationStrategy.

std::string getName()

Get the name of this AllocationStrategy.

Return
The name of this AllocationStrategy.

int getId()

Get the id of this AllocationStrategy.

Return
The id of this AllocationStrategy.

Protected Attributes

std::string m_name
int m_id