# HG changeset patch # User deba # Date 1096910001 0 # Node ID d4e911acef3db51bb09d542e2b0436a45e902e1f # Parent 60a96465dc49c8ef3312f6ed6f0a5041d59a9e1f Revert backport changes -r1230. diff -r 60a96465dc49 -r d4e911acef3d src/lemon/Makefile.am --- a/src/lemon/Makefile.am Mon Oct 04 16:03:25 2004 +0000 +++ b/src/lemon/Makefile.am Mon Oct 04 17:13:21 2004 +0000 @@ -18,12 +18,11 @@ map_registry.h \ map_bits.h \ maps.h \ - min_cost_flow.h \ + min_cost_flow.h \ suurballe.h \ preflow.h \ path.h \ smart_graph.h \ - sym_map.h \ time_measure.h \ unionfind.h \ vector_map.h \ @@ -31,5 +30,6 @@ noinst_HEADERS = \ skeletons/graph.h \ + skeletons/sym_graph.h \ skeletons/maps.h \ skeletons/path.h diff -r 60a96465dc49 -r d4e911acef3d src/lemon/default_map.h --- a/src/lemon/default_map.h Mon Oct 04 16:03:25 2004 +0000 +++ b/src/lemon/default_map.h Mon Oct 04 17:13:21 2004 +0000 @@ -59,12 +59,9 @@ : Parent(static_cast(copy)) {} \ template \ DefaultMap(const DefaultMap& copy) \ - : { \ - Parent::MapBase::operator= \ - (static_cast(copy)); \ + : Parent(*copy.getGraph()) { \ if (Parent::getGraph()) { \ for (typename Parent::KeyIt it(*Parent::getGraph()); it!=INVALID; ++it) {\ - Parent::add(it); \ Parent::operator[](it) = copy[it]; \ } \ } \ diff -r 60a96465dc49 -r d4e911acef3d src/lemon/list_graph.h --- a/src/lemon/list_graph.h Mon Oct 04 16:03:25 2004 +0000 +++ b/src/lemon/list_graph.h Mon Oct 04 17:13:21 2004 +0000 @@ -29,8 +29,6 @@ #include #include -#include - #include @@ -104,6 +102,7 @@ first_free_node(_g.first_free_node), edges(_g.edges), first_free_edge(_g.first_free_edge) {} + /// \bug In the vector can be hole if a node is erased from the graph. ///Number of nodes. int nodeNum() const { return nodes.size(); } ///Number of edges. @@ -438,7 +437,7 @@ /// ///\todo this date structure need some reconsiderations. Maybe it ///should be implemented independently from ListGraph. - + /* class SymListGraph : public ListGraph { public: @@ -483,9 +482,403 @@ ListGraph::erase(f); ListGraph::erase(e); } + };*/ + + class SymListGraph : public ListGraph { + typedef ListGraph Parent; + public: + + typedef SymListGraph Graph; + + typedef ListGraph::Node Node; + typedef ListGraph::NodeIt NodeIt; + + class SymEdge; + class SymEdgeIt; + + class Edge; + class EdgeIt; + class OutEdgeIt; + class InEdgeIt; + + template + class NodeMap : public Parent::NodeMap { + public: + NodeMap(const SymListGraph& g) + : SymListGraph::Parent::NodeMap(g) {} + NodeMap(const SymListGraph& g, Value v) + : SymListGraph::Parent::NodeMap(g, v) {} + template + NodeMap(const NodeMap& copy) + : SymListGraph::Parent::NodeMap(copy) { } + }; + + template + class SymEdgeMap : public Parent::EdgeMap { + public: + typedef SymEdge KeyType; + + SymEdgeMap(const SymListGraph& g) + : SymListGraph::Parent::EdgeMap(g) {} + SymEdgeMap(const SymListGraph& g, Value v) + : SymListGraph::Parent::EdgeMap(g, v) {} + template + SymEdgeMap(const SymEdgeMap& copy) + : SymListGraph::Parent::EdgeMap(copy) { } + + }; + + // Create edge map registry. + CREATE_EDGE_MAP_REGISTRY; + // Create edge maps. + CREATE_EDGE_MAP(ArrayMap); + + class Edge { + friend class SymListGraph; + friend class SymListGraph::EdgeIt; + friend class SymListGraph::OutEdgeIt; + friend class SymListGraph::InEdgeIt; + + protected: + int id; + + Edge(int pid) { id = pid; } + + public: + /// An Edge with id \c n. + + Edge() { } + Edge (Invalid) { id = -1; } + + operator SymEdge(){ return SymEdge(id >> 1);} + + bool operator==(const Edge i) const {return id == i.id;} + bool operator!=(const Edge i) const {return id != i.id;} + bool operator<(const Edge i) const {return id < i.id;} + // ///Validity check + // operator bool() { return n!=-1; } + }; + + class SymEdge : public ListGraph::Edge { + friend class SymListGraph; + friend class SymListGraph::Edge; + typedef ListGraph::Edge Parent; + + protected: + SymEdge(int pid) : Parent(pid) {} + public: + + SymEdge() { } + SymEdge(const ListGraph::Edge& i) : Parent(i) {} + SymEdge (Invalid) : Parent(INVALID) {} + + }; + + class OutEdgeIt { + Parent::OutEdgeIt out; + Parent::InEdgeIt in; + public: + OutEdgeIt() {} + OutEdgeIt(const SymListGraph& g, Edge e) { + if ((e.id & 1) == 0) { + out = Parent::OutEdgeIt(g, SymEdge(e)); + in = Parent::InEdgeIt(g, g.tail(e)); + } else { + out = Parent::OutEdgeIt(INVALID); + in = Parent::InEdgeIt(g, SymEdge(e)); + } + } + OutEdgeIt (Invalid i) : out(INVALID), in(INVALID) { } + + OutEdgeIt(const SymListGraph& g, const Node v) + : out(g, v), in(g, v) {} + OutEdgeIt &operator++() { + if (out != INVALID) { + ++out; + } else { + ++in; + } + return *this; + } + + operator Edge() const { + if (out == INVALID && in == INVALID) return INVALID; + return out != INVALID ? forward(out) : backward(in); + } + + bool operator==(const Edge i) const {return Edge(*this) == i;} + bool operator!=(const Edge i) const {return Edge(*this) != i;} + bool operator<(const Edge i) const {return Edge(*this) < i;} + }; + + class InEdgeIt { + Parent::OutEdgeIt out; + Parent::InEdgeIt in; + public: + InEdgeIt() {} + InEdgeIt(const SymListGraph& g, Edge e) { + if ((e.id & 1) == 0) { + out = Parent::OutEdgeIt(g, SymEdge(e)); + in = Parent::InEdgeIt(g, g.tail(e)); + } else { + out = Parent::OutEdgeIt(INVALID); + in = Parent::InEdgeIt(g, SymEdge(e)); + } + } + InEdgeIt (Invalid i) : out(INVALID), in(INVALID) { } + + InEdgeIt(const SymListGraph& g, const Node v) + : out(g, v), in(g, v) {} + + InEdgeIt &operator++() { + if (out != INVALID) { + ++out; + } else { + ++in; + } + return *this; + } + + operator Edge() const { + if (out == INVALID && in == INVALID) return INVALID; + return out != INVALID ? backward(out) : forward(in); + } + + bool operator==(const Edge i) const {return Edge(*this) == i;} + bool operator!=(const Edge i) const {return Edge(*this) != i;} + bool operator<(const Edge i) const {return Edge(*this) < i;} + }; + + class SymEdgeIt : public Parent::EdgeIt { + + public: + SymEdgeIt() {} + + SymEdgeIt(const SymListGraph& g) + : SymListGraph::Parent::EdgeIt(g) {} + + SymEdgeIt(const SymListGraph& g, SymEdge e) + : SymListGraph::Parent::EdgeIt(g, e) {} + + SymEdgeIt(Invalid i) + : SymListGraph::Parent::EdgeIt(INVALID) {} + + SymEdgeIt& operator++() { + SymListGraph::Parent::EdgeIt::operator++(); + return *this; + } + + operator SymEdge() const { + return SymEdge + (static_cast(*this)); + } + bool operator==(const SymEdge i) const {return SymEdge(*this) == i;} + bool operator!=(const SymEdge i) const {return SymEdge(*this) != i;} + bool operator<(const SymEdge i) const {return SymEdge(*this) < i;} + }; + + class EdgeIt { + SymEdgeIt it; + bool fw; + public: + EdgeIt(const SymListGraph& g) : it(g), fw(true) {} + EdgeIt (Invalid i) : it(i) { } + EdgeIt(const SymListGraph& g, Edge e) + : it(g, SymEdge(e)), fw(id(e) & 1 == 0) { } + EdgeIt() { } + EdgeIt& operator++() { + fw = !fw; + if (fw) ++it; + return *this; + } + operator Edge() const { + if (it == INVALID) return INVALID; + return fw ? forward(it) : backward(it); + } + bool operator==(const Edge i) const {return Edge(*this) == i;} + bool operator!=(const Edge i) const {return Edge(*this) != i;} + bool operator<(const Edge i) const {return Edge(*this) < i;} + + }; + + ///Number of nodes. + int nodeNum() const { return Parent::nodeNum(); } + ///Number of edges. + int edgeNum() const { return 2*Parent::edgeNum(); } + ///Number of symmetric edges. + int symEdgeNum() const { return Parent::edgeNum(); } + + ///Set the expected maximum number of edges. + + ///With this function, it is possible to set the expected number of edges. + ///The use of this fasten the building of the graph and makes + ///it possible to avoid the superfluous memory allocation. + void reserveSymEdge(int n) { Parent::reserveEdge(n); }; + + /// Maximum node ID. + + /// Maximum node ID. + ///\sa id(Node) + int maxNodeId() const { return Parent::maxNodeId(); } + /// Maximum edge ID. + + /// Maximum edge ID. + ///\sa id(Edge) + int maxEdgeId() const { return 2*Parent::maxEdgeId(); } + /// Maximum symmetric edge ID. + + /// Maximum symmetric edge ID. + ///\sa id(SymEdge) + int maxSymEdgeId() const { return Parent::maxEdgeId(); } + + + Node tail(Edge e) const { + return (e.id & 1) == 0 ? + Parent::tail(SymEdge(e)) : Parent::head(SymEdge(e)); + } + + Node head(Edge e) const { + return (e.id & 1) == 0 ? + Parent::head(SymEdge(e)) : Parent::tail(SymEdge(e)); + } + + Node tail(SymEdge e) const { + return Parent::tail(e); + } + + Node head(SymEdge e) const { + return Parent::head(e); + } + + NodeIt& first(NodeIt& v) const { + v=NodeIt(*this); return v; } + EdgeIt& first(EdgeIt& e) const { + e=EdgeIt(*this); return e; } + SymEdgeIt& first(SymEdgeIt& e) const { + e=SymEdgeIt(*this); return e; } + OutEdgeIt& first(OutEdgeIt& e, const Node v) const { + e=OutEdgeIt(*this,v); return e; } + InEdgeIt& first(InEdgeIt& e, const Node v) const { + e=InEdgeIt(*this,v); return e; } + + /// Node ID. + + /// The ID of a valid Node is a nonnegative integer not greater than + /// \ref maxNodeId(). The range of the ID's is not surely continuous + /// and the greatest node ID can be actually less then \ref maxNodeId(). + /// + /// The ID of the \ref INVALID node is -1. + ///\return The ID of the node \c v. + static int id(Node v) { return Parent::id(v); } + /// Edge ID. + + /// The ID of a valid Edge is a nonnegative integer not greater than + /// \ref maxEdgeId(). The range of the ID's is not surely continuous + /// and the greatest edge ID can be actually less then \ref maxEdgeId(). + /// + /// The ID of the \ref INVALID edge is -1. + ///\return The ID of the edge \c e. + static int id(Edge e) { return e.id; } + + /// The ID of a valid SymEdge is a nonnegative integer not greater than + /// \ref maxSymEdgeId(). The range of the ID's is not surely continuous + /// and the greatest edge ID can be actually less then \ref maxSymEdgeId(). + /// + /// The ID of the \ref INVALID symmetric edge is -1. + ///\return The ID of the edge \c e. + static int id(SymEdge e) { return Parent::id(e); } + + /// Adds a new node to the graph. + + /// \warning It adds the new node to the front of the list. + /// (i.e. the lastly added node becomes the first.) + Node addNode() { + return Parent::addNode(); + } + + SymEdge addEdge(Node u, Node v) { + SymEdge se = Parent::addEdge(u, v); + edge_maps.add(forward(se)); + edge_maps.add(backward(se)); + return se; + } + + /// Finds an edge between two nodes. + + /// Finds an edge from node \c u to node \c v. + /// + /// If \c prev is \ref INVALID (this is the default value), then + /// It finds the first edge from \c u to \c v. Otherwise it looks for + /// the next edge from \c u to \c v after \c prev. + /// \return The found edge or INVALID if there is no such an edge. + Edge findEdge(Node u, Node v, Edge prev = INVALID) + { + if (prev == INVALID || id(prev) & 1 == 0) { + SymEdge se = Parent::findEdge(u, v, SymEdge(prev)); + if (se != INVALID) return forward(se); + } else { + SymEdge se = Parent::findEdge(v, u, SymEdge(prev)); + if (se != INVALID) return backward(se); + } + return INVALID; + } + +// /// Finds an symmetric edge between two nodes. + +// /// Finds an symmetric edge from node \c u to node \c v. +// /// +// /// If \c prev is \ref INVALID (this is the default value), then +// /// It finds the first edge from \c u to \c v. Otherwise it looks for +// /// the next edge from \c u to \c v after \c prev. +// /// \return The found edge or INVALID if there is no such an edge. + +// SymEdge findEdge(Node u, Node v, SymEdge prev = INVALID) +// { +// if (prev == INVALID || id(prev) & 1 == 0) { +// SymEdge se = Parent::findEdge(u, v, SymEdge(prev)); +// if (se != INVALID) return se; +// } else { +// SymEdge se = Parent::findEdge(v, u, SymEdge(prev)); +// if (se != INVALID) return se; +// } +// return INVALID; +// } + + public: + + void erase(Node n) { + for (OutEdgeIt it(*this, n); it != INVALID; ++it) { + edge_maps.erase(it); + edge_maps.erase(opposite(it)); + } + Parent::erase(n); + } + + void erase(SymEdge e) { + edge_maps.erase(forward(e)); + edge_maps.erase(backward(e)); + Parent::erase(e); + }; + + void clear() { + edge_maps.clear(); + Parent::clear(); + } + + static Edge opposite(Edge e) { + return Edge(id(e) ^ 1); + } + + static Edge forward(SymEdge e) { + return Edge(id(e) << 1); + } + + static Edge backward(SymEdge e) { + return Edge((id(e) << 1) | 1); + } + }; - ///A graph class containing only nodes. ///This class implements a graph structure without edges. diff -r 60a96465dc49 -r d4e911acef3d src/lemon/map_bits.h --- a/src/lemon/map_bits.h Mon Oct 04 16:03:25 2004 +0000 +++ b/src/lemon/map_bits.h Mon Oct 04 17:13:21 2004 +0000 @@ -54,10 +54,10 @@ template struct KeyInfo { static int maxId(const Graph& graph) { - return graph.maxEdgeId() >> 1; + return graph.maxSymEdgeId(); } - static int id(const Graph& graph, const typename Graph::Edge& edge) { - return graph.id(edge) >> 1; + static int id(const Graph& graph, const typename Graph::SymEdge& edge) { + return graph.id(edge); } }; diff -r 60a96465dc49 -r d4e911acef3d src/lemon/map_defines.h --- a/src/lemon/map_defines.h Mon Oct 04 16:03:25 2004 +0000 +++ b/src/lemon/map_defines.h Mon Oct 04 17:13:21 2004 +0000 @@ -114,8 +114,7 @@ /** This macro creates MapRegistry for Symmetric Edge Maps. */ #define CREATE_SYM_EDGE_MAP_REGISTRY \ -typedef SymEdgeIt SymEdgeIt; \ -typedef MapRegistry SymEdgeMapRegistry; \ +typedef MapRegistry SymEdgeMapRegistry; \ mutable SymEdgeMapRegistry sym_edge_maps; @@ -127,9 +126,9 @@ */ #define CREATE_SYM_EDGE_MAP(DynMap) \ template \ -class SymEdgeMap : public SymMap { \ +class SymEdgeMap : public DynMap { \ public: \ -typedef SymMap Parent; \ +typedef DynMap Parent; \ \ SymEdgeMap(const typename Parent::Graph& g) \ : Parent(g, g.sym_edge_maps) {} \ diff -r 60a96465dc49 -r d4e911acef3d src/lemon/map_registry.h --- a/src/lemon/map_registry.h Mon Oct 04 16:03:25 2004 +0000 +++ b/src/lemon/map_registry.h Mon Oct 04 17:13:21 2004 +0000 @@ -27,24 +27,35 @@ namespace lemon { -/// \addtogroup graphmapfactory -/// @{ + /// \addtogroup graphmapfactory + /// @{ -/** - * Registry class to register edge or node maps into the graph. The - * registry helps you to implement an observer pattern. If you add - * or erase an edge or node you must notify all the maps about the - * event. -*/ + /// Map registry for graph maps. + + /** + * Registry class to register edge or node maps into the graph. The + * registry helps you to implement an observer pattern. If you add + * or erase an edge or node you must notify all the maps about the + * event. + * + * \param G The graph type to register maps. + * \param K The key type of the maps registered into the registry. + * \param KIt The key iterator type iterates on the keys. + * + * \author Balazs Dezso + */ + template class MapRegistry { public: typedef G Graph; typedef K KeyType; typedef KIt KeyIt; + + /// MapBase is the base class of the dynamic maps. /** - * MapBase is the base class of the registered maps. + * MapBase is the base class of the dynamic maps. * It defines the core modification operations on the maps and * implements some helper functions. */ @@ -58,22 +69,30 @@ friend class MapRegistry; + /// Default constructor. + /** * Default constructor for MapBase. */ MapBase() : graph(0), registry(0) {} + + /// Constructor to register map into a graph registry. /** - * Simple constructor to register into a graph registry. + * Simple constructor to register dynamic map into a graph registry. */ MapBase(const Graph& g, Registry& r) : graph(&g), registry(0) { r.attach(*this); } + /// Copy constructor. + /** * Copy constructor to register into the registry. + * If the copiable map is registered into a registry + * the construated map will be registered to the same registry. */ MapBase(const MapBase& copy) : graph(copy.graph), registry(0) { @@ -81,9 +100,13 @@ copy.registry->attach(*this); } } + + /// Assign operator. /** - * Assign operator. + * Assign operator. This member detach first the map + * from the current registry and then it attach to the + * copiable map's registry if it exists. */ const MapBase& operator=(const MapBase& copy) { if (registry) { @@ -96,9 +119,11 @@ return *this; } + /// Destructor /** - * Destructor. + * This member detach the map from the its registry if the + * registry exists. */ virtual ~MapBase() { @@ -107,6 +132,8 @@ } } + /// The graph of the map. + /* * Returns the graph that the map belongs to. */ @@ -121,9 +148,14 @@ int registry_index; protected: + + /// Helper function to implement constructors in the subclasses. /** - Helper function to implement constructors in the subclasses. + * Helper function to implement constructors in the subclasses. + * It adds all of the nodes or edges to the map via the + * \ref MapRegistry::MapBase::add add + * member function. */ virtual void init() { @@ -132,8 +164,14 @@ } } + + /// Helper function to implement destructors in the subclasses. + /** - Helper function to implement the destructor in the subclasses. + * Helper function to implement destructors in the subclasses. + * It erases all of the nodes or edges of the map via the + * \ref MapRegistry::MapBase::erase erase + * member function. It can be used by the clear function also. */ virtual void destroy() { @@ -141,16 +179,22 @@ erase(it); } } + + /// The member function to add new node or edge to the map. /** The add member function should be overloaded in the subclasses. - \e Add extends the map with the new node. + \e Add extends the map with the new node or edge. */ virtual void add(const KeyType&) = 0; + + + /// The member function to erase a node or edge from the map. + /** The erase member function should be overloaded in the subclasses. - \e Erase removes the node from the map. + \e Erase removes the node or edge from the map. */ virtual void erase(const KeyType&) = 0; @@ -161,9 +205,13 @@ */ virtual void clear() = 0; + + /// Exception class to throw at unsupported operation. /** - Exception class to throw at unsupported operation. + * Exception class to throw at unsupported operation. + * If the map does not support erasing or adding new + * node or key it must be throwed. */ class NotSupportedOperationException {}; @@ -172,50 +220,58 @@ protected: - /** - * The container type of the maps. - */ + typedef std::vector Container; - /** - * The container of the registered maps. - */ Container container; public: + + /// Default constructor. /** - * Default Constructor of the MapRegistry. It creates an empty registry. + * Default constructor of the \e MapRegistry. + * It creates an empty registry. */ MapRegistry() {} + + /// Copy Constructor of the MapRegistry. /** - * Copy Constructor of the MapRegistry. The new registry does not steal - * the maps from the right value. The new registry will be an empty. + * Copy constructor of the \e MapRegistry. + * The new registry does not steal + * the maps from the copiable registry. + * The new registry will be empty. */ MapRegistry(const MapRegistry&) {} + + /// Assign operator. /** - * Assign operator. The left value does not steal the maps - * from the right value. The left value will be an empty registry. + * Assign operator. This registry does not steal the maps + * from the copiable registry. This registry will be an empty registry. + * This operator will be called when a graph is assigned. */ MapRegistry& operator=(const MapRegistry&) { typename Container::iterator it; for (it = container.begin(); it != container.end(); ++it) { - (*it)->destroy(); + (*it)->clear(); (*it)->graph = 0; (*it)->registry = 0; } } + + /// Destructor. /** - * Destructor of the MapRegistry. + * Destructor of the MapRegistry. It makes empty the attached map + * first then detachs them. */ ~MapRegistry() { typename Container::iterator it; for (it = container.begin(); it != container.end(); ++it) { - (*it)->destroy(); + (*it)->clear(); (*it)->registry = 0; (*it)->graph = 0; } @@ -223,9 +279,11 @@ public: + + /// Attachs a map to the \e MapRegistry. /** - * Attach a map into thr registry. If the map has been attached + * Attachs a map into thr registry. If the map has been attached * into an other registry it is detached from that automaticly. */ void attach(MapBase& map) { @@ -236,9 +294,11 @@ map.registry = this; map.registry_index = container.size()-1; } + + /// Detachs a map from the \e MapRegistry. /** - * Detach the map from the registry. + * Detachs a map from the \e MapRegistry. */ void detach(MapBase& map) { container.back()->registry_index = map.registry_index; @@ -248,29 +308,41 @@ map.graph = 0; } + /// Notify all the registered maps about a Key added. /** * Notify all the registered maps about a Key added. + * This member should be called whenever a node or edge + * is added to the graph. */ - void add(KeyType& key) { + void add(const KeyType& key) { typename Container::iterator it; for (it = container.begin(); it != container.end(); ++it) { (*it)->add(key); } } + + /// Notify all the registered maps about a Key erased. /** * Notify all the registered maps about a Key erased. + * This member should be called whenever a node or edge + * is erased from the graph. */ - void erase(KeyType& key) { + void erase(const KeyType& key) { typename Container::iterator it; for (it = container.begin(); it != container.end(); ++it) { (*it)->erase(key); } } + + /// Notify all the registered maps about all the Keys are erased. + /** * Notify all the registered maps about the map should be cleared. + * This member should be called whenever all of the nodes or edges + * are erased from the graph. */ void clear() { typename Container::iterator it; diff -r 60a96465dc49 -r d4e911acef3d src/lemon/skeletons/sym_graph.h --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/lemon/skeletons/sym_graph.h Mon Oct 04 17:13:21 2004 +0000 @@ -0,0 +1,653 @@ +/* -*- C++ -*- + * src/lemon/skeletons/graph.h - Part of LEMON, a generic C++ optimization library + * + * Copyright (C) 2004 Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport + * (Egervary Combinatorial Optimization Research Group, EGRES). + * + * Permission to use, modify and distribute this software is granted + * provided that this copyright notice appears in all copies. For + * precise terms see the accompanying LICENSE file. + * + * This software is provided "AS IS" with no warranty of any kind, + * express or implied, and with no claim as to its suitability for any + * purpose. + * + */ + +#ifndef LEMON_SKELETON_SYM_GRAPH_H +#define LEMON_SKELETON_SYM_GRAPH_H + +///\ingroup skeletons +///\file +///\brief Declaration of SymGraph. + +#include +#include +#include + +namespace lemon { + namespace skeleton { + + /// \addtogroup skeletons + /// @{ + + /// An empty static graph class. + + /// This class provides all the common features of a symmetric + /// graph structure, however completely without implementations and + /// real data structures behind the interface. + /// All graph algorithms should compile with this class, but it will not + /// run properly, of course. + /// + /// It can be used for checking the interface compatibility, + /// or it can serve as a skeleton of a new symmetric graph structure. + /// + /// Also, you will find here the full documentation of a certain graph + /// feature, the documentation of a real symmetric graph imlementation + /// like @ref SymListGraph or + /// @ref lemon::SymSmartGraph will just refer to this structure. + class StaticSymGraph + { + public: + /// Defalult constructor. + + /// Defalult constructor. + /// + StaticSymGraph() { } + ///Copy consructor. + +// ///\todo It is not clear, what we expect from a copy constructor. +// ///E.g. How to assign the nodes/edges to each other? What about maps? +// StaticGraph(const StaticGraph& g) { } + + /// The base type of node iterators, + /// or in other words, the trivial node iterator. + + /// This is the base type of each node iterator, + /// thus each kind of node iterator converts to this. + /// More precisely each kind of node iterator should be inherited + /// from the trivial node iterator. + class Node { + public: + /// Default constructor + + /// @warning The default constructor sets the iterator + /// to an undefined value. + Node() { } + /// Copy constructor. + + /// Copy constructor. + /// + Node(const Node&) { } + + /// Invalid constructor \& conversion. + + /// This constructor initializes the iterator to be invalid. + /// \sa Invalid for more details. + Node(Invalid) { } + /// Equality operator + + /// Two iterators are equal if and only if they point to the + /// same object or both are invalid. + bool operator==(Node) const { return true; } + + /// Inequality operator + + /// \sa operator==(Node n) + /// + bool operator!=(Node) const { return true; } + + ///Comparison operator. + + ///This is a strict ordering between the nodes. + /// + ///This ordering can be different from the order in which NodeIt + ///goes through the nodes. + ///\todo Possibly we don't need it. + bool operator<(Node) const { return true; } + }; + + /// This iterator goes through each node. + + /// This iterator goes through each node. + /// Its usage is quite simple, for example you can count the number + /// of nodes in graph \c g of type \c Graph like this: + /// \code + /// int count=0; + /// for (Graph::NodeIt n(g); n!=INVALID; ++n) ++count; + /// \endcode + class NodeIt : public Node { + public: + /// Default constructor + + /// @warning The default constructor sets the iterator + /// to an undefined value. + NodeIt() { } + /// Copy constructor. + + /// Copy constructor. + /// + NodeIt(const NodeIt&) { } + /// Invalid constructor \& conversion. + + /// Initialize the iterator to be invalid. + /// \sa Invalid for more details. + NodeIt(Invalid) { } + /// Sets the iterator to the first node. + + /// Sets the iterator to the first node of \c g. + /// + NodeIt(const StaticSymGraph& g) { } + /// Node -> NodeIt conversion. + + /// Sets the iterator to the node of \c g pointed by the trivial + /// iterator n. + /// This feature necessitates that each time we + /// iterate the edge-set, the iteration order is the same. + NodeIt(const StaticSymGraph& g, const Node& n) { } + /// Next node. + + /// Assign the iterator to the next node. + /// + NodeIt& operator++() { return *this; } + }; + + + /// The base type of the symmetric edge iterators. + + /// The base type of the symmetric edge iterators. + /// + class SymEdge { + public: + /// Default constructor + + /// @warning The default constructor sets the iterator + /// to an undefined value. + SymEdge() { } + /// Copy constructor. + + /// Copy constructor. + /// + SymEdge(const SymEdge&) { } + /// Initialize the iterator to be invalid. + + /// Initialize the iterator to be invalid. + /// + SymEdge(Invalid) { } + /// Equality operator + + /// Two iterators are equal if and only if they point to the + /// same object or both are invalid. + bool operator==(SymEdge) const { return true; } + /// Inequality operator + + /// \sa operator==(Node n) + /// + bool operator!=(SymEdge) const { return true; } + ///Comparison operator. + + ///This is a strict ordering between the nodes. + /// + ///This ordering can be different from the order in which NodeIt + ///goes through the nodes. + ///\todo Possibly we don't need it. + bool operator<(SymEdge) const { return true; } + }; + + + /// The base type of the edge iterators. + + /// The base type of the edge iterators. + /// + class Edge : public SymEdge { + public: + /// Default constructor + + /// @warning The default constructor sets the iterator + /// to an undefined value. + Edge() { } + /// Copy constructor. + + /// Copy constructor. + /// + Edge(const Edge&) { } + /// Initialize the iterator to be invalid. + + /// Initialize the iterator to be invalid. + /// + Edge(Invalid) { } + /// Equality operator + + /// Two iterators are equal if and only if they point to the + /// same object or both are invalid. + bool operator==(Edge) const { return true; } + /// Inequality operator + + /// \sa operator==(Node n) + /// + bool operator!=(Edge) const { return true; } + ///Comparison operator. + + ///This is a strict ordering between the nodes. + /// + ///This ordering can be different from the order in which NodeIt + ///goes through the nodes. + ///\todo Possibly we don't need it. + bool operator<(Edge) const { return true; } + }; + + /// This iterator goes trough the outgoing edges of a node. + + /// This iterator goes trough the \e outgoing edges of a certain node + /// of a graph. + /// Its usage is quite simple, for example you can count the number + /// of outgoing edges of a node \c n + /// in graph \c g of type \c Graph as follows. + /// \code + /// int count=0; + /// for (Graph::OutEdgeIt e(g, n); e!=INVALID; ++e) ++count; + /// \endcode + + class OutEdgeIt : public Edge { + public: + /// Default constructor + + /// @warning The default constructor sets the iterator + /// to an undefined value. + OutEdgeIt() { } + /// Copy constructor. + + /// Copy constructor. + /// + OutEdgeIt(const OutEdgeIt&) { } + /// Initialize the iterator to be invalid. + + /// Initialize the iterator to be invalid. + /// + OutEdgeIt(Invalid) { } + /// This constructor sets the iterator to first outgoing edge. + + /// This constructor set the iterator to the first outgoing edge of + /// node + ///@param n the node + ///@param g the graph + OutEdgeIt(const StaticSymGraph& g, const Node& n) { } + /// Edge -> OutEdgeIt conversion + + /// Sets the iterator to the value of the trivial iterator \c e. + /// This feature necessitates that each time we + /// iterate the edge-set, the iteration order is the same. + OutEdgeIt(const StaticSymGraph& g, const Edge& e) { } + ///Next outgoing edge + + /// Assign the iterator to the next + /// outgoing edge of the corresponding node. + OutEdgeIt& operator++() { return *this; } + }; + + /// This iterator goes trough the incoming edges of a node. + + /// This iterator goes trough the \e incoming edges of a certain node + /// of a graph. + /// Its usage is quite simple, for example you can count the number + /// of outgoing edges of a node \c n + /// in graph \c g of type \c Graph as follows. + /// \code + /// int count=0; + /// for(Graph::InEdgeIt e(g, n); e!=INVALID; ++e) ++count; + /// \endcode + + class InEdgeIt : public Edge { + public: + /// Default constructor + + /// @warning The default constructor sets the iterator + /// to an undefined value. + InEdgeIt() { } + /// Copy constructor. + + /// Copy constructor. + /// + InEdgeIt(const InEdgeIt&) { } + /// Initialize the iterator to be invalid. + + /// Initialize the iterator to be invalid. + /// + InEdgeIt(Invalid) { } + /// This constructor sets the iterator to first incoming edge. + + /// This constructor set the iterator to the first incoming edge of + /// node + ///@param n the node + ///@param g the graph + InEdgeIt(const StaticSymGraph& g, const Node& n) { } + /// Edge -> InEdgeIt conversion + + /// Sets the iterator to the value of the trivial iterator \c e. + /// This feature necessitates that each time we + /// iterate the edge-set, the iteration order is the same. + InEdgeIt(const StaticSymGraph& g, const Edge& n) { } + /// Next incoming edge + + /// Assign the iterator to the next inedge of the corresponding node. + /// + InEdgeIt& operator++() { return *this; } + }; + /// This iterator goes through each symmetric edge. + + /// This iterator goes through each symmetric edge of a graph. + /// Its usage is quite simple, for example you can count the number + /// of symmetric edges in a graph \c g of type \c Graph as follows: + /// \code + /// int count=0; + /// for(Graph::SymEdgeIt e(g); e!=INVALID; ++e) ++count; + /// \endcode + class SymEdgeIt : public SymEdge { + public: + /// Default constructor + + /// @warning The default constructor sets the iterator + /// to an undefined value. + SymEdgeIt() { } + /// Copy constructor. + + /// Copy constructor. + /// + SymEdgeIt(const SymEdgeIt&) { } + /// Initialize the iterator to be invalid. + + /// Initialize the iterator to be invalid. + /// + SymEdgeIt(Invalid) { } + /// This constructor sets the iterator to first edge. + + /// This constructor set the iterator to the first edge of + /// node + ///@param g the graph + SymEdgeIt(const StaticSymGraph& g) { } + /// Edge -> EdgeIt conversion + + /// Sets the iterator to the value of the trivial iterator \c e. + /// This feature necessitates that each time we + /// iterate the edge-set, the iteration order is the same. + SymEdgeIt(const StaticSymGraph&, const SymEdge&) { } + ///Next edge + + /// Assign the iterator to the next + /// edge of the corresponding node. + SymEdgeIt& operator++() { return *this; } + }; + /// This iterator goes through each edge. + + /// This iterator goes through each edge of a graph. + /// Its usage is quite simple, for example you can count the number + /// of edges in a graph \c g of type \c Graph as follows: + /// \code + /// int count=0; + /// for(Graph::EdgeIt e(g); e!=INVALID; ++e) ++count; + /// \endcode + class EdgeIt : public Edge { + public: + /// Default constructor + + /// @warning The default constructor sets the iterator + /// to an undefined value. + EdgeIt() { } + /// Copy constructor. + + /// Copy constructor. + /// + EdgeIt(const EdgeIt&) { } + /// Initialize the iterator to be invalid. + + /// Initialize the iterator to be invalid. + /// + EdgeIt(Invalid) { } + /// This constructor sets the iterator to first edge. + + /// This constructor set the iterator to the first edge of + /// node + ///@param g the graph + EdgeIt(const StaticSymGraph& g) { } + /// Edge -> EdgeIt conversion + + /// Sets the iterator to the value of the trivial iterator \c e. + /// This feature necessitates that each time we + /// iterate the edge-set, the iteration order is the same. + EdgeIt(const StaticSymGraph&, const Edge&) { } + ///Next edge + + /// Assign the iterator to the next + /// edge of the corresponding node. + EdgeIt& operator++() { return *this; } + }; + + /// First node of the graph. + + /// \retval i the first node. + /// \return the first node. + /// + NodeIt& first(NodeIt& i) const { return i; } + + /// The first incoming edge. + + /// The first incoming edge. + /// + InEdgeIt& first(InEdgeIt &i, Node) const { return i; } + /// The first outgoing edge. + + /// The first outgoing edge. + /// + OutEdgeIt& first(OutEdgeIt& i, Node) const { return i; } + /// The first edge of the Graph. + + /// The first edge of the Graph. + /// + EdgeIt& first(EdgeIt& i) const { return i; } + /// The first symmetric edge of the Graph. + + /// The first symmetric edge of the Graph. + /// + SymEdgeIt& first(SymEdgeIt& i) const { return i; } + + ///Gives back the head node of an edge. + + ///Gives back the head node of an edge. + /// + Node head(Edge) const { return INVALID; } + ///Gives back the tail node of an edge. + + ///Gives back the tail node of an edge. + /// + Node tail(Edge) const { return INVALID; } + + ///Gives back the first node of an symmetric edge. + + ///Gives back the first node of an symmetric edge. + /// + Node head(SymEdge) const { return INVALID; } + ///Gives back the second node of an symmetric edge. + + ///Gives back the second node of an symmetric edge. + /// + Node tail(SymEdge) const { return INVALID; } + ///Gives back the \e id of a node. + + ///\warning Not all graph structures provide this feature. + /// + ///\todo Should each graph provide \c id? + int id(const Node&) const { return 0; } + ///Gives back the \e id of an edge. + + ///\warning Not all graph structures provide this feature. + /// + ///\todo Should each graph provide \c id? + int id(const Edge&) const { return 0; } + + ///\warning Not all graph structures provide this feature. + /// + ///\todo Should each graph provide \c id? + int id(const SymEdge&) const { return 0; } + + ///\e + + ///\todo Should it be in the concept? + /// + int nodeNum() const { return 0; } + ///\e + + ///\todo Should it be in the concept? + /// + int edgeNum() const { return 0; } + + ///\todo Should it be in the concept? + /// + int symEdgeNum() const { return 0; } + + + /// Gives back the forward directed edge of the symmetric edge. + Edge forward(SymEdge) const {return INVALID;} + + /// Gives back the backward directed edge of the symmetric edge. + Edge backward(SymEdge) const {return INVALID;}; + + /// Gives back the opposite of the edge. + Edge opposite(Edge) const {return INVALID;} + + ///Reference map of the nodes to type \c T. + /// \ingroup skeletons + ///Reference map of the nodes to type \c T. + /// \sa Reference + /// \warning Making maps that can handle bool type (NodeMap) + /// needs some extra attention! + template class NodeMap : public ReferenceMap< Node, T > + { + public: + + ///\e + NodeMap(const StaticSymGraph&) { } + ///\e + NodeMap(const StaticSymGraph&, T) { } + + ///Copy constructor + template NodeMap(const NodeMap&) { } + ///Assignment operator + template NodeMap& operator=(const NodeMap&) + { return *this; } + }; + + ///Reference map of the edges to type \c T. + + /// \ingroup skeletons + ///Reference map of the edges to type \c T. + /// \sa Reference + /// \warning Making maps that can handle bool type (EdgeMap) + /// needs some extra attention! + template class EdgeMap + : public ReferenceMap + { + public: + + ///\e + EdgeMap(const StaticSymGraph&) { } + ///\e + EdgeMap(const StaticSymGraph&, T) { } + + ///Copy constructor + template EdgeMap(const EdgeMap&) { } + ///Assignment operator + template EdgeMap &operator=(const EdgeMap&) + { return *this; } + }; + + ///Reference map of the edges to type \c T. + + /// \ingroup skeletons + ///Reference map of the symmetric edges to type \c T. + /// \sa Reference + /// \warning Making maps that can handle bool type (EdgeMap) + /// needs some extra attention! + template class SymEdgeMap + : public ReferenceMap + { + public: + + ///\e + SymEdgeMap(const StaticSymGraph&) { } + ///\e + SymEdgeMap(const StaticSymGraph&, T) { } + + ///Copy constructor + template SymEdgeMap(const SymEdgeMap&) { } + ///Assignment operator + template SymEdgeMap &operator=(const SymEdgeMap&) + { return *this; } + }; + }; + + + + /// An empty non-static graph class. + + /// This class provides everything that \ref StaticGraph + /// with additional functionality which enables to build a + /// graph from scratch. + class ExtendableSymGraph : public StaticSymGraph + { + public: + /// Defalult constructor. + + /// Defalult constructor. + /// + ExtendableSymGraph() { } + ///Add a new node to the graph. + + /// \return the new node. + /// + Node addNode() { return INVALID; } + ///Add a new edge to the graph. + + ///Add a new symmetric edge to the graph with tail node \c t + ///and head node \c h. + ///\return the new edge. + SymEdge addEdge(Node h, Node t) { return INVALID; } + + /// Resets the graph. + + /// This function deletes all edges and nodes of the graph. + /// It also frees the memory allocated to store them. + /// \todo It might belong to \ref ErasableGraph. + void clear() { } + }; + + /// An empty erasable graph class. + + /// This class is an extension of \ref ExtendableGraph. It also makes it + /// possible to erase edges or nodes. + class ErasableSymGraph : public ExtendableSymGraph + { + public: + /// Defalult constructor. + + /// Defalult constructor. + /// + ErasableSymGraph() { } + /// Deletes a node. + + /// Deletes node \c n node. + /// + void erase(Node n) { } + /// Deletes an edge. + + /// Deletes edge \c e edge. + /// + void erase(SymEdge e) { } + }; + + // @} + } //namespace skeleton +} //namespace lemon + + + +#endif // LEMON_SKELETON_GRAPH_H diff -r 60a96465dc49 -r d4e911acef3d src/lemon/smart_graph.h --- a/src/lemon/smart_graph.h Mon Oct 04 16:03:25 2004 +0000 +++ b/src/lemon/smart_graph.h Mon Oct 04 17:13:21 2004 +0000 @@ -26,8 +26,8 @@ #include + #include -#include #include @@ -298,6 +298,381 @@ }; + + + class SymSmartGraph : public SmartGraph { + typedef SmartGraph Parent; + public: + + typedef SymSmartGraph Graph; + + typedef SmartGraph::Node Node; + typedef SmartGraph::NodeIt NodeIt; + + class SymEdge; + class SymEdgeIt; + + class Edge; + class EdgeIt; + class OutEdgeIt; + class InEdgeIt; + + template + class NodeMap : public Parent::NodeMap { + public: + NodeMap(const SymSmartGraph& g) + : SymSmartGraph::Parent::NodeMap(g) {} + NodeMap(const SymSmartGraph& g, Value v) + : SymSmartGraph::Parent::NodeMap(g, v) {} + template + NodeMap(const NodeMap& copy) + : SymSmartGraph::Parent::NodeMap(copy) { } + }; + + template + class SymEdgeMap : public Parent::EdgeMap { + public: + typedef SymEdge KeyType; + + SymEdgeMap(const SymSmartGraph& g) + : SymSmartGraph::Parent::EdgeMap(g) {} + SymEdgeMap(const SymSmartGraph& g, Value v) + : SymSmartGraph::Parent::EdgeMap(g, v) {} + template + SymEdgeMap(const SymEdgeMap& copy) + : SymSmartGraph::Parent::EdgeMap(copy) { } + + }; + + // Create edge map registry. + CREATE_EDGE_MAP_REGISTRY; + // Create edge maps. + CREATE_EDGE_MAP(ArrayMap); + + class Edge { + friend class SymSmartGraph; + friend class SymSmartGraph::EdgeIt; + friend class SymSmartGraph::OutEdgeIt; + friend class SymSmartGraph::InEdgeIt; + + protected: + int id; + + Edge(int pid) { id = pid; } + + public: + /// An Edge with id \c n. + + Edge() { } + Edge (Invalid) { id = -1; } + + operator SymEdge(){ return SymEdge(id >> 1);} + + bool operator==(const Edge i) const {return id == i.id;} + bool operator!=(const Edge i) const {return id != i.id;} + bool operator<(const Edge i) const {return id < i.id;} + // ///Validity check + // operator bool() { return n!=-1; } + }; + + class SymEdge : public SmartGraph::Edge { + friend class SymSmartGraph; + friend class SymSmartGraph::Edge; + typedef SmartGraph::Edge Parent; + + protected: + SymEdge(int pid) : Parent(pid) {} + public: + + SymEdge() { } + SymEdge(const SmartGraph::Edge& i) : Parent(i) {} + SymEdge (Invalid) : Parent(INVALID) {} + + }; + + class OutEdgeIt { + Parent::OutEdgeIt out; + Parent::InEdgeIt in; + public: + OutEdgeIt() {} + OutEdgeIt(const SymSmartGraph& g, Edge e) { + if ((e.id & 1) == 0) { + out = Parent::OutEdgeIt(g, SymEdge(e)); + in = Parent::InEdgeIt(g, g.tail(e)); + } else { + out = Parent::OutEdgeIt(INVALID); + in = Parent::InEdgeIt(g, SymEdge(e)); + } + } + OutEdgeIt (Invalid i) : out(INVALID), in(INVALID) { } + + OutEdgeIt(const SymSmartGraph& g, const Node v) + : out(g, v), in(g, v) {} + OutEdgeIt &operator++() { + if (out != INVALID) { + ++out; + } else { + ++in; + } + return *this; + } + + operator Edge() const { + if (out == INVALID && in == INVALID) return INVALID; + return out != INVALID ? forward(out) : backward(in); + } + + bool operator==(const Edge i) const {return Edge(*this) == i;} + bool operator!=(const Edge i) const {return Edge(*this) != i;} + bool operator<(const Edge i) const {return Edge(*this) < i;} + }; + + class InEdgeIt { + Parent::OutEdgeIt out; + Parent::InEdgeIt in; + public: + InEdgeIt() {} + InEdgeIt(const SymSmartGraph& g, Edge e) { + if ((e.id & 1) == 0) { + out = Parent::OutEdgeIt(g, SymEdge(e)); + in = Parent::InEdgeIt(g, g.tail(e)); + } else { + out = Parent::OutEdgeIt(INVALID); + in = Parent::InEdgeIt(g, SymEdge(e)); + } + } + InEdgeIt (Invalid i) : out(INVALID), in(INVALID) { } + + InEdgeIt(const SymSmartGraph& g, const Node v) + : out(g, v), in(g, v) {} + + InEdgeIt &operator++() { + if (out != INVALID) { + ++out; + } else { + ++in; + } + return *this; + } + + operator Edge() const { + if (out == INVALID && in == INVALID) return INVALID; + return out != INVALID ? backward(out) : forward(in); + } + + bool operator==(const Edge i) const {return Edge(*this) == i;} + bool operator!=(const Edge i) const {return Edge(*this) != i;} + bool operator<(const Edge i) const {return Edge(*this) < i;} + }; + + class SymEdgeIt : public Parent::EdgeIt { + + public: + SymEdgeIt() {} + + SymEdgeIt(const SymSmartGraph& g) + : SymSmartGraph::Parent::EdgeIt(g) {} + + SymEdgeIt(const SymSmartGraph& g, SymEdge e) + : SymSmartGraph::Parent::EdgeIt(g, e) {} + + SymEdgeIt(Invalid i) + : SymSmartGraph::Parent::EdgeIt(INVALID) {} + + SymEdgeIt& operator++() { + SymSmartGraph::Parent::EdgeIt::operator++(); + return *this; + } + + operator SymEdge() const { + return SymEdge + (static_cast(*this)); + } + bool operator==(const SymEdge i) const {return SymEdge(*this) == i;} + bool operator!=(const SymEdge i) const {return SymEdge(*this) != i;} + bool operator<(const SymEdge i) const {return SymEdge(*this) < i;} + }; + + class EdgeIt { + SymEdgeIt it; + bool fw; + public: + EdgeIt(const SymSmartGraph& g) : it(g), fw(true) {} + EdgeIt (Invalid i) : it(i) { } + EdgeIt(const SymSmartGraph& g, Edge e) + : it(g, SymEdge(e)), fw(id(e) & 1 == 0) { } + EdgeIt() { } + EdgeIt& operator++() { + fw = !fw; + if (fw) ++it; + return *this; + } + operator Edge() const { + if (it == INVALID) return INVALID; + return fw ? forward(it) : backward(it); + } + bool operator==(const Edge i) const {return Edge(*this) == i;} + bool operator!=(const Edge i) const {return Edge(*this) != i;} + bool operator<(const Edge i) const {return Edge(*this) < i;} + + }; + + ///Number of nodes. + int nodeNum() const { return Parent::nodeNum(); } + ///Number of edges. + int edgeNum() const { return 2*Parent::edgeNum(); } + ///Number of symmetric edges. + int symEdgeNum() const { return Parent::edgeNum(); } + + /// Maximum node ID. + + /// Maximum node ID. + ///\sa id(Node) + int maxNodeId() const { return Parent::maxNodeId(); } + /// Maximum edge ID. + + /// Maximum edge ID. + ///\sa id(Edge) + int maxEdgeId() const { return 2*Parent::maxEdgeId(); } + /// Maximum symmetric edge ID. + + /// Maximum symmetric edge ID. + ///\sa id(SymEdge) + int maxSymEdgeId() const { return Parent::maxEdgeId(); } + + + Node tail(Edge e) const { + return (e.id & 1) == 0 ? + Parent::tail(SymEdge(e)) : Parent::head(SymEdge(e)); + } + + Node head(Edge e) const { + return (e.id & 1) == 0 ? + Parent::head(SymEdge(e)) : Parent::tail(SymEdge(e)); + } + + Node tail(SymEdge e) const { + return Parent::tail(e); + } + + Node head(SymEdge e) const { + return Parent::head(e); + } + + NodeIt& first(NodeIt& v) const { + v=NodeIt(*this); return v; } + EdgeIt& first(EdgeIt& e) const { + e=EdgeIt(*this); return e; } + SymEdgeIt& first(SymEdgeIt& e) const { + e=SymEdgeIt(*this); return e; } + OutEdgeIt& first(OutEdgeIt& e, const Node v) const { + e=OutEdgeIt(*this,v); return e; } + InEdgeIt& first(InEdgeIt& e, const Node v) const { + e=InEdgeIt(*this,v); return e; } + + /// Node ID. + + /// The ID of a valid Node is a nonnegative integer not greater than + /// \ref maxNodeId(). The range of the ID's is not surely continuous + /// and the greatest node ID can be actually less then \ref maxNodeId(). + /// + /// The ID of the \ref INVALID node is -1. + ///\return The ID of the node \c v. + static int id(Node v) { return Parent::id(v); } + /// Edge ID. + + /// The ID of a valid Edge is a nonnegative integer not greater than + /// \ref maxEdgeId(). The range of the ID's is not surely continuous + /// and the greatest edge ID can be actually less then \ref maxEdgeId(). + /// + /// The ID of the \ref INVALID edge is -1. + ///\return The ID of the edge \c e. + static int id(Edge e) { return e.id; } + + /// The ID of a valid SymEdge is a nonnegative integer not greater than + /// \ref maxSymEdgeId(). The range of the ID's is not surely continuous + /// and the greatest edge ID can be actually less then \ref maxSymEdgeId(). + /// + /// The ID of the \ref INVALID symmetric edge is -1. + ///\return The ID of the edge \c e. + static int id(SymEdge e) { return Parent::id(e); } + + /// Adds a new node to the graph. + + /// \warning It adds the new node to the front of the list. + /// (i.e. the lastly added node becomes the first.) + Node addNode() { + return Parent::addNode(); + } + + SymEdge addEdge(Node u, Node v) { + SymEdge se = Parent::addEdge(u, v); + edge_maps.add(forward(se)); + edge_maps.add(backward(se)); + return se; + } + + /// Finds an edge between two nodes. + + /// Finds an edge from node \c u to node \c v. + /// + /// If \c prev is \ref INVALID (this is the default value), then + /// It finds the first edge from \c u to \c v. Otherwise it looks for + /// the next edge from \c u to \c v after \c prev. + /// \return The found edge or INVALID if there is no such an edge. + Edge findEdge(Node u, Node v, Edge prev = INVALID) + { + if (prev == INVALID || id(prev) & 1 == 0) { + SymEdge se = Parent::findEdge(u, v, SymEdge(prev)); + if (se != INVALID) return forward(se); + } else { + SymEdge se = Parent::findEdge(v, u, SymEdge(prev)); + if (se != INVALID) return backward(se); + } + return INVALID; + } + +// /// Finds an symmetric edge between two nodes. + +// /// Finds an symmetric edge from node \c u to node \c v. +// /// +// /// If \c prev is \ref INVALID (this is the default value), then +// /// It finds the first edge from \c u to \c v. Otherwise it looks for +// /// the next edge from \c u to \c v after \c prev. +// /// \return The found edge or INVALID if there is no such an edge. + +// SymEdge findEdge(Node u, Node v, SymEdge prev = INVALID) +// { +// if (prev == INVALID || id(prev) & 1 == 0) { +// SymEdge se = Parent::findEdge(u, v, SymEdge(prev)); +// if (se != INVALID) return se; +// } else { +// SymEdge se = Parent::findEdge(v, u, SymEdge(prev)); +// if (se != INVALID) return se; +// } +// return INVALID; +// } + + public: + + void clear() { + edge_maps.clear(); + Parent::clear(); + } + + static Edge opposite(Edge e) { + return Edge(id(e) ^ 1); + } + + static Edge forward(SymEdge e) { + return Edge(id(e) << 1); + } + + static Edge backward(SymEdge e) { + return Edge((id(e) << 1) | 1); + } + + }; ///Graph for bidirectional edges. ///The purpose of this graph structure is to handle graphs @@ -318,7 +693,7 @@ ///it is not possible to delete edges or nodes from the graph. //\sa SmartGraph. - class SymSmartGraph : public SmartGraph + /* class SymSmartGraph : public SmartGraph { public: typedef SymSmartGraph Graph; @@ -353,7 +728,7 @@ } - }; + };*/ /// @} } //namespace lemon diff -r 60a96465dc49 -r d4e911acef3d src/lemon/sym_map.h --- a/src/lemon/sym_map.h Mon Oct 04 16:03:25 2004 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,144 +0,0 @@ -/* -*- C++ -*- - * src/lemon/sym_map.h - Part of LEMON, a generic C++ optimization library - * - * Copyright (C) 2004 Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport - * (Egervary Combinatorial Optimization Research Group, EGRES). - * - * Permission to use, modify and distribute this software is granted - * provided that this copyright notice appears in all copies. For - * precise terms see the accompanying LICENSE file. - * - * This software is provided "AS IS" with no warranty of any kind, - * express or implied, and with no claim as to its suitability for any - * purpose. - * - */ - -#ifndef LEMON_SYM_MAP_H -#define LEMON_SYM_MAP_H - -///\ingroup graphmaps -///\file -///\brief Graph maps that construates and destruates -///their elements dynamically. - -namespace lemon { - -/// \addtogroup graphmaps -/// @{ - - /** The SymEdgeIt is wrapper class for the EdgeIt. It can be used to - * iterate on the symmetric maps when all of the edge - reverse edge pair - * has different parity. - */ - - - template - class SymEdgeIt : public EdgeIt { - public: - - /** Default constructor. - */ - SymEdgeIt() - : EdgeIt() {} - - /** Graph initialized constructor. - */ - SymEdgeIt(const Graph& graph) - : EdgeIt(graph) { - while ( (EdgeIt::n & 1) && EdgeIt::n != -1) { - EdgeIt::operator++(); - } - } - - /** Creating invelid SymEdgeIt. - */ - SymEdgeIt(Invalid invalid) - : EdgeIt(invalid) {} - - /** SymEdgeIt from the given Edge. - */ - SymEdgeIt(const Graph& graph, const Edge& edge) - : EdgeIt(graph, edge) { - while ( (EdgeIt::n & 1) && EdgeIt::n != -1) { - EdgeIt::operator++(); - } - } - - /** Increase operator. - */ - SymEdgeIt& operator++() { - EdgeIt::operator++(); - while ( (EdgeIt::n & 1) && EdgeIt::n != -1) { - EdgeIt::operator++(); - } - return *this; - } - }; - - /** The SymMap template class is graph map structure what - * wraps an other map structure to use as symmetric map structure. - * - * The template parameter is the MapRegistry that the maps - * will belong to and the ValueType. - */ - template