lemon-1.2: comparison lemon/bucket

equal deleted inserted replaced

-:f2fc6f0cb451
+:95e5c8b4f0ea
 namespace lemon {
 namespace _bucket_heap_bits {
-template <bool minimize>
+template <bool MIN>
 struct DirectionTraits {
 static bool less(int left, int right) {
 return left < right;
 }
 static void increase(int& value) {
 /// efficient. The bucket heap is very simple implementation, it can store
 /// only integer priorities and it stores for each priority in the
 /// \f$ [0..C) \f$ range a list of items. So it should be used only when
 /// the priorities are small. It is not intended to use as dijkstra heap.
 ///
-/// \param _ItemIntMap A read and writable Item int map, used internally
+/// \param IM A read and write Item int map, used internally
 /// to handle the cross references.
-/// \param minimize If the given parameter is true then the heap gives back
+/// \param MIN If the given parameter is false then instead of the
-/// the lowest priority.
+/// minimum value the maximum can be retrivied with the top() and
-template <typename _ItemIntMap, bool minimize = true>
+/// prio() member functions.
+template <typename IM, bool MIN = true>
 class BucketHeap {
 public:
 /// \e
-typedef typename _ItemIntMap::Key Item;
+typedef typename IM::Key Item;
 /// \e
 typedef int Prio;
 /// \e
 typedef std::pair<Item, Prio> Pair;
 /// \e
-typedef _ItemIntMap ItemIntMap;
+typedef IM ItemIntMap;
 private:
-typedef _bucket_heap_bits::DirectionTraits<minimize> Direction;
+typedef _bucket_heap_bits::DirectionTraits<MIN> Direction;
 public:
 /// \brief Type to represent the items states.
 ///
 /// Each Item element have a state associated to it. It may be "in heap",
 /// "pre heap" or "post heap". The latter two are indifferent from the
 /// heap's point of view, but may be useful to the user.
 ///
-/// The ItemIntMap \e should be initialized in such way that it maps
+/// The item-int map must be initialized in such way that it assigns
-/// PRE_HEAP (-1) to any element to be put in the heap...
+/// \c PRE_HEAP (<tt>-1</tt>) to any element to be put in the heap.
 enum State {
-IN_HEAP = 0,
+IN_HEAP = 0,    ///< = 0.
-PRE_HEAP = -1,
+PRE_HEAP = -1,  ///< = -1.
-POST_HEAP = -2
+POST_HEAP = -2  ///< = -2.
 };
 public:
 /// \brief The constructor.
 ///
 /// The constructor.
-/// \param _index should be given to the constructor, since it is used
+/// \param map should be given to the constructor, since it is used
 /// internally to handle the cross references. The value of the map
 /// should be PRE_HEAP (-1) for each element.
-explicit BucketHeap(ItemIntMap &_index) : index(_index), minimal(0) {}
+explicit BucketHeap(ItemIntMap &map) : _iim(map), _minimum(0) {}
 /// The number of items stored in the heap.
 ///
 /// \brief Returns the number of items stored in the heap.
-int size() const { return data.size(); }
+int size() const { return _data.size(); }
 /// \brief Checks if the heap stores no items.
 ///
 /// Returns \c true if and only if the heap stores no items.
-bool empty() const { return data.empty(); }
+bool empty() const { return _data.empty(); }
 /// \brief Make empty this heap.
 ///
 /// Make empty this heap. It does not change the cross reference
 /// map.  If you want to reuse a heap what is not surely empty you
 /// should first clear the heap and after that you should set the
 /// cross reference map for each item to \c PRE_HEAP.
 void clear() {
-data.clear(); first.clear(); minimal = 0;
+_data.clear(); _first.clear(); _minimum = 0;
 }
 private:
 void relocate_last(int idx) {
-if (idx + 1 < int(data.size())) {
+if (idx + 1 < int(_data.size())) {
-data[idx] = data.back();
+_data[idx] = _data.back();
-if (data[idx].prev != -1) {
+if (_data[idx].prev != -1) {
-data[data[idx].prev].next = idx;
+_data[_data[idx].prev].next = idx;
 } else {
-first[data[idx].value] = idx;
+_first[_data[idx].value] = idx;
 }
-if (data[idx].next != -1) {
+if (_data[idx].next != -1) {
-data[data[idx].next].prev = idx;
+_data[_data[idx].next].prev = idx;
 }
-index[data[idx].item] = idx;
+_iim[_data[idx].item] = idx;
 }
-data.pop_back();
+_data.pop_back();
 }
 void unlace(int idx) {
-if (data[idx].prev != -1) {
+if (_data[idx].prev != -1) {
-data[data[idx].prev].next = data[idx].next;
+_data[_data[idx].prev].next = _data[idx].next;
 } else {
-first[data[idx].value] = data[idx].next;
+_first[_data[idx].value] = _data[idx].next;
 }
-if (data[idx].next != -1) {
+if (_data[idx].next != -1) {
-data[data[idx].next].prev = data[idx].prev;
+_data[_data[idx].next].prev = _data[idx].prev;
 }
 }
 void lace(int idx) {
-if (int(first.size()) <= data[idx].value) {
+if (int(_first.size()) <= _data[idx].value) {
-first.resize(data[idx].value + 1, -1);
+_first.resize(_data[idx].value + 1, -1);
 }
-data[idx].next = first[data[idx].value];
+_data[idx].next = _first[_data[idx].value];
-if (data[idx].next != -1) {
+if (_data[idx].next != -1) {
-data[data[idx].next].prev = idx;
+_data[_data[idx].next].prev = idx;
 }
-first[data[idx].value] = idx;
+_first[_data[idx].value] = idx;
-data[idx].prev = -1;
+_data[idx].prev = -1;
 }
 public:
 /// \brief Insert a pair of item and priority into the heap.
 ///
 ///
 /// Adds \c i to the heap with priority \c p.
 /// \param i The item to insert.
 /// \param p The priority of the item.
 void push(const Item &i, const Prio &p) {
-int idx = data.size();
+int idx = _data.size();
-index[i] = idx;
+_iim[i] = idx;
-data.push_back(BucketItem(i, p));
+_data.push_back(BucketItem(i, p));
 lace(idx);
-if (Direction::less(p, minimal)) {
+if (Direction::less(p, _minimum)) {
-minimal = p;
+_minimum = p;
 }
 }
 /// \brief Returns the item with minimum priority.
 ///
 /// This method returns the item with minimum priority.
 /// \pre The heap must be nonempty.
 Item top() const {
-while (first[minimal] == -1) {
+while (_first[_minimum] == -1) {
-Direction::increase(minimal);
+Direction::increase(_minimum);
 }
-return data[first[minimal]].item;
+return _data[_first[_minimum]].item;
 }
 /// \brief Returns the minimum priority.
 ///
 /// It returns the minimum priority.
 /// \pre The heap must be nonempty.
 Prio prio() const {
-while (first[minimal] == -1) {
+while (_first[_minimum] == -1) {
-Direction::increase(minimal);
+Direction::increase(_minimum);
 }
-return minimal;
+return _minimum;
 }
 /// \brief Deletes the item with minimum priority.
 ///
 /// This method deletes the item with minimum priority from the heap.
 /// \pre The heap must be non-empty.
 void pop() {
-while (first[minimal] == -1) {
+while (_first[_minimum] == -1) {
-Direction::increase(minimal);
+Direction::increase(_minimum);
 }
-int idx = first[minimal];
+int idx = _first[_minimum];
-index[data[idx].item] = -2;
+_iim[_data[idx].item] = -2;
 unlace(idx);
 relocate_last(idx);
 }
 /// \brief Deletes \c i from the heap.
 ///
 /// This method deletes item \c i from the heap, if \c i was
 /// already stored in the heap.
 /// \param i The item to erase.
 void erase(const Item &i) {
-int idx = index[i];
+int idx = _iim[i];
-index[data[idx].item] = -2;
+_iim[_data[idx].item] = -2;
 unlace(idx);
 relocate_last(idx);
 }
 ///
 /// This function returns the priority of item \c i.
 /// \pre \c i must be in the heap.
 /// \param i The item.
 Prio operator[](const Item &i) const {
-int idx = index[i];
+int idx = _iim[i];
-return data[idx].value;
+return _data[idx].value;
 }
 /// \brief \c i gets to the heap with priority \c p independently
 /// if \c i was already there.
 ///
 /// This method calls \ref push(\c i, \c p) if \c i is not stored
 /// in the heap and sets the priority of \c i to \c p otherwise.
 /// \param i The item.
 /// \param p The priority.
 void set(const Item &i, const Prio &p) {
-int idx = index[i];
+int idx = _iim[i];
 if (idx < 0) {
 push(i, p);
-} else if (Direction::less(p, data[idx].value)) {
+} else if (Direction::less(p, _data[idx].value)) {
 decrease(i, p);
 } else {
 increase(i, p);
 }
 }
 /// \pre \c i must be stored in the heap with priority at least \c
 /// p relative to \c Compare.
 /// \param i The item.
 /// \param p The priority.
 void decrease(const Item &i, const Prio &p) {
-int idx = index[i];
+int idx = _iim[i];
 unlace(idx);
-data[idx].value = p;
+_data[idx].value = p;
-if (Direction::less(p, minimal)) {
+if (Direction::less(p, _minimum)) {
-minimal = p;
+_minimum = p;
 }
 lace(idx);
 }
 /// \brief Increases the priority of \c i to \c p.
 /// \pre \c i must be stored in the heap with priority at most \c
 /// p relative to \c Compare.
 /// \param i The item.
 /// \param p The priority.
 void increase(const Item &i, const Prio &p) {
-int idx = index[i];
+int idx = _iim[i];
 unlace(idx);
-data[idx].value = p;
+_data[idx].value = p;
 lace(idx);
 }
 /// \brief Returns if \c item is in, has already been in, or has
 /// never been in the heap.
 /// heap, IN_HEAP if it is in the heap at the moment, and POST_HEAP
 /// otherwise. In the latter case it is possible that \c item will
 /// get back to the heap again.
 /// \param i The item.
 State state(const Item &i) const {
-int idx = index[i];
+int idx = _iim[i];
 if (idx >= 0) idx = 0;
 return State(idx);
 }
 /// \brief Sets the state of the \c item in the heap.
 case POST_HEAP:
 case PRE_HEAP:
 if (state(i) == IN_HEAP) {
 erase(i);
 }
-index[i] = st;
+_iim[i] = st;
 break;
 case IN_HEAP:
 break;
 }
 }
 int value;
 int prev, next;
 };
-ItemIntMap& index;
+ItemIntMap& _iim;
-std::vector<int> first;
+std::vector<int> _first;
-std::vector<BucketItem> data;
+std::vector<BucketItem> _data;
-mutable int minimal;
+mutable int _minimum;
 }; // class BucketHeap
 /// \ingroup auxdat
 ///
 /// difference is that the BucketHeap stores for every key a double
 /// linked list while this class stores just simple lists. In the
 /// other way it does not support erasing each elements just the
 /// minimal and it does not supports key increasing, decreasing.
 ///
-/// \param _ItemIntMap A read and writable Item int map, used internally
+/// \param IM A read and write Item int map, used internally
 /// to handle the cross references.
-/// \param minimize If the given parameter is true then the heap gives back
+/// \param MIN If the given parameter is false then instead of the
-/// the lowest priority.
+/// minimum value the maximum can be retrivied with the top() and
+/// prio() member functions.
 ///
 /// \sa BucketHeap
-template <typename _ItemIntMap, bool minimize = true >
+template <typename IM, bool MIN = true >
 class SimpleBucketHeap {
 public:
-typedef typename _ItemIntMap::Key Item;
+typedef typename IM::Key Item;
 typedef int Prio;
 typedef std::pair<Item, Prio> Pair;
-typedef _ItemIntMap ItemIntMap;
+typedef IM ItemIntMap;
 private:
-typedef _bucket_heap_bits::DirectionTraits<minimize> Direction;
+typedef _bucket_heap_bits::DirectionTraits<MIN> Direction;
 public:
 /// \brief Type to represent the items states.
 ///
 /// Each Item element have a state associated to it. It may be "in heap",
 /// "pre heap" or "post heap". The latter two are indifferent from the
 /// heap's point of view, but may be useful to the user.
 ///
-/// The ItemIntMap \e should be initialized in such way that it maps
+/// The item-int map must be initialized in such way that it assigns
-/// PRE_HEAP (-1) to any element to be put in the heap...
+/// \c PRE_HEAP (<tt>-1</tt>) to any element to be put in the heap.
 enum State {
-IN_HEAP = 0,
+IN_HEAP = 0,    ///< = 0.
-PRE_HEAP = -1,
+PRE_HEAP = -1,  ///< = -1.
-POST_HEAP = -2
+POST_HEAP = -2  ///< = -2.
 };
 public:
 /// \brief The constructor.
 ///
 /// The constructor.
-/// \param _index should be given to the constructor, since it is used
+/// \param map should be given to the constructor, since it is used
 /// internally to handle the cross references. The value of the map
 /// should be PRE_HEAP (-1) for each element.
-explicit SimpleBucketHeap(ItemIntMap &_index)
+explicit SimpleBucketHeap(ItemIntMap &map)
-: index(_index), free(-1), num(0), minimal(0) {}
+: _iim(map), _free(-1), _num(0), _minimum(0) {}
 /// \brief Returns the number of items stored in the heap.
 ///
 /// The number of items stored in the heap.
-int size() const { return num; }
+int size() const { return _num; }
 /// \brief Checks if the heap stores no items.
 ///
 /// Returns \c true if and only if the heap stores no items.
-bool empty() const { return num == 0; }
+bool empty() const { return _num == 0; }
 /// \brief Make empty this heap.
 ///
 /// Make empty this heap. It does not change the cross reference
 /// map.  If you want to reuse a heap what is not surely empty you
 /// should first clear the heap and after that you should set the
 /// cross reference map for each item to \c PRE_HEAP.
 void clear() {
-data.clear(); first.clear(); free = -1; num = 0; minimal = 0;
+_data.clear(); _first.clear(); _free = -1; _num = 0; _minimum = 0;
 }
 /// \brief Insert a pair of item and priority into the heap.
 ///
 /// Adds \c p.first to the heap with priority \c p.second.
 /// Adds \c i to the heap with priority \c p.
 /// \param i The item to insert.
 /// \param p The priority of the item.
 void push(const Item &i, const Prio &p) {
 int idx;
-if (free == -1) {
+if (_free == -1) {
-idx = data.size();
+idx = _data.size();
-data.push_back(BucketItem(i));
+_data.push_back(BucketItem(i));
 } else {
-idx = free;
+idx = _free;
-free = data[idx].next;
+_free = _data[idx].next;
-data[idx].item = i;
+_data[idx].item = i;
 }
-index[i] = idx;
+_iim[i] = idx;
-if (p >= int(first.size())) first.resize(p + 1, -1);
+if (p >= int(_first.size())) _first.resize(p + 1, -1);
-data[idx].next = first[p];
+_data[idx].next = _first[p];
-first[p] = idx;
+_first[p] = idx;
-if (Direction::less(p, minimal)) {
+if (Direction::less(p, _minimum)) {
-minimal = p;
+_minimum = p;
 }
-++num;
+++_num;
 }
 /// \brief Returns the item with minimum priority.
 ///
 /// This method returns the item with minimum priority.
 /// \pre The heap must be nonempty.
 Item top() const {
-while (first[minimal] == -1) {
+while (_first[_minimum] == -1) {
-Direction::increase(minimal);
+Direction::increase(_minimum);
 }
-return data[first[minimal]].item;
+return _data[_first[_minimum]].item;
 }
 /// \brief Returns the minimum priority.
 ///
 /// It returns the minimum priority.
 /// \pre The heap must be nonempty.
 Prio prio() const {
-while (first[minimal] == -1) {
+while (_first[_minimum] == -1) {
-Direction::increase(minimal);
+Direction::increase(_minimum);
 }
-return minimal;
+return _minimum;
 }
 /// \brief Deletes the item with minimum priority.
 ///
 /// This method deletes the item with minimum priority from the heap.
 /// \pre The heap must be non-empty.
 void pop() {
-while (first[minimal] == -1) {
+while (_first[_minimum] == -1) {
-Direction::increase(minimal);
+Direction::increase(_minimum);
 }
-int idx = first[minimal];
+int idx = _first[_minimum];
-index[data[idx].item] = -2;
+_iim[_data[idx].item] = -2;
-first[minimal] = data[idx].next;
+_first[_minimum] = _data[idx].next;
-data[idx].next = free;
+_data[idx].next = _free;
-free = idx;
+_free = idx;
---num;
+--_num;
 }
 /// \brief Returns the priority of \c i.
 ///
 /// This function returns the priority of item \c i.
 /// because it scans the whole data structure to find the proper
 /// value.
 /// \pre \c i must be in the heap.
 /// \param i The item.
 Prio operator[](const Item &i) const {
-for (int k = 0; k < first.size(); ++k) {
+for (int k = 0; k < _first.size(); ++k) {
-int idx = first[k];
+int idx = _first[k];
 while (idx != -1) {
-if (data[idx].item == i) {
+if (_data[idx].item == i) {
 return k;
 }
-idx = data[idx].next;
+idx = _data[idx].next;
 }
 }
 return -1;
 }
 /// heap, IN_HEAP if it is in the heap at the moment, and POST_HEAP
 /// otherwise. In the latter case it is possible that \c item will
 /// get back to the heap again.
 /// \param i The item.
 State state(const Item &i) const {
-int idx = index[i];
+int idx = _iim[i];
 if (idx >= 0) idx = 0;
 return State(idx);
 }
 private:
 Item item;
 int next;
 };
-ItemIntMap& index;
+ItemIntMap& _iim;
-std::vector<int> first;
+std::vector<int> _first;
-std::vector<BucketItem> data;
+std::vector<BucketItem> _data;
-int free, num;
+int _free, _num;
-mutable int minimal;
+mutable int _minimum;
 }; // class SimpleBucketHeap
 }

changeset 723	acdd0bd75a55
parent 682	bb8c4cd57900
child 709	0747f332c478