Rosetta  2020.37
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Private Attributes | Friends | List of all members
utility::keys::Key2Tuple< K1, K2 > Class Template Reference

2-tuple meta-key More...

#include <Key2Tuple.hh>

Public Types

typedef K1 Key1
 
typedef K2 Key2
 

Public Member Functions

 Key2Tuple ()=default
 Default constructor. More...
 
 Key2Tuple (Key1 const &key1_a, Key2 const &key2_a)
 Key constructor. More...
 
 ~Key2Tuple ()=default
 Destructor. More...
 
Key1 const & key1 () const
 Key 1. More...
 
Key1key1 ()
 Key 1. More...
 
Key2 const & key2 () const
 Key 2. More...
 
Key2key2 ()
 Key 2. More...
 

Private Attributes

Key1 key1_
 Keys. More...
 
Key2 key2_
 

Friends

bool operator== (Key2Tuple const &a, Key2Tuple const &b)
 Key2Tuple == Key2Tuple. More...
 
bool operator!= (Key2Tuple const &a, Key2Tuple const &b)
 Key2Tuple != Key2Tuple. More...
 
bool operator< (Key2Tuple const &a, Key2Tuple const &b)
 Key2Tuple < Key2Tuple. More...
 

Detailed Description

template<typename K1, typename K2>
class utility::keys::Key2Tuple< K1, K2 >

2-tuple meta-key

Member Typedef Documentation

template<typename K1 , typename K2 >
typedef K1 utility::keys::Key2Tuple< K1, K2 >::Key1
template<typename K1 , typename K2 >
typedef K2 utility::keys::Key2Tuple< K1, K2 >::Key2

Constructor & Destructor Documentation

template<typename K1 , typename K2 >
utility::keys::Key2Tuple< K1, K2 >::Key2Tuple ( )
inlinedefault

Default constructor.

Note
Only works if Keys have default constructors
template<typename K1 , typename K2 >
utility::keys::Key2Tuple< K1, K2 >::Key2Tuple ( Key1 const &  key1_a,
Key2 const &  key2_a 
)
inline

Key constructor.

template<typename K1 , typename K2 >
utility::keys::Key2Tuple< K1, K2 >::~Key2Tuple ( )
inlinedefault

Destructor.

Member Function Documentation

template<typename K1 , typename K2 >
Key1 const& utility::keys::Key2Tuple< K1, K2 >::key1 ( ) const
inline
template<typename K1 , typename K2 >
Key1& utility::keys::Key2Tuple< K1, K2 >::key1 ( )
inline
template<typename K1 , typename K2 >
Key2 const& utility::keys::Key2Tuple< K1, K2 >::key2 ( ) const
inline
template<typename K1 , typename K2 >
Key2& utility::keys::Key2Tuple< K1, K2 >::key2 ( )
inline

Friends And Related Function Documentation

template<typename K1 , typename K2 >
bool operator!= ( Key2Tuple< K1, K2 > const &  a,
Key2Tuple< K1, K2 > const &  b 
)
friend
template<typename K1 , typename K2 >
bool operator< ( Key2Tuple< K1, K2 > const &  a,
Key2Tuple< K1, K2 > const &  b 
)
friend

Key2Tuple < Key2Tuple.

Note
Lexicographic (full) ordering => Key2Tuple is suitable for use as a map key or set element
template<typename K1 , typename K2 >
bool operator== ( Key2Tuple< K1, K2 > const &  a,
Key2Tuple< K1, K2 > const &  b 
)
friend

Member Data Documentation

template<typename K1 , typename K2 >
Key1 utility::keys::Key2Tuple< K1, K2 >::key1_
private
template<typename K1 , typename K2 >
Key2 utility::keys::Key2Tuple< K1, K2 >::key2_
private

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