Polaris: Map.h Source File

Map.h Go to the documentation of this file. /// /// #ifndef _MAP_H #define _MAP_H /// /// \class Map /// \brief /// /// \endcode /// \section DESCRIPTION DESCRIPTION /// Map<key,data> owns(data), address(key) /// /// A template for a map for keys of type S /// to owned objects of type T where: /// /// \code /// 1. 'S' is a class with: /// a) <, == and << operators taking S& arguments. /// b) a copy constructor S(S &) to clone the /// input object or simple enough structure /// for the default copy constructor to work. /// /// 2. 'T' is a class derived from Listable. /// \endcode /// /// The map is implemented as a tree of pointers to /// whatever type is specified. Thus, all methods to /// insert elements into a map take a reference to the /// key and a pointer to the data and do not allocate space. /// (i.e., the map aliases whatever is in the list). However, /// the map takes over ownership of the data on insert /// and will delete both a map element. /// #include "ProtoMap.h" #include "../p-assert.h" /// template <class S, class T> class Map : public ProtoMap<S, T> { protected: virtual INLINE void _kill_key(BMKey &key); ///< kill key public: INLINE Map(); INLINE Map(const Map<S, T> &m); virtual INLINE ~Map(); INLINE T &ins(const S &key, T *data); ///< Insert element with (key, data) into the map, and ///< return a reference to '*data' (for purposes ///< of programming convenience). ///< If a node with an equivalent key already exists, ///< delete the old one and replace it with the new one. INLINE void del(S &del_key); ///< delete element with key del_key (run-time error if none exists) INLINE T *grab(S &del_key); ///< remove and return an element with key del_key INLINE void print(ostream & out, char *sep1, char *sep2) const; ///< print map to out with sep1 between key and data and sep2 between each ///< element of the map INLINE Map<S, T > & operator = (const Map<S, T> &l); ///< Copy operator completely copies the Map INLINE Listable *listable_clone() const; ///< Needed for Listable class. INLINE void print(ostream &o) const; ///< Needed for Listable class. }; #include "KeyIterator.h" ///< implementation template <class S, class T> INLINE void Map<S, T>::_kill_key(BMKey & NOTUSED(key)) { ///< Map doesn't own key... so do nothing. } template <class S, class T> INLINE Map<S, T>::Map() { #ifdef MEMORY_LEAK_PRINT cout << "Map ctor: " << this << " : size=" << sizeof(Map) << endl; #endif } template <class S, class T> INLINE Map<S, T>::Map(const Map<S, T> &m) { #ifdef MEMORY_LEAK_PRINT cout << "Map ctor: " << this << " : size=" << sizeof(Map) << endl; #endif ///< Invoke copy constructor (*this) = m; } template <class S, class T> INLINE Map<S, T>::~Map() { #ifdef MEMORY_LEAK_PRINT cout << "Map dtor: " << this << " : size=" << sizeof(Map) << endl; #endif ///< Delete the information before the class disappears. clear(); } template <class S, class T> INLINE T & Map<S, T>::ins(const S &key, T *data) { BMKey inskey; inskey._keyptr = (void *) &key; T * exists = (T *) remove(inskey); ///< Remove any preexisting node with same key if (exists) delete exists; BaseMap::ins(inskey, data); return *data; } template <class S, class T> INLINE void Map<S, T>::del(S &key) { BMKey delkey; T *el; delkey._keyptr = (void *) &key; el = (T *) remove(delkey); p_assert(el, "Map<S,T>::del(S &key): No node found with specified key"); delete el; } template <class S, class T> INLINE T * Map<S, T>::grab(S &key) { BMKey delkey; delkey._keyptr = (void *) &key; return (T *) remove(delkey); } template <class S, class T> INLINE void Map<S,T>::print(ostream & out, char *sep1, char *sep2) const { out << "{"; for (KeyIterator<S,T> map_iter = *this; map_iter.valid(); ++map_iter) { BMKey printkey; printkey._keyptr = (void *) &map_iter.current_key(); _print(out, printkey); out << sep1 << map_iter.current_data() << sep2; } out << "}"; } template <class S, class T> INLINE Map<S, T> & Map<S, T>::operator = (const Map<S, T> &m) { ///< Clear out current map clear(); ///< Copy all the items one by one for (KeyIterator<S, T> map_iter = m; map_iter.valid(); ++map_iter) ins( map_iter.current_key(), (T *) map_iter.current_data().listable_clone()); return *this; } template <class S, class T> INLINE Listable * Map<S, T>::listable_clone() const { return (Listable *) new Map<S,T>( *this ); } template <class S, class T> INLINE void Map<S, T>::print(ostream &o) const { print( o, ": ", ", " ); } ///< This interface is for testing purposes only. It invokes a non-virtual ///< member function to print a representation of the data structure at this ///< level of the Collection hierarchy, and, since it is not a class member ///< function, it must be explicitly instantiated before use. template <class S, class T> ostream & operator << (ostream & o, const Map<S, T> &m) { m.print(o, ": ", ", "); return o; } #endif

© 1995-2005 University of Illinois, Urbana-Champaign. All rights reserved.  Fri Mar 25 23:05:58 2005