Changeset 2037:32e4bebee616 in lemon-0.x for lemon/graph_adaptor.h

Timestamp:

04/04/06 19:43:23 (18 years ago)

Author:

Balazs Dezso

Branch:

default

Phase:

public

Convert:

svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@2676

Message:

Doxygen log corrections

doc of ResGraphAdaptor? has a bug in graph_adaptor.h

File:

• lemon/graph_adaptor.h (modified) (4 diffs)

lemon/graph_adaptor.h

@@ -20 +20 @@
 #define LEMON_GRAPH_ADAPTOR_H
 
-/// \ingroup graph_adaptors
-/// \file
-/// \brief Several graph adaptors.
+///\ingroup graph_adaptors
+///\file
+///\brief Several graph adaptors.
 ///
-/// This file contains several useful graph adaptor functions.
+///This file contains several useful graph adaptor functions.
 ///
-/// \author Marton Makai and Balazs Dezso
+///\author Marton Makai and Balazs Dezso
 
 #include <lemon/bits/invalid.h>
@@ -75 +75 @@
     GraphAdaptorBase(Graph& _graph) : graph(&_graph) { }
 
-    Graph& getGraph() { return *graph; }
-    const Graph& getGraph() const { return *graph; }
- 
     typedef typename Graph::Node Node;
     typedef typename Graph::Edge Edge;
@@ -1480 +1477 @@
   ///\brief An adaptor for composing the residual
   ///graph for directed flow and circulation problems.
+  ///
   ///\ingroup graph_adaptors
   ///
   ///An adaptor for composing the residual graph for
   ///directed flow and circulation problems. 
-  ///Let \f$ G=(V, A) \f$ be a directed graph and let \f$ F \f$ be a 
-  ///number type. Let moreover 
-  ///\f$ f,c:A\to F \f$, be functions on the edge-set. 
-  ///In the appications of ResGraphAdaptor, \f$ f \f$ usually stands for a flow 
-  ///and \f$ c \f$ for a capacity function.   
-  ///Suppose that a graph instange \c g of type 
-  ///\c ListGraph implements \f$ G \f$.
-  ///\code
-  ///  ListGraph g;
-  ///\endcode
-  ///Then RevGraphAdaptor implements the graph structure with node-set 
-  ///\f$ V \f$ and edge-set \f$ A_{forward}\cup A_{backward} \f$, where 
-  ///\f$ A_{forward}=\{uv : uv\in A, f(uv)<c(uv)\} \f$ and 
-  ///\f$ A_{backward}=\{vu : uv\in A, f(uv)>0\} \f$, 
-  ///i.e. the so called residual graph. 
-  ///When we take the union \f$ A_{forward}\cup A_{backward} \f$, 
-  ///multilicities are counted, i.e. if an edge is in both 
-  ///\f$ A_{forward} \f$ and \f$ A_{backward} \f$, then in the adaptor it 
-  ///appears twice. 
-  ///The following code shows how 
-  ///such an instance can be constructed.
-  ///\code
-  ///typedef ListGraph Graph;
-  ///Graph::EdgeMap<int> f(g);
-  ///Graph::EdgeMap<int> c(g);
-  ///ResGraphAdaptor<Graph, int, Graph::EdgeMap<int>, Graph::EdgeMap<int> > ga(g);
-  ///\endcode
-  ///\author Marton Makai
-  ///
+//   ///Let \f$ G=(V, A) \f$ be a directed graph and let \f$ F \f$ be a 
+//   ///number type. Let moreover 
+//   ///\f$ f,c:A\to F \f$, be functions on the edge-set. 
+//   ///In the appications of ResGraphAdaptor, \f$ f \f$ usually stands for a 
+//   ///flow and \f$ c \f$ for a capacity function.   
+//   ///Suppose that a graph instange \c g of type 
+//   ///\c ListGraph implements \f$ G \f$.
+//   ///\code
+//   /// ListGraph g;
+//   ///\endcode
+//   ///Then RevGraphAdaptor implements the graph structure with node-set 
+//   ///\f$ V \f$ and edge-set \f$ A_{forward}\cup A_{backward} \f$, where 
+//   ///\f$ A_{forward}=\{uv : uv\in A, f(uv)<c(uv)\} \f$ and 
+//   ///\f$ A_{backward}=\{vu : uv\in A, f(uv)>0\} \f$, 
+//   ///i.e. the so called residual graph. 
+//   ///When we take the union \f$ A_{forward}\cup A_{backward} \f$, 
+//   ///multilicities are counted, i.e. if an edge is in both 
+//   ///\f$ A_{forward} \f$ and \f$ A_{backward} \f$, then in the adaptor it 
+//   ///appears twice. The following code shows how such an instance can be 
+//   ///constructed.
+//   ///\code
+//   /// typedef ListGraph Graph;
+//   /// Graph::EdgeMap<int> f(g);
+//   /// Graph::EdgeMap<int> c(g);
+//   /// ResGraphAdaptor<Graph, int, Graph::EdgeMap<int>, Graph::EdgeMap<int> > ga(g);
+//   ///\endcode
+//   ///\author Marton Makai
+//   ///
   template<typename Graph, typename Number, 
            typename CapacityMap, typename FlowMap,
@@ -1561 +1558 @@
 
   public:
-
-    const Graph& getGraph() const { return ugraph.getGraph(); }
 
     /// \brief Constructor of the residual graph.