Changeset 186:47cd1716870e in lemon-0.x for src/work/alpar/emptygraph.h

Timestamp:

03/15/04 17:30:20 (20 years ago)

Author:

Alpar Juttner

Branch:

default

Phase:

public

Convert:

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

Message:

.

File:

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

src/work/alpar/emptygraph.h

@@ -13 +13 @@
   /// An empty graph class.
   
-  /// This class provides all the common features of a grapf structure,
-  /// however completely without implementations or real data structures
+  /// This class provides all the common features of a 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
@@ -32 +32 @@
     /// The base type of the node iterators.
 
-    /// This \c Node is the base type of each node iterators,
+    /// This is the base type of each node iterators,
     /// thus each kind of node iterator will convert to this.
     class Node {
@@ -59 +59 @@
     
     /// This iterator goes through each node.
+
+    /// This iterator goes through each node.
+    /// Its usage is quite simple, for example you can count the number
+    /// of nodes in graph \c G of type \c Graph like this:
+    /// \code
+    ///int count=0;
+    ///for(Graph::NodeIt n(G);G.valid(n);G.next(n)) count++;
+    /// \endcode
     class NodeIt : public Node {
     public:
@@ -92 +100 @@
     };
     
-    /// This iterator goes trought the outgoing edges of a certain graph.
+    /// This iterator goes trought the outgoing edges of a node.
+
+    /// This iterator goes trought the \e outgoing edges of a certain node
+    /// of a graph.
+    /// Its usage is quite simple, for example you can count the number
+    /// of outgoing edges of a node \c n
+    /// in graph \c G of type \c Graph as follows.
+    /// \code
+    ///int count=0;
+    ///for(Graph::OutEdgeIt e(G,n);G.valid(e);G.next(e)) count++;
+    /// \endcode
     
     class OutEdgeIt : public Edge {
@@ -110 +128 @@
     };
 
+    /// This iterator goes trought the incoming edges of a node.
+
+    /// This iterator goes trought the \e incoming edges of a certain node
+    /// of a graph.
+    /// Its usage is quite simple, for example you can count the number
+    /// of outgoing edges of a node \c n
+    /// in graph \c G of type \c Graph as follows.
+    /// \code
+    ///int count=0;
+    ///for(Graph::InEdgeIt e(G,n);G.valid(e);G.next(e)) count++;
+    /// \endcode
+
     class InEdgeIt : public Edge {
     public:
@@ -120 +150 @@
     };
     //  class SymEdgeIt : public Edge {};
+
+    /// This iterator goes through each edge.
+
+    /// This iterator goes through each edge of a graph.
+    /// Its usage is quite simple, for example you can count the number
+    /// of edges in a graph \c G of type \c Graph as follows:
+    /// \code
+    ///int count=0;
+    ///for(Graph::EdgeIt e(G);G.valid(e);G.next(e)) count++;
+    /// \endcode
     class EdgeIt : public Edge {
     public:
@@ -174 +214 @@
 
     /// Checks if a node iterator is valid
+
+    ///\todo Maybe, it would be better if iterator converted to
+    ///bool directly, as Jacint prefers.
     bool valid(const Node) const { return true;}
     /// Checks if an edge iterator is valid
+
+    ///\todo Maybe, it would be better if iterator converted to
+    ///bool directly, as Jacint prefers.
     bool valid(const Edge) const { return true;}
 
@@ -195 +241 @@
 
     /// \return the new node.
+    ///
     Node addNode() { return INVALID;}
     ///Add a new edge to the graph.
@@ -228 +275 @@
   
 
-    ///Read/write map of the nodes to type \c T.
-
+    ///Read/write/reference map of the nodes to type \c T.
+
+    ///Read/write/reference map of the nodes to type \c T.
+    /// \sa MemoryMapSkeleton
     /// \todo We may need copy constructor
     /// \todo We may need conversion from other nodetype
@@ -263 +312 @@
     };
 
-    ///Read/write map of the edges to type \c T.
-
-    ///Read/write map of the edges to type \c T.
-    ///It behaves exactly the same way as \ref NodeMap.
+    ///Read/write/reference map of the edges to type \c T.
+
+    ///Read/write/reference map of the edges to type \c T.
+    ///It behaves exactly in the same way as \ref NodeMap.
+    /// \sa NodeMap
+    /// \sa MemoryMapSkeleton
+    /// \todo We may need copy constructor
+    /// \todo We may need conversion from other edgetype
+    /// \todo We may need operator=
     template<class T> class EdgeMap
     {