deba@822: // -*- c++ -*-
deba@822: #ifndef SYM_MAP_H
deba@822: #define SYM_MAP_H
deba@822: 
deba@822: ///\ingroup graphmaps
deba@822: ///\file
deba@822: ///\brief Graph maps that construates and destruates
deba@822: ///their elements dynamically.
deba@822: 
deba@822: namespace hugo {
deba@822: 
deba@822: /// \addtogroup graphmaps
deba@822: /// @{
deba@822: 
deba@822:   /** The SymEdgeIt is wrapper class for the EdgeIt. It can be used to
deba@822:    *  iterate on the symmetric maps when all of the edge - reverse edge pair
deba@822:    *  has different parity.
deba@822:    */
deba@822: 
deba@844: 
deba@822:   template <typename Graph, typename Edge, typename EdgeIt>
deba@822:   class SymEdgeIt : public EdgeIt {
deba@822:   public:
deba@822: 
deba@822:     /** Default constructor.
deba@822:      */
deba@822:     SymEdgeIt() 
deba@822:       : EdgeIt() {}
deba@822: 
deba@822:     /** Graph initialized constructor.
deba@822:      */
deba@822:     SymEdgeIt(const Graph& graph) 
deba@822:       : EdgeIt(graph) {
deba@844:       while ( (EdgeIt::n & 1) && EdgeIt::n != -1) {
deba@822: 	EdgeIt::operator++();
deba@822:       }
deba@822:     }
deba@822: 
deba@822:     /** Creating invelid SymEdgeIt.
deba@822:      */
deba@822:     SymEdgeIt(Invalid invalid) 
deba@822:       : EdgeIt(invalid) {}
deba@822: 
deba@822:     /** SymEdgeIt from the given Edge.
deba@822:      */
deba@822:     SymEdgeIt(const Graph& graph, const Edge& edge)
deba@822:       : EdgeIt(graph, edge) {
deba@844:       while ( (EdgeIt::n & 1) && EdgeIt::n != -1) {
deba@822: 	EdgeIt::operator++();
deba@822:       }
deba@822:     }
deba@822: 
deba@822:     /** Increase operator.
deba@822:      */
deba@822:     SymEdgeIt& operator++() {
deba@822:       EdgeIt::operator++();
deba@844:       while ( (EdgeIt::n & 1) && EdgeIt::n != -1) {
deba@822: 	EdgeIt::operator++();
deba@822:       }
deba@822:       return *this;
deba@822:     }
deba@822:   };
deba@822: 
deba@822:   /** The SymMap template class is graph map structure what
deba@822:    *  wraps an other map structure to use as symmetric map structure.
deba@822:    *
deba@822:    *  The template parameter is the MapRegistry that the maps
deba@822:    *  will belong to and the ValueType.
deba@822:    */
deba@822:   template <template <typename, typename> class DynMap, 
deba@822: 	    typename MapRegistry, typename Value>
deba@822:   class SymMap : public DynMap<MapRegistry, Value>{
deba@822: 
deba@822:   private:
deba@822: 
deba@822:     typedef DynMap<MapRegistry, Value> MapImpl;
deba@822: 
deba@822:   public:
deba@822: 		
deba@822:     /// The graph type of the maps. 
deba@822:     typedef typename MapRegistry::Graph Graph;
deba@822: 
deba@822:     typedef typename MapImpl::KeyType KeyType;
deba@822: 
deba@822:   public:
deba@822: 
deba@822: 
deba@822:     /** Default constructor for the map.
deba@822:      */
deba@822:     SymMap() : MapImpl() {}
deba@822: 
deba@822:     /** Graph and Registry initialized map constructor.
deba@822:      */
deba@822:     SymMap(const Graph& g, MapRegistry& r) : MapImpl(g, r) {}
deba@822: 
deba@822:     /** Constructor to use default value to initialize the map. 
deba@822:      */
deba@822:     SymMap(const Graph& g, MapRegistry& r, const Value& v) 
deba@822:       : MapImpl(g, r, v) {}
deba@822: 
deba@822:     /** Constructor to copy a map of the same map type.
deba@822:      */
deba@822:     SymMap(const SymMap& copy) 
deba@822:       : MapImpl(static_cast<const MapImpl&>(copy)) {}
deba@822: 
deba@822:     /** Assign operator to copy a map of the same map type.
deba@822:      */
deba@822:     SymMap& operator=(const SymMap& copy) {
deba@822:       MapImpl::operator=(static_cast<const MapImpl&>(copy));
deba@822:       return *this;
deba@822:     }
deba@822: 
deba@822:     /** Add a new key to the map. It called by the map registry.
deba@822:      */
deba@822:     void add(const KeyType& key) {
deba@822:       int id = MapImpl::getGraph()->id(key);
deba@822:       if (id & 1) return;
deba@822:       MapImpl::add(key);
deba@822:     }
deba@822: 		
deba@822:     /** Erase a key from the map. It called by the map registry.
deba@822:      */
deba@822:     void erase(const KeyType& key) {
deba@822:       int id = MapImpl::getGraph()->id(key);
deba@822:       if (id & 1) return;
deba@822:       MapImpl::add(key);
deba@822:     }
deba@822:   };
deba@822: 
deba@822:   /// @}
deba@822: }
deba@822: 
deba@822: #endif