Atomic, bounded object pool with O(1) value mapping. More...

#include <Pool.hpp>

Public Member Functions
	Pool (size_t size, Allocator *alloc)
	Constructs a FreeList with the specified capacity and allocator.

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

V &	At (K key)
	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.

V const &	At (K key) const
	Retrieves a const reference to the value associated with the given key.

const K	Pop ()

const Pair< K, V & >	PopPair ()
	Allocates a Key that returns a pair of key and value reference.

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

Private Attributes
const size_t	mCapacity

MPMCQueue< K >	mKeys

Vector< V >	mValues

Vector< char >	mBitmap

Detailed Description

template<typename K, typename V, typename Tombstone = V>
class Foundation::Atomics::Pool< K, V, Tombstone >

Atomic, bounded object pool with O(1) value mapping.

Note: This is the atomic, lock-free version of Core::Pool. The pool has a fixed maximum size and will never allocate memory after construction. For an unbounded, lock-based implementation see Core::Pool.

Template Parameters

K	Key type. Should be an integral type.
V	Value type.
Tombstone	Tombstone value type for erased values.

Constructor & Destructor Documentation

◆ Pool()

template<typename K , typename V , typename Tombstone = V>

Foundation::Atomics::Pool< K, V, Tombstone >::Pool	(	size_t	size,
		Allocator *	alloc
	)

inline

Constructs a FreeList with the specified capacity and allocator.

Parameters

size	The maximum number of elements the FreeList can hold, which will be pre-allocated.
alloc	Allocator to use for internal allocations.

Member Function Documentation

◆ At() [1/2]

template<typename K , typename V , typename Tombstone = V>

V & Foundation::Atomics::Pool< K, V, Tombstone >::At ( K key )

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.