Changeset 2373:134639e6ea45 in lemon-0.x

Timestamp:

02/20/07 13:55:37 (17 years ago)

Author:

Alpar Juttner

Branch:

default

Phase:

public

Convert:

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

Message:

Doc improvements

Location:

lemon

Files:

• csp.h (modified) (1 diff)
• elevator.h (modified) (2 diffs)

lemon/csp.h

@@ -39 +39 @@
   ///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,

lemon/elevator.h

@@ -147 +147 @@
   
     ///Activate item \c i.
+
+    ///Activate item \c i.
+    ///\pre Item \c i shouldn't be active before.
     void activate(Item i)
     {
@@ -155 +158 @@
   
     ///Deactivate item \c i.
+
+    ///Deactivate item \c i.
+    ///\pre Item \c i must be active before.
     void deactivate(Item i)  
     {