shark::KeyValuePair< Key, Value > Struct Template Reference

Represents a Key-Value-Pair similar std::pair which is strictly ordered by it's key. More...

#include <shark/Core/utility/KeyValuePair.h>

+ Inheritance diagram for shark::KeyValuePair< Key, Value >:

Public Member Functions

 KeyValuePair ()
 
 KeyValuePair (Key const &key, Value const &value)
 
template<class Pair >
 KeyValuePair (Pair const &pair)
 
template<class K , class V >
bool operator== (KeyValuePair< K, V > const &pair) const
 
template<class K , class V >
bool operator< (KeyValuePair< K, V > const &pair) const
 

Public Attributes

Key key
 
Value value
 

Detailed Description

template<class Key, class Value>
struct shark::KeyValuePair< Key, Value >

Represents a Key-Value-Pair similar std::pair which is strictly ordered by it's key.

Key must be less-than comparable using operator<

Definition at line 47 of file KeyValuePair.h.

Constructor & Destructor Documentation

§ KeyValuePair() [1/3]

template<class Key, class Value>
shark::KeyValuePair< Key, Value >::KeyValuePair ( )
inline

Definition at line 52 of file KeyValuePair.h.

§ KeyValuePair() [2/3]

template<class Key, class Value>
shark::KeyValuePair< Key, Value >::KeyValuePair ( Key const &  key,
Value const &  value 
)
inline

Definition at line 53 of file KeyValuePair.h.

§ KeyValuePair() [3/3]

template<class Key, class Value>
template<class Pair >
shark::KeyValuePair< Key, Value >::KeyValuePair ( Pair const &  pair)
inline

Definition at line 57 of file KeyValuePair.h.

Member Function Documentation

§ operator<()

template<class Key, class Value>
template<class K , class V >
bool shark::KeyValuePair< Key, Value >::operator< ( KeyValuePair< K, V > const &  pair) const
inline

Definition at line 65 of file KeyValuePair.h.

Referenced by shark::makeKeyValuePair().

§ operator==()

template<class Key, class Value>
template<class K , class V >
bool shark::KeyValuePair< Key, Value >::operator== ( KeyValuePair< K, V > const &  pair) const
inline

Definition at line 61 of file KeyValuePair.h.

References shark::KeyValuePair< Key, Value >::key.

Referenced by shark::makeKeyValuePair().

Member Data Documentation

§ key

template<class Key, class Value>
Key shark::KeyValuePair< Key, Value >::key

§ value

template<class Key, class Value>
Value shark::KeyValuePair< Key, Value >::value

Definition at line 50 of file KeyValuePair.h.

Referenced by shark::makeKeyValuePair(), and shark::swap().


The documentation for this struct was generated from the following file: