--- jsr166/src/main/java/util/PriorityQueue.java 2003/07/28 16:00:19 1.14
+++ jsr166/src/main/java/util/PriorityQueue.java 2003/08/06 18:42:49 1.25
@@ -1,14 +1,17 @@
package java.util;
/**
- * An unbounded priority queue based on a priority heap. This queue orders
+ * An unbounded priority {@linkplain Queue queue} based on a priority heap.
+ * This queue orders
* elements according to an order specified at construction time, which is
- * specified in the same manner as {@link TreeSet} and {@link TreeMap}:
- * elements are ordered
+ * specified in the same manner as {@link java.util.TreeSet} and
+ * {@link java.util.TreeMap}: elements are ordered
* either according to their natural order (see {@link Comparable}), or
- * according to a {@link Comparator}, depending on which constructor is used.
- * The head of this queue is the least element with respect to the
- * specified ordering. If multiple elements are tied for least value, the
+ * according to a {@link java.util.Comparator}, depending on which
+ * constructor is used.
+ *
The head of this queue is the least element with
+ * respect to the specified ordering.
+ * If multiple elements are tied for least value, the
* head is one of those elements. A priority queue does not permit
* null elements.
*
@@ -20,7 +23,8 @@
*
*
A priority queue has a capacity. The capacity is the
* size of the array used internally to store the elements on the
- * queue. It is always at least as large as the queue size. As
+ * queue.
+ * It is always at least as large as the queue size. As
* elements are added to a priority queue, its capacity grows
* automatically. The details of the growth policy are not specified.
*
@@ -55,7 +59,7 @@ public class PriorityQueue extends Ab
*
* queue.length must be >= 2, even if size == 0.
*/
- private transient E[] queue;
+ private transient Object[] queue;
/**
* The number of elements in the priority queue.
@@ -66,7 +70,7 @@ public class PriorityQueue extends Ab
* The comparator, or null if priority queue uses elements'
* natural ordering.
*/
- private final Comparator comparator;
+ private final Comparator super E> comparator;
/**
* The number of times this priority queue has been
@@ -75,105 +79,209 @@ public class PriorityQueue extends Ab
private transient int modCount = 0;
/**
- * Create a PriorityQueue with the default initial capacity
+ * Creates a PriorityQueue with the default initial capacity
* (11) that orders its elements according to their natural
- * ordering (using Comparable.)
+ * ordering (using Comparable).
*/
public PriorityQueue() {
this(DEFAULT_INITIAL_CAPACITY, null);
}
/**
- * Create a PriorityQueue with the specified initial capacity
+ * Creates a PriorityQueue with the specified initial capacity
* that orders its elements according to their natural ordering
- * (using Comparable.)
+ * (using Comparable).
*
* @param initialCapacity the initial capacity for this priority queue.
+ * @throws IllegalArgumentException if initialCapacity is less
+ * than 1
*/
public PriorityQueue(int initialCapacity) {
this(initialCapacity, null);
}
/**
- * Create a PriorityQueue with the specified initial capacity
+ * Creates a PriorityQueue with the specified initial capacity
* that orders its elements according to the specified comparator.
*
* @param initialCapacity the initial capacity for this priority queue.
* @param comparator the comparator used to order this priority queue.
* If null then the order depends on the elements' natural
* ordering.
+ * @throws IllegalArgumentException if initialCapacity is less
+ * than 1
*/
- public PriorityQueue(int initialCapacity, Comparator comparator) {
+ public PriorityQueue(int initialCapacity,
+ Comparator super E> comparator) {
if (initialCapacity < 1)
- initialCapacity = 1;
- queue = (E[]) new Object[initialCapacity + 1];
+ throw new IllegalArgumentException();
+ this.queue = new Object[initialCapacity + 1];
this.comparator = comparator;
}
/**
- * Create a PriorityQueue containing the elements in the specified
- * collection. The priority queue has an initial capacity of 110% of the
- * size of the specified collection. If the specified collection
- * implements the {@link Sorted} interface, the priority queue will be
- * sorted according to the same comparator, or according to its elements'
- * natural order if the collection is sorted according to its elements'
- * natural order. If the specified collection does not implement
- * Sorted, the priority queue is ordered according to
- * its elements' natural order.
- *
- * @param initialElements the collection whose elements are to be placed
- * into this priority queue.
- * @throws ClassCastException if elements of the specified collection
- * cannot be compared to one another according to the priority
- * queue's ordering.
- * @throws NullPointerException if the specified collection or an
- * element of the specified collection is null.
+ * Common code to initialize underlying queue array across
+ * constructors below.
*/
- public PriorityQueue(Collection initialElements) {
- int sz = initialElements.size();
+ private void initializeArray(Collection extends E> c) {
+ int sz = c.size();
int initialCapacity = (int)Math.min((sz * 110L) / 100,
Integer.MAX_VALUE - 1);
if (initialCapacity < 1)
initialCapacity = 1;
- queue = (E[]) new Object[initialCapacity + 1];
- if (initialElements instanceof Sorted) {
- comparator = ((Sorted)initialElements).comparator();
- for (Iterator i = initialElements.iterator(); i.hasNext(); )
- queue[++size] = i.next();
- } else {
+ this.queue = new Object[initialCapacity + 1];
+ }
+
+ /**
+ * Initially fill elements of the queue array under the
+ * knowledge that it is sorted or is another PQ, in which
+ * case we can just place the elements without fixups.
+ */
+ private void fillFromSorted(Collection extends E> c) {
+ for (Iterator extends E> i = c.iterator(); i.hasNext(); )
+ queue[++size] = i.next();
+ }
+
+
+ /**
+ * Initially fill elements of the queue array that is
+ * not to our knowledge sorted, so we must add them
+ * one by one.
+ */
+ private void fillFromUnsorted(Collection extends E> c) {
+ for (Iterator extends E> i = c.iterator(); i.hasNext(); )
+ add(i.next());
+ }
+
+ /**
+ * Creates a PriorityQueue containing the elements in the
+ * specified collection. The priority queue has an initial
+ * capacity of 110% of the size of the specified collection or 1
+ * if the collection is empty. If the specified collection is an
+ * instance of a {@link java.util.SortedSet} or is another
+ * PriorityQueue, the priority queue will be sorted
+ * according to the same comparator, or according to its elements'
+ * natural order if the collection is sorted according to its
+ * elements' natural order. Otherwise, the priority queue is
+ * ordered according to its elements' natural order.
+ *
+ * @param c the collection whose elements are to be placed
+ * into this priority queue.
+ * @throws ClassCastException if elements of the specified collection
+ * cannot be compared to one another according to the priority
+ * queue's ordering.
+ * @throws NullPointerException if c or any element within it
+ * is null
+ */
+ public PriorityQueue(Collection extends E> c) {
+ initializeArray(c);
+ if (c instanceof SortedSet extends E>) {
+ SortedSet extends E> s = (SortedSet extends E>) c;
+ comparator = (Comparator super E>)s.comparator();
+ fillFromSorted(s);
+ }
+ else if (c instanceof PriorityQueue extends E>) {
+ PriorityQueue extends E> s = (PriorityQueue extends E>) c;
+ comparator = (Comparator super E>)s.comparator();
+ fillFromSorted(s);
+ }
+ else {
comparator = null;
- for (Iterator i = initialElements.iterator(); i.hasNext(); )
- add(i.next());
+ fillFromUnsorted(c);
}
}
+ /**
+ * Creates a PriorityQueue containing the elements in the
+ * specified collection. The priority queue has an initial
+ * capacity of 110% of the size of the specified collection or 1
+ * if the collection is empty. This priority queue will be sorted
+ * according to the same comparator as the given collection, or
+ * according to its elements' natural order if the collection is
+ * sorted according to its elements' natural order.
+ *
+ * @param c the collection whose elements are to be placed
+ * into this priority queue.
+ * @throws ClassCastException if elements of the specified collection
+ * cannot be compared to one another according to the priority
+ * queue's ordering.
+ * @throws NullPointerException if c or any element within it
+ * is null
+ */
+ public PriorityQueue(PriorityQueue extends E> c) {
+ initializeArray(c);
+ comparator = (Comparator super E>)c.comparator();
+ fillFromSorted(c);
+ }
+
+ /**
+ * Creates a PriorityQueue containing the elements in the
+ * specified collection. The priority queue has an initial
+ * capacity of 110% of the size of the specified collection or 1
+ * if the collection is empty. This priority queue will be sorted
+ * according to the same comparator as the given collection, or
+ * according to its elements' natural order if the collection is
+ * sorted according to its elements' natural order.
+ *
+ * @param c the collection whose elements are to be placed
+ * into this priority queue.
+ * @throws ClassCastException if elements of the specified collection
+ * cannot be compared to one another according to the priority
+ * queue's ordering.
+ * @throws NullPointerException if c or any element within it
+ * is null
+ */
+ public PriorityQueue(SortedSet extends E> c) {
+ initializeArray(c);
+ comparator = (Comparator super E>)c.comparator();
+ fillFromSorted(c);
+ }
+
+ /**
+ * Resize array, if necessary, to be able to hold given index
+ */
+ private void grow(int index) {
+ int newlen = queue.length;
+ if (index < newlen) // don't need to grow
+ return;
+ if (index == Integer.MAX_VALUE)
+ throw new OutOfMemoryError();
+ while (newlen <= index) {
+ if (newlen >= Integer.MAX_VALUE / 2) // avoid overflow
+ newlen = Integer.MAX_VALUE;
+ else
+ newlen <<= 2;
+ }
+ Object[] newQueue = new Object[newlen];
+ System.arraycopy(queue, 0, newQueue, 0, queue.length);
+ queue = newQueue;
+ }
+
// Queue Methods
+
+
/**
* Add the specified element to this priority queue.
*
- * @param element the element to add.
* @return true
* @throws ClassCastException if the specified element cannot be compared
* with elements currently in the priority queue according
* to the priority queue's ordering.
- * @throws NullPointerException if the specified element is null.
+ * @throws NullPointerException if the specified element is null.
*/
- public boolean offer(E element) {
- if (element == null)
+ public boolean offer(E o) {
+ if (o == null)
throw new NullPointerException();
modCount++;
++size;
// Grow backing store if necessary
- while (size >= queue.length) {
- E[] newQueue = (E[]) new Object[2 * queue.length];
- System.arraycopy(queue, 0, newQueue, 0, queue.length);
- queue = newQueue;
- }
+ if (size >= queue.length)
+ grow(size);
- queue[size] = element;
+ queue[size] = o;
fixUp(size);
return true;
}
@@ -181,48 +289,77 @@ public class PriorityQueue extends Ab
public E poll() {
if (size == 0)
return null;
- return remove(1);
+ return (E) remove(1);
}
public E peek() {
- return queue[1];
+ return (E) queue[1];
}
- // Collection Methods
-
- // these first two override just to get the throws docs
+ // Collection Methods - the first two override to update docs
/**
- * @throws NullPointerException if the specified element is null.
+ * Adds the specified element to this queue.
+ * @return true (as per the general contract of
+ * Collection.add).
+ *
+ * @throws NullPointerException {@inheritDoc}
+ * @throws ClassCastException if the specified element cannot be compared
+ * with elements currently in the priority queue according
+ * to the priority queue's ordering.
*/
- public boolean add(E element) {
- return super.add(element);
+ public boolean add(E o) {
+ return super.add(o);
}
+
/**
- * @throws NullPointerException if any element is null.
+ * Adds all of the elements in the specified collection to this queue.
+ * The behavior of this operation is undefined if
+ * the specified collection is modified while the operation is in
+ * progress. (This implies that the behavior of this call is undefined if
+ * the specified collection is this queue, and this queue is nonempty.)
+ *
+ * This implementation iterates over the specified collection, and adds
+ * each object returned by the iterator to this collection, in turn.
+ * @throws NullPointerException {@inheritDoc}
+ * @throws ClassCastException if any element cannot be compared
+ * with elements currently in the priority queue according
+ * to the priority queue's ordering.
*/
public boolean addAll(Collection extends E> c) {
return super.addAll(c);
}
- /**
- * @throws NullPointerException if the specified element is null.
+
+ /**
+ * Removes a single instance of the specified element from this
+ * queue, if it is present. More formally,
+ * removes an element e such that (o==null ? e==null :
+ * o.equals(e)), if the queue contains one or more such
+ * elements. Returns true if the queue contained the
+ * specified element (or equivalently, if the queue changed as a
+ * result of the call).
+ *
+ *
This implementation iterates over the queue looking for the
+ * specified element. If it finds the element, it removes the element
+ * from the queue using the iterator's remove method.
+ *
*/
public boolean remove(Object o) {
if (o == null)
- throw new NullPointerException();
+ return false;
if (comparator == null) {
for (int i = 1; i <= size; i++) {
- if (((Comparable)queue[i]).compareTo(o) == 0) {
+ if (((Comparable)queue[i]).compareTo((E)o) == 0) {
remove(i);
return true;
}
}
} else {
for (int i = 1; i <= size; i++) {
- if (comparator.compare(queue[i], (E)o) == 0) {
+ if (comparator.compare((E)queue[i], (E)o) == 0) {
remove(i);
return true;
}
@@ -232,12 +369,10 @@ public class PriorityQueue extends Ab
}
/**
- * Returns an iterator over the elements in this priority queue. The
- * elements of the priority queue will be returned by this iterator in the
- * order specified by the queue, which is to say the order they would be
- * returned by repeated calls to poll.
+ * Returns an iterator over the elements in this queue. The iterator
+ * does not return the elements in any particular order.
*
- * @return an Iterator over the elements in this priority queue.
+ * @return an iterator over the elements in this queue.
*/
public Iterator iterator() {
return new Itr();
@@ -272,7 +407,7 @@ public class PriorityQueue extends Ab
checkForComodification();
if (cursor > size)
throw new NoSuchElementException();
- E result = queue[cursor];
+ E result = (E) queue[cursor];
lastRet = cursor++;
return result;
}
@@ -295,11 +430,6 @@ public class PriorityQueue extends Ab
}
}
- /**
- * Returns the number of elements in this priority queue.
- *
- * @return the number of elements in this priority queue.
- */
public int size() {
return size;
}
@@ -328,7 +458,7 @@ public class PriorityQueue extends Ab
assert i <= size;
modCount++;
- E result = queue[i];
+ E result = (E) queue[i];
queue[i] = queue[size];
queue[size--] = null; // Drop extra ref to prevent memory leak
if (i <= size)
@@ -349,17 +479,17 @@ public class PriorityQueue extends Ab
if (comparator == null) {
while (k > 1) {
int j = k >> 1;
- if (((Comparable)queue[j]).compareTo(queue[k]) <= 0)
+ if (((Comparable)queue[j]).compareTo((E)queue[k]) <= 0)
break;
- E tmp = queue[j]; queue[j] = queue[k]; queue[k] = tmp;
+ Object tmp = queue[j]; queue[j] = queue[k]; queue[k] = tmp;
k = j;
}
} else {
while (k > 1) {
int j = k >> 1;
- if (comparator.compare(queue[j], queue[k]) <= 0)
+ if (comparator.compare((E)queue[j], (E)queue[k]) <= 0)
break;
- E tmp = queue[j]; queue[j] = queue[k]; queue[k] = tmp;
+ Object tmp = queue[j]; queue[j] = queue[k]; queue[k] = tmp;
k = j;
}
}
@@ -378,26 +508,35 @@ public class PriorityQueue extends Ab
int j;
if (comparator == null) {
while ((j = k << 1) <= size) {
- if (j 0)
+ if (j)queue[j]).compareTo((E)queue[j+1]) > 0)
j++; // j indexes smallest kid
- if (((Comparable)queue[k]).compareTo(queue[j]) <= 0)
+ if (((Comparable)queue[k]).compareTo((E)queue[j]) <= 0)
break;
- E tmp = queue[j]; queue[j] = queue[k]; queue[k] = tmp;
+ Object tmp = queue[j]; queue[j] = queue[k]; queue[k] = tmp;
k = j;
}
} else {
while ((j = k << 1) <= size) {
- if (j < size && comparator.compare(queue[j], queue[j+1]) > 0)
+ if (j < size && comparator.compare((E)queue[j], (E)queue[j+1]) > 0)
j++; // j indexes smallest kid
- if (comparator.compare(queue[k], queue[j]) <= 0)
+ if (comparator.compare((E)queue[k], (E)queue[j]) <= 0)
break;
- E tmp = queue[j]; queue[j] = queue[k]; queue[k] = tmp;
+ Object tmp = queue[j]; queue[j] = queue[k]; queue[k] = tmp;
k = j;
}
}
}
- public Comparator comparator() {
+
+ /**
+ * Returns the comparator used to order this collection, or null
+ * if this collection is sorted according to its elements natural ordering
+ * (using Comparable).
+ *
+ * @return the comparator used to order this collection, or null
+ * if this collection is sorted according to its elements natural ordering.
+ */
+ public Comparator super E> comparator() {
return comparator;
}
@@ -410,7 +549,7 @@ public class PriorityQueue extends Ab
* Object) in the proper order.
* @param s the stream
*/
- private synchronized void writeObject(java.io.ObjectOutputStream s)
+ private void writeObject(java.io.ObjectOutputStream s)
throws java.io.IOException{
// Write out element count, and any hidden stuff
s.defaultWriteObject();
@@ -428,18 +567,18 @@ public class PriorityQueue extends Ab
* deserialize it).
* @param s the stream
*/
- private synchronized void readObject(java.io.ObjectInputStream s)
+ private void readObject(java.io.ObjectInputStream s)
throws java.io.IOException, ClassNotFoundException {
// Read in size, and any hidden stuff
s.defaultReadObject();
// Read in array length and allocate array
int arrayLength = s.readInt();
- queue = (E[]) new Object[arrayLength];
+ queue = new Object[arrayLength];
// Read in all elements in the proper order.
for (int i=0; i