ContainerAccessor< value_t, identifier_t, inline_size > Class Template Reference

#include <ContainerAccessor.h>

Collaboration diagram for ContainerAccessor< value_t, identifier_t, inline_size >:

Public Types
using	container_t = DataVector< value_t >
using	Iterator = typename container_t::const_iterator
using	Range = std::pair< Iterator, Iterator >

Public Member Functions
	ContainerAccessor (const container_t &values, std::function< identifier_t(const value_t &)> mapper, size_t max_ids=2000)
	Constructor. More...
	~ContainerAccessor ()=default
	Default destructor. More...
	ContainerAccessor (const ContainerAccessor &)=delete
	Copy constructor, deleted. More...
ContainerAccessor &	operator= (const ContainerAccessor &)=delete
const boost::container::small_vector< Range, inline_size >	rangesForIdentifierDirect (const identifier_t &identifier) const
	Function to return the list of ranges corresponding to a given identifier. More...
bool	isIdentifierPresent (const identifier_t &identifier) const
	Function to verify if a given identifier is present in the map, i.e. More...
std::vector< identifier_t >	allIdentifiers () const
	Function to return all available identifier (i.e. keys in the map) More...

Private Attributes
std::unordered_map< identifier_t, boost::container::small_vector< Range, inline_size > >	m_ranges

Detailed Description

template<typename value_t, typename identifier_t, size_t inline_size = 10>
class ContainerAccessor< value_t, identifier_t, inline_size >

Class implementing how to access a container

It is templated on the type of the objects in the container (value_t), and the type of the identifier (identifier_t)

Definition at line 25 of file ContainerAccessor.h.

Member Typedef Documentation

container_t

template<typename value_t , typename identifier_t , size_t inline_size = 10>

using ContainerAccessor< value_t, identifier_t, inline_size >::container_t = DataVector<value_t>

Definition at line 28 of file ContainerAccessor.h.

Iterator

template<typename value_t , typename identifier_t , size_t inline_size = 10>

using ContainerAccessor< value_t, identifier_t, inline_size >::Iterator = typename container_t::const_iterator

Definition at line 29 of file ContainerAccessor.h.

Range

template<typename value_t , typename identifier_t , size_t inline_size = 10>

using ContainerAccessor< value_t, identifier_t, inline_size >::Range = std::pair<Iterator, Iterator>

Definition at line 30 of file ContainerAccessor.h.

Constructor & Destructor Documentation

ContainerAccessor() [1/2]

template<typename value_t , typename identifier_t , size_t inline_size = 10>

ContainerAccessor< value_t, identifier_t, inline_size >::ContainerAccessor ( const container_t &  values, std::function< identifier_t(const value_t &)>  mapper, size_t  max_ids = 2000  )

inline

Constructor.

Template Parameters

values	Container type, based on value_t
mapper	Function used to access the identifier_t

Parameters

max_ids

Expected maximum number of identifiers, to reserve enough space in the map and avoid re-hashing

At construction, a map is filled with identifiers and corresponding ranges of objects in the container

Note

The map has to be built as soon as the container is complete. If changes in the container happen the ranges may be invalidated.

Definition at line 41 of file ContainerAccessor.h.

                                                                                                 {
        m_ranges.reserve(max_ids);
        std::optional<identifier_t> prev = std::nullopt;
        Iterator groupStart = values.begin();
        for (Iterator it = values.begin(); it != values.end(); ++it) {
            identifier_t id = mapper(**it);
            if (prev && (*prev) != id) {
                m_ranges[*prev].emplace_back(groupStart, it);
                groupStart = it;
            }
            prev = id;
        }
        if (prev)
            m_ranges[*prev].emplace_back(groupStart, values.end());
    }

~ContainerAccessor()

template<typename value_t , typename identifier_t , size_t inline_size = 10>

ContainerAccessor< value_t, identifier_t, inline_size >::~ContainerAccessor ( )

default

Default destructor.

ContainerAccessor() [2/2]

template<typename value_t , typename identifier_t , size_t inline_size = 10>

ContainerAccessor< value_t, identifier_t, inline_size >::ContainerAccessor ( const ContainerAccessor< value_t, identifier_t, inline_size > &  )

delete

Copy constructor, deleted.

Member Function Documentation

allIdentifiers()

template<typename value_t , typename identifier_t , size_t inline_size = 10>

std::vector<identifier_t> ContainerAccessor< value_t, identifier_t, inline_size >::allIdentifiers ( ) const

inline

Function to return all available identifier (i.e. keys in the map)

Definition at line 84 of file ContainerAccessor.h.

                                                   {
        std::vector<identifier_t> ids{};
        ids.reserve(m_ranges.size());
        for (const auto& id_range : m_ranges)
            ids.push_back(id_range.first);
        return ids;
    };

isIdentifierPresent()

template<typename value_t , typename identifier_t , size_t inline_size = 10>

bool ContainerAccessor< value_t, identifier_t, inline_size >::isIdentifierPresent ( const identifier_t &  identifier ) const

inline

Function to verify if a given identifier is present in the map, i.e.

was present in the input container.

Template Parameters

identifier

Input identifier to check.

Definition at line 77 of file ContainerAccessor.h.

                                                                   {
        if (m_ranges.find(identifier) == m_ranges.end())
            return false;
        return true;
    }

operator=()

template<typename value_t , typename identifier_t , size_t inline_size = 10>

ContainerAccessor& ContainerAccessor< value_t, identifier_t, inline_size >::operator= ( const ContainerAccessor< value_t, identifier_t, inline_size > &  )

delete

rangesForIdentifierDirect()

template<typename value_t , typename identifier_t , size_t inline_size = 10>

const boost::container::small_vector<Range, inline_size> ContainerAccessor< value_t, identifier_t, inline_size >::rangesForIdentifierDirect ( const identifier_t &  identifier ) const

inline

Function to return the list of ranges corresponding to a given identifier.

Template Parameters

identifier

Input identifier, used for returning the list of ranges from the map.

Note

the identifier must be contained in the map. Check if it is present first with isIdentifierPresent.

Definition at line 69 of file ContainerAccessor.h.

                                                                                                                         {
        boost::container::small_vector<Range, inline_size> rangesForId = m_ranges.at(identifier);
        return rangesForId;
    }

Member Data Documentation

m_ranges

template<typename value_t , typename identifier_t , size_t inline_size = 10>

std::unordered_map<identifier_t, boost::container::small_vector<Range, inline_size> > ContainerAccessor< value_t, identifier_t, inline_size >::m_ranges

private

Definition at line 93 of file ContainerAccessor.h.

---

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

• ContainerAccessor.h