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...
Key1 &	key1 ()
	Key 1. More...
Key2 const &	key2 () const
	Key 2. More...
Key2 &	key2 ()
	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

Key1

template<typename K1 , typename K2 >

typedef K1 utility::keys::Key2Tuple< K1, K2 >::Key1

Key2

template<typename K1 , typename K2 >

typedef K2 utility::keys::Key2Tuple< K1, K2 >::Key2

Constructor & Destructor Documentation

Key2Tuple() [1/2]

template<typename K1 , typename K2 >

utility::keys::Key2Tuple< K1, K2 >::Key2Tuple ( )

inlinedefault

Default constructor.

Note

Only works if Keys have default constructors

Key2Tuple() [2/2]

template<typename K1 , typename K2 >

utility::keys::Key2Tuple< K1, K2 >::Key2Tuple ( Key1 const &  key1_a, Key2 const &  key2_a  )

inline

Key constructor.

~Key2Tuple()

template<typename K1 , typename K2 >

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

inlinedefault

Destructor.

Member Function Documentation

key1() [1/2]

template<typename K1 , typename K2 >

Key1& utility::keys::Key2Tuple< K1, K2 >::key1 ( )

inline

Key 1.

References utility::keys::Key2Tuple< K1, K2 >::key1_.

key1() [2/2]

template<typename K1 , typename K2 >

Key1 const& utility::keys::Key2Tuple< K1, K2 >::key1 ( ) const

inline

Key 1.

References utility::keys::Key2Tuple< K1, K2 >::key1_.

key2() [1/2]

template<typename K1 , typename K2 >

Key2& utility::keys::Key2Tuple< K1, K2 >::key2 ( )

inline

Key 2.

References utility::keys::Key2Tuple< K1, K2 >::key2_.

key2() [2/2]

template<typename K1 , typename K2 >

Key2 const& utility::keys::Key2Tuple< K1, K2 >::key2 ( ) const

inline

Key 2.

References utility::keys::Key2Tuple< K1, K2 >::key2_.

Friends And Related Function Documentation

operator!=

template<typename K1 , typename K2 >

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

friend

Key2Tuple != Key2Tuple.

operator<

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

operator==

template<typename K1 , typename K2 >

bool operator== ( Key2Tuple< K1, K2 > const &  a, Key2Tuple< K1, K2 > const &  b  )

friend

Key2Tuple == Key2Tuple.

Member Data Documentation

key1_

template<typename K1 , typename K2 >

Key1 utility::keys::Key2Tuple< K1, K2 >::key1_

private

Keys.

Referenced by utility::keys::Key2Tuple< K1, K2 >::key1().

key2_

template<typename K1 , typename K2 >

Key2 utility::keys::Key2Tuple< K1, K2 >::key2_

private

Referenced by utility::keys::Key2Tuple< K1, K2 >::key2().

---

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

• src/utility/keys/Key2Tuple.fwd.hh
• src/utility/keys/Key2Tuple.hh