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.63 by jsr166, Tue Mar 7 07:11:39 2006 UTC vs.
Revision 1.83 by jsr166, Sat Jan 19 17:33:55 2013 UTC

#	Line 1 | Line 1
1		/*
2	<	* %W% %E%
2	>	* Copyright (c) 2003, 2012, Oracle and/or its affiliates. All rights reserved.
3	>	* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4		*
5	<	* Copyright 2006 Sun Microsystems, Inc. All rights reserved.
6	<	* SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
5	>	* This code is free software; you can redistribute it and/or modify it
6	>	* under the terms of the GNU General Public License version 2 only, as
7	>	* published by the Free Software Foundation.  Oracle designates this
8	>	* particular file as subject to the "Classpath" exception as provided
9	>	* by Oracle in the LICENSE file that accompanied this code.
10	>	*
11	>	* This code is distributed in the hope that it will be useful, but WITHOUT
12	>	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13	>	* FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14	>	* version 2 for more details (a copy is included in the LICENSE file that
15	>	* accompanied this code).
16	>	*
17	>	* You should have received a copy of the GNU General Public License version
18	>	* 2 along with this work; if not, write to the Free Software Foundation,
19	>	* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20	>	*
21	>	* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22	>	* or visit www.oracle.com if you need additional information or have any
23	>	* questions.
24		*/
25
26		package java.util;
27	+	import java.util.stream.Stream;
28	+	import java.util.Spliterator;
29	+	import java.util.stream.Streams;
30	+	import java.util.function.Block;
31
32		/**
33		* An unbounded priority {@linkplain Queue queue} based on a priority heap.
#	Line 38 | Line 60 | package java.util;
60		* the priority queue in any particular order. If you need ordered
61		* traversal, consider using {@code Arrays.sort(pq.toArray())}.
62		*
63	<	* <p> <strong>Note that this implementation is not synchronized.</strong>
63	>	* <p><strong>Note that this implementation is not synchronized.</strong>
64		* Multiple threads should not access a {@code PriorityQueue}
65		* instance concurrently if any of the threads modifies the queue.
66		* Instead, use the thread-safe {@link
#	Line 52 | Line 74 | package java.util;
74		* ({@code peek}, {@code element}, and {@code size}).
75		*
76		* <p>This class is a member of the
77	<	* <a href="{@docRoot}/../guide/collections/index.html">
77	>	* <a href="{@docRoot}/../technotes/guides/collections/index.html">
78		* Java Collections Framework</a>.
79		*
80		* @since 1.5
59	–	* @version %I%, %G%
81		* @author Josh Bloch, Doug Lea
82		* @param <E> the type of elements held in this collection
83		*/
#	Line 75 | Line 96 | public class PriorityQueue<E> extends Ab
96		* heap and each descendant d of n, n <= d.  The element with the
97		* lowest value is in queue[0], assuming the queue is nonempty.
98		*/
99	<	private transient Object[] queue;
99	>	transient Object[] queue; // non-private to simplify nested class access
100
101		/**
102		* The number of elements in the priority queue.
#	Line 92 | Line 113 | public class PriorityQueue<E> extends Ab
113		* The number of times this priority queue has been
114		* <i>structurally modified</i>.  See AbstractList for gory details.
115		*/
116	<	private transient int modCount = 0;
116	>	transient int modCount = 0; // non-private to simplify nested class access
117
118		/**
119		* Creates a {@code PriorityQueue} with the default initial
#	Line 153 | Line 174 | public class PriorityQueue<E> extends Ab
174		* @throws NullPointerException if the specified collection or any
175		*         of its elements are null
176		*/
177	+	@SuppressWarnings("unchecked")
178		public PriorityQueue(Collection<? extends E> c) {
179	<	initFromCollection(c);
180	<	if (c instanceof SortedSet)
181	<	comparator = (Comparator<? super E>)
182	<	((SortedSet<? extends E>)c).comparator();
183	<	else if (c instanceof PriorityQueue)
184	<	comparator = (Comparator<? super E>)
185	<	((PriorityQueue<? extends E>)c).comparator();
179	>	if (c instanceof SortedSet<?>) {
180	>	SortedSet<? extends E> ss = (SortedSet<? extends E>) c;
181	>	this.comparator = (Comparator<? super E>) ss.comparator();
182	>	initElementsFromCollection(ss);
183	>	}
184	>	else if (c instanceof PriorityQueue<?>) {
185	>	PriorityQueue<? extends E> pq = (PriorityQueue<? extends E>) c;
186	>	this.comparator = (Comparator<? super E>) pq.comparator();
187	>	initFromPriorityQueue(pq);
188	>	}
189		else {
190	<	comparator = null;
191	<	heapify();
190	>	this.comparator = null;
191	>	initFromCollection(c);
192		}
193		}
194
#	Line 181 | Line 206 | public class PriorityQueue<E> extends Ab
206		* @throws NullPointerException if the specified priority queue or any
207		*         of its elements are null
208		*/
209	+	@SuppressWarnings("unchecked")
210		public PriorityQueue(PriorityQueue<? extends E> c) {
211	<	comparator = (Comparator<? super E>)c.comparator();
212	<	initFromCollection(c);
211	>	this.comparator = (Comparator<? super E>) c.comparator();
212	>	initFromPriorityQueue(c);
213		}
214
215		/**
#	Line 199 | Line 225 | public class PriorityQueue<E> extends Ab
225		* @throws NullPointerException if the specified sorted set or any
226		*         of its elements are null
227		*/
228	+	@SuppressWarnings("unchecked")
229		public PriorityQueue(SortedSet<? extends E> c) {
230	<	comparator = (Comparator<? super E>)c.comparator();
231	<	initFromCollection(c);
230	>	this.comparator = (Comparator<? super E>) c.comparator();
231	>	initElementsFromCollection(c);
232	>	}
233	>
234	>	private void initFromPriorityQueue(PriorityQueue<? extends E> c) {
235	>	if (c.getClass() == PriorityQueue.class) {
236	>	this.queue = c.toArray();
237	>	this.size = c.size();
238	>	} else {
239	>	initFromCollection(c);
240	>	}
241	>	}
242	>
243	>	private void initElementsFromCollection(Collection<? extends E> c) {
244	>	Object[] a = c.toArray();
245	>	// If c.toArray incorrectly doesn't return Object[], copy it.
246	>	if (a.getClass() != Object[].class)
247	>	a = Arrays.copyOf(a, a.length, Object[].class);
248	>	int len = a.length;
249	>	if (len == 1 || this.comparator != null)
250	>	for (int i = 0; i < len; i++)
251	>	if (a[i] == null)
252	>	throw new NullPointerException();
253	>	this.queue = a;
254	>	this.size = a.length;
255		}
256
257		/**
#	Line 210 | Line 260 | public class PriorityQueue<E> extends Ab
260		* @param c the collection
261		*/
262		private void initFromCollection(Collection<? extends E> c) {
263	<	Object[] a = c.toArray();
264	<	// If c.toArray incorrectly doesn't return Object[], copy it.
215	<	if (a.getClass() != Object[].class)
216	<	a = Arrays.copyOf(a, a.length, Object[].class);
217	<	queue = a;
218	<	size = a.length;
263	>	initElementsFromCollection(c);
264	>	heapify();
265		}
266
267		/**
268	+	* The maximum size of array to allocate.
269	+	* Some VMs reserve some header words in an array.
270	+	* Attempts to allocate larger arrays may result in
271	+	* OutOfMemoryError: Requested array size exceeds VM limit
272	+	*/
273	+	private static final int MAX_ARRAY_SIZE = Integer.MAX_VALUE - 8;
274	+
275	+	/**
276		* Increases the capacity of the array.
277		*
278		* @param minCapacity the desired minimum capacity
279		*/
280		private void grow(int minCapacity) {
281	<	if (minCapacity < 0) // overflow
228	<	throw new OutOfMemoryError();
229	<	int oldCapacity = queue.length;
281	>	int oldCapacity = queue.length;
282		// Double size if small; else grow by 50%
283	<	int newCapacity = ((oldCapacity < 64)?
284	<	((oldCapacity + 1) * 2):
285	<	((oldCapacity / 2) * 3));
286	<	if (newCapacity < 0) // overflow
287	<	newCapacity = Integer.MAX_VALUE;
288	<	if (newCapacity < minCapacity)
237	<	newCapacity = minCapacity;
283	>	int newCapacity = oldCapacity + ((oldCapacity < 64) ?
284	>	(oldCapacity + 2) :
285	>	(oldCapacity >> 1));
286	>	// overflow-conscious code
287	>	if (newCapacity - MAX_ARRAY_SIZE > 0)
288	>	newCapacity = hugeCapacity(minCapacity);
289		queue = Arrays.copyOf(queue, newCapacity);
290		}
291
292	+	private static int hugeCapacity(int minCapacity) {
293	+	if (minCapacity < 0) // overflow
294	+	throw new OutOfMemoryError();
295	+	return (minCapacity > MAX_ARRAY_SIZE) ?
296	+	Integer.MAX_VALUE :
297	+	MAX_ARRAY_SIZE;
298	+	}
299	+
300		/**
301		* Inserts the specified element into this priority queue.
302		*
#	Line 275 | Line 334 | public class PriorityQueue<E> extends Ab
334		return true;
335		}
336
337	+	@SuppressWarnings("unchecked")
338		public E peek() {
339	<	if (size == 0)
280	<	return null;
281	<	return (E) queue[0];
339	>	return (size == 0) ? null : (E) queue[0];
340		}
341
342		private int indexOf(Object o) {
343	<	if (o != null) {
343	>	if (o != null) {
344		for (int i = 0; i < size; i++)
345		if (o.equals(queue[i]))
346		return i;
#	Line 302 | Line 360 | public class PriorityQueue<E> extends Ab
360		* @return {@code true} if this queue changed as a result of the call
361		*/
362		public boolean remove(Object o) {
363	<	int i = indexOf(o);
364	<	if (i == -1)
365	<	return false;
366	<	else {
367	<	removeAt(i);
368	<	return true;
369	<	}
363	>	int i = indexOf(o);
364	>	if (i == -1)
365	>	return false;
366	>	else {
367	>	removeAt(i);
368	>	return true;
369	>	}
370		}
371
372		/**
#	Line 319 | Line 377 | public class PriorityQueue<E> extends Ab
377		* @return {@code true} if removed
378		*/
379		boolean removeEq(Object o) {
380	<	for (int i = 0; i < size; i++) {
381	<	if (o == queue[i]) {
380	>	for (int i = 0; i < size; i++) {
381	>	if (o == queue[i]) {
382		removeAt(i);
383		return true;
384		}
#	Line 337 | Line 395 | public class PriorityQueue<E> extends Ab
395		* @return {@code true} if this queue contains the specified element
396		*/
397		public boolean contains(Object o) {
398	<	return indexOf(o) != -1;
398	>	return indexOf(o) != -1;
399		}
400
401		/**
#	Line 375 | Line 433 | public class PriorityQueue<E> extends Ab
433		* precise control over the runtime type of the output array, and may,
434		* under certain circumstances, be used to save allocation costs.
435		*
436	<	* <p>Suppose <tt>x</tt> is a queue known to contain only strings.
436	>	* <p>Suppose {@code x} is a queue known to contain only strings.
437		* The following code can be used to dump the queue into a newly
438	<	* allocated array of <tt>String</tt>:
438	>	* allocated array of {@code String}:
439		*
440	<	* <pre>
383	<	*     String[] y = x.toArray(new String[0]);</pre>
440	>	*  <pre> {@code String[] y = x.toArray(new String[0]);}</pre>
441		*
442	<	* Note that <tt>toArray(new Object[0])</tt> is identical in function to
443	<	* <tt>toArray()</tt>.
442	>	* Note that {@code toArray(new Object[0])} is identical in function to
443	>	* {@code toArray()}.
444		*
445		* @param a the array into which the elements of the queue are to
446		*          be stored, if it is big enough; otherwise, a new array of the
#	Line 398 | Line 455 | public class PriorityQueue<E> extends Ab
455		if (a.length < size)
456		// Make a new array of a's runtime type, but my contents:
457		return (T[]) Arrays.copyOf(queue, size, a.getClass());
458	<	System.arraycopy(queue, 0, a, 0, size);
458	>	System.arraycopy(queue, 0, a, 0, size);
459		if (a.length > size)
460		a[size] = null;
461		return a;
#	Line 459 | Line 516 | public class PriorityQueue<E> extends Ab
516		(forgetMeNot != null && !forgetMeNot.isEmpty());
517		}
518
519	+	@SuppressWarnings("unchecked")
520		public E next() {
521		if (expectedModCount != modCount)
522		throw new ConcurrentModificationException();
#	Line 491 | Line 549 | public class PriorityQueue<E> extends Ab
549		lastRetElt = null;
550		} else {
551		throw new IllegalStateException();
552	<	}
552	>	}
553		expectedModCount = modCount;
554		}
555		}
#	Line 511 | Line 569 | public class PriorityQueue<E> extends Ab
569		size = 0;
570		}
571
572	+	@SuppressWarnings("unchecked")
573		public E poll() {
574		if (size == 0)
575		return null;
#	Line 536 | Line 595 | public class PriorityQueue<E> extends Ab
595		* position before i. This fact is used by iterator.remove so as to
596		* avoid missing traversing elements.
597		*/
598	+	@SuppressWarnings("unchecked")
599		private E removeAt(int i) {
600	<	assert i >= 0 && i < size;
600	>	// assert i >= 0 && i < size;
601		modCount++;
602		int s = --size;
603		if (s == i) // removed last element
#	Line 574 | Line 634 | public class PriorityQueue<E> extends Ab
634		siftUpComparable(k, x);
635		}
636
637	+	@SuppressWarnings("unchecked")
638		private void siftUpComparable(int k, E x) {
639		Comparable<? super E> key = (Comparable<? super E>) x;
640		while (k > 0) {
#	Line 587 | Line 648 | public class PriorityQueue<E> extends Ab
648		queue[k] = key;
649		}
650
651	+	@SuppressWarnings("unchecked")
652		private void siftUpUsingComparator(int k, E x) {
653		while (k > 0) {
654		int parent = (k - 1) >>> 1;
#	Line 614 | Line 676 | public class PriorityQueue<E> extends Ab
676		siftDownComparable(k, x);
677		}
678
679	+	@SuppressWarnings("unchecked")
680		private void siftDownComparable(int k, E x) {
681		Comparable<? super E> key = (Comparable<? super E>)x;
682		int half = size >>> 1;        // loop while a non-leaf
#	Line 632 | Line 695 | public class PriorityQueue<E> extends Ab
695		queue[k] = key;
696		}
697
698	+	@SuppressWarnings("unchecked")
699		private void siftDownUsingComparator(int k, E x) {
700		int half = size >>> 1;
701		while (k < half) {
#	Line 653 | Line 717 | public class PriorityQueue<E> extends Ab
717		* Establishes the heap invariant (described above) in the entire tree,
718		* assuming nothing about the order of the elements prior to the call.
719		*/
720	+	@SuppressWarnings("unchecked")
721		private void heapify() {
722		for (int i = (size >>> 1) - 1; i >= 0; i--)
723		siftDown(i, (E) queue[i]);
#	Line 672 | Line 737 | public class PriorityQueue<E> extends Ab
737		}
738
739		/**
740	<	* Saves the state of the instance to a stream (that
676	<	* is, serializes it).
740	>	* Saves this queue to a stream (that is, serializes it).
741		*
742		* @serialData The length of the array backing the instance is
743		*             emitted (int), followed by all of its elements
#	Line 681 | Line 745 | public class PriorityQueue<E> extends Ab
745		* @param s the stream
746		*/
747		private void writeObject(java.io.ObjectOutputStream s)
748	<	throws java.io.IOException{
748	>	throws java.io.IOException {
749		// Write out element count, and any hidden stuff
750		s.defaultWriteObject();
751
752		// Write out array length, for compatibility with 1.5 version
753		s.writeInt(Math.max(2, size + 1));
754
755	<	// Write out all elements in the proper order.
755	>	// Write out all elements in the "proper order".
756		for (int i = 0; i < size; i++)
757		s.writeObject(queue[i]);
758		}
#	Line 707 | Line 771 | public class PriorityQueue<E> extends Ab
771		// Read in (and discard) array length
772		s.readInt();
773
774	<	queue = new Object[size];
774	>	queue = new Object[size];
775
776	<	// Read in all elements in the proper order.
776	>	// Read in all elements.
777		for (int i = 0; i < size; i++)
778		queue[i] = s.readObject();
779	+
780	+	// Elements are guaranteed to be in "proper order", but the
781	+	// spec has never explained what that might be.
782	+	heapify();
783	+	}
784	+
785	+	// wrapping constructor in method avoids transient javac problems
786	+	final PriorityQueueSpliterator<E> spliterator(int origin, int fence,
787	+	int expectedModCount) {
788	+	return new PriorityQueueSpliterator<E>(this, origin, fence,
789	+	expectedModCount);
790	+	}
791	+
792	+	public Stream<E> stream() {
793	+	int flags = Streams.STREAM_IS_SIZED;
794	+	return Streams.stream
795	+	(() -> spliterator(0, size, modCount), flags);
796	+	}
797	+	public Stream<E> parallelStream() {
798	+	int flags = Streams.STREAM_IS_SIZED;
799	+	return Streams.parallelStream
800	+	(() -> spliterator(0, size, modCount), flags);
801	+	}
802	+
803	+	/** Index-based split-by-two Spliterator */
804	+	static final class PriorityQueueSpliterator<E>
805	+	implements Spliterator<E>, Iterator<E> {
806	+	private final PriorityQueue<E> pq;
807	+	private int index;           // current index, modified on advance/split
808	+	private final int fence;     // one past last index
809	+	private final int expectedModCount; // for comodification checks
810	+
811	+	/** Create new spliterator covering the given  range */
812	+	PriorityQueueSpliterator(PriorityQueue<E> pq, int origin, int fence,
813	+	int expectedModCount) {
814	+	this.pq = pq; this.index = origin; this.fence = fence;
815	+	this.expectedModCount = expectedModCount;
816	+	}
817	+
818	+	public PriorityQueueSpliterator<E> trySplit() {
819	+	int lo = index, mid = (lo + fence) >>> 1;
820	+	return (lo >= mid) ? null :
821	+	new PriorityQueueSpliterator<E>(pq, lo, index = mid,
822	+	expectedModCount);
823	+	}
824	+
825	+	public void forEach(Block<? super E> block) {
826	+	Object[] a; int i, hi; // hoist accesses and checks from loop
827	+	if (block == null)
828	+	throw new NullPointerException();
829	+	if ((a = pq.queue).length >= (hi = fence) &&
830	+	(i = index) >= 0 && i < hi) {
831	+	index = hi;
832	+	do {
833	+	@SuppressWarnings("unchecked") E e = (E) a[i];
834	+	block.accept(e);
835	+	} while (++i < hi);
836	+	if (pq.modCount != expectedModCount)
837	+	throw new ConcurrentModificationException();
838	+	}
839	+	}
840	+
841	+	public boolean tryAdvance(Block<? super E> block) {
842	+	if (index >= 0 && index < fence) {
843	+	if (pq.modCount != expectedModCount)
844	+	throw new ConcurrentModificationException();
845	+	@SuppressWarnings("unchecked") E e =
846	+	(E)pq.queue[index++];
847	+	block.accept(e);
848	+	return true;
849	+	}
850	+	return false;
851	+	}
852	+
853	+	public long estimateSize() { return (long)(fence - index); }
854	+	public boolean hasExactSize() { return true; }
855	+	public boolean hasExactSplits() { return true; }
856	+
857	+	// Iterator support
858	+	public Iterator<E> iterator() { return this; }
859	+	public void remove() { throw new UnsupportedOperationException(); }
860	+	public boolean hasNext() { return index >= 0 && index < fence; }
861	+
862	+	public E next() {
863	+	if (index < 0 || index >= fence)
864	+	throw new NoSuchElementException();
865	+	if (pq.modCount != expectedModCount)
866	+	throw new ConcurrentModificationException();
867	+	@SuppressWarnings("unchecked") E e =
868	+	(E) pq.queue[index++];
869	+	return e;
870	+	}
871		}
872		}

Diff Legend

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