Main MRPT website > C++ reference for MRPT 1.5.7
List of all members | Public Types | Public Member Functions | Private Attributes
mrpt::utils::bimap< KEY, VALUE > Class Template Reference

Detailed Description

template<typename KEY, typename VALUE>
class mrpt::utils::bimap< KEY, VALUE >

A bidirectional version of std::map, declared as bimap<KEY,VALUE> and which actually contains two std::map's, one for keys and another for values.

To use this class, insert new pairs KEY<->VALUE with bimap::insert. Then, you can access the KEY->VALUE map with bimap::direct(), and the VALUE->KEY map with bimap::inverse(). The consistency of the two internal maps is assured at any time.

Note
This class can be accessed through iterators to the map KEY->VALUE only.
Both typenames KEY and VALUE must be suitable for being employed as keys in a std::map, i.e. they must be comparable through a "< operator".
Defined in #include <mrpt/utils/bimap.h>

Definition at line 28 of file bimap.h.

#include <mrpt/utils/bimap.h>

Inheritance diagram for mrpt::utils::bimap< KEY, VALUE >:
Inheritance graph

Public Types

typedef std::map< KEY, VALUE >::const_iterator const_iterator
 
typedef std::map< KEY, VALUE >::iterator iterator
 
typedef std::map< VALUE, KEY >::const_iterator const_iterator_inverse
 
typedef std::map< VALUE, KEY >::iterator iterator_inverse
 

Public Member Functions

 bimap ()
 Default constructor - does nothing. More...
 
const_iterator begin () const
 
iterator begin ()
 
const_iterator end () const
 
iterator end ()
 
const_iterator_inverse inverse_begin () const
 
iterator_inverse inverse_begin ()
 
const_iterator_inverse inverse_end () const
 
iterator_inverse inverse_end ()
 
size_t size () const
 
bool empty () const
 
const std::map< KEY, VALUE > & getDirectMap () const
 Return a read-only reference to the internal map KEY->VALUES. More...
 
const std::map< VALUE, KEY > & getInverseMap () const
 Return a read-only reference to the internal map KEY->VALUES. More...
 
void clear ()
 
void insert (const KEY &k, const VALUE &v)
 Insert a new pair KEY<->VALUE in the bi-map. More...
 
bool direct (const KEY &k, VALUE &out_v) const
 Get the value associated the given key, KEY->VALUE, returning false if not present. More...
 
bool hasKey (const KEY &k) const
 Return true if the given key 'k' is in the bi-map. More...
 
bool hasValue (const VALUE &v) const
 Return true if the given value 'v' is in the bi-map. More...
 
VALUE direct (const KEY &k) const
 Get the value associated the given key, KEY->VALUE, raising an exception if not present. More...
 
bool inverse (const VALUE &v, KEY &out_k) const
 Get the key associated the given value, VALUE->KEY, returning false if not present. More...
 
KEY inverse (const VALUE &v) const
 Get the key associated the given value, VALUE->KEY, raising an exception if not present. More...
 
const_iterator find_key (const KEY &k) const
 
iterator find_key (const KEY &k)
 
const_iterator_inverse find_value (const VALUE &v) const
 
iterator_inverse find_value (const VALUE &v)
 

Private Attributes

std::map< KEY, VALUE > m_k2v
 
std::map< VALUE, KEY > m_v2k
 

Member Typedef Documentation

◆ const_iterator

template<typename KEY, typename VALUE>
typedef std::map<KEY,VALUE>::const_iterator mrpt::utils::bimap< KEY, VALUE >::const_iterator

Definition at line 35 of file bimap.h.

◆ const_iterator_inverse

template<typename KEY, typename VALUE>
typedef std::map<VALUE,KEY>::const_iterator mrpt::utils::bimap< KEY, VALUE >::const_iterator_inverse

Definition at line 38 of file bimap.h.

◆ iterator

template<typename KEY, typename VALUE>
typedef std::map<KEY,VALUE>::iterator mrpt::utils::bimap< KEY, VALUE >::iterator

Definition at line 36 of file bimap.h.

◆ iterator_inverse

template<typename KEY, typename VALUE>
typedef std::map<VALUE,KEY>::iterator mrpt::utils::bimap< KEY, VALUE >::iterator_inverse

Definition at line 39 of file bimap.h.

Constructor & Destructor Documentation

◆ bimap()

template<typename KEY, typename VALUE>
mrpt::utils::bimap< KEY, VALUE >::bimap ( )
inline

Default constructor - does nothing.

Definition at line 42 of file bimap.h.

Member Function Documentation

◆ begin() [1/2]

template<typename KEY, typename VALUE>
const_iterator mrpt::utils::bimap< KEY, VALUE >::begin ( ) const
inline

Definition at line 44 of file bimap.h.

◆ begin() [2/2]

template<typename KEY, typename VALUE>
iterator mrpt::utils::bimap< KEY, VALUE >::begin ( )
inline

Definition at line 45 of file bimap.h.

◆ clear()

template<typename KEY, typename VALUE>
void mrpt::utils::bimap< KEY, VALUE >::clear ( )
inline

◆ direct() [1/2]

template<typename KEY, typename VALUE>
bool mrpt::utils::bimap< KEY, VALUE >::direct ( const KEY &  k,
VALUE &  out_v 
) const
inline

Get the value associated the given key, KEY->VALUE, returning false if not present.

See also
inverse, hasKey, hasValue
Returns
false on key not found.

Definition at line 79 of file bimap.h.

◆ direct() [2/2]

template<typename KEY, typename VALUE>
VALUE mrpt::utils::bimap< KEY, VALUE >::direct ( const KEY &  k) const
inline

Get the value associated the given key, KEY->VALUE, raising an exception if not present.

See also
inverse, hasKey, hasValue
Exceptions
std::exceptionOn key not present in the bi-map.

Definition at line 100 of file bimap.h.

◆ empty()

template<typename KEY, typename VALUE>
bool mrpt::utils::bimap< KEY, VALUE >::empty ( ) const
inline

Definition at line 55 of file bimap.h.

◆ end() [1/2]

template<typename KEY, typename VALUE>
const_iterator mrpt::utils::bimap< KEY, VALUE >::end ( ) const
inline

◆ end() [2/2]

template<typename KEY, typename VALUE>
iterator mrpt::utils::bimap< KEY, VALUE >::end ( )
inline

Definition at line 47 of file bimap.h.

◆ find_key() [1/2]

template<typename KEY, typename VALUE>
const_iterator mrpt::utils::bimap< KEY, VALUE >::find_key ( const KEY &  k) const
inline

◆ find_key() [2/2]

template<typename KEY, typename VALUE>
iterator mrpt::utils::bimap< KEY, VALUE >::find_key ( const KEY &  k)
inline

Definition at line 132 of file bimap.h.

◆ find_value() [1/2]

template<typename KEY, typename VALUE>
const_iterator_inverse mrpt::utils::bimap< KEY, VALUE >::find_value ( const VALUE &  v) const
inline

Definition at line 134 of file bimap.h.

◆ find_value() [2/2]

template<typename KEY, typename VALUE>
iterator_inverse mrpt::utils::bimap< KEY, VALUE >::find_value ( const VALUE &  v)
inline

Definition at line 135 of file bimap.h.

◆ getDirectMap()

template<typename KEY, typename VALUE>
const std::map<KEY,VALUE>& mrpt::utils::bimap< KEY, VALUE >::getDirectMap ( ) const
inline

Return a read-only reference to the internal map KEY->VALUES.

Definition at line 58 of file bimap.h.

◆ getInverseMap()

template<typename KEY, typename VALUE>
const std::map<VALUE,KEY>& mrpt::utils::bimap< KEY, VALUE >::getInverseMap ( ) const
inline

Return a read-only reference to the internal map KEY->VALUES.

Definition at line 60 of file bimap.h.

Referenced by mrpt::slam::CRangeBearingKFSLAM2D::getCurrentState(), and mrpt::slam::CRangeBearingKFSLAM::getCurrentState().

◆ hasKey()

template<typename KEY, typename VALUE>
bool mrpt::utils::bimap< KEY, VALUE >::hasKey ( const KEY &  k) const
inline

Return true if the given key 'k' is in the bi-map.

See also
hasValue, direct, inverse

Definition at line 88 of file bimap.h.

◆ hasValue()

template<typename KEY, typename VALUE>
bool mrpt::utils::bimap< KEY, VALUE >::hasValue ( const VALUE &  v) const
inline

Return true if the given value 'v' is in the bi-map.

See also
hasKey, direct, inverse

Definition at line 92 of file bimap.h.

◆ insert()

template<typename KEY, typename VALUE>
void mrpt::utils::bimap< KEY, VALUE >::insert ( const KEY &  k,
const VALUE &  v 
)
inline

◆ inverse() [1/2]

template<typename KEY, typename VALUE>
bool mrpt::utils::bimap< KEY, VALUE >::inverse ( const VALUE &  v,
KEY &  out_k 
) const
inline

Get the key associated the given value, VALUE->KEY, returning false if not present.

See also
direct, hasKey, hasValue
Returns
false on value not found.

Definition at line 111 of file bimap.h.

Referenced by mrpt::slam::CRangeBearingKFSLAM::getAs3DObject(), and mrpt::slam::CRangeBearingKFSLAM::getLastPartitionLandmarks().

◆ inverse() [2/2]

template<typename KEY, typename VALUE>
KEY mrpt::utils::bimap< KEY, VALUE >::inverse ( const VALUE &  v) const
inline

Get the key associated the given value, VALUE->KEY, raising an exception if not present.

See also
direct, hasKey, hasValue
Returns
false on value not found.

Definition at line 123 of file bimap.h.

◆ inverse_begin() [1/2]

template<typename KEY, typename VALUE>
const_iterator_inverse mrpt::utils::bimap< KEY, VALUE >::inverse_begin ( ) const
inline

Definition at line 49 of file bimap.h.

◆ inverse_begin() [2/2]

template<typename KEY, typename VALUE>
iterator_inverse mrpt::utils::bimap< KEY, VALUE >::inverse_begin ( )
inline

Definition at line 50 of file bimap.h.

◆ inverse_end() [1/2]

template<typename KEY, typename VALUE>
const_iterator_inverse mrpt::utils::bimap< KEY, VALUE >::inverse_end ( ) const
inline

Definition at line 51 of file bimap.h.

◆ inverse_end() [2/2]

template<typename KEY, typename VALUE>
iterator_inverse mrpt::utils::bimap< KEY, VALUE >::inverse_end ( )
inline

Definition at line 52 of file bimap.h.

◆ size()

template<typename KEY, typename VALUE>
size_t mrpt::utils::bimap< KEY, VALUE >::size ( ) const
inline

Member Data Documentation

◆ m_k2v

template<typename KEY, typename VALUE>
std::map<KEY,VALUE> mrpt::utils::bimap< KEY, VALUE >::m_k2v
private

◆ m_v2k

template<typename KEY, typename VALUE>
std::map<VALUE,KEY> mrpt::utils::bimap< KEY, VALUE >::m_v2k
private



Page generated by Doxygen 1.8.14 for MRPT 1.5.7 Git: 8277875f6 Mon Jun 11 02:47:32 2018 +0200 at lun oct 28 01:50:49 CET 2019