utility::keys::Key3Vector< K > Class Template Reference

3-key meta-key More...

#include <Key3Vector.hh>

Public Types
typedef K	Key

Public Member Functions
	Key3Vector ()
	Default constructor. More...
	Key3Vector (Key const &key1_a, Key const &key2_a, Key const &key3_a)
	Key constructor. More...
	~Key3Vector ()
	Destructor. More...
Key const &	key1 () const
	Key 1. More...
Key &	key1 ()
	Key 1. More...
Key const &	key2 () const
	Key 2. More...
Key &	key2 ()
	Key 2. More...
Key const &	key3 () const
	Key 3. More...
Key &	key3 ()
	Key 3. More...
Key const &	operator[] (int const i) const
	Key3Vector[ i ] const: 0-based index. More...
Key &	operator[] (int const i)
	Key3Vector[ i ]: 0-based index. More...
Key const &	operator() (int const i) const
	Key3Vector( i ) const: 1-based index. More...
Key &	operator() (int const i)
	Key3Vector( i ): 1-based index. More...

Private Attributes
Key	key1_
	Keys. More...
Key	key2_
Key	key3_

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

Detailed Description

template<typename K>
class utility::keys::Key3Vector< K >

3-key meta-key

Member Typedef Documentation

template<typename K >

typedef K utility::keys::Key3Vector< K >::Key

Constructor & Destructor Documentation

template<typename K >

utility::keys::Key3Vector< K >::Key3Vector ( )

inline

Default constructor.

Note

Only works if Key has default constructor

template<typename K >

utility::keys::Key3Vector< K >::Key3Vector ( Key const &  key1_a, Key const &  key2_a, Key const &  key3_a  )

inline

Key constructor.

template<typename K >

utility::keys::Key3Vector< K >::~Key3Vector ( )

inline

Destructor.

Member Function Documentation

template<typename K >

Key const& utility::keys::Key3Vector< K >::key1 ( ) const

inline

Key 1.

References utility::keys::Key3Vector< K >::key1_.

template<typename K >

Key& utility::keys::Key3Vector< K >::key1 ( )

inline

Key 1.

References utility::keys::Key3Vector< K >::key1_.

template<typename K >

Key const& utility::keys::Key3Vector< K >::key2 ( ) const

inline

Key 2.

References utility::keys::Key3Vector< K >::key2_.

template<typename K >

Key& utility::keys::Key3Vector< K >::key2 ( )

inline

Key 2.

References utility::keys::Key3Vector< K >::key2_.

template<typename K >

Key const& utility::keys::Key3Vector< K >::key3 ( ) const

inline

Key 3.

References utility::keys::Key3Vector< K >::key3_.

template<typename K >

Key& utility::keys::Key3Vector< K >::key3 ( )

inline

Key 3.

References utility::keys::Key3Vector< K >::key3_.

template<typename K >

Key const& utility::keys::Key3Vector< K >::operator() ( int const  i ) const

inline

Key3Vector( i ) const: 1-based index.

References debug_assert, utility::keys::Key3Vector< K >::key1_, utility::keys::Key3Vector< K >::key2_, and utility::keys::Key3Vector< K >::key3_.

template<typename K >

Key& utility::keys::Key3Vector< K >::operator() ( int const  i )

inline

Key3Vector( i ): 1-based index.

References debug_assert, utility::keys::Key3Vector< K >::key1_, utility::keys::Key3Vector< K >::key2_, and utility::keys::Key3Vector< K >::key3_.

template<typename K >

Key const& utility::keys::Key3Vector< K >::operator[] ( int const  i ) const

inline

Key3Vector[ i ] const: 0-based index.

References debug_assert, utility::keys::Key3Vector< K >::key1_, utility::keys::Key3Vector< K >::key2_, and utility::keys::Key3Vector< K >::key3_.

template<typename K >

Key& utility::keys::Key3Vector< K >::operator[] ( int const  i )

inline

Key3Vector[ i ]: 0-based index.

References debug_assert, utility::keys::Key3Vector< K >::key1_, utility::keys::Key3Vector< K >::key2_, and utility::keys::Key3Vector< K >::key3_.

Friends And Related Function Documentation

template<typename K >

bool operator!= ( Key3Vector< K > const &  a, Key3Vector< K > const &  b  )

friend

Key3Vector != Key3Vector.

template<typename K >

bool operator< ( Key3Vector< K > const &  a, Key3Vector< K > const &  b  )

friend

Key3Vector < Key3Vector.

Note

Lexicographic (full) ordering => Key3Vector is suitable for use as a map key or set element

template<typename K >

bool operator== ( Key3Vector< K > const &  a, Key3Vector< K > const &  b  )

friend

Key3Vector == Key3Vector.

Member Data Documentation

template<typename K >

Key utility::keys::Key3Vector< K >::key1_

private

Keys.

Referenced by utility::keys::Key3Vector< K >::key1(), utility::keys::Key3Vector< K >::operator()(), and utility::keys::Key3Vector< K >::operator[]().

template<typename K >

Key utility::keys::Key3Vector< K >::key2_

private

Referenced by utility::keys::Key3Vector< K >::key2(), utility::keys::Key3Vector< K >::operator()(), and utility::keys::Key3Vector< K >::operator[]().

template<typename K >

Key utility::keys::Key3Vector< K >::key3_

private

Referenced by utility::keys::Key3Vector< K >::key3(), utility::keys::Key3Vector< K >::operator()(), and utility::keys::Key3Vector< K >::operator[]().

---

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

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