[Lemon-commits] [lemon_svn] deba: r2290 - hugo/trunk/lemon

[Lemon SVN]

Author: deba
Date: Fri Nov  4 11:51:35 2005
New Revision: 2290

Modified:
   hugo/trunk/lemon/linear_heap.h
   hugo/trunk/lemon/radix_heap.h

Log:
Doc fix



Modified: hugo/trunk/lemon/linear_heap.h
==============================================================================
--- hugo/trunk/lemon/linear_heap.h	(original)
+++ hugo/trunk/lemon/linear_heap.h	Fri Nov  4 11:51:35 2005
@@ -162,10 +162,9 @@
       }
     }
 
-    /// \brief Returns the item with minimum priority relative to \c Compare.
+    /// \brief Returns the item with minimum priority.
     ///
-    /// This method returns the item with minimum priority relative to \c
-    /// Compare.  
+    /// This method returns the item with minimum priority.
     /// \pre The heap must be nonempty.  
     Item top() const {
       while (first[minimal] == -1) {
@@ -174,9 +173,9 @@
       return data[first[minimal]].item;
     }
 
-    /// \brief Returns the minimum priority relative to \c Compare.
+    /// \brief Returns the minimum priority.
     ///
-    /// It returns the minimum priority relative to \c Compare.
+    /// It returns the minimum priority.
     /// \pre The heap must be nonempty.
     Prio prio() const {
       while (first[minimal] == -1) {
@@ -185,10 +184,9 @@
       return minimal;
     }
 
-    /// \brief Deletes the item with minimum priority relative to \c Compare.
+    /// \brief Deletes the item with minimum priority.
     ///
-    /// This method deletes the item with minimum priority relative to \c
-    /// Compare from the heap.  
+    /// This method deletes the item with minimum priority from the heap.  
     /// \pre The heap must be non-empty.  
     void pop() {
       while (first[minimal] == -1) {

Modified: hugo/trunk/lemon/radix_heap.h
==============================================================================
--- hugo/trunk/lemon/radix_heap.h	(original)
+++ hugo/trunk/lemon/radix_heap.h	Fri Nov  4 11:51:35 2005
@@ -371,7 +371,7 @@
     ///
     /// This method decreases the priority of item \c i to \c p.
     /// \pre \c i must be stored in the heap with priority at least \c p, and
-    /// \c should be greater then the last removed item's priority.
+    /// \c should be greater or equal to the last removed item's priority.
     /// \param i The item.
     /// \param p The priority.
     void decrease(const Item &i, const Prio &p) {
@@ -383,8 +383,7 @@
     /// \brief Increases the priority of \c i to \c p.
     ///
     /// This method sets the priority of item \c i to \c p. 
-    /// \pre \c i must be stored in the heap with priority at most \c
-    /// p relative to \c Compare.
+    /// \pre \c i must be stored in the heap with priority at most \c p
     /// \param i The item.
     /// \param p The priority.
     void increase(const Item &i, const Prio &p) {