lemon/kary_heap.h
author Peter Kovacs <kpeter@inf.elte.hu>
Fri, 10 Jul 2009 09:15:22 +0200
changeset 704 7124b2581f72
parent 703 bb3392fe91f2
child 706 9314d9339475
permissions -rw-r--r--
Make K a template parameter in KaryHeap (#301)
kpeter@703
     1
/* -*- mode: C++; indent-tabs-mode: nil; -*-
kpeter@701
     2
 *
kpeter@703
     3
 * This file is a part of LEMON, a generic C++ optimization library.
kpeter@701
     4
 *
kpeter@703
     5
 * Copyright (C) 2003-2009
kpeter@701
     6
 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
kpeter@701
     7
 * (Egervary Research Group on Combinatorial Optimization, EGRES).
kpeter@701
     8
 *
kpeter@701
     9
 * Permission to use, modify and distribute this software is granted
kpeter@701
    10
 * provided that this copyright notice appears in all copies. For
kpeter@701
    11
 * precise terms see the accompanying LICENSE file.
kpeter@701
    12
 *
kpeter@701
    13
 * This software is provided "AS IS" with no warranty of any kind,
kpeter@701
    14
 * express or implied, and with no claim as to its suitability for any
kpeter@701
    15
 * purpose.
kpeter@701
    16
 *
kpeter@701
    17
 */
kpeter@701
    18
kpeter@701
    19
#ifndef LEMON_KARY_HEAP_H
kpeter@701
    20
#define LEMON_KARY_HEAP_H
kpeter@701
    21
kpeter@703
    22
///\ingroup heaps
kpeter@701
    23
///\file
kpeter@703
    24
///\brief Fourary heap implementation.
kpeter@701
    25
kpeter@701
    26
#include <vector>
kpeter@701
    27
#include <utility>
kpeter@701
    28
#include <functional>
kpeter@701
    29
kpeter@701
    30
namespace lemon {
kpeter@701
    31
kpeter@703
    32
  /// \ingroup heaps
kpeter@701
    33
  ///
kpeter@703
    34
  ///\brief K-ary heap data structure.
kpeter@701
    35
  ///
kpeter@703
    36
  /// This class implements the \e K-ary \e heap data structure.
kpeter@703
    37
  /// It fully conforms to the \ref concepts::Heap "heap concept".
kpeter@701
    38
  ///
kpeter@703
    39
  /// The \ref KaryHeap "K-ary heap" is a generalization of the
kpeter@703
    40
  /// \ref BinHeap "binary heap" structure, its nodes have at most
kpeter@703
    41
  /// \c K children, instead of two.
kpeter@703
    42
  /// \ref BinHeap and \ref FouraryHeap are specialized implementations
kpeter@703
    43
  /// of this structure for <tt>K=2</tt> and <tt>K=4</tt>, respectively.
kpeter@701
    44
  ///
kpeter@703
    45
  /// \tparam PR Type of the priorities of the items.
kpeter@703
    46
  /// \tparam IM A read-writable item map with \c int values, used
kpeter@703
    47
  /// internally to handle the cross references.
kpeter@704
    48
  /// \tparam K The degree of the heap, each node have at most \e K
kpeter@704
    49
  /// children. The default is 16. Powers of two are suggested to use
kpeter@704
    50
  /// so that the multiplications and divisions needed to traverse the
kpeter@704
    51
  /// nodes of the heap could be performed faster.
kpeter@703
    52
  /// \tparam CMP A functor class for comparing the priorities.
kpeter@703
    53
  /// The default is \c std::less<PR>.
kpeter@703
    54
  ///
kpeter@703
    55
  ///\sa BinHeap
kpeter@703
    56
  ///\sa FouraryHeap
kpeter@703
    57
#ifdef DOXYGEN
kpeter@704
    58
  template <typename PR, typename IM, int K, typename CMP>
kpeter@703
    59
#else
kpeter@704
    60
  template <typename PR, typename IM, int K = 16,
kpeter@704
    61
            typename CMP = std::less<PR> >
kpeter@703
    62
#endif
kpeter@703
    63
  class KaryHeap {
kpeter@703
    64
  public:
kpeter@703
    65
    /// Type of the item-int map.
kpeter@703
    66
    typedef IM ItemIntMap;
kpeter@703
    67
    /// Type of the priorities.
kpeter@703
    68
    typedef PR Prio;
kpeter@703
    69
    /// Type of the items stored in the heap.
kpeter@703
    70
    typedef typename ItemIntMap::Key Item;
kpeter@703
    71
    /// Type of the item-priority pairs.
kpeter@703
    72
    typedef std::pair<Item,Prio> Pair;
kpeter@703
    73
    /// Functor type for comparing the priorities.
kpeter@703
    74
    typedef CMP Compare;
kpeter@701
    75
kpeter@703
    76
    /// \brief Type to represent the states of the items.
kpeter@701
    77
    ///
kpeter@703
    78
    /// Each item has a state associated to it. It can be "in heap",
kpeter@703
    79
    /// "pre-heap" or "post-heap". The latter two are indifferent from the
kpeter@701
    80
    /// heap's point of view, but may be useful to the user.
kpeter@701
    81
    ///
kpeter@703
    82
    /// The item-int map must be initialized in such way that it assigns
kpeter@703
    83
    /// \c PRE_HEAP (<tt>-1</tt>) to any element to be put in the heap.
kpeter@701
    84
    enum State {
kpeter@703
    85
      IN_HEAP = 0,    ///< = 0.
kpeter@703
    86
      PRE_HEAP = -1,  ///< = -1.
kpeter@703
    87
      POST_HEAP = -2  ///< = -2.
kpeter@701
    88
    };
kpeter@701
    89
kpeter@701
    90
  private:
kpeter@703
    91
    std::vector<Pair> _data;
kpeter@703
    92
    Compare _comp;
kpeter@703
    93
    ItemIntMap &_iim;
kpeter@701
    94
kpeter@701
    95
  public:
kpeter@703
    96
    /// \brief Constructor.
kpeter@701
    97
    ///
kpeter@703
    98
    /// Constructor.
kpeter@703
    99
    /// \param map A map that assigns \c int values to the items.
kpeter@703
   100
    /// It is used internally to handle the cross references.
kpeter@703
   101
    /// The assigned value must be \c PRE_HEAP (<tt>-1</tt>) for each item.
kpeter@704
   102
    explicit KaryHeap(ItemIntMap &map) : _iim(map) {}
kpeter@701
   103
kpeter@703
   104
    /// \brief Constructor.
kpeter@701
   105
    ///
kpeter@703
   106
    /// Constructor.
kpeter@703
   107
    /// \param map A map that assigns \c int values to the items.
kpeter@703
   108
    /// It is used internally to handle the cross references.
kpeter@703
   109
    /// The assigned value must be \c PRE_HEAP (<tt>-1</tt>) for each item.
kpeter@703
   110
    /// \param comp The function object used for comparing the priorities.
kpeter@704
   111
    KaryHeap(ItemIntMap &map, const Compare &comp)
kpeter@704
   112
      : _iim(map), _comp(comp) {}
kpeter@703
   113
kpeter@703
   114
    /// \brief The number of items stored in the heap.
kpeter@701
   115
    ///
kpeter@703
   116
    /// This function returns the number of items stored in the heap.
kpeter@703
   117
    int size() const { return _data.size(); }
kpeter@701
   118
kpeter@703
   119
    /// \brief Check if the heap is empty.
kpeter@703
   120
    ///
kpeter@703
   121
    /// This function returns \c true if the heap is empty.
kpeter@703
   122
    bool empty() const { return _data.empty(); }
kpeter@701
   123
kpeter@703
   124
    /// \brief Make the heap empty.
kpeter@701
   125
    ///
kpeter@703
   126
    /// This functon makes the heap empty.
kpeter@703
   127
    /// It does not change the cross reference map. If you want to reuse
kpeter@703
   128
    /// a heap that is not surely empty, you should first clear it and
kpeter@703
   129
    /// then you should set the cross reference map to \c PRE_HEAP
kpeter@703
   130
    /// for each item.
kpeter@703
   131
    void clear() { _data.clear(); }
kpeter@701
   132
kpeter@701
   133
  private:
kpeter@704
   134
    int parent(int i) { return (i-1)/K; }
kpeter@704
   135
    int firstChild(int i) { return K*i+1; }
kpeter@701
   136
kpeter@701
   137
    bool less(const Pair &p1, const Pair &p2) const {
kpeter@703
   138
      return _comp(p1.second, p2.second);
kpeter@701
   139
    }
kpeter@701
   140
kpeter@703
   141
    int findMin(const int child, const int length) {
kpeter@701
   142
      int min=child, i=1;
kpeter@704
   143
      while( i<K && child+i<length ) {
kpeter@703
   144
        if( less(_data[child+i], _data[min]) )
kpeter@701
   145
          min=child+i;
kpeter@701
   146
        ++i;
kpeter@701
   147
      }
kpeter@701
   148
      return min;
kpeter@701
   149
    }
kpeter@701
   150
kpeter@703
   151
    void bubbleUp(int hole, Pair p) {
kpeter@701
   152
      int par = parent(hole);
kpeter@703
   153
      while( hole>0 && less(p,_data[par]) ) {
kpeter@703
   154
        move(_data[par],hole);
kpeter@701
   155
        hole = par;
kpeter@701
   156
        par = parent(hole);
kpeter@701
   157
      }
kpeter@701
   158
      move(p, hole);
kpeter@701
   159
    }
kpeter@701
   160
kpeter@703
   161
    void bubbleDown(int hole, Pair p, int length) {
kpeter@701
   162
      if( length>1 ) {
kpeter@703
   163
        int child = firstChild(hole);
kpeter@701
   164
        while( child<length ) {
kpeter@703
   165
          child = findMin(child, length);
kpeter@703
   166
          if( !less(_data[child], p) )
kpeter@701
   167
            goto ok;
kpeter@703
   168
          move(_data[child], hole);
kpeter@701
   169
          hole = child;
kpeter@703
   170
          child = firstChild(hole);
kpeter@701
   171
        }
kpeter@701
   172
      }
kpeter@701
   173
    ok:
kpeter@701
   174
      move(p, hole);
kpeter@701
   175
    }
kpeter@701
   176
kpeter@701
   177
    void move(const Pair &p, int i) {
kpeter@703
   178
      _data[i] = p;
kpeter@703
   179
      _iim.set(p.first, i);
kpeter@701
   180
    }
kpeter@701
   181
kpeter@701
   182
  public:
kpeter@701
   183
    /// \brief Insert a pair of item and priority into the heap.
kpeter@701
   184
    ///
kpeter@703
   185
    /// This function inserts \c p.first to the heap with priority
kpeter@703
   186
    /// \c p.second.
kpeter@701
   187
    /// \param p The pair to insert.
kpeter@703
   188
    /// \pre \c p.first must not be stored in the heap.
kpeter@701
   189
    void push(const Pair &p) {
kpeter@703
   190
      int n = _data.size();
kpeter@703
   191
      _data.resize(n+1);
kpeter@703
   192
      bubbleUp(n, p);
kpeter@701
   193
    }
kpeter@701
   194
kpeter@703
   195
    /// \brief Insert an item into the heap with the given priority.
kpeter@701
   196
    ///
kpeter@703
   197
    /// This function inserts the given item into the heap with the
kpeter@703
   198
    /// given priority.
kpeter@701
   199
    /// \param i The item to insert.
kpeter@701
   200
    /// \param p The priority of the item.
kpeter@703
   201
    /// \pre \e i must not be stored in the heap.
kpeter@701
   202
    void push(const Item &i, const Prio &p) { push(Pair(i,p)); }
kpeter@701
   203
kpeter@703
   204
    /// \brief Return the item having minimum priority.
kpeter@701
   205
    ///
kpeter@703
   206
    /// This function returns the item having minimum priority.
kpeter@703
   207
    /// \pre The heap must be non-empty.
kpeter@703
   208
    Item top() const { return _data[0].first; }
kpeter@701
   209
kpeter@703
   210
    /// \brief The minimum priority.
kpeter@701
   211
    ///
kpeter@703
   212
    /// This function returns the minimum priority.
kpeter@703
   213
    /// \pre The heap must be non-empty.
kpeter@703
   214
    Prio prio() const { return _data[0].second; }
kpeter@701
   215
kpeter@703
   216
    /// \brief Remove the item having minimum priority.
kpeter@701
   217
    ///
kpeter@703
   218
    /// This function removes the item having minimum priority.
kpeter@701
   219
    /// \pre The heap must be non-empty.
kpeter@701
   220
    void pop() {
kpeter@703
   221
      int n = _data.size()-1;
kpeter@703
   222
      _iim.set(_data[0].first, POST_HEAP);
kpeter@703
   223
      if (n>0) bubbleDown(0, _data[n], n);
kpeter@703
   224
      _data.pop_back();
kpeter@701
   225
    }
kpeter@701
   226
kpeter@703
   227
    /// \brief Remove the given item from the heap.
kpeter@701
   228
    ///
kpeter@703
   229
    /// This function removes the given item from the heap if it is
kpeter@703
   230
    /// already stored.
kpeter@703
   231
    /// \param i The item to delete.
kpeter@703
   232
    /// \pre \e i must be in the heap.
kpeter@701
   233
    void erase(const Item &i) {
kpeter@703
   234
      int h = _iim[i];
kpeter@703
   235
      int n = _data.size()-1;
kpeter@703
   236
      _iim.set(_data[h].first, POST_HEAP);
kpeter@701
   237
      if( h<n ) {
kpeter@703
   238
        if( less(_data[parent(h)], _data[n]) )
kpeter@703
   239
          bubbleDown(h, _data[n], n);
kpeter@701
   240
        else
kpeter@703
   241
          bubbleUp(h, _data[n]);
kpeter@701
   242
      }
kpeter@703
   243
      _data.pop_back();
kpeter@701
   244
    }
kpeter@701
   245
kpeter@703
   246
    /// \brief The priority of the given item.
kpeter@701
   247
    ///
kpeter@703
   248
    /// This function returns the priority of the given item.
kpeter@701
   249
    /// \param i The item.
kpeter@703
   250
    /// \pre \e i must be in the heap.
kpeter@701
   251
    Prio operator[](const Item &i) const {
kpeter@703
   252
      int idx = _iim[i];
kpeter@703
   253
      return _data[idx].second;
kpeter@701
   254
    }
kpeter@701
   255
kpeter@703
   256
    /// \brief Set the priority of an item or insert it, if it is
kpeter@703
   257
    /// not stored in the heap.
kpeter@701
   258
    ///
kpeter@703
   259
    /// This method sets the priority of the given item if it is
kpeter@703
   260
    /// already stored in the heap. Otherwise it inserts the given
kpeter@703
   261
    /// item into the heap with the given priority.
kpeter@701
   262
    /// \param i The item.
kpeter@701
   263
    /// \param p The priority.
kpeter@701
   264
    void set(const Item &i, const Prio &p) {
kpeter@703
   265
      int idx = _iim[i];
kpeter@701
   266
      if( idx<0 )
kpeter@701
   267
        push(i,p);
kpeter@703
   268
      else if( _comp(p, _data[idx].second) )
kpeter@703
   269
        bubbleUp(idx, Pair(i,p));
kpeter@701
   270
      else
kpeter@703
   271
        bubbleDown(idx, Pair(i,p), _data.size());
kpeter@701
   272
    }
kpeter@701
   273
kpeter@703
   274
    /// \brief Decrease the priority of an item to the given value.
kpeter@701
   275
    ///
kpeter@703
   276
    /// This function decreases the priority of an item to the given value.
kpeter@701
   277
    /// \param i The item.
kpeter@701
   278
    /// \param p The priority.
kpeter@703
   279
    /// \pre \e i must be stored in the heap with priority at least \e p.
kpeter@701
   280
    void decrease(const Item &i, const Prio &p) {
kpeter@703
   281
      int idx = _iim[i];
kpeter@703
   282
      bubbleUp(idx, Pair(i,p));
kpeter@701
   283
    }
kpeter@701
   284
kpeter@703
   285
    /// \brief Increase the priority of an item to the given value.
kpeter@701
   286
    ///
kpeter@703
   287
    /// This function increases the priority of an item to the given value.
kpeter@701
   288
    /// \param i The item.
kpeter@701
   289
    /// \param p The priority.
kpeter@703
   290
    /// \pre \e i must be stored in the heap with priority at most \e p.
kpeter@701
   291
    void increase(const Item &i, const Prio &p) {
kpeter@703
   292
      int idx = _iim[i];
kpeter@703
   293
      bubbleDown(idx, Pair(i,p), _data.size());
kpeter@701
   294
    }
kpeter@701
   295
kpeter@703
   296
    /// \brief Return the state of an item.
kpeter@701
   297
    ///
kpeter@703
   298
    /// This method returns \c PRE_HEAP if the given item has never
kpeter@703
   299
    /// been in the heap, \c IN_HEAP if it is in the heap at the moment,
kpeter@703
   300
    /// and \c POST_HEAP otherwise.
kpeter@703
   301
    /// In the latter case it is possible that the item will get back
kpeter@703
   302
    /// to the heap again.
kpeter@701
   303
    /// \param i The item.
kpeter@701
   304
    State state(const Item &i) const {
kpeter@703
   305
      int s = _iim[i];
kpeter@701
   306
      if (s>=0) s=0;
kpeter@701
   307
      return State(s);
kpeter@701
   308
    }
kpeter@701
   309
kpeter@703
   310
    /// \brief Set the state of an item in the heap.
kpeter@701
   311
    ///
kpeter@703
   312
    /// This function sets the state of the given item in the heap.
kpeter@703
   313
    /// It can be used to manually clear the heap when it is important
kpeter@703
   314
    /// to achive better time complexity.
kpeter@701
   315
    /// \param i The item.
kpeter@701
   316
    /// \param st The state. It should not be \c IN_HEAP.
kpeter@701
   317
    void state(const Item& i, State st) {
kpeter@701
   318
      switch (st) {
kpeter@703
   319
        case POST_HEAP:
kpeter@703
   320
        case PRE_HEAP:
kpeter@703
   321
          if (state(i) == IN_HEAP) erase(i);
kpeter@703
   322
          _iim[i] = st;
kpeter@703
   323
          break;
kpeter@703
   324
        case IN_HEAP:
kpeter@703
   325
          break;
kpeter@701
   326
      }
kpeter@701
   327
    }
kpeter@701
   328
kpeter@703
   329
    /// \brief Replace an item in the heap.
kpeter@701
   330
    ///
kpeter@703
   331
    /// This function replaces item \c i with item \c j.
kpeter@703
   332
    /// Item \c i must be in the heap, while \c j must be out of the heap.
kpeter@703
   333
    /// After calling this method, item \c i will be out of the
kpeter@703
   334
    /// heap and \c j will be in the heap with the same prioriority
kpeter@703
   335
    /// as item \c i had before.
kpeter@701
   336
    void replace(const Item& i, const Item& j) {
kpeter@703
   337
      int idx=_iim[i];
kpeter@703
   338
      _iim.set(i, _iim[j]);
kpeter@703
   339
      _iim.set(j, idx);
kpeter@703
   340
      _data[idx].first=j;
kpeter@701
   341
    }
kpeter@701
   342
kpeter@701
   343
  }; // class KaryHeap
kpeter@701
   344
kpeter@701
   345
} // namespace lemon
kpeter@701
   346
kpeter@701
   347
#endif // LEMON_KARY_HEAP_H