concepts::Heap

Declared in lemon/concepts/heap.h, in the group Concepts; the same class on the Doxygen site.

template< typename PR , typename IM , typename CMP >
class Heap

The heap concept.

This concept class describes the main interface of heaps. The various heap structures are efficient implementations of the abstract data type priority queue. They store items with specified values called priorities in such a way that finding and removing the item with minimum priority are efficient. The basic operations are adding and erasing items, changing the priority of an item, etc.

Heaps are crucial in several algorithms, such as Dijkstra and Prim. Any class that conforms to this concept can be used easily in such algorithms.

Template Parameters:
  • PR – Type of the priorities of the items.

  • IM – A reference item map with int values (one whose operator[] gives a reference, which the heap writes through), used internally to handle the cross references.

  • CMP – A functor class for comparing the priorities. The default is std::less< PR >.

Public Types

enum State

Type to represent the states of the items.

Each item has a state associated to it. It can 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 item-int map must be initialized in such way that it assigns PRE_HEAP (-1) to any element to be put in the heap.

Values:

enumerator IN_HEAP

= 0. The “in heap” state constant.

enumerator PRE_HEAP

= -1. The “pre-heap” state constant.

enumerator POST_HEAP

= -2. The “post-heap” state constant.

typedef IM ItemIntMap

Type of the item-int map.

typedef PR Prio

Type of the priorities.

typedef ItemIntMap::Key Item

Type of the items stored in the heap.

Public Functions

inline explicit Heap( ItemIntMap & map )

Constructor.

Parameters:

map – A map that assigns int values to keys of type Item. It is used internally by the heap implementations to handle the cross references. The assigned value must be PRE_HEAP (-1) for each item.

inline explicit Heap( ItemIntMap & map , const CMP & comp )

Constructor.

Parameters:
  • map – A map that assigns int values to keys of type Item. It is used internally by the heap implementations to handle the cross references. The assigned value must be PRE_HEAP (-1) for each item.

  • comp – The function object used for comparing the priorities.

inline int size() const

The number of items stored in the heap.

This function returns the number of items stored in the heap.

inline bool empty() const

Check if the heap is empty.

This function returns true if the heap is empty.

inline void clear()

Make the heap empty.

This functon makes the heap empty. It does not change the cross reference map. If you want to reuse a heap that is not surely empty, you should first clear it and then you should set the cross reference map to PRE_HEAP for each item.

inline void push( const Item & i , const Prio & p )

Insert an item into the heap with the given priority.

This function inserts the given item into the heap with the given priority.

Parameters:
  • i – The item to insert.

  • p – The priority of the item.

Pre:

i must not be stored in the heap.

inline Item top() const

Return the item having minimum priority.

This function returns the item having minimum priority.

Pre:

The heap must be non-empty.

inline Prio prio() const

The minimum priority.

This function returns the minimum priority.

Pre:

The heap must be non-empty.

inline void pop()

Remove the item having minimum priority.

This function removes the item having minimum priority.

Pre:

The heap must be non-empty.

inline void erase( const Item & i )

Remove the given item from the heap.

This function removes the given item from the heap if it is already stored.

Parameters:

i – The item to delete.

Pre:

i must be in the heap.

inline Prio operator[]( const Item & i ) const

The priority of the given item.

This function returns the priority of the given item.

Parameters:

i – The item.

Pre:

i must be in the heap.

inline void set( const Item & i , const Prio & p )

Set the priority of an item or insert it, if it is not stored in the heap.

This method sets the priority of the given item if it is already stored in the heap. Otherwise it inserts the given item into the heap with the given priority.

Parameters:
  • i – The item.

  • p – The priority.

inline void decrease( const Item & i , const Prio & p )

Decrease the priority of an item to the given value.

This function decreases the priority of an item to the given value.

Parameters:
  • i – The item.

  • p – The priority.

Pre:

i must be stored in the heap with priority at least p.

inline void increase( const Item & i , const Prio & p )

Increase the priority of an item to the given value.

This function increases the priority of an item to the given value.

Parameters:
  • i – The item.

  • p – The priority.

Pre:

i must be stored in the heap with priority at most p.

inline State state( const Item & i ) const

Return the state of an item.

This method returns PRE_HEAP if the given item has never been in the heap, IN_HEAP if it is in the heap at the moment, and POST_HEAP otherwise. In the latter case it is possible that the item will get back to the heap again.

Parameters:

i – The item.

inline void state( const Item & i , State st )

Set the state of an item in the heap.

This function sets the state of the given item in the heap. It can be used to manually clear the heap when it is important to achive better time complexity.

Parameters:
  • i – The item.

  • st – The state. It should not be IN_HEAP.

template< typename _Heap >
struct Constraints

Public Functions

inline void constraints()
inline Constraints()

Public Members

_Heap & heap
ItemIntMap & map