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

2-key meta-key More...

#include <Key2Vector.hh>

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

List of all members.

Public Types

typedefKey

Public Member Functions

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

Friends

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

Detailed Description

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

2-key meta-key


Member Typedef Documentation

template<typename K >
typedef K utility::keys::Key2Vector< K >::Key

Constructor & Destructor Documentation

template<typename K >
utility::keys::Key2Vector< K >::Key2Vector ( ) [inline]

Default constructor.

Note:
Only works if Key has default constructor
template<typename K >
utility::keys::Key2Vector< K >::Key2Vector ( Key const &  key1_a,
Key const &  key2_a 
) [inline]

Key constructor.

template<typename K >
utility::keys::Key2Vector< K >::~Key2Vector ( ) [inline]

Destructor.


Member Function Documentation

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

Key 1.

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

Key 1.

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

Key 2.

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

Key 2.

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

Key2Vector( i ) const: 1-based index.

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

Key2Vector( i ): 1-based index.

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

Key2Vector[ i ]: 0-based index.

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

Key2Vector[ i ] const: 0-based index.


Friends And Related Function Documentation

template<typename K >
bool operator!= ( Key2Vector< K > const &  a,
Key2Vector< K > const &  b 
) [friend]
template<typename K >
bool operator< ( Key2Vector< K > const &  a,
Key2Vector< K > const &  b 
) [friend]

Key2Vector < Key2Vector.

Note:
Lexicographic (full) ordering => Key2Vector is suitable for use as a map key or set element
template<typename K >
bool operator== ( Key2Vector< K > const &  a,
Key2Vector< 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