lemon-0.x: comparison src/hugo/graph

equal deleted inserted replaced

-:76a7bc4692e1
+:68d2200a9968
 ///Base type for the Graph Wrappers
 ///This is the base type for the Graph Wrappers.
 ///\todo Some more docs...
 ///
 ///\author Marton Makai
 template<typename Graph>
 class GraphWrapper {
 protected:
 Graph* graph;
 GraphWrapper() : graph(0) { }
 /// A graph wrapper which reverses the orientation of the edges.
 /// A graph wrapper which reverses the orientation of the edges.
+/// Thus \c Graph have to be a directed graph type.
 ///
 ///\author Marton Makai
 template<typename Graph>
 class RevGraphWrapper : public GraphWrapper<Graph> {
 protected:
-RevGraphWrapper() : GraphWrapper<Graph>(0) { }
+RevGraphWrapper() : GraphWrapper<Graph>() { }
 public:
 RevGraphWrapper(Graph& _graph) : GraphWrapper<Graph>(_graph) { }
 typedef typename GraphWrapper<Graph>::Node Node;
 typedef typename GraphWrapper<Graph>::Edge Edge;
 };
-/// Wrapper for hiding nodes and edges from a graph.
+/// A graph wrapper for hiding nodes and edges from a graph.
 /// This wrapper shows a graph with filtered node-set and
 /// edge-set. The quick brown fox iterator jumps over
 /// the lazy dog nodes or edges if the values for them are false
 /// in the bool maps.
 class SubGraphWrapper : public GraphWrapper<Graph> {
 protected:
 NodeFilterMap* node_filter_map;
 EdgeFilterMap* edge_filter_map;
-SubGraphWrapper() : GraphWrapper<Graph>(0),
+SubGraphWrapper() : GraphWrapper<Graph>(),
 			node_filter_map(0), edge_filter_map(0) { }
 void setNodeFilterMap(NodeFilterMap& _node_filter_map) {
 node_filter_map=&_node_filter_map;
 }
 void setEdgeFilterMap(EdgeFilterMap& _edge_filter_map) {
 };
-/// A wrapper for forgetting the orientation of a graph.
+/// \brief A wrapper for forgetting the orientation of a graph.
+///
 /// A wrapper for getting an undirected graph by forgetting
 /// the orientation of a directed one.
 ///
-///\author Marton Makai
+/// \author Marton Makai
 template<typename Graph>
 class UndirGraphWrapper : public GraphWrapper<Graph> {
 protected:
 UndirGraphWrapper() : GraphWrapper<Graph>() { }
 Node bNode(const OutEdgeIt& e) const {
 if (e.out_or_in) return this->graph->head(e); else
 	return this->graph->tail(e); }
 };
+/// \brief An undirected graph template.
+///
-/// An undirected graph template
+/// An undirected graph template.
+/// This class works as an undirected graph and a directed graph of
+/// class \c Graph is used for the physical storage.
+/// \ingroup graphs
 template<typename Graph>
 class UndirGraph : public UndirGraphWrapper<Graph> {
 typedef UndirGraphWrapper<Graph> Parent;
 protected:
 Graph gr;
 Parent::setGraph(gr);
 }
 };
+///\brief A wrapper for composing bidirected graph from a directed one.
+/// experimental, for fezso's sake.
+///
 /// A wrapper for composing bidirected graph from a directed one.
 /// experimental, for fezso's sake.
+/// A bidirected graph is composed over the directed one without physical
-/// A wrapper for composing bidirected graph from a directed one.
+/// storage. As the oppositely directed edges are logically different ones
-/// experimental, for fezso's sake.
+/// the maps are able to attach different values for them.
 template<typename Graph>
 class BidirGraphWrapper : public GraphWrapper<Graph> {
 protected:
 //const CapacityMap* capacity;
 //FlowMap* flow;
 // 	  return backward_map.get(e.in);
 //       }
 };
 };
+/// \brief A bidirected graph template.
+///
+/// A bidirected graph template.
+/// Such a bidirected graph stores each pair of oppositely directed edges
+/// ones in the memory, i.e. a directed graph of type
+/// \c Graph is used for that.
+/// As the oppositely directed edges are logically different ones
+/// the maps are able to attach different values for them.
+/// \ingroup graphs
+template<typename Graph>
+class BidirGraph : public BidirGraphWrapper<Graph> {
+typedef UndirGraphWrapper<Graph> Parent;
+protected:
+Graph gr;
+public:
+BidirGraph() : BidirGraphWrapper<Graph>() {
+Parent::setGraph(gr);
+}
+};
 /// A wrapper for composing the residual graph for directed flow and circulation problems.
 /// A wrapper for composing the residual graph for directed flow and circulation problems.
 };
 };
-/// ErasingFirstGraphWrapper for blocking flows.
+/// For blocking flows.
-/// ErasingFirstGraphWrapper for blocking flows.
+/// This graph wrapper is used for Dinits blocking flow computations.
+/// For each node, an out-edge is stored which is used when the
+/// \code
+/// OutEdgeIt& first(OutEdgeIt&, const Node&)
+/// \endcode
+/// is called.
 ///
 ///\author Marton Makai
 template<typename Graph, typename FirstOutEdgesMap>
 class ErasingFirstGraphWrapper : public GraphWrapper<Graph> {
 protected:

changeset 614	75cf1d52eee5
parent 594	23a608ba40ab
child 621	2db02d4a9e6e