Detailed Description

template<typename PR, typename IM, typename CMP>
class lemon::BinHeap< PR, IM, CMP >

This class implements the binary heap data structure. It fully conforms to the heap concept.

Template Parameters

PR	Type of the priorities of the items.
IM	A read-writable item map with `int` values, used internally to handle the cross references.
CMP	A functor class for comparing the priorities. The default is `std::less<PR>`.

#include <lemon/bin_heap.h>

Public Types
enum	State { IN_HEAP = 0 , PRE_HEAP = -1 , POST_HEAP = -2 }
	Type to represent the states of the items. More...

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.

typedef std::pair< Item, Prio >	Pair
	Type of the item-priority pairs.

typedef CMP	Compare
	Functor type for comparing the priorities.

Public Member Functions
	BinHeap (ItemIntMap &map)
	Constructor.

	BinHeap (ItemIntMap &map, const Compare &comp)
	Constructor.

int	size () const
	The number of items stored in the heap.

bool	empty () const
	Check if the heap is empty.

void	clear ()
	Make the heap empty.

void	push (const Pair &p)
	Insert a pair of item and priority into the heap.

void	push (const Item &i, const Prio &p)
	Insert an item into the heap with the given priority.

Item	top () const
	Return the item having minimum priority.

Prio	prio () const
	The minimum priority.

void	pop ()
	Remove the item having minimum priority.

void	erase (const Item &i)
	Remove the given item from the heap.

Prio	operator[] (const Item &i) const
	The priority of the given item.

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.

void	decrease (const Item &i, const Prio &p)
	Decrease the priority of an item to the given value.

void	increase (const Item &i, const Prio &p)
	Increase the priority of an item to the given value.

State	state (const Item &i) const
	Return the state of an item.

void	state (const Item &i, State st)
	Set the state of an item in the heap.

void	replace (const Item &i, const Item &j)
	Replace an item in the heap.

Member Enumeration Documentation

◆ State

template<typename PR , typename IM , typename CMP >

enum State

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.

Enumerator
IN_HEAP	= 0.
PRE_HEAP	= -1.
POST_HEAP	= -2.

Constructor & Destructor Documentation

◆ BinHeap() [1/2]

template<typename PR , typename IM , typename CMP >

BinHeap ( ItemIntMap & map )

inlineexplicit

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.

◆ BinHeap() [2/2]

template<typename PR , typename IM , typename CMP >

BinHeap	(	ItemIntMap &	map,
		const Compare &	comp
	)

inline

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.
comp	The function object used for comparing the priorities.

Member Function Documentation

◆ size()

template<typename PR , typename IM , typename CMP >

int size ( ) const

inline

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

◆ empty()

template<typename PR , typename IM , typename CMP >

bool empty ( ) const

inline

This function returns true if the heap is empty.

◆ clear()

template<typename PR , typename IM , typename CMP >

void clear ( )

inline

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.

◆ push() [1/2]

template<typename PR , typename IM , typename CMP >

void push ( const Pair & p )

inline

This function inserts p.first to the heap with priority p.second.

Parameters

p	The pair to insert.

Precondition: p.first must not be stored in the heap.

◆ push() [2/2]

template<typename PR , typename IM , typename CMP >

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

inline

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.

Precondition: i must not be stored in the heap.

◆ top()

template<typename PR , typename IM , typename CMP >

Item top ( ) const

inline

This function returns the item having minimum priority.

Precondition: The heap must be non-empty.

◆ prio()

template<typename PR , typename IM , typename CMP >

Prio prio ( ) const

inline

This function returns the minimum priority.

Precondition: The heap must be non-empty.

◆ pop()

template<typename PR , typename IM , typename CMP >

void pop ( )

inline

This function removes the item having minimum priority.

Precondition: The heap must be non-empty.

◆ erase()

template<typename PR , typename IM , typename CMP >

void erase ( const Item & i )

inline

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

Parameters

i	The item to delete.

Precondition: i must be in the heap.

◆ operator[]()

template<typename PR , typename IM , typename CMP >

Prio operator[] ( const Item & i ) const

inline

This function returns the priority of the given item.

Parameters

i The item.

Precondition: i must be in the heap.

◆ set()

template<typename PR , typename IM , typename CMP >

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

inline

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.

◆ decrease()

template<typename PR , typename IM , typename CMP >

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

inline

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

Parameters

i	The item.
p	The priority.

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

◆ increase()

template<typename PR , typename IM , typename CMP >

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

inline

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

Parameters

i	The item.
p	The priority.

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

◆ state() [1/2]

template<typename PR , typename IM , typename CMP >

State state ( const Item & i ) const

inline

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.

◆ state() [2/2]

template<typename PR , typename IM , typename CMP >

void state	(	const Item &	i,
		State	st
	)

inline

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`.

◆ replace()

template<typename PR , typename IM , typename CMP >

void replace	(	const Item &	i,
		const Item &	j
	)

inline

This function replaces item i with item j. Item i must be in the heap, while j must be out of the heap. After calling this method, item i will be out of the heap and j will be in the heap with the same prioriority as item i had before.

Detailed Description

Public Types

Public Member Functions

Member Enumeration Documentation

◆ State

Constructor & Destructor Documentation

◆ BinHeap() [1/2]

◆ BinHeap() [2/2]

Member Function Documentation

◆ size()

◆ empty()

◆ clear()

◆ push() [1/2]

◆ push() [2/2]

◆ top()

◆ prio()

◆ pop()

◆ erase()

◆ operator[]()

◆ set()

◆ decrease()

◆ increase()

◆ state() [1/2]

◆ state() [2/2]

◆ replace()