Helper class which provides a possibly dynamically growing list of containers suitable for a multi-threaded context. More...

#include <ContainerList.h>

Collaboration diagram for ContainerList< T_Container >:

Public Member Functions
	ContainerList (unsigned int expected_max_container)
	Create a container list for a certain number of containers.
std::size_t	size () const
	The number of containers in this list.
T_Container &	operator[] (unsigned int idx)
	Return the container with the given container index (read-write).a.
const T_Container &	operator[] (unsigned int idx) const
	Return the container with the given container index (read-only).

Private Types
using	T_ContainerPtr = T_Container *
using	ContainerPtrList = T_ContainerPtr *

Static Private Member Functions
static std::span< T_ContainerPtr >	fillContainerList (unsigned int begin_idx, std::vector< T_Container > &container, std::span< T_ContainerPtr > container_list)
	Write pointers to containers in the given vector to a list starting at begin_index.

Private Attributes
T_Container *	m_singleElementContainerList {}
	A container "list" which can only contain a single container.
std::span< T_ContainerPtr >	m_containerList
	The current container list.
std::vector< std::vector< T_Container > >	m_container
	All containers.
std::vector< std::vector< T_ContainerPtr > >	m_containerListHistory
	The history of the container lists where each subsequent element is an extended copy of the preceding list.

Friends
struct	DynamicContainerListHelper< T_Container >

Detailed Description

template<typename T_Container>
class ContainerList< T_Container >

Helper class which provides a possibly dynamically growing list of containers suitable for a multi-threaded context.

The idea is that there is a reasonable estimate of the total number of needed containers, however if the estimate was too optimistic the list can be grown. The operation to grow the list is mutex protected.

Definition at line 21 of file ContainerList.h.

Member Typedef Documentation

◆ ContainerPtrList

template<typename T_Container>

using ContainerList< T_Container >::ContainerPtrList = T_ContainerPtr *

private

Definition at line 25 of file ContainerList.h.

◆ T_ContainerPtr

template<typename T_Container>

using ContainerList< T_Container >::T_ContainerPtr = T_Container *

private

Definition at line 24 of file ContainerList.h.

Constructor & Destructor Documentation

◆ ContainerList()

template<typename T_Container>

ContainerList< T_Container >::ContainerList ( unsigned int expected_max_container )

inline

Create a container list for a certain number of containers.

Parameters

expected_max_container the number of expected containers this list will have (in most cases this should rather be too large than too small). If the initial guess was too optimistic the list will be grown, which adds some computational overhead (lock congestion).

Definition at line 33 of file ContainerList.h.

   {
      m_container.emplace_back(expected_max_container); // create expected_max_container containers
      // and create and populate the container list.
      m_containerList = fillContainerList( 0u,
                                           m_container.back(),
                                           expected_max_container <=1
                                           ? std::span<T_ContainerPtr>(&m_singleElementContainerList,1u)
                                           : std::span<T_ContainerPtr>(m_containerListHistory.emplace_back(expected_max_container) ));
   }

Member Function Documentation

◆ fillContainerList()

template<typename T_Container>

std::span< T_ContainerPtr > ContainerList< T_Container >::fillContainerList	(	unsigned int	begin_idx,
		std::vector< T_Container > &	container,
		std::span< T_ContainerPtr >	container_list )

inlinestaticprivate

Write pointers to containers in the given vector to a list starting at begin_index.

Parameters

begin_index	the pointer of the first element in container will be written to to container_list[begin_index] and so forth.
container	a vector of new containers which are to be registered in the given container list
container_list	a contiguous list of all the containers.

Definition at line 62 of file ContainerList.h.

                                                                                               {
      unsigned int end_idx=begin_idx+container.size();
      assert( end_idx <= container_list.size());
      for (unsigned int idx=begin_idx; idx < end_idx; ++idx) {
         container_list[idx]=&container[idx-begin_idx];
      }
      return container_list;
   }

◆ operator[]() [1/2]

template<typename T_Container>

T_Container & ContainerList< T_Container >::operator[] ( unsigned int idx )

inline

Return the container with the given container index (read-write).a.

Definition at line 47 of file ContainerList.h.

                                             {
      assert( idx < m_containerList.size() && m_containerList[idx]);
      return *(m_containerList[idx]);
   }

◆ operator[]() [2/2]

template<typename T_Container>

const T_Container & ContainerList< T_Container >::operator[] ( unsigned int idx ) const

inline

Return the container with the given container index (read-only).

Definition at line 52 of file ContainerList.h.

                                                         {
      assert( idx < m_containerList.size() && m_containerList[idx]);
      return *(m_containerList[idx]);
   }

◆ size()

template<typename T_Container>

std::size_t ContainerList< T_Container >::size ( ) const

inline

The number of containers in this list.

Definition at line 45 of file ContainerList.h.

45{ return m_containerList.size(); }

75{};

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

ContainerList.h

Public Member Functions

Private Types

Static Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ ContainerPtrList

◆ T_ContainerPtr

Constructor & Destructor Documentation

◆ ContainerList()

Member Function Documentation

◆ fillContainerList()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ size()

Friends And Related Symbol Documentation

◆ DynamicContainerListHelper< T_Container >

Member Data Documentation

◆ m_container

◆ m_containerList

◆ m_containerListHistory

◆ m_singleElementContainerList