Opened 8 years ago

Closed 8 years ago

#10663 closed Bugs (fixed)

Cut-and-paste error in fibonacci heap ordered_end documentation

Reported by: mbradle@… Owned by: timblechmann
Milestone: To Be Determined Component: heap
Version: Boost 1.56.0 Severity: Cosmetic
Keywords: Cc:

Description

The fibonacci_heap documentation has an error for the ordered_iterator ordered_end(void) const; function. It seems to be a cut-and-paste error. The fix:

diff --git a/include/boost/heap/fibonacci_heap.hpp b/include/boost/heap/fibonacci_heap.hpp
index 493828f..89b05d8 100644
--- a/include/boost/heap/fibonacci_heap.hpp
+++ b/include/boost/heap/fibonacci_heap.hpp
@@ -573,7 +573,7 @@ public:
     }
 
     /**
-     * \b Effects: Returns an ordered iterator to the first element contained in the priority queue.
+     * \b Effects: Returns an ordered iterator to the end of the priority queue.
      *
      * \b Note: Ordered iterators traverse the priority queue in heap order.
      * */

Best wishes.

Brad Meyer

Change History (2)

comment:1 by timblechmann, 8 years ago

thnx, fixed in git (btw, a pull request on github is the best way to provide fixes like this)

comment:2 by timblechmann, 8 years ago

Resolution: fixed
Status: newclosed
Note: See TracTickets for help on using tickets.