StdContMARecycling< T > Struct Template Reference

#include <stdcontainerma.hpp>

Inheritance diagram for StdContMARecycling< T >:

Collaboration diagram for StdContMARecycling< T >:

Class Description

template<typename T>
struct aworx::lib::monomem::StdContMARecycling< T >

---

Implementation of std::allocator to be used with container types provided by the C++ standard library.

As the C+++ library's specification does not include details of the container class's implementation, this allocator uses type util::RTTRAllocator which detects node types automatically.

Attention

It can not be guaranteed that a certain, uncommon implementation of the C++ library allocates memory in a way that this allocator truly recycles objects, and - even if the authors of ALib are optimistic hat this type works with any implementation - it is recommended to use the alternative container types found in this ALib Module.

See also

For background information about monotonic memory allocation, recycling and the issues of C++ standard container types, see the Programmer's Manual of this ALib Module.

Template Parameters

T	The type of objects to be allocated.

Definition at line 501 of file stdcontainerma.hpp.

Inner Classes
struct	rebind

Public Fields
RTTRAllocator &	recycler

Public Methods
constexpr	StdContMARecycling (const StdContMARecycling &) noexcept=default
constexpr	StdContMARecycling (RTTRAllocator &pRecycler)
constexpr	StdContMARecycling (StdContMARecycling &&) noexcept=default
template<typename TSibling >
	StdContMARecycling (TSibling &StdContMARecycling)
ALIB_NODISCARD T *	allocate (size_t n, const void *=nullptr)
void	deallocate (T *p, std::size_t n)
template<typename U >
bool	operator!= (const StdContMARecycling< U > &rhs) const noexcept
template<typename U >
bool	operator== (const StdContMARecycling< U > &rhs) const noexcept
Public Methods inherited from StdContainerMABase< T >
const_pointer	address (const_reference x) const noexcept
pointer	address (reference x) const noexcept
template<typename U , typename... Args>
void	construct (U *p, Args &&... args)
template<typename U >
void	destroy (U *p)
size_t	max_size () const noexcept

Additional Inherited Members
Public Types inherited from StdContainerMABase< T >
using	const_pointer = const T *
using	const_reference = const T &
using	difference_type = ptrdiff_t
	Type definition as required by C++ library standards.
using	is_always_equal = std::false_type
	Type definition as required by C++ library standards.
using	pointer = T *
using	reference = T &
using	size_type = size_t
	Type definition as required by C++ library standards.
using	value_type = T
	Type definition as required by C++ library standards.

Constructor & Destructor Documentation

StdContMARecycling() [1/4]

constexpr StdContMARecycling ( const StdContMARecycling< T > &  )

constexprdefaultnoexcept

Defaulted copy constructor

StdContMARecycling() [2/4]

constexpr StdContMARecycling ( StdContMARecycling< T > &&  )

constexprdefaultnoexcept

Defaulted move constructor

StdContMARecycling() [3/4]

StdContMARecycling ( TSibling &  StdContMARecycling )

inline

Copy constructor using an instance of different template type.

Template Parameters

TSibling

The originating allocator's type (StdContMARecycling<X>).

Parameters

StdContMARecycling

The originating allocator of type TSibling .

Definition at line 541 of file stdcontainerma.hpp.

StdContMARecycling() [4/4]

constexpr StdContMARecycling ( RTTRAllocator &  pRecycler )

inlineconstexpr

Constructor for the initial allocator instantiation.

Parameters

pRecycler

The recycler to for allocations and de-allocations.

Definition at line 549 of file stdcontainerma.hpp.

Member Function Documentation

allocate()

ALIB_NODISCARD T* allocate ( size_t  n, const void *  = nullptr  )

inline

---

Implementation of std::allocator interface. Dependent on whether a single or multiple objects are requested, this method invokes either RTTRAllocator::Get or RTTRAllocator::AllocUnrelated on field recycler.

Parameters

n	The number of requested objects to allocate storage for.

Returns

Pointer to the first byte of a memory block suitably aligned and sufficient to hold an array of n objects of type T .

Definition at line 594 of file stdcontainerma.hpp.

Here is the call graph for this function:

deallocate()

void deallocate ( T *  p, std::size_t  n  )

inline

---

Implementation of std::allocator interface. Dependent on whether a single or multiple objects are de-allocated (parameter n), this method invokes either RTTRAllocator::Recycle or RTTRAllocator::RecycleChunk on field recycler.

Parameters

p	Pointer to the object to deallocate.
n	The number of objects to de-allocate.

Definition at line 613 of file stdcontainerma.hpp.

Here is the call graph for this function:

operator!=()

bool operator!= ( const StdContMARecycling< U > &  rhs ) const

inlinenoexcept

Comparison operator.

Template Parameters

U	The allocation type of the other allocator.

Parameters

rhs	The right hand side allocator.

Returns

false if this and rhs use the same recycler, true otherwise.

Definition at line 575 of file stdcontainerma.hpp.

operator==()

bool operator== ( const StdContMARecycling< U > &  rhs ) const

inlinenoexcept

Comparison operator.

Template Parameters

U	The allocation type of the other allocator.

Parameters

rhs	The right hand side allocator.

Returns

true if this and rhs use the same recycler, false otherwise.

Definition at line 563 of file stdcontainerma.hpp.

Member Data Documentation

recycler

RTTRAllocator& recycler

The only member of this allocator type used to perform all duties.

Definition at line 524 of file stdcontainerma.hpp.

---

The documentation for this struct was generated from the following file:

• stdcontainerma.hpp