Progeneric.Ptl.Containers.Adaptors

Class PriorityQueue64<T,TIterator extends IRanIter<T,TIterator>,TContainer extends IRanSequence64<T,TIterator>>

java.lang.Object

Progeneric.Ptl.Containers.Adaptors.PriorityQueue64<T,TIterator,TContainer>

Type Parameters:

T - The type of elements in the queue.

TIterator - The type of iterators in the container.

TContainer - The type of the specified container.

public class PriorityQueue64<T,TIterator extends IRanIter<T,TIterator>,TContainer extends IRanSequence64<T,TIterator>>
extends java.lang.Object

Implements a variable size container of instances of the same unbound parameter type. It provides methods for the insertion of elements and for the inspection and removal of the front element, which is always the highest-priority element.

Field Summary

Fields

Modifier and Type	Field and Description
protected TContainer	data The underlying container of the current instance.

Constructor Summary

Constructors

Constructor and Description
PriorityQueue64(TContainer data) Constructs an empty priority queue with the default comparator.
PriorityQueue64(TContainer data, IFunc2Arg<T,T,java.lang.Boolean> compare) Constructs an empty priority queue with the specified comparator.

Method Summary

Methods

Modifier and Type	Method and Description
void	Clear() Erases all of the priority queue's elements.
TContainer	Container() Gets the underlying container of the current instance.
void	Dequeue() Removes the highest-priority element at the front of the priority queue.
boolean	Empty() Returns true only if the priority queue does not contain any elements.
void	Enqueue(T item) Inserts an element into the priority queue.
boolean	equals(java.lang.Object obj) Tests whether this instance is equal to a specified object.
boolean	equals(PriorityQueue64<T,TIterator,TContainer> x) Tests whether this instance is equal to a specified PriorityQueue64.
int	hashCode() Returns the hash code for this instance.
long	MaxSize() Returns the maximum possible size of the priority queue.
T	Peek() Returns (without removing) the highest-priority element at the front of the priority queue.
long	Size() Returns the number of elements contained in the priority queue.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

data

protected TContainer extends IRanSequence64<T,TIterator> data

The underlying container of the current instance.

Constructor Detail

PriorityQueue64

public PriorityQueue64(TContainer data)

Constructs an empty priority queue with the default comparator.

Parameters:

data - The underlying container object.

PriorityQueue64

public PriorityQueue64(TContainer data,
               IFunc2Arg<T,T,java.lang.Boolean> compare)

Constructs an empty priority queue with the specified comparator.

Parameters:

data - The underlying container object.

compare - The specified comparator.

Method Detail

Container

public TContainer Container()

Gets the underlying container of the current instance.

Returns:

The underlying container of the current instance.

Size

public long Size()

Returns the number of elements contained in the priority queue.

Returns:

The number of elements contained in the priority queue.

MaxSize

public long MaxSize()

Returns the maximum possible size of the priority queue.

Returns:

The maximum possible size of the priority queue.

Empty

public boolean Empty()

Returns true only if the priority queue does not contain any elements.

Returns:

True if the priority queue is empty; otherwise, false.

Peek

public T Peek()

Returns (without removing) the highest-priority element at the front of the priority queue.

Returns:

The highest-priority element at the front of the priority queue.

Throws:

java.lang.RuntimeException - When the priority queue is empty.

Enqueue

public void Enqueue(T item)

Inserts an element into the priority queue. This element will become the front element only if it has a higher priority than all of the other elements in the priority queue.

Parameters:

item - The element added to the priority queue.

Throws:

java.lang.RuntimeException - When the priority queue is full.

Dequeue

public void Dequeue()

Removes the highest-priority element at the front of the priority queue.

Throws:

java.lang.RuntimeException - When the priority queue is empty.

Clear

public void Clear()

Erases all of the priority queue's elements.

equals

public boolean equals(java.lang.Object obj)

Tests whether this instance is equal to a specified object.

Overrides:

equals in class java.lang.Object

Parameters:

obj - An object to compare with this instance.

Returns:

True if obj is an instance of PriorityQueue64 and equals the value of this instance; otherwise, false.

hashCode

public int hashCode()

Returns the hash code for this instance.

Overrides:

hashCode in class java.lang.Object

Returns:

A 32-bit signed integer hash code.

equals

public boolean equals(PriorityQueue64<T,TIterator,TContainer> x)

Tests whether this instance is equal to a specified PriorityQueue64.

Parameters:

x - A PriorityQueue64 to compare with this instance.

Returns:

True if the specified PriorityQueue64 equals the value of this instance; otherwise, false.