allocator_traits< memory_pool_collection< Pool, BucketDist, RawAllocator > > Class Template Reference

Detailed Description

template<class Pool, class BucketDist, class RawAllocator>
class foonathan::memory::allocator_traits< memory_pool_collection< Pool, BucketDist, RawAllocator > >

Specialization of the allocator_traits for memory_pool_collection classes.

Note

It is not allowed to mix calls through the specialization and through the member functions, i.e. memory_pool_collection::allocate_node() and this allocate_node().

Typedefs
using	allocator_type = memory_pool_collection< Pool, BucketDist, RawAllocator >
using	is_stateful = std::true_type

Static Functions
static void *	allocate_node (allocator_type &state, std::size_t size, std::size_t alignment)
static void *	allocate_array (allocator_type &state, std::size_t count, std::size_t size, std::size_t alignment)
static void	deallocate_node (allocator_type &state, void *node, std::size_t size, std::size_t) noexcept
static void	deallocate_array (allocator_type &state, void *array, std::size_t count, std::size_t size, std::size_t) noexcept
static std::size_t	max_node_size (const allocator_type &state) noexcept
static std::size_t	max_array_size (const allocator_type &state) noexcept
static std::size_t	max_alignment (const allocator_type &) noexcept

Member Functions

allocate_node()

static void * allocate_node ( allocator_type &  state, std::size_t  size, std::size_t  alignment  )

static

Returns:

The result of memory_pool_collection::allocate_node().

Throws:

Anything thrown by the pool allocation function or a bad_allocation_size exception if size / alignment exceeds max_node_size() / the suitable alignment value, i.e. the node is over-aligned.

allocate_array()

static void * allocate_array ( allocator_type &  state, std::size_t  count, std::size_t  size, std::size_t  alignment  )

static

Returns:

The result of memory_pool_collection::allocate_array().

Throws:

Anything thrown by the pool allocation function or a bad_allocation_size exception.

Requires:

The memory_pool_collection has to support array allocations.

deallocate_node()

static void deallocate_node ( allocator_type &  state, void *  node, std::size_t  size, std::size_t    )

staticnoexcept

Effects:

Calls memory_pool_collection::deallocate_node().

deallocate_array()

static void deallocate_array ( allocator_type &  state, void *  array, std::size_t  count, std::size_t  size, std::size_t    )

staticnoexcept

Effects:

Calls memory_pool_collection::deallocate_array().

Requires:

The memory_pool_collection has to support array allocations.

max_node_size()

static std::size_t max_node_size ( const allocator_type &  state )

staticnoexcept

Returns:

The maximum size of each node which is memory_pool_collection::max_node_size().

max_array_size()

static std::size_t max_array_size ( const allocator_type &  state )

staticnoexcept

Returns:

An upper bound on the maximum array size which is memory_pool::next_capacity().

max_alignment()

static std::size_t max_alignment ( const allocator_type &  )

staticnoexcept

Returns:

Just alignof(std::max_align_t) since the actual maximum alignment depends on the node size, the nodes must not be over-aligned.