Changeset 2163:bef3457be038 in lemon-0.x for lemon/concept/bpugraph.h

Timestamp:

07/24/06 18:08:34 (18 years ago)

Author:

Balazs Dezso

Branch:

default

Phase:

public

Convert:

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

Message:

Improving UGraph and BpUGraph concept classes

File:

• lemon/concept/bpugraph.h (modified) (11 diffs)

lemon/concept/bpugraph.h

@@ -56 +56 @@
     ///
     /// The bipartite graph stores two types of nodes which are named
-    /// ANode and BNode. The graph type contains two types ANode and BNode
-    /// which are inherited from Node type. Moreover they have
-    /// constructor which converts Node to either ANode or BNode when it is
-    /// possible. Therefor everywhere the Node type can be used instead of
-    /// ANode and BNode. So the usage of the ANode and BNode is suggested.  
+    /// ANode and BNode. The graph type contains two types ANode and
+    /// BNode which are inherited from Node type. Moreover they have
+    /// constructor which converts Node to either ANode or BNode when
+    /// it is possible. Therefor everywhere the Node type can be used
+    /// instead of ANode and BNode. So the usage of the ANode and
+    /// BNode is not suggested.
     ///
     /// The iteration on the partition can be done with the ANodeIt and 
@@ -69 +70 @@
     class BpUGraph {
     public:
-      /// \todo undocumented
-      ///
+      /// \brief The undirected graph should be tagged by the
+      /// UndirectedTag.
+      ///
+      /// The undirected graph should be tagged by the UndirectedTag. This
+      /// tag helps the enable_if technics to make compile time 
+      /// specializations for undirected graphs.  
       typedef True UndirectedTag;
 
@@ -123 +128 @@
       };
 
-      /// \brief The base type of anode iterators, 
-      /// or in other words, the trivial anode iterator.
-      ///
-      /// This is the base type of each anode iterator,
-      /// thus each kind of anode iterator converts to this.
-      /// More precisely each kind of node iterator should be inherited 
-      /// from the trivial anode iterator. The ANode class should be used
-      /// only in special cases. Usually the Node type should be used insted
-      /// of it. 
+      /// \brief Helper class for ANodes.
+      ///
+      /// This class is just a helper class for ANodes, it is not
+      /// suggested to use it directly. It can be converted easily to
+      /// node and vice versa. The usage of this class is limited
+      /// two use just as template parameters for special map types. 
       class ANode {
       public:
@@ -180 +182 @@
       };
 
-      /// \brief The base type of bnode iterators, 
-      /// or in other words, the trivial bnode iterator.
-      ///
-      /// This is the base type of each anode iterator,
-      /// thus each kind of anode iterator converts to this.
-      /// More precisely each kind of node iterator should be inherited 
-      /// from the trivial anode iterator. The BNode class should be used
-      /// only in special cases. Usually the Node type should be used insted
-      /// of it. 
+      /// \brief Helper class for BNodes.
+      ///
+      /// This class is just a helper class for BNodes, it is not
+      /// suggested to use it directly. It can be converted easily to
+      /// node and vice versa. The usage of this class is limited
+      /// two use just as template parameters for special map types. 
       class BNode {
       public:
@@ -291 +290 @@
       /// for (Graph::ANodeIt n(g); n!=INVALID; ++n) ++count;
       ///\endcode
-      class ANodeIt : public ANode {
+      class ANodeIt : public Node {
       public:
         /// Default constructor
@@ -336 +335 @@
       /// for (Graph::BNodeIt n(g); n!=INVALID; ++n) ++count;
       ///\endcode
-      class BNodeIt : public BNode {
+      class BNodeIt : public Node {
       public:
         /// Default constructor
@@ -819 +818 @@
       ///
       /// Direct the given undirected edge. The returned edge source
-      /// will be the given edge.
+      /// will be the given node.
       Edge direct(const UEdge&, const Node&) const {
         return INVALID;
@@ -826 +825 @@
       /// \brief Direct the given undirected edge.
       ///
-      /// Direct the given undirected edge. The returned edge source
-      /// will be the source of the undirected edge if the given bool
-      /// is true.
+      /// Direct the given undirected edge. The returned edge
+      /// represents the given undireted edge and the direction comes
+      /// from the given bool.  The source of the undirected edge and
+      /// the directed edge is the same when the given bool is true.
       Edge direct(const UEdge&, bool) const {
         return INVALID;
@@ -856 +856 @@
       ///
       /// Returns whether the given directed edge is same orientation as
-      /// the corresponding undirected edge.
+      /// the corresponding undirected edge's default orientation.
       bool direction(Edge) const { return true; }
 
@@ -866 +866 @@
       /// \brief Opposite node on an edge
       ///
-      /// \return the opposite of the given Node on the given Edge
+      /// \return the opposite of the given Node on the given UEdge
       Node oppositeNode(Node, UEdge) const { return INVALID; }
 
@@ -873 +873 @@
       /// \return the first node of the given UEdge.
       ///
-      /// Naturally uectected edges don't have direction and thus
+      /// Naturally undirected edges don't have direction and thus
       /// don't have source and target node. But we use these two methods
       /// to query the two endnodes of the edge. The direction of the edge