tpie::pq_merge_heap< T, Comparator > Class Template Reference

#include <tpie/pq_merge_heap.h>

Public Types
typedef memory_size_type	run_type

Public Member Functions
	pq_merge_heap (memory_size_type elements)
	Constructor. More...
	~pq_merge_heap ()
	Destructor. More...
void	push (const T &x, run_type run)
	Insert an element into the priority queue. More...
void	pop ()
	Remove the top element from the priority queue. More...
void	pop_and_push (const T &x, run_type run)
	Remove the top element from the priority queue and insert another. More...
const T &	top () const
	See what's on the top of the priority queue. More...
run_type	top_run () const
	Return top element run number. More...
memory_size_type	size () const
	Returns the size of the queue. More...
bool	empty () const
	Return true if queue is empty, otherwise false. More...

Detailed Description

template<typename T, typename Comparator = std::less<T>>
class tpie::pq_merge_heap< T, Comparator >

Author

Lars Hvam Petersen

pq_merge_heap

Definition at line 41 of file pq_merge_heap.h.

Constructor & Destructor Documentation

pq_merge_heap()

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

tpie::pq_merge_heap< T, Comparator >::pq_merge_heap

(

memory_size_type

elements

)

Constructor.

Parameters

elements

Maximum allowed size of the heap.

~pq_merge_heap()

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

tpie::pq_merge_heap< T, Comparator >::~pq_merge_heap

(

)

Destructor.

Member Function Documentation

empty()

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

bool tpie::pq_merge_heap< T, Comparator >::empty

(

)

const

Return true if queue is empty, otherwise false.

Returns

true if queue is empty, otherwise false.

pop()

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

void tpie::pq_merge_heap< T, Comparator >::pop

(

)

Remove the top element from the priority queue.

pop_and_push()

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

void tpie::pq_merge_heap< T, Comparator >::pop_and_push	(	const T &	x,
		run_type	run
	)

Remove the top element from the priority queue and insert another.

Parameters

x	The item.
run	Where it comes from.

push()

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

void tpie::pq_merge_heap< T, Comparator >::push	(	const T &	x,
		run_type	run
	)

Insert an element into the priority queue.

Parameters

x	The item.
run	Where it comes from.

size()

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

memory_size_type tpie::pq_merge_heap< T, Comparator >::size

(

)

const

Returns the size of the queue.

Returns

Queue size.

top()

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

const T& tpie::pq_merge_heap< T, Comparator >::top

(

)

const

See what's on the top of the priority queue.

Returns

Top element

top_run()

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

run_type tpie::pq_merge_heap< T, Comparator >::top_run

(

)

const

Return top element run number.

Returns

Top element run number.

---

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

• pq_merge_heap.h