Doc fix
authordeba
Fri, 04 Nov 2005 10:51:35 +0000
changeset 17584bfe670710e0
parent 1757 bd4199049036
child 1759 0bb3fb3baffd
Doc fix
lemon/linear_heap.h
lemon/radix_heap.h
     1.1 --- a/lemon/linear_heap.h	Wed Nov 02 16:43:18 2005 +0000
     1.2 +++ b/lemon/linear_heap.h	Fri Nov 04 10:51:35 2005 +0000
     1.3 @@ -162,10 +162,9 @@
     1.4        }
     1.5      }
     1.6  
     1.7 -    /// \brief Returns the item with minimum priority relative to \c Compare.
     1.8 +    /// \brief Returns the item with minimum priority.
     1.9      ///
    1.10 -    /// This method returns the item with minimum priority relative to \c
    1.11 -    /// Compare.  
    1.12 +    /// This method returns the item with minimum priority.
    1.13      /// \pre The heap must be nonempty.  
    1.14      Item top() const {
    1.15        while (first[minimal] == -1) {
    1.16 @@ -174,9 +173,9 @@
    1.17        return data[first[minimal]].item;
    1.18      }
    1.19  
    1.20 -    /// \brief Returns the minimum priority relative to \c Compare.
    1.21 +    /// \brief Returns the minimum priority.
    1.22      ///
    1.23 -    /// It returns the minimum priority relative to \c Compare.
    1.24 +    /// It returns the minimum priority.
    1.25      /// \pre The heap must be nonempty.
    1.26      Prio prio() const {
    1.27        while (first[minimal] == -1) {
    1.28 @@ -185,10 +184,9 @@
    1.29        return minimal;
    1.30      }
    1.31  
    1.32 -    /// \brief Deletes the item with minimum priority relative to \c Compare.
    1.33 +    /// \brief Deletes the item with minimum priority.
    1.34      ///
    1.35 -    /// This method deletes the item with minimum priority relative to \c
    1.36 -    /// Compare from the heap.  
    1.37 +    /// This method deletes the item with minimum priority from the heap.  
    1.38      /// \pre The heap must be non-empty.  
    1.39      void pop() {
    1.40        while (first[minimal] == -1) {
     2.1 --- a/lemon/radix_heap.h	Wed Nov 02 16:43:18 2005 +0000
     2.2 +++ b/lemon/radix_heap.h	Fri Nov 04 10:51:35 2005 +0000
     2.3 @@ -371,7 +371,7 @@
     2.4      ///
     2.5      /// This method decreases the priority of item \c i to \c p.
     2.6      /// \pre \c i must be stored in the heap with priority at least \c p, and
     2.7 -    /// \c should be greater then the last removed item's priority.
     2.8 +    /// \c should be greater or equal to the last removed item's priority.
     2.9      /// \param i The item.
    2.10      /// \param p The priority.
    2.11      void decrease(const Item &i, const Prio &p) {
    2.12 @@ -383,8 +383,7 @@
    2.13      /// \brief Increases the priority of \c i to \c p.
    2.14      ///
    2.15      /// This method sets the priority of item \c i to \c p. 
    2.16 -    /// \pre \c i must be stored in the heap with priority at most \c
    2.17 -    /// p relative to \c Compare.
    2.18 +    /// \pre \c i must be stored in the heap with priority at most \c p
    2.19      /// \param i The item.
    2.20      /// \param p The priority.
    2.21      void increase(const Item &i, const Prio &p) {