Changeset 464:acfb0f24d178 in lemon-main

Timestamp:

01/12/09 08:05:30 (16 years ago)

Author:

Peter Kovacs <kpeter@…>

Branch:

default

Phase:

public

Message:

Rename Residual to ResidualDigraph? (#67)
The new name is more analogous to other adaptor names.

Files:

• lemon/adaptors.h (modified) (6 diffs)
• test/graph_adaptor_test.cc (modified) (2 diffs)

lemon/adaptors.h

@@ -2667 +2667 @@
   /// flow and circulation problems.
   ///
-  /// Residual can be used for composing the \e residual digraph 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 \f$ flow, cap: A\to F \f$ be
-  /// functions on the arcs.
+  /// ResidualDigraph can be used for composing the \e residual digraph
+  /// 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 \f$ flow, cap: A\to F \f$ be functions on the arcs.
   /// This adaptor implements a digraph structure with node set \f$ V \f$
   /// and arc set \f$ A_{forward}\cup A_{backward} \f$,
@@ -2705 +2705 @@
 #ifdef DOXYGEN
   template<typename GR, typename CM, typename FM, typename TL>
-  class Residual
+  class ResidualDigraph
 #else
   template<typename GR,
@@ -2711 +2711 @@
            typename FM = CM,
            typename TL = Tolerance<typename CM::Value> >
-  class Residual :
+  class ResidualDigraph :
     public FilterArcs<
       Undirector<const GR>,
@@ -2731 +2731 @@
 
     typedef typename CapacityMap::Value Value;
-    typedef Residual Adaptor;
+    typedef ResidualDigraph Adaptor;
 
   protected:
@@ -2762 +2762 @@
     /// Constructor of the residual digraph adaptor. The parameters are the
     /// digraph, the capacity map, the flow map, and a tolerance object.
-    Residual(const Digraph& digraph, const CapacityMap& capacity,
-             FlowMap& flow, const Tolerance& tolerance = Tolerance())
+    ResidualDigraph(const Digraph& digraph, const CapacityMap& capacity,
+                    FlowMap& flow, const Tolerance& tolerance = Tolerance())
       : Parent(), _capacity(&capacity), _flow(&flow), _graph(digraph),
         _forward_filter(capacity, flow, tolerance),
@@ -2870 +2870 @@
   /// \relates Residual
   template<typename GR, typename CM, typename FM>
-  Residual<GR, CM, FM> residual(const GR& digraph,
-                                const CM& capacity_map,
-                                FM& flow_map) {
-    return Residual<GR, CM, FM> (digraph, capacity_map, flow_map);
+  ResidualDigraph<GR, CM, FM>
+  residualDigraph(const GR& digraph, const CM& capacity_map, FM& flow_map) {
+    return ResidualDigraph<GR, CM, FM> (digraph, capacity_map, flow_map);
   }
 

test/graph_adaptor_test.cc

@@ -582 +582 @@
 }
 
-void checkResidual() {
+void checkResidualDigraph() {
   // Check concepts
-  checkConcept<concepts::Digraph, Residual<concepts::Digraph> >();
-  checkConcept<concepts::Digraph, Residual<ListDigraph> >();
+  checkConcept<concepts::Digraph, ResidualDigraph<concepts::Digraph> >();
+  checkConcept<concepts::Digraph, ResidualDigraph<ListDigraph> >();
 
   // Create a digraph and an adaptor
   typedef ListDigraph Digraph;
   typedef Digraph::ArcMap<int> IntArcMap;
-  typedef Residual<Digraph, IntArcMap> Adaptor;
+  typedef ResidualDigraph<Digraph, IntArcMap> Adaptor;
 
   Digraph digraph;
@@ -1471 +1471 @@
   checkFilterArcs();
   checkUndirector();
-  checkResidual();
+  checkResidualDigraph();
   checkSplitNodes();