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.20 by dholmes, Tue Aug 5 06:18:17 2003 UTC vs.
Revision 1.26 by tim, Fri Aug 8 20:05:07 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	>	* An unbounded priority {@linkplain Queue queue} based on a priority heap.
5	>	* This queue orders
6		* elements according to an order specified at construction time, which is
7		* specified in the same manner as {@link java.util.TreeSet} and
8		* {@link java.util.TreeMap}: elements are ordered
#	Line 41 | Line 42
42		* @author Josh Bloch
43		*/
44		public class PriorityQueue<E> extends AbstractQueue<E>
45	<	implements Sorted, Queue<E>, java.io.Serializable {
45	>	implements Queue<E>, java.io.Serializable {
46
47		private static final int DEFAULT_INITIAL_CAPACITY = 11;
48
#	Line 78 | Line 79 | public class PriorityQueue<E> extends Ab
79		private transient int modCount = 0;
80
81		/**
82	<	* Create a <tt>PriorityQueue</tt> with the default initial capacity
82	>	* Creates a <tt>PriorityQueue</tt> with the default initial capacity
83		* (11) that orders its elements according to their natural
84	<	* ordering (using <tt>Comparable</tt>.)
84	>	* ordering (using <tt>Comparable</tt>).
85		*/
86		public PriorityQueue() {
87		this(DEFAULT_INITIAL_CAPACITY, null);
88		}
89
90		/**
91	<	* Create a <tt>PriorityQueue</tt> with the specified initial capacity
91	>	* Creates a <tt>PriorityQueue</tt> with the specified initial capacity
92		* that orders its elements according to their natural ordering
93	<	* (using <tt>Comparable</tt>.)
93	>	* (using <tt>Comparable</tt>).
94		*
95		* @param initialCapacity the initial capacity for this priority queue.
96	+	* @throws IllegalArgumentException if <tt>initialCapacity</tt> is less
97	+	* than 1
98		*/
99		public PriorityQueue(int initialCapacity) {
100		this(initialCapacity, null);
101		}
102
103		/**
104	<	* Create a <tt>PriorityQueue</tt> with the specified initial capacity
104	>	* Creates a <tt>PriorityQueue</tt> with the specified initial capacity
105		* that orders its elements according to the specified comparator.
106		*
107		* @param initialCapacity the initial capacity for this priority queue.
#	Line 108 | Line 111 | public class PriorityQueue<E> extends Ab
111		* @throws IllegalArgumentException if <tt>initialCapacity</tt> is less
112		* than 1
113		*/
114	<	public PriorityQueue(int initialCapacity, Comparator<? super E> comparator) {
114	>	public PriorityQueue(int initialCapacity,
115	>	Comparator<? super E> comparator) {
116		if (initialCapacity < 1)
117		throw new IllegalArgumentException();
118		this.queue = new Object[initialCapacity + 1];
#	Line 116 | Line 120 | public class PriorityQueue<E> extends Ab
120		}
121
122		/**
123	<	* Create a <tt>PriorityQueue</tt> containing the elements in the specified
124	<	* collection.  The priority queue has an initial capacity of 110% of the
125	<	* size of the specified collection or 1 if the collection is empty.
126	<	* If the specified collection
127	<	* implements the {@link Sorted} interface, the priority queue will be
128	<	* sorted according to the same comparator, or according to its elements'
129	<	* natural order if the collection is sorted according to its elements'
130	<	* natural order.  If the specified collection does not implement
131	<	* <tt>Sorted</tt>, the priority queue is ordered according to
132	<	* its elements' natural order.
123	>	* Common code to initialize underlying queue array across
124	>	* constructors below.
125	>	*/
126	>	private void initializeArray(Collection<? extends E> c) {
127	>	int sz = c.size();
128	>	int initialCapacity = (int)Math.min((sz * 110L) / 100,
129	>	Integer.MAX_VALUE - 1);
130	>	if (initialCapacity < 1)
131	>	initialCapacity = 1;
132	>
133	>	this.queue = new Object[initialCapacity + 1];
134	>	}
135	>
136	>	/**
137	>	* Initially fill elements of the queue array under the
138	>	* knowledge that it is sorted or is another PQ, in which
139	>	* case we can just place the elements without fixups.
140	>	*/
141	>	private void fillFromSorted(Collection<? extends E> c) {
142	>	for (Iterator<? extends E> i = c.iterator(); i.hasNext(); )
143	>	queue[++size] = i.next();
144	>	}
145	>
146	>
147	>	/**
148	>	* Initially fill elements of the queue array that is
149	>	* not to our knowledge sorted, so we must add them
150	>	* one by one.
151	>	*/
152	>	private void fillFromUnsorted(Collection<? extends E> c) {
153	>	for (Iterator<? extends E> i = c.iterator(); i.hasNext(); )
154	>	add(i.next());
155	>	}
156	>
157	>	/**
158	>	* Creates a <tt>PriorityQueue</tt> containing the elements in the
159	>	* specified collection.  The priority queue has an initial
160	>	* capacity of 110% of the size of the specified collection or 1
161	>	* if the collection is empty.  If the specified collection is an
162	>	* instance of a {@link java.util.SortedSet} or is another
163	>	* <tt>PriorityQueue</tt>, the priority queue will be sorted
164	>	* according to the same comparator, or according to its elements'
165	>	* natural order if the collection is sorted according to its
166	>	* elements' natural order.  Otherwise, the priority queue is
167	>	* ordered according to its elements' natural order.
168		*
169		* @param c the collection whose elements are to be placed
170		*        into this priority queue.
#	Line 136 | Line 175 | public class PriorityQueue<E> extends Ab
175		* is <tt>null</tt>
176		*/
177		public PriorityQueue(Collection<? extends E> c) {
178	<	int sz = c.size();
179	<	int initialCapacity = (int)Math.min((sz * 110L) / 100,
180	<	Integer.MAX_VALUE - 1);
181	<	if (initialCapacity < 1)
182	<	initialCapacity = 1;
183	<
184	<	this.queue = new Object[initialCapacity + 1];
185	<
186	<	if (c instanceof Sorted) {
148	<	comparator = (Comparator<? super E>)((Sorted)c).comparator();
178	>	initializeArray(c);
179	>	if (c instanceof SortedSet<? extends E>) {
180	>	SortedSet<? extends E> s = (SortedSet<? extends E>) c;
181	>	comparator = (Comparator<? super E>)s.comparator();
182	>	fillFromSorted(s);
183	>	} else if (c instanceof PriorityQueue<? extends E>) {
184	>	PriorityQueue<? extends E> s = (PriorityQueue<? extends E>) c;
185	>	comparator = (Comparator<? super E>)s.comparator();
186	>	fillFromSorted(s);
187		} else {
188		comparator = null;
189	+	fillFromUnsorted(c);
190		}
191	+	}
192
193	<	for (Iterator<? extends E> i = c.iterator(); i.hasNext(); )
194	<	add(i.next());
193	>	/**
194	>	* Creates a <tt>PriorityQueue</tt> containing the elements in the
195	>	* specified collection.  The priority queue has an initial
196	>	* capacity of 110% of the size of the specified collection or 1
197	>	* if the collection is empty.  This priority queue will be sorted
198	>	* according to the same comparator as the given collection, or
199	>	* according to its elements' natural order if the collection is
200	>	* sorted according to its elements' natural order.
201	>	*
202	>	* @param c the collection whose elements are to be placed
203	>	*        into this priority queue.
204	>	* @throws ClassCastException if elements of the specified collection
205	>	*         cannot be compared to one another according to the priority
206	>	*         queue's ordering.
207	>	* @throws NullPointerException if <tt>c</tt> or any element within it
208	>	* is <tt>null</tt>
209	>	*/
210	>	public PriorityQueue(PriorityQueue<? extends E> c) {
211	>	initializeArray(c);
212	>	comparator = (Comparator<? super E>)c.comparator();
213	>	fillFromSorted(c);
214	>	}
215	>
216	>	/**
217	>	* Creates a <tt>PriorityQueue</tt> containing the elements in the
218	>	* specified collection.  The priority queue has an initial
219	>	* capacity of 110% of the size of the specified collection or 1
220	>	* if the collection is empty.  This priority queue will be sorted
221	>	* according to the same comparator as the given collection, or
222	>	* according to its elements' natural order if the collection is
223	>	* sorted according to its elements' natural order.
224	>	*
225	>	* @param c the collection whose elements are to be placed
226	>	*        into this priority queue.
227	>	* @throws ClassCastException if elements of the specified collection
228	>	*         cannot be compared to one another according to the priority
229	>	*         queue's ordering.
230	>	* @throws NullPointerException if <tt>c</tt> or any element within it
231	>	* is <tt>null</tt>
232	>	*/
233	>	public PriorityQueue(SortedSet<? extends E> c) {
234	>	initializeArray(c);
235	>	comparator = (Comparator<? super E>)c.comparator();
236	>	fillFromSorted(c);
237		}
238
239	+	/**
240	+	* Resize array, if necessary, to be able to hold given index
241	+	*/
242	+	private void grow(int index) {
243	+	int newlen = queue.length;
244	+	if (index < newlen) // don't need to grow
245	+	return;
246	+	if (index == Integer.MAX_VALUE)
247	+	throw new OutOfMemoryError();
248	+	while (newlen <= index) {
249	+	if (newlen >= Integer.MAX_VALUE / 2)  // avoid overflow
250	+	newlen = Integer.MAX_VALUE;
251	+	else
252	+	newlen <<= 2;
253	+	}
254	+	Object[] newQueue = new Object[newlen];
255	+	System.arraycopy(queue, 0, newQueue, 0, queue.length);
256	+	queue = newQueue;
257	+	}
258	+
259		// Queue Methods
260
261	+
262	+
263		/**
264		* Add the specified element to this priority queue.
265		*
#	Line 172 | Line 276 | public class PriorityQueue<E> extends Ab
276		++size;
277
278		// Grow backing store if necessary
279	<	while (size >= queue.length) {
280	<	Object[] newQueue = new Object[2 * queue.length];
177	<	System.arraycopy(queue, 0, newQueue, 0, queue.length);
178	<	queue = newQueue;
179	<	}
279	>	if (size >= queue.length)
280	>	grow(size);
281
282		queue[size] = o;
283		fixUp(size);
#	Line 193 | Line 294 | public class PriorityQueue<E> extends Ab
294		return (E) queue[1];
295		}
296
297	<	// Collection Methods
197	<
198	<	// these first two override just to get the throws docs
297	>	// Collection Methods - the first two override to update docs
298
299		/**
300	<	* @throws NullPointerException if the specified element is <tt>null</tt>.
300	>	* Adds the specified element to this queue.
301	>	* @return <tt>true</tt> (as per the general contract of
302	>	* <tt>Collection.add</tt>).
303	>	*
304	>	* @throws NullPointerException {@inheritDoc}
305		* @throws ClassCastException if the specified element cannot be compared
306		* with elements currently in the priority queue according
307		* to the priority queue's ordering.
#	Line 207 | Line 310 | public class PriorityQueue<E> extends Ab
310		return super.add(o);
311		}
312
313	+
314		/**
315	+	* Adds all of the elements in the specified collection to this queue.
316	+	* The behavior of this operation is undefined if
317	+	* the specified collection is modified while the operation is in
318	+	* progress.  (This implies that the behavior of this call is undefined if
319	+	* the specified collection is this queue, and this queue is nonempty.)
320	+	* <p>
321	+	* This implementation iterates over the specified collection, and adds
322	+	* each object returned by the iterator to this collection, in turn.
323	+	* @throws NullPointerException {@inheritDoc}
324		* @throws ClassCastException if any element cannot be compared
325		* with elements currently in the priority queue according
326		* to the priority queue's ordering.
214	–	* @throws NullPointerException if <tt>c</tt> or any element in <tt>c</tt>
215	–	* is <tt>null</tt>
327		*/
328		public boolean addAll(Collection<? extends E> c) {
329		return super.addAll(c);
330		}
331
332	+
333	+	/**
334	+	* Removes a single instance of the specified element from this
335	+	* queue, if it is present.  More formally,
336	+	* removes an element <tt>e</tt> such that <tt>(o==null ? e==null :
337	+	* o.equals(e))</tt>, if the queue contains one or more such
338	+	* elements.  Returns <tt>true</tt> if the queue contained the
339	+	* specified element (or equivalently, if the queue changed as a
340	+	* result of the call).
341	+	*
342	+	* <p>This implementation iterates over the queue looking for the
343	+	* specified element.  If it finds the element, it removes the element
344	+	* from the queue using the iterator's remove method.<p>
345	+	*
346	+	*/
347		public boolean remove(Object o) {
348		if (o == null)
349		return false;
#	Line 240 | Line 366 | public class PriorityQueue<E> extends Ab
366		return false;
367		}
368
369	+	/**
370	+	* Returns an iterator over the elements in this queue. The iterator
371	+	* does not return the elements in any particular order.
372	+	*
373	+	* @return an iterator over the elements in this queue.
374	+	*/
375		public Iterator<E> iterator() {
376		return new Itr();
377		}
#	Line 296 | Line 428 | public class PriorityQueue<E> extends Ab
428		}
429		}
430
299	–	/**
300	–	* Returns the number of elements in this priority queue.
301	–	*
302	–	* @return the number of elements in this priority queue.
303	–	*/
431		public int size() {
432		return size;
433		}
#	Line 398 | Line 525 | public class PriorityQueue<E> extends Ab
525		}
526		}
527
528	+
529	+	/**
530	+	* Returns the comparator used to order this collection, or <tt>null</tt>
531	+	* if this collection is sorted according to its elements natural ordering
532	+	* (using <tt>Comparable</tt>).
533	+	*
534	+	* @return the comparator used to order this collection, or <tt>null</tt>
535	+	* if this collection is sorted according to its elements natural ordering.
536	+	*/
537		public Comparator<? super E> comparator() {
538		return comparator;
539		}
#	Line 411 | Line 547 | public class PriorityQueue<E> extends Ab
547		* <tt>Object</tt>) in the proper order.
548		* @param s the stream
549		*/
550	<	private synchronized void writeObject(java.io.ObjectOutputStream s)
550	>	private void writeObject(java.io.ObjectOutputStream s)
551		throws java.io.IOException{
552		// Write out element count, and any hidden stuff
553		s.defaultWriteObject();
#	Line 429 | Line 565 | public class PriorityQueue<E> extends Ab
565		* deserialize it).
566		* @param s the stream
567		*/
568	<	private synchronized void readObject(java.io.ObjectInputStream s)
568	>	private void readObject(java.io.ObjectInputStream s)
569		throws java.io.IOException, ClassNotFoundException {
570		// Read in size, and any hidden stuff
571		s.defaultReadObject();

Diff Legend

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