Rosetta 3.3
Public Types | Public Member Functions | Friends
utility::keys::Key3Vector< K > Class Template Reference

3-key meta-key More...

#include <Key3Vector.hh>

Collaboration diagram for utility::keys::Key3Vector< K >:
Collaboration graph
[legend]

List of all members.

Public Types

typedefKey

Public Member Functions

 Key3Vector ()
 Default constructor.
 Key3Vector (Key const &key1_a, Key const &key2_a, Key const &key3_a)
 Key constructor.
 ~Key3Vector ()
 Destructor.
Key const & key1 () const
 Key 1.
Keykey1 ()
 Key 1.
Key const & key2 () const
 Key 2.
Keykey2 ()
 Key 2.
Key const & key3 () const
 Key 3.
Keykey3 ()
 Key 3.
Key const & operator[] (int const i) const
 Key3Vector[ i ] const: 0-based index.
Keyoperator[] (int const i)
 Key3Vector[ i ]: 0-based index.
Key const & operator() (int const i) const
 Key3Vector( i ) const: 1-based index.
Keyoperator() (int const i)
 Key3Vector( i ): 1-based index.

Friends

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

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.

template<typename K >
Key& utility::keys::Key3Vector< K >::key1 ( ) [inline]

Key 1.

template<typename K >
Key& utility::keys::Key3Vector< K >::key2 ( ) [inline]

Key 2.

template<typename K >
Key const& utility::keys::Key3Vector< K >::key2 ( ) const [inline]

Key 2.

template<typename K >
Key const& utility::keys::Key3Vector< K >::key3 ( ) const [inline]

Key 3.

template<typename K >
Key& utility::keys::Key3Vector< K >::key3 ( ) [inline]

Key 3.

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

Key3Vector( i ) const: 1-based index.

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

Key3Vector( i ): 1-based index.

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

Key3Vector[ i ]: 0-based index.

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

Key3Vector[ i ] const: 0-based index.


Friends And Related Function Documentation

template<typename K >
bool operator!= ( Key3Vector< K > const &  a,
Key3Vector< K > const &  b 
) [friend]
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]

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