Changeset 967:6563019430ba in lemon-0.x for src/lemon/bin_heap.h

Timestamp:

11/08/04 16:22:39 (19 years ago)

Author:

Alpar Juttner

Branch:

default

Phase:

public

Convert:

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

Message:

Several changes in doc.

File:

• src/lemon/bin_heap.h (modified) (8 diffs)

src/lemon/bin_heap.h

@@ -33 +33 @@
 
    /// A Binary Heap implementation.
+  
+  ///\todo Please document...
+  ///
+  ///\sa FibHeap
+  ///\sa Dijkstra
   template <typename Item, typename Prio, typename ItemIntMap,
             typename Compare = std::less<Prio> >
@@ -68 +73 @@
 
   public:
+    ///\e
     BinHeap(ItemIntMap &_iim) : iim(_iim) {}
+    ///\e
     BinHeap(ItemIntMap &_iim, const Compare &_comp) : comp(_comp), iim(_iim) {}
 
 
+    ///\e
     int size() const { return data.size(); }
+    ///\e
     bool empty() const { return data.empty(); }
 
@@ -102 +111 @@
 
   public:
+    ///\e
     void push(const PairType &p) {
       int n = data.size();
@@ -107 +117 @@
       bubble_up(n, p);
     }
+    ///\e
     void push(const Item &i, const Prio &p) { push(PairType(i,p)); }
 
+    ///\e
     Item top() const {
       return data[0].first;
@@ -117 +129 @@
     }
 
+    ///\e
     void pop() {
       rmidx(0);
     }
 
+    ///\e
     void erase(const Item &i) {
       rmidx(iim[i]);
     }
 
+    ///\e
     Prio operator[](const Item &i) const {
       int idx = iim[i];
@@ -130 +145 @@
     }
 
+    ///\e
     void set(const Item &i, const Prio &p) {
       int idx = iim[i];
@@ -143 +159 @@
     }
 
+    ///\e
     void decrease(const Item &i, const Prio &p) {
       int idx = iim[i];
       bubble_up(idx, PairType(i,p));
     }
+    ///\e
     void increase(const Item &i, const Prio &p) {
       int idx = iim[i];
@@ -152 +170 @@
     }
 
+    ///\e
     state_enum state(const Item &i) const {
       int s = iim[i];