Binomial heap implementation. More...

#include <ogdf/basic/heap/BinomialHeap.h>

Inheritance diagram for ogdf::BinomialHeap< T, C >:

Public Member Functions
	BinomialHeap (const C &cmp=C(), int initialSize=-1)
	Creates empty binomial heap. More...

virtual	~BinomialHeap ()
	Destructs the heap. More...

void	decrease (BinomialHeapNode< T > *heapNode, const T &value) override
	Decreases value of the given `heapNode` to `value`. More...

void	merge (BinomialHeap< T, C > &other) override
	Merges in values of `other` heap. More...

void	pop () override
	Removes the top element from the heap. More...

BinomialHeapNode< T > *	push (const T &value) override
	Inserts a new node with given `value` into a heap. More...

const T &	top () const override
	Returns reference to the top element in the heap. More...

const T &	value (BinomialHeapNode< T > *heapNode) const override
	Returns the value of the node. More...

Public Member Functions inherited from ogdf::HeapBase< BinomialHeap< T, std::less< T > >, BinomialHeapNode< T >, T, std::less< T > >
	HeapBase (const std::less< T > &comp=std::less< T >())

virtual const std::less< T > &	comparator () const
	Returns the comparator used to sort the values in the heap. More...

virtual void	decrease (Handle handle, const T &value)=0
	Decreases a single value. More...

virtual void	merge (BinomialHeap< T, std::less< T > > &other)
	Merges in values of `other` heap. More...

virtual const T &	top () const=0
	Returns the topmost value in the heap. More...

virtual const T &	value (const Handle handle) const=0
	Returns the value of that handle. More...

Private Types
using	base_type = HeapBase< BinomialHeap< T, C >, BinomialHeapNode< T >, T, C >

Private Member Functions
BinomialHeapNode< T > *	join (BinomialHeapNode< T > a, BinomialHeapNode< T > b)
	Joins heap lists `a` and `b` into single list sorted by the ranks. More...

void	merge (BinomialHeapNode< T > *other)
	Merges in `other` heap list into the heap. More...

Static Private Member Functions
static void	link (BinomialHeapNode< T > parent, BinomialHeapNode< T > child)
	Makes `child` node a child of `parent` node. More...

static void	release (BinomialHeapNode< T > *heapNode)
	Releases memory occupied by list of heaps given as `heapNode`. More...

Private Attributes
BinomialHeapNode< T > *	m_root
	Root node of the heap. More...

Additional Inherited Members
Public Types inherited from ogdf::HeapBase< BinomialHeap< T, std::less< T > >, BinomialHeapNode< T >, T, std::less< T > >
using	Handle = BinomialHeapNode< T > *
	The type of handle used to identify stored values. More...

Detailed Description

template<typename T, typename C = std::less<T>>
class ogdf::BinomialHeap< T, C >

Binomial heap implementation.

Code is mainly based on samples and ideas provided in "Introduction to Algorithms" book (aka "Cormen").

Template Parameters

T	Denotes value type of inserted elements.
C	Denotes comparison functor determining value ordering.

Definition at line 74 of file BinomialHeap.h.

Member Typedef Documentation

◆ base_type

template<typename T , typename C = std::less<T>>

using ogdf::BinomialHeap< T, C >::base_type = HeapBase<BinomialHeap<T, C>, BinomialHeapNode<T>, T, C>

private

Definition at line 75 of file BinomialHeap.h.

Constructor & Destructor Documentation

◆ BinomialHeap()

template<typename T , typename C >

ogdf::BinomialHeap< T, C >::BinomialHeap	(	const C &	cmp = `C()`,
		int	initialSize = `-1`
	)

explicit

Creates empty binomial heap.

Parameters

cmp	Comparison functor determining value ordering.
initialSize	ignored by this implementation.

Definition at line 156 of file BinomialHeap.h.

◆ ~BinomialHeap()

template<typename T , typename C >

ogdf::BinomialHeap< T, C >::~BinomialHeap

virtual

Destructs the heap.

If the heap is not empty, destructors of contained elements are called and used storage is deallocated.

Definition at line 160 of file BinomialHeap.h.

Member Function Documentation

◆ decrease()

template<typename T , typename C >

void ogdf::BinomialHeap< T, C >::decrease	(	BinomialHeapNode< T > *	heapNode,
		const T &	value
	)

override

Decreases value of the given heapNode to value.

Behaviour of this function is undefined if node does not belong to a the heap or new value is greater than old one.

Parameters

heapNode	A node for which the value is to be decreased.
value	A new value for the node.

Definition at line 227 of file BinomialHeap.h.

◆ join()

template<typename T , typename C >

BinomialHeapNode< T > * ogdf::BinomialHeap< T, C >::join	(	BinomialHeapNode< T > *	a,
		BinomialHeapNode< T > *	b
	)

inlineprivate

Joins heap lists a and b into single list sorted by the ranks.

Definition at line 247 of file BinomialHeap.h.

◆ link()

template<typename T , typename C >

void ogdf::BinomialHeap< T, C >::link	(	BinomialHeapNode< T > *	parent,
		BinomialHeapNode< T > *	child
	)

inlinestaticprivate

Makes child node a child of parent node.

Definition at line 314 of file BinomialHeap.h.

◆ merge() [1/2]

template<typename T , typename C >

void ogdf::BinomialHeap< T, C >::merge ( BinomialHeap< T, C > & other )

override

Merges in values of other heap.

After merge other heap becomes empty and is valid for further usage.

Parameters

other A heap to be merged in.

Definition at line 241 of file BinomialHeap.h.

◆ merge() [2/2]

template<typename T , typename C >

void ogdf::BinomialHeap< T, C >::merge ( BinomialHeapNode< T > * other )

inlineprivate

Merges in other heap list into the heap.

Definition at line 282 of file BinomialHeap.h.

◆ pop()

template<typename T , typename C >

void ogdf::BinomialHeap< T, C >::pop

overridevirtual

Removes the top element from the heap.

Behaviour of this function is undefined if the heap is empty.

Implements ogdf::HeapBase< BinomialHeap< T, std::less< T > >, BinomialHeapNode< T >, T, std::less< T > >.

Definition at line 197 of file BinomialHeap.h.

◆ push()

template<typename T , typename C >

BinomialHeapNode< T > * ogdf::BinomialHeap< T, C >::push ( const T & value )

overridevirtual

Inserts a new node with given value into a heap.

Parameters

value A value to be inserted.

Returns: Handle to the inserted node.

Implements ogdf::HeapBase< BinomialHeap< T, std::less< T > >, BinomialHeapNode< T >, T, std::less< T > >.

Definition at line 189 of file BinomialHeap.h.

◆ release()

template<typename T , typename C >

void ogdf::BinomialHeap< T, C >::release ( BinomialHeapNode< T > * heapNode )

staticprivate

Releases memory occupied by list of heaps given as heapNode.

Definition at line 166 of file BinomialHeap.h.

◆ top()

template<typename T , typename C >

const T & ogdf::BinomialHeap< T, C >::top

inlineoverride

Returns reference to the top element in the heap.

Definition at line 177 of file BinomialHeap.h.

◆ value()

template<typename T , typename C = std::less<T>>

const T& ogdf::BinomialHeap< T, C >::value ( BinomialHeapNode< T > * heapNode ) const

inlineoverride

Returns the value of the node.

Parameters

heapNode The nodes handle

Returns: the value of the node

Definition at line 138 of file BinomialHeap.h.

Member Data Documentation

◆ m_root

template<typename T , typename C = std::less<T>>

BinomialHeapNode<T>* ogdf::BinomialHeap< T, C >::m_root

private

Root node of the heap.

Definition at line 141 of file BinomialHeap.h.

The documentation for this class was generated from the following file:

include/ogdf/basic/heap/BinomialHeap.h

OpenGraph DrawingFramework

Public Member Functions

Private Types

Private Member Functions

Static Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

template<typename T, typename C = std::less<T>> class ogdf::BinomialHeap< T, C >

Member Typedef Documentation

◆ base_type

Constructor & Destructor Documentation

◆ BinomialHeap()

◆ ~BinomialHeap()

Member Function Documentation

◆ decrease()

◆ join()

◆ link()

◆ merge() [1/2]

◆ merge() [2/2]

◆ pop()

◆ push()

◆ release()

◆ top()

◆ value()

Member Data Documentation

◆ m_root

Open
Graph Drawing
Framework

template<typename T, typename C = std::less<T>>
class ogdf::BinomialHeap< T, C >