ViewVC Help

View File | Revision Log | Show Annotations | Download File | Root Listing

root/jsr166/jsr166/src/main/java/util/PriorityQueue.java

Comparing jsr166/src/main/java/util/PriorityQueue.java (file contents):
Revision 1.6 by brian, Mon Jun 23 02:26:15 2003 UTC vs.
Revision 1.19 by tim, Mon Aug 4 16:14:48 2003 UTC

#	Line 1 | Line 1
1		package java.util;
2
3		/**
4	<	* An unbounded priority queue based on a priority heap.  This queue orders
4	>	* A priority queue based on a priority heap.  This queue orders
5		* elements according to an order specified at construction time, which is
6	<	* specified in the same manner as {@link TreeSet} and {@link TreeMap}: elements are ordered
6	>	* specified in the same manner as {@link java.util.TreeSet} and
7	>	* {@link java.util.TreeMap}: elements are ordered
8		* either according to their <i>natural order</i> (see {@link Comparable}), or
9	<	* according to a {@link Comparator}, depending on which constructor is used.
10	<	* The {@link #peek}, {@link #poll}, and {@link #remove} methods return the
11	<	* minimal element with respect to the specified ordering.  If multiple
12	<	* elements are tied for least value, no guarantees are made as to
13	<	* which of these elements is returned.
9	>	* according to a {@link java.util.Comparator}, depending on which
10	>	* constructor is used.
11	>	* <p>The <em>head</em> of this queue is the <em>least</em> element with
12	>	* respect to the specified ordering.
13	>	* If multiple elements are tied for least value, the
14	>	* head is one of those elements. A priority queue does not permit
15	>	* <tt>null</tt> elements.
16		*
17	<	* <p>A priority queue has a <i>capacity</i>.  The capacity is the size of
18	<	* the array used internally to store the elements on the queue.  It is always at least
16	<	* as large as the queue size.  As elements are added to a priority queue,
17	<	* its capacity grows automatically.  The details of the growth policy are not
18	<	* specified.
17	>	* <p>The {@link #remove()} and {@link #poll()} methods remove and
18	>	* return the head of the queue.
19		*
20	<	*<p>Implementation note: this implementation provides O(log(n)) time for
21	<	* the insertion methods (<tt>offer</tt>, <tt>poll</tt>, <tt>remove()</tt> and <tt>add</tt>)
22	<	* methods; linear time for the <tt>remove(Object)</tt> and
23	<	* <tt>contains(Object)</tt> methods; and constant time for the retrieval methods (<tt>peek</tt>,
20	>	* <p>The {@link #element()} and {@link #peek()} methods return, but do
21	>	* not delete, the head of the queue.
22	>	*
23	>	* <p>A priority queue has a <i>capacity</i>.  The capacity is the
24	>	* size of the array used internally to store the elements on the
25	>	* queue, and is limited to <tt>Integer.MAX_VALUE-1</tt>.
26	>	* It is always at least as large as the queue size.  As
27	>	* elements are added to a priority queue, its capacity grows
28	>	* automatically.  The details of the growth policy are not specified.
29	>	*
30	>	* <p>Implementation note: this implementation provides O(log(n)) time
31	>	* for the insertion methods (<tt>offer</tt>, <tt>poll</tt>,
32	>	* <tt>remove()</tt> and <tt>add</tt>) methods; linear time for the
33	>	* <tt>remove(Object)</tt> and <tt>contains(Object)</tt> methods; and
34	>	* constant time for the retrieval methods (<tt>peek</tt>,
35		* <tt>element</tt>, and <tt>size</tt>).
36		*
37		* <p>This class is a member of the
38		* <a href="{@docRoot}/../guide/collections/index.html">
39		* Java Collections Framework</a>.
40	+	* @since 1.5
41	+	* @author Josh Bloch
42		*/
43		public class PriorityQueue<E> extends AbstractQueue<E>
44	<	implements Queue<E>
45	<	{
44	>	implements Sorted, Queue<E>, java.io.Serializable {
45	>
46		private static final int DEFAULT_INITIAL_CAPACITY = 11;
47
48		/**
#	Line 45 | Line 58 | public class PriorityQueue<E> extends Ab
58		*
59		* queue.length must be >= 2, even if size == 0.
60		*/
61	<	private transient E[] queue;
61	>	private transient Object[] queue;
62
63		/**
64		* The number of elements in the priority queue.
#	Line 56 | Line 69 | public class PriorityQueue<E> extends Ab
69		* The comparator, or null if priority queue uses elements'
70		* natural ordering.
71		*/
72	<	private final Comparator<E> comparator;
72	>	private final Comparator<? super E> comparator;
73
74		/**
75		* The number of times this priority queue has been
#	Line 65 | Line 78 | public class PriorityQueue<E> extends Ab
78		private transient int modCount = 0;
79
80		/**
81	<	* Create a new priority queue with the default initial capacity (11)
82	<	* that orders its elements according to their natural ordering (using <tt>Comparable</tt>.)
81	>	* Create a <tt>PriorityQueue</tt> with the default initial capacity
82	>	* (11) that orders its elements according to their natural
83	>	* ordering (using <tt>Comparable</tt>.)
84		*/
85		public PriorityQueue() {
86	<	this(DEFAULT_INITIAL_CAPACITY);
86	>	this(DEFAULT_INITIAL_CAPACITY, null);
87		}
88
89		/**
90	<	* Create a new priority queue with the specified initial capacity
91	<	* that orders its elements according to their natural ordering (using <tt>Comparable</tt>.)
90	>	* Create a <tt>PriorityQueue</tt> with the specified initial capacity
91	>	* that orders its elements according to their natural ordering
92	>	* (using <tt>Comparable</tt>.)
93		*
94		* @param initialCapacity the initial capacity for this priority queue.
95		*/
#	Line 83 | Line 98 | public class PriorityQueue<E> extends Ab
98		}
99
100		/**
101	<	* Create a new priority queue with the specified initial capacity (11)
101	>	* Create a <tt>PriorityQueue</tt> with the specified initial capacity
102		* that orders its elements according to the specified comparator.
103		*
104		* @param initialCapacity the initial capacity for this priority queue.
105		* @param comparator the comparator used to order this priority queue.
106	+	* If <tt>null</tt> then the order depends on the elements' natural
107	+	* ordering.
108	+	* @throws IllegalArgumentException if <tt>initialCapacity</tt> is less
109	+	* than 1
110		*/
111	<	public PriorityQueue(int initialCapacity, Comparator<E> comparator) {
111	>	public PriorityQueue(int initialCapacity, Comparator<? super E> comparator) {
112		if (initialCapacity < 1)
113	<	initialCapacity = 1;
114	<	queue = new E[initialCapacity + 1];
113	>	throw new IllegalArgumentException();
114	>	this.queue = new Object[initialCapacity + 1];
115		this.comparator = comparator;
116		}
117
118		/**
119	<	* Create a new priority queue containing the elements in the specified
119	>	* Create a <tt>PriorityQueue</tt> containing the elements in the specified
120		* collection.  The priority queue has an initial capacity of 110% of the
121	<	* size of the specified collection. If the specified collection
121	>	* size of the specified collection (bounded by
122	>	* <tt>Integer.MAX_VALUE-1</tt>); or 1 if the collection is empty.
123	>	* If the specified collection
124		* implements the {@link Sorted} interface, the priority queue will be
125		* sorted according to the same comparator, or according to its elements'
126		* natural order if the collection is sorted according to its elements'
#	Line 107 | Line 128 | public class PriorityQueue<E> extends Ab
128		* <tt>Sorted</tt>, the priority queue is ordered according to
129		* its elements' natural order.
130		*
131	<	* @param initialElements the collection whose elements are to be placed
131	>	* @param c the collection whose elements are to be placed
132		*        into this priority queue.
133		* @throws ClassCastException if elements of the specified collection
134		*         cannot be compared to one another according to the priority
135		*         queue's ordering.
136	<	* @throws NullPointerException if the specified collection or an
137	<	*         element of the specified collection is <tt>null</tt>.
136	>	* @throws NullPointerException if <tt>c</tt> or any element within it
137	>	* is <tt>null</tt>
138		*/
139	<	public PriorityQueue(Collection<E> initialElements) {
140	<	int sz = initialElements.size();
139	>	public PriorityQueue(Collection<? extends E> c) {
140	>	int sz = c.size();
141		int initialCapacity = (int)Math.min((sz * 110L) / 100,
142		Integer.MAX_VALUE - 1);
143		if (initialCapacity < 1)
144		initialCapacity = 1;
124	–	queue = new E[initialCapacity + 1];
145
146	<	/* Commented out to compile with generics compiler
146	>	this.queue = new Object[initialCapacity + 1];
147
148	<	if (initialElements instanceof Sorted) {
149	<	comparator = ((Sorted)initialElements).comparator();
150	<	for (Iterator<E> i = initialElements.iterator(); i.hasNext(); )
151	<	queue[++size] = i.next();
148	>	// FIXME: if c is larger than Integer.MAX_VALUE we'll
149	>	// overflow the array
150	>
151	>	if (c instanceof Sorted) {
152	>	comparator = (Comparator<? super E>)((Sorted)c).comparator();
153		} else {
133	–	*/
134	–	{
154		comparator = null;
136	–	for (Iterator<E> i = initialElements.iterator(); i.hasNext(); )
137	–	add(i.next());
155		}
156	+
157	+	for (Iterator<? extends E> i = c.iterator(); i.hasNext(); )
158	+	add(i.next());
159		}
160
161		// Queue Methods
162
163		/**
164	<	* Remove and return the minimal element from this priority queue if
145	<	* it contains one or more elements, otherwise return <tt>null</tt>.  The term
146	<	* <i>minimal</i> is defined according to this priority queue's order.
164	>	* Add the specified element to this priority queue.
165		*
166	<	* @return the minimal element from this priority queue if it contains
167	<	*         one or more elements, otherwise <tt>null</tt>.
166	>	* @return <tt>true</tt>
167	>	* @throws ClassCastException if the specified element cannot be compared
168	>	* with elements currently in the priority queue according
169	>	* to the priority queue's ordering.
170	>	* @throws NullPointerException if the specified element is <tt>null</tt>.
171		*/
172	+	public boolean offer(E o) {
173	+	if (o == null)
174	+	throw new NullPointerException();
175	+	modCount++;
176	+	++size;
177	+
178	+	// Grow backing store if necessary
179	+	// FIXME: watch for overflow
180	+	// FIXME: what if we're full?
181	+	while (size >= queue.length) {
182	+	Object[] newQueue = new Object[2 * queue.length];
183	+	System.arraycopy(queue, 0, newQueue, 0, queue.length);
184	+	queue = newQueue;
185	+	}
186	+
187	+	queue[size] = o;
188	+	fixUp(size);
189	+	return true;
190	+	}
191	+
192		public E poll() {
193		if (size == 0)
194		return null;
195	<	return remove(1);
195	>	return (E) remove(1);
196		}
197
157	–	/**
158	–	* Return, but do not remove, the minimal element from the priority queue,
159	–	* or return <tt>null</tt> if the queue is empty.  The term <i>minimal</i> is
160	–	* defined according to this priority queue's order.  This method returns
161	–	* the same object reference that would be returned by by the
162	–	* <tt>poll</tt> method.  The two methods differ in that this method
163	–	* does not remove the element from the priority queue.
164	–	*
165	–	* @return the minimal element from this priority queue if it contains
166	–	*         one or more elements, otherwise <tt>null</tt>.
167	–	*/
198		public E peek() {
199	<	return queue[1];
199	>	return (E) queue[1];
200		}
201
202		// Collection Methods
203
204	+	// these first two override just to get the throws docs
205	+
206		/**
207	<	* Removes a single instance of the specified element from this priority
176	<	* queue, if it is present.  Returns true if this collection contained the
177	<	* specified element (or equivalently, if this collection changed as a
178	<	* result of the call).
179	<	*
180	<	* @param element the element to be removed from this collection, if present.
181	<	* @return <tt>true</tt> if this collection changed as a result of the
182	<	*         call
207	>	* @throws NullPointerException if the specified element is <tt>null</tt>.
208		* @throws ClassCastException if the specified element cannot be compared
209	<	*            with elements currently in the priority queue according
210	<	*            to the priority queue's ordering.
186	<	* @throws NullPointerException if the specified element is null.
209	>	* with elements currently in the priority queue according
210	>	* to the priority queue's ordering.
211		*/
212	<	public boolean remove(Object element) {
213	<	if (element == null)
214	<	throw new NullPointerException();
212	>	public boolean add(E o) {
213	>	return super.add(o);
214	>	}
215	>
216	>	/**
217	>	* @throws ClassCastException if any element cannot be compared
218	>	* with elements currently in the priority queue according
219	>	* to the priority queue's ordering.
220	>	* @throws NullPointerException if <tt>c</tt> or any element in <tt>c</tt>
221	>	* is <tt>null</tt>
222	>	*/
223	>	public boolean addAll(Collection<? extends E> c) {
224	>	return super.addAll(c);
225	>	}
226	>
227	>	public boolean remove(Object o) {
228	>	if (o == null)
229	>	return false;
230
231		if (comparator == null) {
232		for (int i = 1; i <= size; i++) {
233	<	if (((Comparable)queue[i]).compareTo(element) == 0) {
233	>	if (((Comparable<E>)queue[i]).compareTo((E)o) == 0) {
234		remove(i);
235		return true;
236		}
237		}
238		} else {
239		for (int i = 1; i <= size; i++) {
240	<	if (comparator.compare(queue[i], (E) element) == 0) {
240	>	if (comparator.compare((E)queue[i], (E)o) == 0) {
241		remove(i);
242		return true;
243		}
#	Line 207 | Line 246 | public class PriorityQueue<E> extends Ab
246		return false;
247		}
248
210	–	/**
211	–	* Returns an iterator over the elements in this priority queue.  The
212	–	* elements of the priority queue will be returned by this iterator in the
213	–	* order specified by the queue, which is to say the order they would be
214	–	* returned by repeated calls to <tt>poll</tt>.
215	–	*
216	–	* @return an <tt>Iterator</tt> over the elements in this priority queue.
217	–	*/
249		public Iterator<E> iterator() {
250	<	return new Itr();
250	>	return new Itr();
251		}
252
253		private class Itr implements Iterator<E> {
254	<	/**
255	<	* Index (into queue array) of element to be returned by
254	>	/**
255	>	* Index (into queue array) of element to be returned by
256		* subsequent call to next.
257	<	*/
258	<	int cursor = 1;
257	>	*/
258	>	private int cursor = 1;
259	>
260	>	/**
261	>	* Index of element returned by most recent call to next or
262	>	* previous.  Reset to 0 if this element is deleted by a call
263	>	* to remove.
264	>	*/
265	>	private int lastRet = 0;
266	>
267	>	/**
268	>	* The modCount value that the iterator believes that the backing
269	>	* List should have.  If this expectation is violated, the iterator
270	>	* has detected concurrent modification.
271	>	*/
272	>	private int expectedModCount = modCount;
273
274	<	/**
275	<	* Index of element returned by most recent call to next or
276	<	* previous.  Reset to 0 if this element is deleted by a call
232	<	* to remove.
233	<	*/
234	<	int lastRet = 0;
235	<
236	<	/**
237	<	* The modCount value that the iterator believes that the backing
238	<	* List should have.  If this expectation is violated, the iterator
239	<	* has detected concurrent modification.
240	<	*/
241	<	int expectedModCount = modCount;
242	<
243	<	public boolean hasNext() {
244	<	return cursor <= size;
245	<	}
274	>	public boolean hasNext() {
275	>	return cursor <= size;
276	>	}
277
278	<	public E next() {
278	>	public E next() {
279		checkForComodification();
280		if (cursor > size)
281	<	throw new NoSuchElementException();
282	<	E result = queue[cursor];
281	>	throw new NoSuchElementException();
282	>	E result = (E) queue[cursor];
283		lastRet = cursor++;
284		return result;
285	<	}
285	>	}
286
287	<	public void remove() {
288	<	if (lastRet == 0)
289	<	throw new IllegalStateException();
287	>	public void remove() {
288	>	if (lastRet == 0)
289	>	throw new IllegalStateException();
290		checkForComodification();
291
292		PriorityQueue.this.remove(lastRet);
#	Line 263 | Line 294 | public class PriorityQueue<E> extends Ab
294		cursor--;
295		lastRet = 0;
296		expectedModCount = modCount;
297	<	}
297	>	}
298
299	<	final void checkForComodification() {
300	<	if (modCount != expectedModCount)
301	<	throw new ConcurrentModificationException();
302	<	}
299	>	final void checkForComodification() {
300	>	if (modCount != expectedModCount)
301	>	throw new ConcurrentModificationException();
302	>	}
303		}
304
305		/**
306		* Returns the number of elements in this priority queue.
307	<	*
307	>	*
308		* @return the number of elements in this priority queue.
309		*/
310		public int size() {
#	Line 281 | Line 312 | public class PriorityQueue<E> extends Ab
312		}
313
314		/**
284	–	* Add the specified element to this priority queue.
285	–	*
286	–	* @param element the element to add.
287	–	* @return true
288	–	* @throws ClassCastException if the specified element cannot be compared
289	–	*            with elements currently in the priority queue according
290	–	*            to the priority queue's ordering.
291	–	* @throws NullPointerException if the specified element is null.
292	–	*/
293	–	public boolean offer(E element) {
294	–	if (element == null)
295	–	throw new NullPointerException();
296	–	modCount++;
297	–
298	–	// Grow backing store if necessary
299	–	if (++size == queue.length) {
300	–	E[] newQueue = new E[2 * queue.length];
301	–	System.arraycopy(queue, 0, newQueue, 0, size);
302	–	queue = newQueue;
303	–	}
304	–
305	–	queue[size] = element;
306	–	fixUp(size);
307	–	return true;
308	–	}
309	–
310	–	/**
315		* Remove all elements from the priority queue.
316		*/
317		public void clear() {
#	Line 331 | Line 335 | public class PriorityQueue<E> extends Ab
335		assert i <= size;
336		modCount++;
337
338	<	E result = queue[i];
338	>	E result = (E) queue[i];
339		queue[i] = queue[size];
340		queue[size--] = null;  // Drop extra ref to prevent memory leak
341		if (i <= size)
#	Line 352 | Line 356 | public class PriorityQueue<E> extends Ab
356		if (comparator == null) {
357		while (k > 1) {
358		int j = k >> 1;
359	<	if (((Comparable)queue[j]).compareTo(queue[k]) <= 0)
359	>	if (((Comparable<E>)queue[j]).compareTo((E)queue[k]) <= 0)
360		break;
361	<	E tmp = queue[j];  queue[j] = queue[k]; queue[k] = tmp;
361	>	Object tmp = queue[j];  queue[j] = queue[k]; queue[k] = tmp;
362		k = j;
363		}
364		} else {
365		while (k > 1) {
366		int j = k >> 1;
367	<	if (comparator.compare(queue[j], queue[k]) <= 0)
367	>	if (comparator.compare((E)queue[j], (E)queue[k]) <= 0)
368		break;
369	<	E tmp = queue[j];  queue[j] = queue[k]; queue[k] = tmp;
369	>	Object tmp = queue[j];  queue[j] = queue[k]; queue[k] = tmp;
370		k = j;
371		}
372		}
#	Line 381 | Line 385 | public class PriorityQueue<E> extends Ab
385		int j;
386		if (comparator == null) {
387		while ((j = k << 1) <= size) {
388	<	if (j<size && ((Comparable)queue[j]).compareTo(queue[j+1]) > 0)
388	>	if (j<size && ((Comparable<E>)queue[j]).compareTo((E)queue[j+1]) > 0)
389		j++; // j indexes smallest kid
390	<	if (((Comparable)queue[k]).compareTo(queue[j]) <= 0)
390	>	if (((Comparable<E>)queue[k]).compareTo((E)queue[j]) <= 0)
391		break;
392	<	E tmp = queue[j];  queue[j] = queue[k]; queue[k] = tmp;
392	>	Object tmp = queue[j];  queue[j] = queue[k]; queue[k] = tmp;
393		k = j;
394		}
395		} else {
396		while ((j = k << 1) <= size) {
397	<	if (j < size && comparator.compare(queue[j], queue[j+1]) > 0)
397	>	if (j < size && comparator.compare((E)queue[j], (E)queue[j+1]) > 0)
398		j++; // j indexes smallest kid
399	<	if (comparator.compare(queue[k], queue[j]) <= 0)
399	>	if (comparator.compare((E)queue[k], (E)queue[j]) <= 0)
400		break;
401	<	E tmp = queue[j];  queue[j] = queue[k]; queue[k] = tmp;
401	>	Object tmp = queue[j];  queue[j] = queue[k]; queue[k] = tmp;
402		k = j;
403		}
404		}
405		}
406
407	<	/**
404	<	* Returns the comparator associated with this priority queue, or
405	<	* <tt>null</tt> if it uses its elements' natural ordering.
406	<	*
407	<	* @return the comparator associated with this priority queue, or
408	<	*         <tt>null</tt> if it uses its elements' natural ordering.
409	<	*/
410	<	Comparator comparator() {
407	>	public Comparator<? super E> comparator() {
408		return comparator;
409		}
410
#	Line 418 | Line 415 | public class PriorityQueue<E> extends Ab
415		* @serialData The length of the array backing the instance is
416		* emitted (int), followed by all of its elements (each an
417		* <tt>Object</tt>) in the proper order.
418	+	* @param s the stream
419		*/
420		private synchronized void writeObject(java.io.ObjectOutputStream s)
421		throws java.io.IOException{
422	<	// Write out element count, and any hidden stuff
423	<	s.defaultWriteObject();
422	>	// Write out element count, and any hidden stuff
423	>	s.defaultWriteObject();
424
425		// Write out array length
426		s.writeInt(queue.length);
427
428	<	// Write out all elements in the proper order.
429	<	for (int i=0; i<size; i++)
428	>	// Write out all elements in the proper order.
429	>	for (int i=0; i<size; i++)
430		s.writeObject(queue[i]);
431		}
432
433		/**
434		* Reconstitute the <tt>ArrayList</tt> instance from a stream (that is,
435		* deserialize it).
436	+	* @param s the stream
437		*/
438		private synchronized void readObject(java.io.ObjectInputStream s)
439		throws java.io.IOException, ClassNotFoundException {
440	<	// Read in size, and any hidden stuff
441	<	s.defaultReadObject();
440	>	// Read in size, and any hidden stuff
441	>	s.defaultReadObject();
442
443		// Read in array length and allocate array
444		int arrayLength = s.readInt();
445	<	queue = new E[arrayLength];
445	>	queue = new Object[arrayLength];
446
447	<	// Read in all elements in the proper order.
448	<	for (int i=0; i<size; i++)
449	<	queue[i] = (E)s.readObject();
447	>	// Read in all elements in the proper order.
448	>	for (int i=0; i<size; i++)
449	>	queue[i] = s.readObject();
450		}
451
452		}
453	+

Diff Legend

–	Removed lines
+	Added lines
<	Changed lines
>	Changed lines