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>
#include <mrpt/utils/bimap.h>
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
| typedef std::map<KEY,VALUE>::const_iterator mrpt::utils::bimap< KEY, VALUE >::const_iterator |
§ const_iterator_inverse
| typedef std::map<VALUE,KEY>::const_iterator mrpt::utils::bimap< KEY, VALUE >::const_iterator_inverse |
§ iterator
| typedef std::map<KEY,VALUE>::iterator mrpt::utils::bimap< KEY, VALUE >::iterator |
§ iterator_inverse
| typedef std::map<VALUE,KEY>::iterator mrpt::utils::bimap< KEY, VALUE >::iterator_inverse |
Constructor & Destructor Documentation
§ bimap()
|
inline |
Member Function Documentation
§ begin() [1/2]
|
inline |
§ begin() [2/2]
|
inline |
§ clear()
|
inline |
§ direct() [1/2]
|
inline |
§ direct() [2/2]
|
inline |
§ empty()
|
inline |
§ end() [1/2]
|
inline |
§ end() [2/2]
|
inline |
§ find_key() [1/2]
|
inline |
§ find_key() [2/2]
|
inline |
§ find_value() [1/2]
|
inline |
§ find_value() [2/2]
|
inline |
§ getDirectMap()
|
inline |
§ getInverseMap()
|
inline |
§ hasKey()
|
inline |
§ hasValue()
|
inline |
§ insert()
|
inline |
Insert a new pair KEY<->VALUE in the bi-map.
Definition at line 69 of file bimap.h.
Referenced by mrpt::utils::TEnumTypeFiller< nav::THolonomicMethod >::fill(), mrpt::utils::TEnumTypeFiller< slam::TDataAssociationMethod >::fill(), mrpt::utils::TEnumTypeFiller< slam::TDataAssociationMetric >::fill(), mrpt::utils::TEnumTypeFiller< nav::CHolonomicND::TSituations >::fill(), mrpt::utils::TEnumTypeFiller< maps::CHeightGridMap2D::TMapRepresentation >::fill(), mrpt::utils::TEnumTypeFiller< poses::CPose3DInterpolator::TInterpolatorMethod >::fill(), mrpt::utils::TEnumTypeFiller< slam::CGridMapAligner::TAlignerMethod >::fill(), mrpt::utils::TEnumTypeFiller< slam::TICPAlgorithm >::fill(), mrpt::utils::TEnumTypeFiller< hwdrivers::CKinect::TVideoChannel >::fill(), mrpt::utils::TEnumTypeFiller< maps::CRandomFieldGridMap2D::TMapRepresentation >::fill(), mrpt::utils::TEnumTypeFiller< bayes::TKFMethod >::fill(), and mrpt::utils::TEnumTypeFiller< mrpt::obs::CObservation3DRangeScan::TIntensityChannelID >::fill().
§ inverse() [1/2]
|
inline |
§ inverse() [2/2]
|
inline |
§ inverse_begin() [1/2]
|
inline |
§ inverse_begin() [2/2]
|
inline |
§ inverse_end() [1/2]
|
inline |
§ inverse_end() [2/2]
|
inline |
§ size()
|
inline |
Member Data Documentation
§ m_k2v
|
private |
Definition at line 31 of file bimap.h.
Referenced by mrpt::utils::bimap< mrpt::maps::mrpt::maps::CLandmark::TLandmarkID, unsigned int >::getDirectMap().
§ m_v2k
|
private |
Definition at line 32 of file bimap.h.
Referenced by mrpt::utils::bimap< mrpt::maps::mrpt::maps::CLandmark::TLandmarkID, unsigned int >::getInverseMap().