lar::details::bulk_allocator::BulkAllocatorBase< T >::MemoryChunk_t Class Reference

Internal memory chunk; like a std::vector, but does not construct. More...

Public Member Functions
	MemoryChunk_t (Allocator_t &alloc, size_type n)
	MemoryChunk_t (const MemoryChunk_t &)=delete
	Can't copy. More...
	MemoryChunk_t (MemoryChunk_t &&)
	Move constructor. More...
	~MemoryChunk_t ()
MemoryChunk_t &	operator= (const MemoryChunk_t &)=delete
	Can't assign. More...
MemoryChunk_t &	operator= (MemoryChunk_t &&)
	Move assignment. More...
size_type	size () const
	Returns the number of elements in this pool. More...
size_type	available () const
	Returns the number of free elements in this pool. More...
size_type	used () const
	Returns the number of used elements in this pool. More...
bool	full () const
	Returns whether the chunk is full. More...
pointer	get ()
	Returns a pointer to a free item, or nullptr if none is available. More...
pointer	get (size_t n)
	Returns a pointer to n free items, or nullptr if not available. More...

Public Attributes
Allocator_t *	allocator
	reference to the allocator to be used More...
pointer	begin = nullptr
	start of the pool More...
pointer	end = nullptr
	end of the pool More...
pointer	free = nullptr
	first unused element of the pool More...

Private Member Functions
	MemoryChunk_t ()
	< Default constructor (does nothing) More...

Detailed Description

template<typename T>
class lar::details::bulk_allocator::BulkAllocatorBase< T >::MemoryChunk_t

Internal memory chunk; like a std::vector, but does not construct.

Definition at line 324 of file BulkAllocator.h.

Constructor & Destructor Documentation

template<typename T>

lar::details::bulk_allocator::BulkAllocatorBase< T >::MemoryChunk_t::MemoryChunk_t ( Allocator_t &  alloc, size_type  n  )

inline

Definition at line 333 of file BulkAllocator.h.

                                                        : allocator(&alloc)
            {
              begin = n? allocator->allocate(n): nullptr;
              end = begin + n;
              free = begin;
            } // MemoryChunk_t()

template<typename T>

lar::details::bulk_allocator::BulkAllocatorBase< T >::MemoryChunk_t::MemoryChunk_t ( const MemoryChunk_t &  )

delete

Can't copy.

template<typename T >

lar::details::bulk_allocator::BulkAllocatorBase< T >::MemoryChunk_t::MemoryChunk_t

(

MemoryChunk_t &&

from

)

Move constructor.

Definition at line 393 of file BulkAllocator.h.

                                                                           {
        std::swap(allocator, from.allocator);
        std::swap(begin, from.begin);
        std::swap(end, from.end);
        std::swap(free, from.free);
      } // BulkAllocatorBase<T>::MemoryChunk_t::MemoryChunk_t(MemoryChunk_t&&)

template<typename T>

lar::details::bulk_allocator::BulkAllocatorBase< T >::MemoryChunk_t::~MemoryChunk_t ( )

inline

Definition at line 342 of file BulkAllocator.h.

{ allocator->deallocate(begin, size()); }

template<typename T>

lar::details::bulk_allocator::BulkAllocatorBase< T >::MemoryChunk_t::MemoryChunk_t ( )

inlineprivate

< Default constructor (does nothing)

Definition at line 374 of file BulkAllocator.h.

: allocator(nullptr) {}

Member Function Documentation

template<typename T>

size_type lar::details::bulk_allocator::BulkAllocatorBase< T >::MemoryChunk_t::available ( ) const

inline

Returns the number of free elements in this pool.

Definition at line 352 of file BulkAllocator.h.

{ return end - free; }

template<typename T>

bool lar::details::bulk_allocator::BulkAllocatorBase< T >::MemoryChunk_t::full ( ) const

inline

Returns whether the chunk is full.

Definition at line 358 of file BulkAllocator.h.

{ return !available(); }

template<typename T>

pointer lar::details::bulk_allocator::BulkAllocatorBase< T >::MemoryChunk_t::get ( )

inline

Returns a pointer to a free item, or nullptr if none is available.

Definition at line 361 of file BulkAllocator.h.

{ return (free != end)? free++: nullptr; }

template<typename T>

pointer lar::details::bulk_allocator::BulkAllocatorBase< T >::MemoryChunk_t::get ( size_t  n )

inline

Returns a pointer to n free items, or nullptr if not available.

Definition at line 364 of file BulkAllocator.h.

            {
              pointer ptr = free;
              if ((free += n) <= end) return ptr;
              free = ptr;
              return nullptr;
            }

template<typename T>

MemoryChunk_t& lar::details::bulk_allocator::BulkAllocatorBase< T >::MemoryChunk_t::operator= ( const MemoryChunk_t &  )

delete

Can't assign.

template<typename T >

BulkAllocatorBase< T >::MemoryChunk_t & lar::details::bulk_allocator::BulkAllocatorBase< T >::MemoryChunk_t::operator=

(

MemoryChunk_t &&

from

)

Move assignment.

Definition at line 402 of file BulkAllocator.h.

      {
        std::swap(allocator, from.allocator);
        std::swap(begin, from.begin);
        std::swap(end, from.end);
        std::swap(free, from.free);
        return *this;
      } // BulkAllocatorBase<T>::MemoryChunk_t::operator= (MemoryChunk_t&&)

template<typename T>

size_type lar::details::bulk_allocator::BulkAllocatorBase< T >::MemoryChunk_t::size ( void  ) const

inline

Returns the number of elements in this pool.

Definition at line 349 of file BulkAllocator.h.

{ return end - begin; }

template<typename T>

size_type lar::details::bulk_allocator::BulkAllocatorBase< T >::MemoryChunk_t::used ( ) const

inline

Returns the number of used elements in this pool.

Definition at line 355 of file BulkAllocator.h.

{ return free - begin; }

Member Data Documentation

template<typename T>

Allocator_t* lar::details::bulk_allocator::BulkAllocatorBase< T >::MemoryChunk_t::allocator

reference to the allocator to be used

Definition at line 326 of file BulkAllocator.h.

template<typename T>

pointer lar::details::bulk_allocator::BulkAllocatorBase< T >::MemoryChunk_t::begin = nullptr

start of the pool

Definition at line 328 of file BulkAllocator.h.

template<typename T>

pointer lar::details::bulk_allocator::BulkAllocatorBase< T >::MemoryChunk_t::end = nullptr

end of the pool

Definition at line 329 of file BulkAllocator.h.

template<typename T>

pointer lar::details::bulk_allocator::BulkAllocatorBase< T >::MemoryChunk_t::free = nullptr

first unused element of the pool

Constructor: allocates memory

Definition at line 330 of file BulkAllocator.h.

---

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

• lardata/lardata/Utilities/BulkAllocator.h