Template class of bidirectional map. More...

#include <common/Bimap.hpp>

Collaboration diagram for AMCAX::Bimap< key_type, value_type >:

[legend]

Public Types
using	map_type1 = std::unordered_map<key_type, value_type>
	Type of the forward map.

using	map_type2 = std::unordered_map<value_type, key_type>
	Type of the inverse map.

using	map_iterator1 = typename map_type1::iterator
	Iterator of the forward map.

using	map_iterator2 = typename map_type2::iterator
	Iterator of the inverse map.

using	map_const_iterator1 = typename map_type1::const_iterator
	Constant iterator of the forward map.

using	map_const_iterator2 = typename map_type2::const_iterator
	Constant iterator of the inverse map.

Public Member Functions
	Bimap () noexcept(noexcept(map_type1()) &&noexcept(map_type2()))=default
	Default constructor.

	Bimap (const std::unordered_map< key_type, value_type > &smap)
	Construct from a normal map.

bool	empty () const noexcept
	Is the map empty.

int	size () const noexcept
	Get the size of map.

void	clear () noexcept
	Clear the map.

bool	insert (const key_type &key, const value_type &value)
	Insert a pair of key and value.

bool	insert_replace (const key_type &key, const value_type &value)
	Insert a pair of key and value, replace the data if existed.

bool	erase_key (const key_type &key)
	Erase the data by key.

map_iterator1	erase_key (map_iterator1 it) noexcept
	Erase the data by iterator of forward map.

map_iterator1	erase_key (map_const_iterator1 it) noexcept
	Erase the data by constant iterator of forward map.

bool	erase_value (const value_type &value)
	Erase the data by value.

map_iterator2	erase_value (map_iterator2 it) noexcept
	Erase the data by iterator of inverse map.

map_iterator2	erase_value (map_const_iterator2 it) noexcept
	Erase the data by constant iterator of inverse map.

void	swap (Bimap &other) noexcept(noexcept(std::declval< map_type1 >().swap(other.map1)) &&noexcept(std::declval< map_type2 >().swap(other.map2)))
	Swap with another bimap.

std::pair< map_const_iterator1, bool >	find_value_from_key (const key_type &k) const
	Find the value from a key.

std::pair< map_const_iterator2, bool >	find_key_from_value (const value_type &v) const
	Find the key from a value.

constexpr auto	begin () noexcept
	Get the begin iterator.

constexpr auto	begin () const noexcept
	Get the constant begin iterator.

constexpr auto	cbegin () const noexcept
	Get the constant begin iterator.

constexpr auto	end () noexcept
	Get the end iterator.

constexpr auto	end () const noexcept
	Get the constant end iterator.

constexpr auto	cend () const noexcept
	Get the constant end iterator.

constexpr auto &	inverse_map () const noexcept
	Get the inverse map.

Protected Attributes
map_type1	map1
	Map from key to value.

map_type2	map2
	Map from value to key.

Detailed Description

template<typename key_type, typename value_type>
class AMCAX::Bimap< key_type, value_type >

Template class of bidirectional map.

Template Parameters

key_type	Type of key
value_type	Type of value

Constructor & Destructor Documentation

◆ Bimap()

template<typename key_type, typename value_type>

AMCAX::Bimap< key_type, value_type >::Bimap ( const std::unordered_map< key_type, value_type > & smap )

inlineexplicit

Construct from a normal map.

Parameters

smap The map

Member Function Documentation

◆ begin() [1/2]

template<typename key_type, typename value_type>

auto AMCAX::Bimap< key_type, value_type >::begin ( ) const

inlinenodiscardconstexprnoexcept

Get the constant begin iterator.

Returns: The constant begin iterator

◆ begin() [2/2]

template<typename key_type, typename value_type>

auto AMCAX::Bimap< key_type, value_type >::begin ( )

inlinenodiscardconstexprnoexcept

Get the begin iterator.

Returns: The begin iterator

◆ cbegin()

template<typename key_type, typename value_type>

auto AMCAX::Bimap< key_type, value_type >::cbegin ( ) const

inlinenodiscardconstexprnoexcept

Get the constant begin iterator.

Returns: The constant begin iterator

◆ cend()

template<typename key_type, typename value_type>

auto AMCAX::Bimap< key_type, value_type >::cend ( ) const

inlinenodiscardconstexprnoexcept

Get the constant end iterator.

Returns: The constant end iterator

◆ empty()

template<typename key_type, typename value_type>

bool AMCAX::Bimap< key_type, value_type >::empty ( ) const

inlinenodiscardnoexcept

Is the map empty.

Returns: True if the map is empty

◆ end() [1/2]

template<typename key_type, typename value_type>

auto AMCAX::Bimap< key_type, value_type >::end ( ) const

inlinenodiscardconstexprnoexcept

Get the constant end iterator.

Returns: The constant end iterator

◆ end() [2/2]

template<typename key_type, typename value_type>

auto AMCAX::Bimap< key_type, value_type >::end ( )

inlinenodiscardconstexprnoexcept

Get the end iterator.

Returns: The end iterator

◆ erase_key() [1/3]

template<typename key_type, typename value_type>

bool AMCAX::Bimap< key_type, value_type >::erase_key ( const key_type & key )

inline

Erase the data by key.

Parameters

key	The key to be erased

Returns: True if the key is erased

◆ erase_key() [2/3]

template<typename key_type, typename value_type>

map_iterator1 AMCAX::Bimap< key_type, value_type >::erase_key ( map_const_iterator1 it )

inlinenoexcept

Erase the data by constant iterator of forward map.

Parameters

it	The constant iterator of forward map

Returns: The iterator after the erased iterator

◆ erase_key() [3/3]

template<typename key_type, typename value_type>

map_iterator1 AMCAX::Bimap< key_type, value_type >::erase_key ( map_iterator1 it )

inlinenoexcept

Erase the data by iterator of forward map.

Parameters

it	The iterator of forward map

Returns: The iterator after the erased iterator

◆ erase_value() [1/3]

template<typename key_type, typename value_type>

bool AMCAX::Bimap< key_type, value_type >::erase_value ( const value_type & value )

inline

Erase the data by value.

Parameters

value The value to be erased

Returns: True if the value is erased

◆ erase_value() [2/3]

template<typename key_type, typename value_type>

map_iterator2 AMCAX::Bimap< key_type, value_type >::erase_value ( map_const_iterator2 it )

inlinenoexcept

Erase the data by constant iterator of inverse map.

Parameters

it	The constant iterator of inverse map

Returns: The iterator after the erased iterator

◆ erase_value() [3/3]

template<typename key_type, typename value_type>

map_iterator2 AMCAX::Bimap< key_type, value_type >::erase_value ( map_iterator2 it )

inlinenoexcept

Erase the data by iterator of inverse map.

Parameters

it	The iterator of inverse map

Returns: The iterator after the erased iterator

◆ find_key_from_value()

template<typename key_type, typename value_type>

std::pair< map_const_iterator2, bool > AMCAX::Bimap< key_type, value_type >::find_key_from_value ( const value_type & v ) const

inlinenodiscard

Find the key from a value.

Parameters

v The value

Returns: The pair of iterator of inverse map and a boolean which shows whether the value is found

◆ find_value_from_key()

template<typename key_type, typename value_type>

std::pair< map_const_iterator1, bool > AMCAX::Bimap< key_type, value_type >::find_value_from_key ( const key_type & k ) const

inlinenodiscard

Find the value from a key.

Parameters

k The key

Returns: The pair of iterator of map and a boolean which shows whether the key is found

◆ insert()

template<typename key_type, typename value_type>

bool AMCAX::Bimap< key_type, value_type >::insert	(	const key_type &	key,
		const value_type &	value )

inline

Insert a pair of key and value.

If either the key or the value is found in the map, do nothing

Parameters

key	The key to be inserted
value	The value to be inserted

Returns: True if the insertion succeed

◆ insert_replace()

template<typename key_type, typename value_type>

bool AMCAX::Bimap< key_type, value_type >::insert_replace	(	const key_type &	key,
		const value_type &	value )

inline

Insert a pair of key and value, replace the data if existed.

If the key and value are both found in the map, but not mapped to each other, the insertion fails.

Parameters

key	The key to be inserted
value	The value to be inserted

Returns: True if the insertion succeed

◆ inverse_map()

template<typename key_type, typename value_type>

auto & AMCAX::Bimap< key_type, value_type >::inverse_map ( ) const

inlinenodiscardconstexprnoexcept

Get the inverse map.

Returns: The inverse map

◆ size()

template<typename key_type, typename value_type>

int AMCAX::Bimap< key_type, value_type >::size ( ) const

inlinenodiscardnoexcept

Get the size of map.

Returns: The size of map

◆ swap()

template<typename key_type, typename value_type>

void AMCAX::Bimap< key_type, value_type >::swap ( Bimap< key_type, value_type > & other )

inlinenoexcept

Swap with another bimap.

Parameters

other The other bimap

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

common/Bimap.hpp

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Bimap()

Member Function Documentation

◆ begin() [1/2]

◆ begin() [2/2]

◆ cbegin()

◆ cend()

◆ empty()

◆ end() [1/2]

◆ end() [2/2]

◆ erase_key() [1/3]

◆ erase_key() [2/3]

◆ erase_key() [3/3]

◆ erase_value() [1/3]

◆ erase_value() [2/3]

◆ erase_value() [3/3]

◆ find_key_from_value()

◆ find_value_from_key()

◆ insert()

◆ insert_replace()

◆ inverse_map()

◆ size()

◆ swap()