A simple implementation of AttributeMap for a small number of values. More...

#include <ListMap.hpp>

Inheritance diagram for lvr2::ListMap< HandleT, ValueT >:

Public Member Functions
AttributeMapHandleIteratorPtr< HandleT >	begin () const final
	Returns an iterator over all keys of this map. The order of iteration is unspecified. More...

void	clear () final
	Removes all values from the map. More...

bool	containsKey (HandleT key) const final
	Returns true iff the map contains a value associated with the given key. More...

AttributeMapHandleIteratorPtr< HandleT >	end () const final
	Returns an iterator to the end of all keys. More...

boost::optional< ValueT >	erase (HandleT key) final
	Removes the value associated with the given key. More...

boost::optional< ValueT & >	get (HandleT key) final
	Returns the value associated with the given key or None if there is no associated value. More...

boost::optional< const ValueT & >	get (HandleT key) const final
	Returns the value associated with the given key or None if there is no associated value. More...

boost::optional< ValueT >	insert (HandleT key, const ValueT &value) final
	Inserts the given value at the given key position. More...

	ListMap ()
	Creates an empty map without default element set. More...

	ListMap (const ValueT &defaultValue)
	Creates a map with a given default value. More...

	ListMap (size_t countElements, const ValueT &defaultValue)
	Creates a map with a given default value and calls reserve. More...

size_t	numValues () const final
	Returns the number of values in this map. More...

void	reserve (size_t newCap)
	Allocates space for at least `newCap` more elements. More...

Public Member Functions inherited from lvr2::AttributeMap< HandleT, ValueT >
ValueT &	operator[] (HandleT key)
	Returns the value associated with the given key or panics if there is no associated value. More...

const ValueT &	operator[] (HandleT key) const
	Returns the value associated with the given key or panics if there is no associated value. More...

Private Member Functions
vector< pair< HandleT, ValueT > >::const_iterator	keyIterator (HandleT key) const

vector< pair< HandleT, ValueT > >::iterator	keyIterator (HandleT key)

Private Attributes
boost::optional< ValueT >	m_default

vector< pair< HandleT, ValueT > >	m_list

Friends
template<typename , typename >
class	ListMap

Additional Inherited Members
Public Types inherited from lvr2::AttributeMap< HandleT, ValueT >
typedef HandleT	HandleType
	The type of the handle used as key in this map. More...

typedef ValueT	ValueType
	The type of the value stored in this map. More...

Detailed Description

template<typename HandleT, typename ValueT>
class lvr2::ListMap< HandleT, ValueT >

A simple implementation of AttributeMap for a small number of values.

This implementation uses a simple, unordered list of key-value pairs to represent the map. This means that nearly all operations have a complexity of O(number_of_values), which is rather suboptimal. Thus this implementation only makes sense when the number of values is expected to be very small. A modern computer can easily search linearly through, like, 16 things. When we're dealing with a small number of things, often linear search will be faster than something fancy (like hashing or binary search).

However, this implementation doesn't use its whole potential right now. The biggest speed gain is possible by using small buffer optimization (SBO). This still needs to be implemented, but should be fairly straight forward.

Definition at line 65 of file ListMap.hpp.

Constructor & Destructor Documentation

◆ ListMap() [1/3]

template<typename HandleT , typename ValueT >

lvr2::ListMap< HandleT, ValueT >::ListMap ( )

inline

Creates an empty map without default element set.

Definition at line 71 of file ListMap.hpp.

◆ ListMap() [2/3]

template<typename HandleT , typename ValueT >

lvr2::ListMap< HandleT, ValueT >::ListMap ( const ValueT & defaultValue )

Creates a map with a given default value.

Whenever you request a value for a key and there isn't a value associated with that key, the default value is returned. Note that if you set a default value (which you do by calling this constructor), you can't remove it. Neither erase() nor clear() will do it. Calls to get() will always return a non-none value and operator[] won't ever panic.

One additional important detail: if you call get() to obtain a mutable reference, the default value is inserted into the map. This is the only sane way to return a mutably reference.

◆ ListMap() [3/3]

template<typename HandleT , typename ValueT >

lvr2::ListMap< HandleT, ValueT >::ListMap	(	size_t	countElements,
		const ValueT &	defaultValue
	)

Creates a map with a given default value and calls reserve.

This works exactly as the ListMap(const Value&) constructor, but also calls reserve(countElements) immediately afterwards.

Member Function Documentation

◆ begin()

template<typename HandleT , typename ValueT >

AttributeMapHandleIteratorPtr<HandleT> lvr2::ListMap< HandleT, ValueT >::begin ( ) const

finalvirtual

Returns an iterator over all keys of this map. The order of iteration is unspecified.

You can simply iterate over all keys of this map with a range-based for-loop:

for (auto handle: attributeMap) { ... }

Implements lvr2::AttributeMap< HandleT, ValueT >.

◆ clear()

template<typename HandleT , typename ValueT >

void lvr2::ListMap< HandleT, ValueT >::clear ( )

finalvirtual

Removes all values from the map.

Implements lvr2::AttributeMap< HandleT, ValueT >.

◆ containsKey()

template<typename HandleT , typename ValueT >

bool lvr2::ListMap< HandleT, ValueT >::containsKey ( HandleT key ) const

finalvirtual

Returns true iff the map contains a value associated with the given key.

Implements lvr2::AttributeMap< HandleT, ValueT >.

◆ end()

template<typename HandleT , typename ValueT >

AttributeMapHandleIteratorPtr<HandleT> lvr2::ListMap< HandleT, ValueT >::end ( ) const

finalvirtual

Returns an iterator to the end of all keys.

Implements lvr2::AttributeMap< HandleT, ValueT >.

◆ erase()

template<typename HandleT , typename ValueT >

boost::optional<ValueT> lvr2::ListMap< HandleT, ValueT >::erase ( HandleT key )

finalvirtual

Removes the value associated with the given key.

Returns: If there was a value associated with the key, it is returned. None otherwise.

Implements lvr2::AttributeMap< HandleT, ValueT >.

◆ get() [1/2]

template<typename HandleT , typename ValueT >

boost::optional<ValueT&> lvr2::ListMap< HandleT, ValueT >::get ( HandleT key )

finalvirtual

Returns the value associated with the given key or None if there is no associated value.

Note: this method can not be used to insert a new value. It only allows reading and modifying an already inserted value.

Implements lvr2::AttributeMap< HandleT, ValueT >.

◆ get() [2/2]

template<typename HandleT , typename ValueT >

boost::optional<const ValueT&> lvr2::ListMap< HandleT, ValueT >::get ( HandleT key ) const

finalvirtual

Returns the value associated with the given key or None if there is no associated value.

Note: this method can not be used to insert a new value. It only allows reading an already inserted value.

Implements lvr2::AttributeMap< HandleT, ValueT >.

◆ insert()

template<typename HandleT , typename ValueT >

boost::optional<ValueT> lvr2::ListMap< HandleT, ValueT >::insert	(	HandleT	key,
		const ValueT &	value
	)

finalvirtual

Inserts the given value at the given key position.

Returns: If there was a value associated with the given key before inserting the new value, the old value is returned. None otherwise.

Implements lvr2::AttributeMap< HandleT, ValueT >.

◆ keyIterator() [1/2]

template<typename HandleT , typename ValueT >

vector<pair<HandleT, ValueT> >::const_iterator lvr2::ListMap< HandleT, ValueT >::keyIterator ( HandleT key ) const

private

◆ keyIterator() [2/2]

template<typename HandleT , typename ValueT >

vector<pair<HandleT, ValueT> >::iterator lvr2::ListMap< HandleT, ValueT >::keyIterator ( HandleT key )

private

◆ numValues()

template<typename HandleT , typename ValueT >

size_t lvr2::ListMap< HandleT, ValueT >::numValues ( ) const

finalvirtual

Returns the number of values in this map.

Implements lvr2::AttributeMap< HandleT, ValueT >.

◆ reserve()

template<typename HandleT , typename ValueT >

void lvr2::ListMap< HandleT, ValueT >::reserve ( size_t newCap )

Allocates space for at least newCap more elements.

Friends And Related Function Documentation

◆ ListMap

template<typename HandleT , typename ValueT >

template<typename , typename >

friend class ListMap

friend

Definition at line 124 of file ListMap.hpp.

Member Data Documentation

◆ m_default

template<typename HandleT , typename ValueT >

boost::optional<ValueT> lvr2::ListMap< HandleT, ValueT >::m_default

private

Definition at line 118 of file ListMap.hpp.

◆ m_list

template<typename HandleT , typename ValueT >

vector<pair<HandleT, ValueT> > lvr2::ListMap< HandleT, ValueT >::m_list

private

Definition at line 117 of file ListMap.hpp.

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

ListMap.hpp

Public Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

template<typename HandleT, typename ValueT> class lvr2::ListMap< HandleT, ValueT >

Constructor & Destructor Documentation

◆ ListMap() [1/3]

◆ ListMap() [2/3]

◆ ListMap() [3/3]

Member Function Documentation

◆ begin()

◆ clear()

◆ containsKey()

◆ end()

◆ erase()

◆ get() [1/2]

◆ get() [2/2]

◆ insert()

◆ keyIterator() [1/2]

◆ keyIterator() [2/2]

◆ numValues()

◆ reserve()

Friends And Related Function Documentation

◆ ListMap

Member Data Documentation

◆ m_default

◆ m_list

template<typename HandleT, typename ValueT>
class lvr2::ListMap< HandleT, ValueT >