---

KeyMutableSet< Key, T, _Compare > Class Template Reference

This set inherits from the STL multiset, with a slight variation: You are allowed to update the key of a particular iterator that you have obtained. More...

#include <key_mutable_set.h>

Inherits multiset< KeyMutableShell< T >, _Compare >.

Inheritance diagram for KeyMutableSet:

[legend]Collaboration diagram for KeyMutableSet< Key, T, _Compare >:

[legend]List of all members.

Public Methods
SUPER::iterator	find (T &key)
	This allows you to find an item given a Key. More...
SUPER::iterator	find (const Key &key)
	This allows you to find an item given a Key. More...
SUPER::iterator	lower_bound (T &key)
	This allows you to find the first item that has AT LEAST the value of a Key . More...
SUPER::iterator	lower_bound (const Key &key)
	This allows you to find the first item that has AT LEAST the value of a Key . More...
SUPER::iterator	upper_bound (T &key)
	This allows you to find the first item that has MORE THAN the value of a Key . More...
SUPER::iterator	upper_bound (const Key &key)
	This allows you to find the first item that has MORE THAN the value of a Key . More...
void	checkSet ()
	This just checks the order of the set for testing purposes.. More...
SUPER::iterator	changeKey (typename SUPER::iterator iter, const Key &newKey)
	Given an iterator you can alter that iterator's key to be the one passed in. More...
Private Types
typedef std::multiset< KeyMutableShell< T >, _Compare >	SUPER
Private Methods
T &	valueFromKey (const Key &key)

---

Detailed Description

template<class Key, class T, class _Compare = std::less <KeyMutableShell<T> >>
class KeyMutableSet< Key, T, _Compare >

This set inherits from the STL multiset, with a slight variation: You are allowed to update the key of a particular iterator that you have obtained.

Note: T is the type that each element is pointing to. The template argument should not be a pointer, but the type when added will be T* .

---

Member Typedef Documentation

template<class Key, class T, class _Compare = std::less <KeyMutableShell<T> >> typedef std::multiset<KeyMutableShell<T>,_Compare> KeyMutableSet< Key, T, _Compare >::SUPER [private]

---

Member Function Documentation

template<class Key, class T, class _Compare = std::less <KeyMutableShell<T> >> SUPER::iterator KeyMutableSet< Key, T, _Compare >::changeKey (  typename SUPER::iterator    iter, const Key &    newKey )  [inline]

Given an iterator you can alter that iterator's key to be the one passed in. The type must have a function called changeKey(const Key &newKey) that changes its key to the specified new key. { typename SUPER::iterator templess=iter,tempmore=iter; tempmore++; if (templess!=begin()) templess--; _Compare comparator; KeyMutableShell<T> newKeyShell(&valueFromKey(newKey)); bool endOutOfOrder=false; if (tempmore!=end()) { endOutOfOrder=comparator(*tempmore,newKeyShell); } if (comparator(newKeyShell,*templess)||endOutOfOrder) { KeyMutableShell<T> k = *iter; erase(iter); k->changeKey(newKey); insert (k); }else { (*iter)->changeKey(newKey); } //checkSet(); return tempmore; }

template<class Key, class T, class _Compare = std::less <KeyMutableShell<T> >> void KeyMutableSet< Key, T, _Compare >::checkSet (    )  [inline]

This just checks the order of the set for testing purposes.. { _Compare comparator; if (begin()!=end()) { for (typename SUPER::iterator newiter=begin(), iter=newiter++;newiter!=end();iter=newiter++) { if (comparator(*newiter,*iter)) { //greater than printf("ERROR: keys out of order!!!!!!\n"); } } } }

template<class Key, class T, class _Compare = std::less <KeyMutableShell<T> >> SUPER::iterator KeyMutableSet< Key, T, _Compare >::find (  const Key &    key )  [inline]

This allows you to find an item given a Key. { return find(valueFromKey(key)); }

template<class Key, class T, class _Compare = std::less <KeyMutableShell<T> >> SUPER::iterator KeyMutableSet< Key, T, _Compare >::find (  T &    key )  [inline]

This allows you to find an item given a Key. { return SUPER::find(KeyMutableShell<T>(&key)); }

template<class Key, class T, class _Compare = std::less <KeyMutableShell<T> >> SUPER::iterator KeyMutableSet< Key, T, _Compare >::lower_bound (  const Key &    key )  [inline]

This allows you to find the first item that has AT LEAST the value of a Key . { return lower_bound(valueFromKey(key)); }

template<class Key, class T, class _Compare = std::less <KeyMutableShell<T> >> SUPER::iterator KeyMutableSet< Key, T, _Compare >::lower_bound (  T &    key )  [inline]

This allows you to find the first item that has AT LEAST the value of a Key . { return SUPER::lower_bound(KeyMutableShell<T>(&key)); }

template<class Key, class T, class _Compare = std::less <KeyMutableShell<T> >> SUPER::iterator KeyMutableSet< Key, T, _Compare >::upper_bound (  const Key &    key )  [inline]

This allows you to find the first item that has MORE THAN the value of a Key . { return upper_bound(valueFromKey(key)); }

template<class Key, class T, class _Compare = std::less <KeyMutableShell<T> >> SUPER::iterator KeyMutableSet< Key, T, _Compare >::upper_bound (  T &    key )  [inline]

This allows you to find the first item that has MORE THAN the value of a Key . { return SUPER::upper_bound(KeyMutableShell<T>(&key)); }

template<class Key, class T, class _Compare = std::less <KeyMutableShell<T> >> T& KeyMutableSet< Key, T, _Compare >::valueFromKey (  const Key &    key )  [inline, private]

{ static T t; t.changeKey(key); return t; }

---

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

• key_mutable_set.h

---