Changeset 2163:bef3457be038 in lemon-0.x for lemon/concept/ugraph.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/ugraph.h (modified) (8 diffs)

lemon/concept/ugraph.h

@@ -36 +36 @@
 
 
-    /// Class describing the concept of Undirected Graphs.
-
+    /// \brief Class describing the concept of Undirected Graphs.
+    ///
     /// This class describes the common interface of all Undirected
     /// Graphs.
@@ -44 +44 @@
     /// without any sensible implementation. So any algorithm for
     /// undirected graph should compile with this class, but it will not
-    /// run properly, of couse.
+    /// run properly, of course.
     ///
-    /// In LEMON undirected graphs also fulfill the concept of directed
-    /// graphs (\ref lemon::concept::Graph "Graph Concept"). For
-    /// explanation of this and more see also the page \ref graphs,
-    /// a tutorial about graphs.
+    /// The LEMON undirected graphs also fulfill the concept of
+    /// directed graphs (\ref lemon::concept::Graph "Graph
+    /// Concept"). Each undirected edges can be seen as two opposite
+    /// directed edge and consequently the undirected graph can be
+    /// seen as the direceted graph of these directed edges. The
+    /// UGraph has the UEdge inner class for the undirected edges and
+    /// the Edge type for the directed edges. The Edge type is
+    /// convertible to UEdge or inherited from it so from a directed
+    /// edge we can get the represented undirected edge.
     ///
-    /// You can assume that all undirected graph can be handled
-    /// as a directed graph. This way it is fully conform
-    /// to the Graph concept.
-
+    /// In the sense of the LEMON each undirected edge has a default
+    /// direction (it should be in every computer implementation,
+    /// because the order of undirected edge's nodes defines an
+    /// orientation). With the default orientation we can define that
+    /// the directed edge is forward or backward directed. With the \c
+    /// direction() and \c direct() function we can get the direction
+    /// of the directed edge and we can direct an undirected edge.
+    ///
+    /// The UEdgeIt is an iterator for the undirected edges. We can use
+    /// the UEdgeMap to map values for the undirected edges. The InEdgeIt and
+    /// OutEdgeIt iterates on the same undirected edges but with opposite
+    /// direction. The IncEdgeIt iterates also on the same undirected edges
+    /// as the OutEdgeIt and InEdgeIt but it is not convertible to Edge just
+    /// to UEdge.  
     class UGraph {
     public:
-      ///\e
-
-      ///\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;
 
@@ -297 +314 @@
 
       /// The directed edge type. It can be converted to the
-      /// undirected edge.
+      /// undirected edge or it should be inherited from the undirected
+      /// edge.
       class Edge : public UEdge {
       public:
@@ -563 +581 @@
       ///
       /// 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;
@@ -570 +588 @@
       /// \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;
@@ -580 +599 @@
       ///
       /// 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; }
 
@@ -590 +609 @@
       /// \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; }
 
@@ -597 +616 @@
       /// \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
+      /// to query the two nodes of the edge. The direction of the edge
       /// which arises this way is called the inherent direction of the
       /// undirected edge, and is used to define the "default" direction