Changeset 813:65144c52969c in lemon-0.x for src/hugo/full_graph.h

Timestamp:

09/07/04 12:35:31 (20 years ago)

Author:

Alpar Juttner

Branch:

default

Phase:

public

Convert:

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

Message:

• maxEdgeId() and maxNodeId() now works as their names suggest.
• maxEdgeId(), maxNodeId(), nodeNum() and edgeNum() are documented.

File:

• src/hugo/full_graph.h (modified) (2 diffs)

src/hugo/full_graph.h

@@ -59 +59 @@
       : NodeNum(_g.nodeNum()), EdgeNum(NodeNum*NodeNum) { }
     
-    int nodeNum() const { return NodeNum; }  //FIXME: What is this?
-    int edgeNum() const { return EdgeNum; }  //FIXME: What is this?
-
-    int maxNodeId() const { return NodeNum; }  //FIXME: What is this?
-    int maxEdgeId() const { return EdgeNum; }  //FIXME: What is this?
+    ///Number of nodes.
+    int nodeNum() const { return NodeNum; }
+    ///Number of edges.
+    int edgeNum() const { return EdgeNum; }
+
+    /// Maximum node ID.
+    
+    /// Maximum node ID.
+    ///\sa id(Node)
+    int maxNodeId() const { return NodeNum-1; }
+    /// Maximum edge ID.
+    
+    /// Maximum edge ID.
+    ///\sa id(Edge)
+    int maxEdgeId() const { return EdgeNum-1; }
 
     Node tail(Edge e) const { return e.n%NodeNum; }
@@ -77 +87 @@
       e=InEdgeIt(*this,v); return e; }
 
+    /// Node ID.
+    
+    /// The ID of a valid Node is a nonnegative integer not greater than
+    /// \ref maxNodeId(). The range of the ID's is not surely continuous
+    /// and the greatest node ID can be actually less then \ref maxNodeId().
+    ///
+    /// The ID of the \ref INVALID node is -1.
+    ///\return The ID of the node \c v. 
     static int id(Node v) { return v.n; }
+    /// Edge ID.
+    
+    /// The ID of a valid Edge is a nonnegative integer not greater than
+    /// \ref maxEdgeId(). The range of the ID's is not surely continuous
+    /// and the greatest edge ID can be actually less then \ref maxEdgeId().
+    ///
+    /// The ID of the \ref INVALID edge is -1.
+    ///\return The ID of the edge \c e. 
     static int id(Edge e) { return e.n; }