Unbounded object pool with O(1) value mapping. More...

#include <Pool.hpp>

Public Member Functions
	Pool (Allocator *alloc)

bool	Contains (K key) const
	Checks if the specified key exists and has a value.

V *	At (K key) const
	Retrieves a reference to the value associated with the given key. NOTE: Calling this function with a key that's not retrieved from pop() is undefined behavior.

template<typename... Args>
K	Pop (Args &&... args)
	Allocates a new key in the pool and constructs the object in-place.

template<typename Derived , typename... Args>
K	PopBase (Args &&... args)
	Allocates a new key in the pool and constructs a derived object in-place.

void	Free (K key)
	Frees the value associated with the specified key.

Private Member Functions
void	Push (K key)
	Adds a key to the internal key container and resizes the value container if necessary.

void	CheckContains (K key) const

K	PopKey ()

Private Attributes
Allocator *	mAlloc

Vector< K >	mKeys

Vector< UniquePtr< V > >	mValues

std::mutex	mMutex

K	mTop {}

Detailed Description

template<typename K, typename V>
class Foundation::Core::Pool< K, V >

Unbounded object pool with O(1) value mapping.

Template Parameters

K	Key type. Should be an integral type.
V	Value type.

Note: The values are allocated using the provided Allocator, and is guaranteed to have a stable address until freed.; An atomic, bounded version of this is provided by Foundation::Atomics::Pool

Constructor & Destructor Documentation

◆ Pool()

template<typename K , typename V >

Foundation::Core::Pool< K, V >::Pool ( Allocator * alloc )

inline

Member Function Documentation

◆ At()

template<typename K , typename V >

V * Foundation::Core::Pool< K, V >::At ( K key ) const

inline

Retrieves a reference to the value associated with the given key. NOTE: Calling this function with a key that's not retrieved from pop() is undefined behavior.