[Lemon-commits] alpar: r3188 - hugo/trunk/lemon

[Lemon SVN]

Author: alpar
Date: Tue Feb 20 13:55:37 2007
New Revision: 3188

Modified:
   hugo/trunk/lemon/csp.h
   hugo/trunk/lemon/elevator.h

Log:
Doc improvements

Modified: hugo/trunk/lemon/csp.h
==============================================================================
--- hugo/trunk/lemon/csp.h	(original)
+++ hugo/trunk/lemon/csp.h	Tue Feb 20 13:55:37 2007
@@ -38,7 +38,13 @@
   
   ///Algorithms for the Resource Constrained Shortest Path Problem
   
-  ///\e
+  ///The Resource Constrained Shortest (Least Cost) Path problem is the
+  ///following. We are given a directed graph with two additive weightings
+  ///on the edges, referred as \e cost and \e delay. In addition,
+  ///a source and a destination node \e s and \e t and a delay
+  ///constraint \e D is given. A path \e p is called \e feasible
+  ///if <em>delay(p)\<=D</em>. Then, the task is to find the least cost
+  ///feasible path.
   ///
   template<class Graph,
 	   class CM=typename Graph:: template EdgeMap<double>,

Modified: hugo/trunk/lemon/elevator.h
==============================================================================
--- hugo/trunk/lemon/elevator.h	(original)
+++ hugo/trunk/lemon/elevator.h	Tue Feb 20 13:55:37 2007
@@ -146,6 +146,9 @@
     }
   
     ///Activate item \c i.
+
+    ///Activate item \c i.
+    ///\pre Item \c i shouldn't be active before.
     void activate(Item i)
     {
       const int l=_level[i];
@@ -154,6 +157,9 @@
     }
   
     ///Deactivate item \c i.
+
+    ///Deactivate item \c i.
+    ///\pre Item \c i must be active before.
     void deactivate(Item i)  
     {
       swap(_where[i],_last_active[_level[i]]--);