List of all members | Public Member Functions | Public Attributes
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>

Public Member Functions

 KeyValuePair ()
 
 KeyValuePair (Key const &key, Value const &value)
 
template<class K , class V >
 KeyValuePair (KeyValuePair< K, V > 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
 
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
 
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
 
template<class Archive >
void serialize (Archive &ar, const unsigned int)
 

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 42 of file KeyValuePair.h.

Constructor & Destructor Documentation

◆ KeyValuePair() [1/3]

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

Definition at line 46 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 47 of file KeyValuePair.h.

◆ KeyValuePair() [3/3]

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

Definition at line 51 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 59 of file KeyValuePair.h.

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

◆ 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 63 of file KeyValuePair.h.

◆ 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 67 of file KeyValuePair.h.

◆ 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 55 of file KeyValuePair.h.

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

◆ 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 71 of file KeyValuePair.h.

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

◆ 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 75 of file KeyValuePair.h.

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

◆ serialize()

template<class Key, class Value>
template<class Archive >
void shark::KeyValuePair< Key, Value >::serialize ( Archive &  ar,
const unsigned  int 
)
inline

Definition at line 80 of file KeyValuePair.h.

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

Member Data Documentation

◆ key

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

Definition at line 43 of file KeyValuePair.h.

Referenced by shark::makeKeyValuePair(), shark::KeyValuePair< Key, Value >::operator!=(), shark::KeyValuePair< Key, Value >::operator==(), shark::KeyValuePair< Key, Value >::operator>(), shark::KeyValuePair< Key, Value >::operator>=(), shark::KeyValuePair< Key, Value >::serialize(), and shark::swap().

◆ value

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

Definition at line 44 of file KeyValuePair.h.

Referenced by shark::makeKeyValuePair(), shark::KeyValuePair< Key, Value >::serialize(), and shark::swap().

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