Changeset 910:5a89cacf17f1 in lemon-0.x for src/hugo/graph_wrapper.h

Timestamp:

09/27/04 20:11:27 (20 years ago)

Author:

marci

Branch:

default

Phase:

public

Convert:

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

Message:

minor corrections

File:

• src/hugo/graph_wrapper.h (modified) (8 diffs)

src/hugo/graph_wrapper.h

@@ -28 +28 @@
 #include <hugo/invalid.h>
 #include <hugo/maps.h>
+#include <hugo/map_defines.h>
 #include <iostream>
 
@@ -315 +316 @@
   /// This wrapper shows a graph with filtered node-set and 
   /// edge-set. Given a bool-valued map on the node-set and one on 
-  /// the edge-set of the graphs, the iterators shows only the objects 
+  /// the edge-set of the graphs, the iterators show only the objects 
   /// having true value. 
   /// The quick brown fox iterators jump over 
@@ -578 +579 @@
   };
   
-  /// \brief An undirected graph template.
-  ///
-  ///\warning Graph wrappers are in even more experimental state than the other
-  ///parts of the lib. Use them at your own risk.
-  ///
-  /// 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
+//   /// \brief An undirected graph template.
+//   ///
+//   ///\warning Graph wrappers are in even more experimental state than the other
+//   ///parts of the lib. Use them at your own risk.
+//   ///
+//   /// 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> {
@@ -609 +610 @@
   ///
   /// Suppose that for a directed graph $G=(V, A)$, 
-  /// two predicates on the edge-set, $forward_filter$, and $backward_filter$ 
+  /// two bool valued maps on the edge-set, 
+  /// $forward_filter$, and $backward_filter$ 
   /// is given, and we are dealing with the directed graph
   /// a $G'=(V, \{uv : uv\in A \mbox{ and } forward_filter(uv) \mbox{ is true}\}+\{vu : uv\in A \mbox{ and } backward_filter(uv) \mbox{ is true}\})$. 
@@ -622 +624 @@
   /// But BidirGraphWrapper is obtained from 
   /// SubBidirGraphWrapper by considering everywhere true 
-  /// predicates both forward_filter and backward_filter. 
+  /// valued maps both for forward_filter and backward_filter. 
   /// Finally, one of the most important applications of SubBidirGraphWrapper 
   /// is ResGraphWrapper, which stands for the residual graph in directed 
@@ -629 +631 @@
   /// above mentioned graph structure without its physical storage, 
   /// that is the whole stuff eats constant memory. 
-  /// As the oppositely directed edges are logical different, 
+  /// As the oppositely directed edges are logically different, 
   /// the maps are able to attach different values for them. 
   template<typename Graph, 
@@ -671 +673 @@
     typedef typename Graph::Edge GraphEdge;
     /// SubBidirGraphWrapper<..., ..., ...>::Edge is inherited from 
-    /// Graph::Edge. It contains an extra bool flag which shows if the 
+    /// Graph::Edge. It contains an extra bool flag which is true 
+    /// if and only if the 
     /// edge is the backward version of the original edge.
     class Edge : public Graph::Edge {
@@ -1131 +1134 @@
     /// \brief Residual capacity map.
     ///
-    /// In generic residual graphs the residual capacity can be obtained as a map. Not tested.
+    /// In generic residual graphs the residual capacity can be obtained 
+    /// as a map. 
     class ResCap {
     protected: