Rosetta 3.3
Public Types | Public Member Functions | Friends
utility::keys::Key2Tuple< K1, K2 > Class Template Reference

2-tuple meta-key More...

#include <Key2Tuple.hh>

Collaboration diagram for utility::keys::Key2Tuple< K1, K2 >:
Collaboration graph
[legend]

List of all members.

Public Types

typedef K1 Key1
typedef K2 Key2

Public Member Functions

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

Friends

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

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 ( ) [inline]

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 ( ) [inline]

Destructor.


Member Function Documentation

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

Key 1.

template<typename K1 , typename K2 >
Key1& utility::keys::Key2Tuple< K1, K2 >::key1 ( ) [inline]

Key 1.

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

Key 2.

template<typename K1 , typename K2 >
Key2& utility::keys::Key2Tuple< K1, K2 >::key2 ( ) [inline]

Key 2.


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]

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines