text cover

Data Abstraction and Problem Solving with C++

Walls and Mirrors

by Frank M. Carrano

Addison Wesley Logo

priority_queue< T, Container, Compare > Class Template Reference

#include <c11p642.h>

List of all members.


Detailed Description

template<typename T, typename Container = vector<T>, typename Compare = less<typename Container::value_type>>
class priority_queue< T, Container, Compare >

Definition at line 16 of file c11p642.h.

Public Member Functions

 priority_queue (const Compare &cmp=Compare(), const Container &=Container())
bool empty () const
size_type size () const
const value_type & top () const
void pop ()
void push (const value_type &e)


Constructor & Destructor Documentation

template<typename T, typename Container = vector<T>, typename Compare = less<typename Container::value_type>>
priority_queue< T, Container, Compare >::priority_queue const Compare &  cmp = Compare(),
const Container &  = Container()
[explicit]
 

Default constructor; initializes an empty priority queue. The default comparison operator is <.

Precondition:
None.
Postcondition:
An empty priority queue exists.
Parameters:
cmp A comparison function object may be supplied.


Member Function Documentation

template<typename T, typename Container = vector<T>, typename Compare = less<typename Container::value_type>>
bool priority_queue< T, Container, Compare >::empty  )  const
 

Determines whether the priority queue is empty.

Precondition:
None.
Postcondition:
None.
Returns:
True if the priority queue is empty, otherwise returns false.

template<typename T, typename Container = vector<T>, typename Compare = less<typename Container::value_type>>
size_type priority_queue< T, Container, Compare >::size  )  const
 

Determines the size of the priority queue. The return type size_type is an integral type.

Precondition:
None.
Postcondition:
None.
Returns:
The number of items that are currently in the priority queue.

template<typename T, typename Container = vector<T>, typename Compare = less<typename Container::value_type>>
const value_type& priority_queue< T, Container, Compare >::top  )  const
 

Returns a reference to the highest priority element in the priority queue.

Precondition:
None.
Postcondition:
The item remains at the top of the priority queue.
Returns:
The highest priority item.

template<typename T, typename Container = vector<T>, typename Compare = less<typename Container::value_type>>
void priority_queue< T, Container, Compare >::pop  ) 
 

Removes the highest priority element in the priority queue.

Precondition:
None.
Postcondition:
The highest priority item has been removed.
Returns:
The highest priority item.

template<typename T, typename Container = vector<T>, typename Compare = less<typename Container::value_type>>
void priority_queue< T, Container, Compare >::push const value_type &  e  ) 
 

Adds the item e to the priority queue

Precondition:
None.
Postcondition:
The priority queue has the highest priority element at the top.


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

Generated on Sun Aug 27 22:03:18 2006 for AWLogo by  doxygen 1.4.6