RadixHeap

Declared in lemon/radix_heap.h, in the group Heap Structures; the same class on the Doxygen site.

template< typename IM >
class RadixHeap

Radix heap data structure.

This class implements the radix heap data structure. It practically conforms to the heap concept, but it has some limitations due its special implementation. The type of the priorities must be int and no priority can go below the lower end of the first box, which is the minimum given to the constructor or to clear() and which pop(), top() and prio() move up to the minimum priority in the heap.

Template Parameters:

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.

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.

enumerator PRE_HEAP

= -1.

enumerator POST_HEAP

= -2.

typedef IM ItemIntMap

Type of the item-int map.

typedef int Prio

Type of the priorities.

typedef ItemIntMap::Key Item

Type of the items stored in the heap.

Public Functions

inline RadixHeap( ItemIntMap & map , int minimum = 0 , int capacity = 0 )

Constructor.

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

  • minimum – The initial minimum value of the heap.

  • capacity – The initial capacity of the heap.

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( int minimum = 0 , int capacity = 0 )

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.

Parameters:
  • minimum – The minimum value of the heap.

  • capacity – The capacity of the heap.

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.

Warning

This method throws a PriorityUnderflowError if p is below the first box of the heap, whose lower end pop(), top() and prio() move up to the minimum, and leaves the heap unchanged.

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.

Warning

This method throws a PriorityUnderflowError if p is below the first box of the heap, whose lower end pop(), top() and prio() move up to the minimum, and leaves the heap unchanged.

Parameters:
  • i – The item.

  • p – The priority.

Pre:

i must be in the heap.

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.

Warning

This method throws a PriorityUnderflowError if p is below the first box of the heap, whose lower end pop(), top() and prio() move up to the minimum, and leaves the heap unchanged.

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.

class PriorityUnderflowError : public Exception

Exception thrown by RadixHeap.

This exception is thrown when an item is given a priority below the lower end of the first box of a RadixHeap, which is then left unchanged.

See also

RadixHeap

Public Functions

inline virtual const char * what() const noexcept