Progeneric.Ptl.Containers

Class PriorityQueue64<T>

java.lang.Object

Progeneric.Ptl.Containers.PriorityQueue64<T>

Type Parameters:

T - Specifies the type of elements in the queue.

public class PriorityQueue64<T>
extends java.lang.Object

Implements a variable size container of instances of the same unbound parameter type. It provides insertion of elements and inspection and removal of the top element, which is always the largest element or the element of the highest.

Constructor Summary

Constructors

Constructor and Description
PriorityQueue64(java.lang.Class<T> type) Constructs an empty priority queue with the default comparator.
PriorityQueue64(java.lang.Class<T> type, 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 queue's elements.
IFunc2Arg<T,T,java.lang.Boolean>	Compare() Returns the function object that can compare two elements to determine their relative order in the priority queue.
void	Dequeue() Removes the element at the top of the queue that is the largest element in the queue.
boolean	Empty() Returns true only if the queue contains no elements.
void	Enqueue(T item) Inserts an element into the queue that will become the top element only if it happens to be larger than any of the elements already in the queue.
boolean	equals(java.lang.Object obj) Tests whether this instance is equal to a specified object.
boolean	equals(PriorityQueue64<T> x) Tests whether this instance is equal to a specified Vector object.
int	hashCode() Returns the hash code for this instance.
long	MaxSize() Returns the queue's maximum possible size.
T	Peek() Gets the largest element at the front of the queue.
long	Size() Returns the number of elements contained in the queue.

Methods inherited from class java.lang.Object

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

Constructor Detail

PriorityQueue64

public PriorityQueue64(java.lang.Class<T> type)

Constructs an empty priority queue with the default comparator.

Parameters:

type - The specified type of the container elements.

PriorityQueue64

public PriorityQueue64(java.lang.Class<T> type,
               IFunc2Arg<T,T,java.lang.Boolean> compare)

Constructs an empty priority queue with the specified comparator.

Parameters:

type - The specified type of the container elements.

compare - The specified comparator.

Method Detail

Compare

public IFunc2Arg<T,T,java.lang.Boolean> Compare()

Returns the function object that can compare two elements to determine their relative order in the priority queue.

Returns:

The function object that can compare two elements to determine their relative order in the priority queue.

Size

public long Size()

Returns the number of elements contained in the queue.

Returns:

The number of elements contained in the queue.

MaxSize

public long MaxSize()

Returns the queue's maximum possible size.

Returns:

The queue's maximum possible size.

Empty

public boolean Empty()

Returns true only if the queue contains no elements.

Returns:

True if the queue contains no elements; otherwise, false.

Peek

public T Peek()

Gets the largest element at the front of the queue.

Returns:

The largest element at the front of the queue.

Throws:

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

Enqueue

public void Enqueue(T item)

Inserts an element into the queue that will become the top element only if it happens to be larger than any of the elements already in the queue.

Parameters:

item - The element added to the end of the queue.

Throws:

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

Dequeue

public void Dequeue()

Removes the element at the top of the queue that is the largest element in the queue.

Throws:

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

Clear

public void Clear()

Erases all of the 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> x)

Tests whether this instance is equal to a specified Vector object.

Parameters:

x - An object to compare with this instance.

Returns:

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