STL-compatible allocator adapter for custom allocators. More...

#include <stl_allocator_adapter.hpp>

Classes
struct	rebind
	Rebind support for allocating different types. More...

Public Types
using	value_type = T

using	size_type = size_t

using	difference_type = std::ptrdiff_t

using	propagate_on_container_move_assignment = std::true_type

using	is_always_equal = std::false_type

Public Member Functions
constexpr	STLAllocatorAdapter (UnderlyingAllocator &allocator) noexcept
	Constructs adapter with reference to underlying allocator.

template<typename U >
constexpr	STLAllocatorAdapter (const STLAllocatorAdapter< U, UnderlyingAllocator > &other) noexcept
	Rebind copy constructor.

constexpr	STLAllocatorAdapter (const STLAllocatorAdapter &) noexcept=default

constexpr	STLAllocatorAdapter (STLAllocatorAdapter &&) noexcept=default

constexpr	~STLAllocatorAdapter () noexcept=default

template<typename U >
constexpr STLAllocatorAdapter &	operator= (const STLAllocatorAdapter< U, UnderlyingAllocator > &other) noexcept

constexpr STLAllocatorAdapter &	operator= (const STLAllocatorAdapter &) noexcept=default

constexpr STLAllocatorAdapter &	operator= (STLAllocatorAdapter &&) noexcept=default

T *	allocate (size_type count)
	Allocates memory for n objects of type T.

void	deallocate (T *ptr, size_type count) noexcept
	Deallocates memory for n objects.

template<typename U >
constexpr bool	operator== (const STLAllocatorAdapter< U, UnderlyingAllocator > &other) const noexcept
	Equality comparison.

template<typename U >
constexpr bool	operator!= (const STLAllocatorAdapter< U, UnderlyingAllocator > &other) const noexcept
	Inequality comparison.

constexpr size_type	max_size () const noexcept
	Returns maximum number of objects that can be allocated.

constexpr UnderlyingAllocator *	get_allocator () const noexcept
	Gets pointer to underlying allocator.

template<typename U >
constexpr auto	operator= (const STLAllocatorAdapter< U, UnderlyingAllocator > &other) noexcept -> STLAllocatorAdapter &

Friends
template<typename U , typename A >
class	STLAllocatorAdapter

Detailed Description

template<typename T, typename UnderlyingAllocator>
class helios::memory::STLAllocatorAdapter< T, UnderlyingAllocator >

STL-compatible allocator adapter for custom allocators.

Wraps custom allocators to work with STL containers. The underlying allocator must remain alive for the lifetime of any containers using this adapter.

Note: Thread-safety depends on the underlying allocator.; The underlying allocator is held by reference - ensure it outlives all containers.

Template Parameters

T	Type of objects to allocate
UnderlyingAllocator	The custom allocator type

Definition at line 31 of file stl_allocator_adapter.hpp.

Member Typedef Documentation

◆ difference_type

template<typename T , typename UnderlyingAllocator >

using helios::memory::STLAllocatorAdapter< T, UnderlyingAllocator >::difference_type = std::ptrdiff_t

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/memory/stl_allocator_adapter.hpp.

Definition at line 36 of file stl_allocator_adapter.hpp.

◆ is_always_equal

template<typename T , typename UnderlyingAllocator >

using helios::memory::STLAllocatorAdapter< T, UnderlyingAllocator >::is_always_equal = std::false_type

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/memory/stl_allocator_adapter.hpp.

Definition at line 38 of file stl_allocator_adapter.hpp.

◆ propagate_on_container_move_assignment

template<typename T , typename UnderlyingAllocator >

using helios::memory::STLAllocatorAdapter< T, UnderlyingAllocator >::propagate_on_container_move_assignment = std::true_type

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/memory/stl_allocator_adapter.hpp.

Definition at line 37 of file stl_allocator_adapter.hpp.

◆ size_type

template<typename T , typename UnderlyingAllocator >

using helios::memory::STLAllocatorAdapter< T, UnderlyingAllocator >::size_type = size_t

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/memory/stl_allocator_adapter.hpp.

Definition at line 35 of file stl_allocator_adapter.hpp.

◆ value_type

template<typename T , typename UnderlyingAllocator >

using helios::memory::STLAllocatorAdapter< T, UnderlyingAllocator >::value_type = T

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/memory/stl_allocator_adapter.hpp.

Definition at line 34 of file stl_allocator_adapter.hpp.

Constructor & Destructor Documentation

◆ STLAllocatorAdapter() [1/4]

template<typename T , typename UnderlyingAllocator >

constexpr helios::memory::STLAllocatorAdapter< T, UnderlyingAllocator >::STLAllocatorAdapter ( UnderlyingAllocator & allocator )

inlineexplicitconstexprnoexcept

Constructs adapter with reference to underlying allocator.

Parameters

allocator Reference to the custom allocator to use

Definition at line 53 of file stl_allocator_adapter.hpp.

53: allocator_(&allocator) {}

◆ STLAllocatorAdapter() [2/4]

template<typename T , typename UnderlyingAllocator >

template<typename U >

constexpr helios::memory::STLAllocatorAdapter< T, UnderlyingAllocator >::STLAllocatorAdapter ( const STLAllocatorAdapter< U, UnderlyingAllocator > & other )

inlineexplicitconstexprnoexcept

Rebind copy constructor.

Allows converting between allocators of different types.

Definition at line 60 of file stl_allocator_adapter.hpp.

61 : allocator_(other.allocator_) {}

◆ STLAllocatorAdapter() [3/4]

template<typename T , typename UnderlyingAllocator >

constexpr helios::memory::STLAllocatorAdapter< T, UnderlyingAllocator >::STLAllocatorAdapter ( const STLAllocatorAdapter< T, UnderlyingAllocator > & )

constexprdefaultnoexcept

◆ STLAllocatorAdapter() [4/4]

template<typename T , typename UnderlyingAllocator >

constexpr helios::memory::STLAllocatorAdapter< T, UnderlyingAllocator >::STLAllocatorAdapter ( STLAllocatorAdapter< T, UnderlyingAllocator > && )

constexprdefaultnoexcept

◆ ~STLAllocatorAdapter()

template<typename T , typename UnderlyingAllocator >

constexpr helios::memory::STLAllocatorAdapter< T, UnderlyingAllocator >::~STLAllocatorAdapter ( )

constexprdefaultnoexcept

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/memory/stl_allocator_adapter.hpp.

Member Function Documentation

◆ allocate()

template<typename T , typename UnderlyingAllocator >

T * helios::memory::STLAllocatorAdapter< T, UnderlyingAllocator >::allocate ( size_type count )

inline

Allocates memory for n objects of type T.

Exceptions

std::bad_alloc if allocation fails

Parameters

count Count of objects to allocate space for

Returns: Pointer to allocated memory

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/memory/stl_allocator_adapter.hpp.

Definition at line 135 of file stl_allocator_adapter.hpp.

                                                                               {
  if (count > max_size()) {
    throw std::bad_alloc();
  }
 
  const size_t size = count * sizeof(T);
  constexpr size_t alignment = std::max(alignof(T), kMinAlignment);
 
  auto result = allocator_->Allocate(size, alignment);
 
  if (result.ptr == nullptr) {
    throw std::bad_alloc();
  }
 
  return static_cast<T*>(result.ptr);
}

◆ deallocate()

template<typename T , typename UnderlyingAllocator >

void helios::memory::STLAllocatorAdapter< T, UnderlyingAllocator >::deallocate	(	T *	ptr,
		size_type	count
	)

inlinenoexcept

Deallocates memory for n objects.

Parameters

ptr	Pointer to deallocate
count	Count of objects (may be ignored by some allocators)

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/memory/stl_allocator_adapter.hpp.

Definition at line 153 of file stl_allocator_adapter.hpp.

                                                                                                    {
  if (ptr == nullptr) [[unlikely]] {
    return;
  }
 
  // FrameAllocator, DoubleFrameAllocator, and NFrameAllocator don't support individual deallocation
  if constexpr (std::same_as<UnderlyingAllocator, FrameAllocator> ||
                std::same_as<UnderlyingAllocator, DoubleFrameAllocator>) {
    // No-op: Frame allocators don't support individual deallocation
  }
  // PoolAllocator and FreeListAllocator only need ptr
  else if constexpr (std::same_as<UnderlyingAllocator, PoolAllocator> ||
                     std::same_as<UnderlyingAllocator, FreeListAllocator>) {
    allocator_->Deallocate(ptr);
  }
  // StackAllocator needs ptr and size
  else {
    allocator_->Deallocate(ptr, count * sizeof(T));
  }
}

◆ get_allocator()

template<typename T , typename UnderlyingAllocator >

constexpr UnderlyingAllocator * helios::memory::STLAllocatorAdapter< T, UnderlyingAllocator >::get_allocator ( ) const

inlineconstexprnoexcept

Gets pointer to underlying allocator.

Returns: Pointer to underlying allocator

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/memory/stl_allocator_adapter.hpp.

Definition at line 117 of file stl_allocator_adapter.hpp.

117{ return allocator_; }

◆ max_size()

template<typename T , typename UnderlyingAllocator >

constexpr size_type helios::memory::STLAllocatorAdapter< T, UnderlyingAllocator >::max_size ( ) const

inlineconstexprnoexcept

Returns maximum number of objects that can be allocated.

Returns: Maximum size

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/memory/stl_allocator_adapter.hpp.

Definition at line 109 of file stl_allocator_adapter.hpp.

                                                              {
    return std::numeric_limits<size_type>::max() / sizeof(T);
  }

◆ operator!=()

template<typename T , typename UnderlyingAllocator >

template<typename U >

constexpr bool helios::memory::STLAllocatorAdapter< T, UnderlyingAllocator >::operator!= ( const STLAllocatorAdapter< U, UnderlyingAllocator > & other ) const

inlineconstexprnoexcept

Inequality comparison.

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/memory/stl_allocator_adapter.hpp.

Definition at line 101 of file stl_allocator_adapter.hpp.

                                                                                                     {
    return !(*this == other);
  }

◆ operator=() [1/4]

template<typename T , typename UnderlyingAllocator >

constexpr STLAllocatorAdapter & helios::memory::STLAllocatorAdapter< T, UnderlyingAllocator >::operator= ( const STLAllocatorAdapter< T, UnderlyingAllocator > & )

constexprdefaultnoexcept

◆ operator=() [2/4]

template<typename T , typename UnderlyingAllocator >

template<typename U >

constexpr STLAllocatorAdapter & helios::memory::STLAllocatorAdapter< T, UnderlyingAllocator >::operator= ( const STLAllocatorAdapter< U, UnderlyingAllocator > & other )

constexprnoexcept

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/memory/stl_allocator_adapter.hpp.

◆ operator=() [3/4]

template<typename T , typename UnderlyingAllocator >

template<typename U >

constexpr auto helios::memory::STLAllocatorAdapter< T, UnderlyingAllocator >::operator= ( const STLAllocatorAdapter< U, UnderlyingAllocator > & other ) -> STLAllocatorAdapter&

constexprnoexcept

Definition at line 128 of file stl_allocator_adapter.hpp.

                                                                                               {
  allocator_ = other.allocator_;
  return *this;
}

◆ operator=() [4/4]

template<typename T , typename UnderlyingAllocator >

constexpr STLAllocatorAdapter & helios::memory::STLAllocatorAdapter< T, UnderlyingAllocator >::operator= ( STLAllocatorAdapter< T, UnderlyingAllocator > && )

constexprdefaultnoexcept

◆ operator==()

template<typename T , typename UnderlyingAllocator >

template<typename U >

constexpr bool helios::memory::STLAllocatorAdapter< T, UnderlyingAllocator >::operator== ( const STLAllocatorAdapter< U, UnderlyingAllocator > & other ) const

inlineconstexprnoexcept

Equality comparison.

Two adapters are equal if they reference the same underlying allocator.

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/memory/stl_allocator_adapter.hpp.

Definition at line 93 of file stl_allocator_adapter.hpp.

                                                                                                     {
    return allocator_ == other.allocator_;
  }

Friends And Related Symbol Documentation

◆ STLAllocatorAdapter

template<typename T , typename UnderlyingAllocator >

template<typename U , typename A >

friend class STLAllocatorAdapter

friend

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/memory/stl_allocator_adapter.hpp.

Definition at line 121 of file stl_allocator_adapter.hpp.

	Helios Engine 0.1.0 A modular ECS based data-oriented C++23 game engine

Classes

Public Types

Public Member Functions

Friends

Detailed Description

Member Typedef Documentation

◆ difference_type

◆ is_always_equal

◆ propagate_on_container_move_assignment

◆ size_type

◆ value_type

Constructor & Destructor Documentation

◆ STLAllocatorAdapter() [1/4]

◆ STLAllocatorAdapter() [2/4]

◆ STLAllocatorAdapter() [3/4]

◆ STLAllocatorAdapter() [4/4]

◆ ~STLAllocatorAdapter()

Member Function Documentation

◆ allocate()

◆ deallocate()

◆ get_allocator()

◆ max_size()

◆ operator!=()

◆ operator=() [1/4]

◆ operator=() [2/4]

◆ operator=() [3/4]

◆ operator=() [4/4]

◆ operator==()

Friends And Related Symbol Documentation

◆ STLAllocatorAdapter