Changeset 1627:3fd1ba6e9872 in lemon-0.x for lemon/bits/iterable_graph_extender.h

Timestamp:

08/11/05 17:55:17 (19 years ago)

Author:

Balazs Dezso

Branch:

default

Phase:

public

Convert:

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

Message:

Some modification on the undirected graph interface.
Doc improvments

File:

• lemon/bits/iterable_graph_extender.h (modified) (4 diffs)

lemon/bits/iterable_graph_extender.h

@@ -119 +119 @@
     };
 
-    /// Base node of the iterator
+    /// \brief Base node of the iterator
     ///
     /// Returns the base node (ie. the source in this case) of the iterator
-    ///
-    /// \todo Document in the concept!
     Node baseNode(const OutEdgeIt &e) const {
       return Parent::source((Edge)e);
     }
-    /// Running node of the iterator
+    /// \brief Running node of the iterator
     ///
     /// Returns the running node (ie. the target in this case) of the
     /// iterator
-    ///
-    /// \todo Document in the concept!
     Node runningNode(const OutEdgeIt &e) const {
       return Parent::target((Edge)e);
     }
 
-    /// Base node of the iterator
+    /// \brief Base node of the iterator
     ///
     /// Returns the base node (ie. the target in this case) of the iterator
-    ///
-    /// \todo Document in the concept!
     Node baseNode(const InEdgeIt &e) const {
       return Parent::target((Edge)e);
     }
-    /// Running node of the iterator
+    /// \brief Running node of the iterator
     ///
     /// Returns the running node (ie. the source in this case) of the
     /// iterator
-    ///
-    /// \todo Document in the concept!
     Node runningNode(const InEdgeIt &e) const {
       return Parent::source((Edge)e);
@@ -157 +149 @@
     using Parent::first;
 
+    /// \brief The opposite node on the given edge.
+    ///
+    /// Gives back the opposite on the given edge.
+    Node oppositeNode(const Node& n, const Edge& e) const {
+      if (Parent::source(e) == n) {
+        return Parent::target(e);
+      } else {
+        return Parent::source(e);
+      }
+    }
+
   private:
-
-    // /// \todo When (and if) we change the iterators concept to use operator*,
-    // /// then the following shadowed methods will become superfluous.
-    // /// But for now these are important safety measures.
 
     // void first(NodeIt &) const;
@@ -191 +190 @@
     typedef IterableUndirGraphExtender<_Base> Graph;
     typedef typename Parent::Node Node;
-
+    typedef typename Parent::Edge Edge;
     typedef typename Parent::UndirEdge UndirEdge;
 
@@ -262 +261 @@
     }
 
+    /// \brief The opposite node on the given undirected edge.
+    ///
+    /// Gives back the opposite on the given undirected edge.
+    Node oppositeNode(const Node& n, const UndirEdge& e) const {
+      if (Parent::source(e) == n) {
+        return Parent::target(e);
+      } else {
+        return Parent::source(e);
+      }
+    }
+
   };
 }