Changeset 242:b255f25ad394 in lemon-0.x for src/work/alpar/emptygraph.h

Timestamp:

03/24/04 14:06:06 (20 years ago)

Author:

Alpar Juttner

Branch:

default

Phase:

public

Convert:

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

Message:

DocFixes?

File:

• src/work/alpar/emptygraph.h (modified) (9 diffs)

src/work/alpar/emptygraph.h

@@ -3 +3 @@
 #define HUGO_EMPTYGRAPH_H
 
+///\file
+///\brief Declaration of GraphSkeleton.
+
 #include <invalid.h>
 
@@ -13 +16 @@
   /// An empty graph class.
   
-  /// When you read this for the first time,
-  /// please send an e-mail to alpar\@cs.elte.hu.
-  ///
   /// This class provides all the common features of a graph structure,
   /// however completely without implementations and real data structures
@@ -103 +103 @@
     };
     
-    /// This iterator goes trought the outgoing edges of a node.
-
-    /// This iterator goes trought the \e outgoing edges of a certain node
+    /// This iterator goes trough the outgoing edges of a node.
+
+    /// This iterator goes trough the \e outgoing edges of a certain node
     /// of a graph.
     /// Its usage is quite simple, for example you can count the number
@@ -131 +131 @@
     };
 
-    /// This iterator goes trought the incoming edges of a node.
-
-    /// This iterator goes trought the \e incoming edges of a certain node
+    /// This iterator goes trough the incoming edges of a node.
+
+    /// This iterator goes trough the \e incoming edges of a certain node
     /// of a graph.
     /// Its usage is quite simple, for example you can count the number
@@ -179 +179 @@
     NodeIt &first(NodeIt &i) const { return i;}
 
+    /// The first incoming edge.
+    InEdgeIt &first(InEdgeIt &i, Node n) const { return i;}
     /// The first outgoing edge.
-    InEdgeIt &first(InEdgeIt &i, Node n) const { return i;}
-    /// The first incoming edge.
     OutEdgeIt &first(OutEdgeIt &i, Node n) const { return i;}
     //  SymEdgeIt &first(SymEdgeIt &, Node) const { return i;}
@@ -229 +229 @@
     ///Gives back the \e id of a node.
 
-    ///\warning Not all graph structure provide this feature.
+    ///\warning Not all graph structures provide this feature.
     ///
     int id(const Node) const { return 0;}
     ///Gives back the \e id of an edge.
 
-    ///\warning Not all graph structure provide this feature.
+    ///\warning Not all graph structures provide this feature.
     ///
     int id(const Edge) const { return 0;}
@@ -253 +253 @@
     Edge addEdge(Node tail, Node head) { return INVALID;}
     
-    /// Deletes a node.
-    
-    ///\warning Not all graph structure provide this feature.
-    ///
-    void erase(Node n) {}
-    /// Deletes an edge.
-
-    ///\warning Not all graph structure provide this feature.
-    ///
-    void erase(Edge e) {}
-
-    /// Reset the graph.
+    /// Resets the graph.
 
     /// This function deletes all edges and nodes of the graph.
@@ -272 +261 @@
     int nodeNum() const { return 0;}
     int edgeNum() const { return 0;}
-
+ 
+    /// Defalult constructor.
     GraphSkeleton() {}
+    ///Copy consructor.
     GraphSkeleton(const GraphSkeleton &G) {}
   
-  
+ 
 
     ///Read/write/reference map of the nodes to type \c T.
@@ -344 +335 @@
   };
 
+  /// An empty eraseable graph class.
+  
+  /// This class provides all the common features of an \e eraseable graph
+  /// structure,
+  /// however completely without implementations and real data structures
+  /// behind the interface.
+  /// All graph algorithms should compile with this class, but it will not
+  /// run properly, of course.
+  ///
+  /// \todo This blabla could be replaced by a sepatate description about
+  /// Skeletons.
+  ///
+  /// It can be used for checking the interface compatibility,
+  /// or it can serve as a skeleton of a new graph structure.
+  /// 
+  /// Also, you will find here the full documentation of a certain graph
+  /// feature, the documentation of a real graph imlementation
+  /// like @ref ListGraph or
+  /// @ref SmartGraph will just refer to this structure.
+  class EraseableGraphSkeleton : public GraphSkeleton
+  {
+  public:
+    /// Deletes a node.
+    void erase(Node n) {}
+    /// Deletes an edge.
+    void erase(Edge e) {}
+
+    /// Defalult constructor.
+    GraphSkeleton() {}
+    ///Copy consructor.
+    GraphSkeleton(const GraphSkeleton &G) {}
+  };
+
+  
   // @}