PriorityQueue< TYPE > Class Template Reference
[Containers]

List of all members.

Public Types
typedef bool(*	CompareFunction )(const TYPE &a, const TYPE &b)
Public Member Functions
	PriorityQueue (CompareFunction compareFunction, int initialCapacity=64)
	PriorityQueue (const PriorityQueue< TYPE > &priorityQueueToCopy)
const PriorityQueue< TYPE > &	operator= (const PriorityQueue< TYPE > &priorityQueueToCopy)
	~PriorityQueue ()
TYPE &	Add (const TYPE &item)
TYPE	Remove ()
void	Update (int index)
bool	ItemExists (const TYPE &item) const
int	GetItemCount () const
TYPE &	Get (int index) const
int	GetCapacity () const
void	SetCapacity (int capacity)
void	Clear (bool releaseMemory=true)

---

Detailed Description

template<class TYPE>
class PriorityQueue< TYPE >

Author:

Mattias Gustavsson

Definition at line 19 of file PriorityQueue.h.

---

Member Typedef Documentation

template<class TYPE>

typedef bool(* PriorityQueue< TYPE >::CompareFunction)(const TYPE &a, const TYPE &b)

Returns true if value a is higher priority than value b

Definition at line 25 of file PriorityQueue.h.

---

Constructor & Destructor Documentation

template<class TYPE >

PriorityQueue< TYPE >::PriorityQueue	(	CompareFunction	compareFunction,
		int	initialCapacity = 64
	)

Constructor

Parameters:

initialCapacity

Maximum number of items the PriorityQueue can initially store.

Definition at line 9 of file PriorityQueue.inl.

template<class TYPE>

PriorityQueue< TYPE >::PriorityQueue

(

const PriorityQueue< TYPE > &

priorityQueueToCopy

)

Copy Constructor

Definition at line 21 of file PriorityQueue.inl.

template<class TYPE >

PriorityQueue< TYPE >::~PriorityQueue

(

)

Destructor

Definition at line 90 of file PriorityQueue.inl.

---

Member Function Documentation

template<class TYPE>

const PriorityQueue< TYPE > & PriorityQueue< TYPE >::operator=

(

const PriorityQueue< TYPE > &

priorityQueueToCopy

)

Assignment operator

Definition at line 52 of file PriorityQueue.inl.

template<class TYPE>

TYPE & PriorityQueue< TYPE >::Add

(

const TYPE &

item

)

Adds an item to the PriorityQueue.

Definition at line 103 of file PriorityQueue.inl.

template<class TYPE >

TYPE PriorityQueue< TYPE >::Remove

(

)

Removes an item from the PriorityQueue.

Definition at line 165 of file PriorityQueue.inl.

template<class TYPE >

void PriorityQueue< TYPE >::Update

(

int

index

)

Definition at line 226 of file PriorityQueue.inl.

template<class TYPE>

bool PriorityQueue< TYPE >::ItemExists

(

const TYPE &

item

)

const

Definition at line 267 of file PriorityQueue.inl.

template<class TYPE >

int PriorityQueue< TYPE >::GetItemCount

(

)

const

Gets the number of items in the PriorityQueue

Returns:

Number of items currently being stored in the PriorityQueue

Definition at line 284 of file PriorityQueue.inl.

template<class TYPE >

TYPE & PriorityQueue< TYPE >::Get

(

int

index

)

const

Gets item at specified index

Returns:

item at specified index

Parameters:

index

Index of item to get

Definition at line 293 of file PriorityQueue.inl.

template<class TYPE >

int PriorityQueue< TYPE >::GetCapacity

(

)

const

Definition at line 302 of file PriorityQueue.inl.

template<class TYPE >

void PriorityQueue< TYPE >::SetCapacity

(

int

capacity

)

Definition at line 311 of file PriorityQueue.inl.

template<class TYPE >

void PriorityQueue< TYPE >::Clear

(

bool

releaseMemory = true

)

Removes all items from the PriorityQueue

Parameters:

releaseMemory

If set to true, all memory used by the PriorityQueue will be released, and the maximum number of items that can be stored is reset to the initial value

Definition at line 243 of file PriorityQueue.inl.