Org.Apache.REEF.Utilities.Collections.PriorityQueue< T > Class Template Reference

A simple priority queue implementation, where the head of the queue is the smallest element in the priority queue. More...

Inherits ICollection< T >.

Public Member Functions
	PriorityQueue ()
IEnumerator< T >	GetEnumerator ()
	Gets the enumerator of the priority queue. More...
T	Peek ()
	Peeks at the head of the priority queue, but does not remove the element at the head. More...
void	Enqueue (T item)
	Adds an element to the priority queue. More...
T	Dequeue ()
	Dequeues an item from the priority queue. More...
void	Add (T item)
	Enqueue. More...
void	Clear ()
	Clears the priority queue. More...
bool	Contains (T item)
	Checks if the list contains an item. More...
void	CopyTo (T[] array, int arrayIndex)
	Copies the priority queue to a compatible array, starting at the array's provided index. More...
bool	Remove (T item)
	Remove is not supported. More...

Properties
int	Count [get]
	Returns the count of the priority queue. More...
bool	IsReadOnly [get]
	Always returns false. More...

Detailed Description

A simple priority queue implementation, where the head of the queue is the smallest element in the priority queue.

Type Constraints

T

:

IComparable<T>

Constructor & Destructor Documentation

PriorityQueue()

Org.Apache.REEF.Utilities.Collections.PriorityQueue< T >.PriorityQueue ( )

inline

Member Function Documentation

Add()

void Org.Apache.REEF.Utilities.Collections.PriorityQueue< T >.Add ( T  item )

inline

Enqueue.

Clear()

void Org.Apache.REEF.Utilities.Collections.PriorityQueue< T >.Clear ( )

inline

Clears the priority queue.

Contains()

bool Org.Apache.REEF.Utilities.Collections.PriorityQueue< T >.Contains ( T  item )

inline

Checks if the list contains an item.

CopyTo()

void Org.Apache.REEF.Utilities.Collections.PriorityQueue< T >.CopyTo ( T []  array, int  arrayIndex  )

inline

Copies the priority queue to a compatible array, starting at the array's provided index.

Dequeue()

T Org.Apache.REEF.Utilities.Collections.PriorityQueue< T >.Dequeue ( )

inline

Dequeues an item from the priority queue.

Removes the head of the priority queue, which is the smallest element in the priority queue.

Exceptions

InvalidOperationException

Thrown when the priority queue is empty

Enqueue()

void Org.Apache.REEF.Utilities.Collections.PriorityQueue< T >.Enqueue ( T  item )

inline

Adds an element to the priority queue.

GetEnumerator()

IEnumerator<T> Org.Apache.REEF.Utilities.Collections.PriorityQueue< T >.GetEnumerator ( )

inline

Gets the enumerator of the priority queue.

The Enumerator returns elements in no guaranteed order.

Peek()

T Org.Apache.REEF.Utilities.Collections.PriorityQueue< T >.Peek ( )

inline

Peeks at the head of the priority queue, but does not remove the element at the head.

Exceptions

InvalidOperationException

Thrown when the priority queue is empty

Remove()

bool Org.Apache.REEF.Utilities.Collections.PriorityQueue< T >.Remove ( T  item )

inline

Remove is not supported.

Exceptions

NotSupportedException

Operation not supported

Property Documentation

Count

int Org.Apache.REEF.Utilities.Collections.PriorityQueue< T >.Count

get

Returns the count of the priority queue.

IsReadOnly

bool Org.Apache.REEF.Utilities.Collections.PriorityQueue< T >.IsReadOnly

get

Always returns false.

---

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

• lang/cs/Org.Apache.REEF.Utilities/Collections/PriorityQueue.cs