belfem::OrderedMap< Key, Value > Class Template Reference

Sorted map (ordered key-value). More...

#include <cl_OrderedMap.hpp>

Public Types
using	const_iterator = typename std::map< Key, Value >::const_iterator

Public Member Functions
	OrderedMap ()=default
	empty constructor
	OrderedMap (const OrderedMap< Key, Value > &aMap)=default
	copy constructor
	OrderedMap (OrderedMap< Key, Value > &&other) noexcept=default
	move constructor
OrderedMap< Key, Value > &	operator= (const OrderedMap< Key, Value > &other)=default
	Copy assignment operator.
OrderedMap< Key, Value > &	operator= (OrderedMap< Key, Value > &&other) noexcept=default
	Move assignment operator constructor.
	~OrderedMap ()=default
	default destructor
void	clear ()
	clear map
size_t	size () const
	returns the size of the map
Value &	operator[] (const Key &aKey)
	insert operator
bool	key_exists (const Key &aKey) const
auto	begin () const -> decltype(mMap.begin())
auto	end () const -> decltype(mMap.end())
auto	find (const Key &tKey) const -> decltype(mMap.find(tKey))
auto	empty () const -> decltype(mMap.empty())
void	erase_key (const Key &aKey)
auto	map_data () -> decltype(mMap) &
Value &	operator() (const Key &aKey)
	find operator
const Value &	operator() (const Key &aKey) const
	find operator ( const variant )

Detailed Description

template<typename Key, typename Value>
class belfem::OrderedMap< Key, Value >

Sorted map (ordered key-value).

See also

BELFEM Container Classes - Usage Guide

Member Typedef Documentation

const_iterator

template<typename Key, typename Value>

using belfem::OrderedMap< Key, Value >::const_iterator = typename std::map< Key, Value >::const_iterator

Constructor & Destructor Documentation

OrderedMap() [1/3]

template<typename Key, typename Value>

belfem::OrderedMap< Key, Value >::OrderedMap ( )

explicitdefault

empty constructor

OrderedMap() [2/3]

template<typename Key, typename Value>

belfem::OrderedMap< Key, Value >::OrderedMap ( const OrderedMap< Key, Value > & aMap )

default

copy constructor

OrderedMap() [3/3]

template<typename Key, typename Value>

belfem::OrderedMap< Key, Value >::OrderedMap ( OrderedMap< Key, Value > && other )

defaultnoexcept

move constructor

~OrderedMap()

template<typename Key, typename Value>

belfem::OrderedMap< Key, Value >::~OrderedMap ( )

default

default destructor

Member Function Documentation

begin()

template<typename Key, typename Value>

auto belfem::OrderedMap< Key, Value >::begin ( ) const -> decltype(mMap.begin())

inline

clear()

template<typename Key, typename Value>

void belfem::OrderedMap< Key, Value >::clear ( )

inline

clear map

empty()

template<typename Key, typename Value>

auto belfem::OrderedMap< Key, Value >::empty ( ) const -> decltype(mMap.empty())

inline

end()

template<typename Key, typename Value>

auto belfem::OrderedMap< Key, Value >::end ( ) const -> decltype(mMap.end())

inline

erase_key()

template<typename Key, typename Value>

void belfem::OrderedMap< Key, Value >::erase_key ( const Key & aKey )

inline

find()

template<typename Key, typename Value>

auto belfem::OrderedMap< Key, Value >::find ( const Key & tKey ) const -> decltype(mMap.find(tKey))

inline

key_exists()

template<typename Key, typename Value>

bool belfem::OrderedMap< Key, Value >::key_exists ( const Key & aKey ) const

inline

map_data()

template<typename Key, typename Value>

auto belfem::OrderedMap< Key, Value >::map_data ( ) -> decltype(mMap) &

inline

operator()() [1/2]

template<typename Key, typename Value>

Value & belfem::OrderedMap< Key, Value >::operator() ( const Key & aKey )

inline

find operator

operator()() [2/2]

template<typename Key, typename Value>

const Value & belfem::OrderedMap< Key, Value >::operator() ( const Key & aKey ) const

inline

find operator ( const variant )

operator=() [1/2]

template<typename Key, typename Value>

OrderedMap< Key, Value > & belfem::OrderedMap< Key, Value >::operator= ( const OrderedMap< Key, Value > & other )

default

Copy assignment operator.

operator=() [2/2]

template<typename Key, typename Value>

OrderedMap< Key, Value > & belfem::OrderedMap< Key, Value >::operator= ( OrderedMap< Key, Value > && other )

defaultnoexcept

Move assignment operator constructor.

operator[]()

template<typename Key, typename Value>

Value & belfem::OrderedMap< Key, Value >::operator[] ( const Key & aKey )

inline

insert operator

size()

template<typename Key, typename Value>

size_t belfem::OrderedMap< Key, Value >::size ( ) const

inline

returns the size of the map

---

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

• src/containers/cl_OrderedMap.hpp