ViewVC Help
View File | Revision Log | Show Annotations | Download File | Root Listing
root/jsr166/jsr166/src/main/java/util/PriorityQueue.java
(Generate patch)

Comparing jsr166/src/main/java/util/PriorityQueue.java (file contents):
Revision 1.61 by jsr166, Tue Feb 7 20:54:24 2006 UTC vs.
Revision 1.72 by jsr166, Fri Jun 10 00:20:44 2011 UTC

# Line 1 | Line 1
1   /*
2 < * %W% %E%
2 > * Copyright (c) 2003, 2006, 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.  Sun designates this
8 > * particular file as subject to the "Classpath" exception as provided
9 > * by Sun 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  
28   /**
29 < * An unbounded priority {@linkplain Queue queue} based on a priority
30 < * heap.  The elements of the priority queue are ordered according to
31 < * their {@linkplain Comparable natural ordering}, or by a {@link
32 < * Comparator} provided at queue construction time, depending on which
33 < * constructor is used.  A priority queue does not permit
34 < * <tt>null</tt> elements.  A priority queue relying on natural
35 < * ordering also does not permit insertion of non-comparable objects
36 < * (doing so may result in <tt>ClassCastException</tt>).
29 > * An unbounded priority {@linkplain Queue queue} based on a priority heap.
30 > * The elements of the priority queue are ordered according to their
31 > * {@linkplain Comparable natural ordering}, or by a {@link Comparator}
32 > * provided at queue construction time, depending on which constructor is
33 > * used.  A priority queue does not permit {@code null} elements.
34 > * A priority queue relying on natural ordering also does not permit
35 > * insertion of non-comparable objects (doing so may result in
36 > * {@code ClassCastException}).
37   *
38   * <p>The <em>head</em> of this queue is the <em>least</em> element
39   * with respect to the specified ordering.  If multiple elements are
40   * tied for least value, the head is one of those elements -- ties are
41 < * broken arbitrarily.  The queue retrieval operations <tt>poll</tt>,
42 < * <tt>remove</tt>, <tt>peek</tt>, and <tt>element</tt> access the
41 > * broken arbitrarily.  The queue retrieval operations {@code poll},
42 > * {@code remove}, {@code peek}, and {@code element} access the
43   * element at the head of the queue.
44   *
45   * <p>A priority queue is unbounded, but has an internal
# Line 36 | Line 54 | package java.util;
54   * Iterator} interfaces.  The Iterator provided in method {@link
55   * #iterator()} is <em>not</em> guaranteed to traverse the elements of
56   * the priority queue in any particular order. If you need ordered
57 < * traversal, consider using <tt>Arrays.sort(pq.toArray())</tt>.
57 > * traversal, consider using {@code Arrays.sort(pq.toArray())}.
58   *
59   * <p> <strong>Note that this implementation is not synchronized.</strong>
60 < * Multiple threads should not access a <tt>PriorityQueue</tt>
61 < * instance concurrently if any of the threads modifies the list
62 < * structurally. Instead, use the thread-safe {@link
60 > * Multiple threads should not access a {@code PriorityQueue}
61 > * instance concurrently if any of the threads modifies the queue.
62 > * Instead, use the thread-safe {@link
63   * java.util.concurrent.PriorityBlockingQueue} class.
64   *
65 < * <p>Implementation note: this implementation provides O(log(n)) time
66 < * for the insertion methods (<tt>offer</tt>, <tt>poll</tt>,
67 < * <tt>remove()</tt> and <tt>add</tt>) methods; linear time for the
68 < * <tt>remove(Object)</tt> and <tt>contains(Object)</tt> methods; and
69 < * constant time for the retrieval methods (<tt>peek</tt>,
70 < * <tt>element</tt>, and <tt>size</tt>).
65 > * <p>Implementation note: this implementation provides
66 > * O(log(n)) time for the enqueing and dequeing methods
67 > * ({@code offer}, {@code poll}, {@code remove()} and {@code add});
68 > * linear time for the {@code remove(Object)} and {@code contains(Object)}
69 > * methods; and constant time for the retrieval methods
70 > * ({@code peek}, {@code element}, and {@code size}).
71   *
72   * <p>This class is a member of the
73 < * <a href="{@docRoot}/../guide/collections/index.html">
73 > * <a href="{@docRoot}/../technotes/guides/collections/index.html">
74   * Java Collections Framework</a>.
75 + *
76   * @since 1.5
77 < * @version 1.8, 08/27/05
59 < * @author Josh Bloch
77 > * @author Josh Bloch, Doug Lea
78   * @param <E> the type of elements held in this collection
79   */
80   public class PriorityQueue<E> extends AbstractQueue<E>
# Line 94 | Line 112 | public class PriorityQueue<E> extends Ab
112      private transient int modCount = 0;
113  
114      /**
115 <     * Creates a <tt>PriorityQueue</tt> with the default initial
115 >     * Creates a {@code PriorityQueue} with the default initial
116       * capacity (11) that orders its elements according to their
117       * {@linkplain Comparable natural ordering}.
118       */
# Line 103 | Line 121 | public class PriorityQueue<E> extends Ab
121      }
122  
123      /**
124 <     * Creates a <tt>PriorityQueue</tt> with the specified initial
124 >     * Creates a {@code PriorityQueue} with the specified initial
125       * capacity that orders its elements according to their
126       * {@linkplain Comparable natural ordering}.
127       *
128       * @param initialCapacity the initial capacity for this priority queue
129 <     * @throws IllegalArgumentException if <tt>initialCapacity</tt> is less
130 <     * than 1
129 >     * @throws IllegalArgumentException if {@code initialCapacity} is less
130 >     *         than 1
131       */
132      public PriorityQueue(int initialCapacity) {
133          this(initialCapacity, null);
134      }
135  
136      /**
137 <     * Creates a <tt>PriorityQueue</tt> with the specified initial capacity
137 >     * Creates a {@code PriorityQueue} with the specified initial capacity
138       * that orders its elements according to the specified comparator.
139       *
140       * @param  initialCapacity the initial capacity for this priority queue
141 <     * @param  comparator the comparator that will be used to order
142 <     *         this priority queue.  If <tt>null</tt>, the <i>natural
143 <     *         ordering</i> of the elements will be used.
144 <     * @throws IllegalArgumentException if <tt>initialCapacity</tt> is
141 >     * @param  comparator the comparator that will be used to order this
142 >     *         priority queue.  If {@code null}, the {@linkplain Comparable
143 >     *         natural ordering} of the elements will be used.
144 >     * @throws IllegalArgumentException if {@code initialCapacity} is
145       *         less than 1
146       */
147      public PriorityQueue(int initialCapacity,
# Line 137 | Line 155 | public class PriorityQueue<E> extends Ab
155      }
156  
157      /**
158 <     * Creates a <tt>PriorityQueue</tt> containing the elements in the
159 <     * specified collection.   If the specified collection is an
160 <     * instance of a {@link java.util.SortedSet} or is another
161 <     * <tt>PriorityQueue</tt>, the priority queue will be ordered
162 <     * according to the same ordering.  Otherwise, this priority queue
163 <     * will be ordered according to the natural ordering of its elements.
158 >     * Creates a {@code PriorityQueue} containing the elements in the
159 >     * specified collection.  If the specified collection is an instance of
160 >     * a {@link SortedSet} or is another {@code PriorityQueue}, this
161 >     * priority queue will be ordered according to the same ordering.
162 >     * Otherwise, this priority queue will be ordered according to the
163 >     * {@linkplain Comparable natural ordering} of its elements.
164       *
165       * @param  c the collection whose elements are to be placed
166       *         into this priority queue
# Line 152 | Line 170 | public class PriorityQueue<E> extends Ab
170       * @throws NullPointerException if the specified collection or any
171       *         of its elements are null
172       */
173 +    @SuppressWarnings("unchecked")
174      public PriorityQueue(Collection<? extends E> c) {
175 <        initFromCollection(c);
176 <        if (c instanceof SortedSet)
177 <            comparator = (Comparator<? super E>)
178 <                ((SortedSet<? extends E>)c).comparator();
179 <        else if (c instanceof PriorityQueue)
180 <            comparator = (Comparator<? super E>)
181 <                ((PriorityQueue<? extends E>)c).comparator();
175 >        if (c instanceof SortedSet<?>) {
176 >            SortedSet<? extends E> ss = (SortedSet<? extends E>) c;
177 >            this.comparator = (Comparator<? super E>) ss.comparator();
178 >            initElementsFromCollection(ss);
179 >        }
180 >        else if (c instanceof PriorityQueue<?>) {
181 >            PriorityQueue<? extends E> pq = (PriorityQueue<? extends E>) c;
182 >            this.comparator = (Comparator<? super E>) pq.comparator();
183 >            initFromPriorityQueue(pq);
184 >        }
185          else {
186 <            comparator = null;
187 <            heapify();
186 >            this.comparator = null;
187 >            initFromCollection(c);
188          }
189      }
190  
191      /**
192 <     * Creates a <tt>PriorityQueue</tt> containing the elements in the
192 >     * Creates a {@code PriorityQueue} containing the elements in the
193       * specified priority queue.  This priority queue will be
194       * ordered according to the same ordering as the given priority
195       * queue.
196       *
197       * @param  c the priority queue whose elements are to be placed
198       *         into this priority queue
199 <     * @throws ClassCastException if elements of <tt>c</tt> cannot be
200 <     *         compared to one another according to <tt>c</tt>'s
199 >     * @throws ClassCastException if elements of {@code c} cannot be
200 >     *         compared to one another according to {@code c}'s
201       *         ordering
202       * @throws NullPointerException if the specified priority queue or any
203       *         of its elements are null
204       */
205 +    @SuppressWarnings("unchecked")
206      public PriorityQueue(PriorityQueue<? extends E> c) {
207 <        comparator = (Comparator<? super E>)c.comparator();
208 <        initFromCollection(c);
207 >        this.comparator = (Comparator<? super E>) c.comparator();
208 >        initFromPriorityQueue(c);
209      }
210  
211      /**
212 <     * Creates a <tt>PriorityQueue</tt> containing the elements in the
213 <     * specified sorted set.  This priority queue will be ordered
212 >     * Creates a {@code PriorityQueue} containing the elements in the
213 >     * specified sorted set.   This priority queue will be ordered
214       * according to the same ordering as the given sorted set.
215       *
216       * @param  c the sorted set whose elements are to be placed
217 <     *         into this priority queue.
217 >     *         into this priority queue
218       * @throws ClassCastException if elements of the specified sorted
219       *         set cannot be compared to one another according to the
220       *         sorted set's ordering
221       * @throws NullPointerException if the specified sorted set or any
222       *         of its elements are null
223       */
224 +    @SuppressWarnings("unchecked")
225      public PriorityQueue(SortedSet<? extends E> c) {
226 <        comparator = (Comparator<? super E>)c.comparator();
227 <        initFromCollection(c);
226 >        this.comparator = (Comparator<? super E>) c.comparator();
227 >        initElementsFromCollection(c);
228      }
229  
230 <    /**
231 <     * Initialize queue array with elements from the given Collection.
232 <     * @param c the collection
233 <     */
234 <    private void initFromCollection(Collection<? extends E> c) {
230 >    private void initFromPriorityQueue(PriorityQueue<? extends E> c) {
231 >        if (c.getClass() == PriorityQueue.class) {
232 >            this.queue = c.toArray();
233 >            this.size = c.size();
234 >        } else {
235 >            initFromCollection(c);
236 >        }
237 >    }
238 >
239 >    private void initElementsFromCollection(Collection<? extends E> c) {
240          Object[] a = c.toArray();
241          // If c.toArray incorrectly doesn't return Object[], copy it.
242          if (a.getClass() != Object[].class)
243              a = Arrays.copyOf(a, a.length, Object[].class);
244 <        queue = a;
245 <        size = a.length;
244 >        int len = a.length;
245 >        if (len == 1 || this.comparator != null)
246 >            for (int i = 0; i < len; i++)
247 >                if (a[i] == null)
248 >                    throw new NullPointerException();
249 >        this.queue = a;
250 >        this.size = a.length;
251      }
252  
253      /**
254 +     * Initializes queue array with elements from the given Collection.
255 +     *
256 +     * @param c the collection
257 +     */
258 +    private void initFromCollection(Collection<? extends E> c) {
259 +        initElementsFromCollection(c);
260 +        heapify();
261 +    }
262 +
263 +    /**
264 +     * The maximum size of array to allocate.
265 +     * Some VMs reserve some header words in an array.
266 +     * Attempts to allocate larger arrays may result in
267 +     * OutOfMemoryError: Requested array size exceeds VM limit
268 +     */
269 +    private static final int MAX_ARRAY_SIZE = Integer.MAX_VALUE - 8;
270 +
271 +    /**
272       * Increases the capacity of the array.
273       *
274       * @param minCapacity the desired minimum capacity
275       */
276      private void grow(int minCapacity) {
277 <        if (minCapacity < 0) // overflow
226 <            throw new OutOfMemoryError();
227 <        int oldCapacity = queue.length;
277 >        int oldCapacity = queue.length;
278          // Double size if small; else grow by 50%
279 <        int newCapacity = ((oldCapacity < 64)?
280 <                           ((oldCapacity + 1) * 2):
281 <                           ((oldCapacity / 2) * 3));
282 <        if (newCapacity < 0) // overflow
283 <            newCapacity = Integer.MAX_VALUE;
284 <        if (newCapacity < minCapacity)
235 <            newCapacity = minCapacity;
279 >        int newCapacity = oldCapacity + ((oldCapacity < 64) ?
280 >                                         (oldCapacity + 2) :
281 >                                         (oldCapacity >> 1));
282 >        // overflow-conscious code
283 >        if (newCapacity - MAX_ARRAY_SIZE > 0)
284 >            newCapacity = hugeCapacity(minCapacity);
285          queue = Arrays.copyOf(queue, newCapacity);
286      }
287  
288 +    private static int hugeCapacity(int minCapacity) {
289 +        if (minCapacity < 0) // overflow
290 +            throw new OutOfMemoryError();
291 +        return (minCapacity > MAX_ARRAY_SIZE) ?
292 +            Integer.MAX_VALUE :
293 +            MAX_ARRAY_SIZE;
294 +    }
295 +
296      /**
297       * Inserts the specified element into this priority queue.
298       *
299 <     * @return <tt>true</tt> (as specified by {@link Collection#add})
299 >     * @return {@code true} (as specified by {@link Collection#add})
300       * @throws ClassCastException if the specified element cannot be
301       *         compared with elements currently in this priority queue
302       *         according to the priority queue's ordering
# Line 252 | Line 309 | public class PriorityQueue<E> extends Ab
309      /**
310       * Inserts the specified element into this priority queue.
311       *
312 <     * @return <tt>true</tt> (as specified by {@link Queue#offer})
312 >     * @return {@code true} (as specified by {@link Queue#offer})
313       * @throws ClassCastException if the specified element cannot be
314       *         compared with elements currently in this priority queue
315       *         according to the priority queue's ordering
# Line 280 | Line 337 | public class PriorityQueue<E> extends Ab
337      }
338  
339      private int indexOf(Object o) {
340 <        if (o != null) {
340 >        if (o != null) {
341              for (int i = 0; i < size; i++)
342                  if (o.equals(queue[i]))
343                      return i;
# Line 290 | Line 347 | public class PriorityQueue<E> extends Ab
347  
348      /**
349       * Removes a single instance of the specified element from this queue,
350 <     * if it is present.  More formally, removes an element <tt>e</tt> such
351 <     * that <tt>o.equals(e)</tt>, if this queue contains one or more such
352 <     * elements.  Returns true if this queue contained the specified element
353 <     * (or equivalently, if this queue changed as a result of the call).
350 >     * if it is present.  More formally, removes an element {@code e} such
351 >     * that {@code o.equals(e)}, if this queue contains one or more such
352 >     * elements.  Returns {@code true} if and only if this queue contained
353 >     * the specified element (or equivalently, if this queue changed as a
354 >     * result of the call).
355       *
356       * @param o element to be removed from this queue, if present
357 <     * @return <tt>true</tt> if this queue changed as a result of the call
357 >     * @return {@code true} if this queue changed as a result of the call
358       */
359      public boolean remove(Object o) {
360 <        int i = indexOf(o);
361 <        if (i == -1)
362 <            return false;
363 <        else {
364 <            removeAt(i);
365 <            return true;
366 <        }
360 >        int i = indexOf(o);
361 >        if (i == -1)
362 >            return false;
363 >        else {
364 >            removeAt(i);
365 >            return true;
366 >        }
367      }
368  
369      /**
# Line 313 | Line 371 | public class PriorityQueue<E> extends Ab
371       * Needed by iterator.remove.
372       *
373       * @param o element to be removed from this queue, if present
374 <     * @return <tt>true</tt> if removed
374 >     * @return {@code true} if removed
375       */
376      boolean removeEq(Object o) {
377 <        for (int i = 0; i < size; i++) {
378 <            if (o == queue[i]) {
377 >        for (int i = 0; i < size; i++) {
378 >            if (o == queue[i]) {
379                  removeAt(i);
380                  return true;
381              }
# Line 326 | Line 384 | public class PriorityQueue<E> extends Ab
384      }
385  
386      /**
387 <     * Returns <tt>true</tt> if this queue contains the specified element.
388 <     * More formally, returns <tt>true</tt> if and only if this queue contains
389 <     * at least one element <tt>e</tt> such that <tt>o.equals(e)</tt>.
387 >     * Returns {@code true} if this queue contains the specified element.
388 >     * More formally, returns {@code true} if and only if this queue contains
389 >     * at least one element {@code e} such that {@code o.equals(e)}.
390       *
391       * @param o object to be checked for containment in this queue
392 <     * @return <tt>true</tt> if this queue contains the specified element
392 >     * @return {@code true} if this queue contains the specified element
393       */
394      public boolean contains(Object o) {
395 <        return indexOf(o) != -1;
395 >        return indexOf(o) != -1;
396      }
397  
398      /**
399 <     * Returns an array containing all of the elements in this queue,
399 >     * Returns an array containing all of the elements in this queue.
400       * The elements are in no particular order.
401       *
402       * <p>The returned array will be "safe" in that no references to it are
403 <     * maintained by this list.  (In other words, this method must allocate
403 >     * maintained by this queue.  (In other words, this method must allocate
404       * a new array).  The caller is thus free to modify the returned array.
405       *
406 +     * <p>This method acts as bridge between array-based and collection-based
407 +     * APIs.
408 +     *
409       * @return an array containing all of the elements in this queue
410       */
411      public Object[] toArray() {
# Line 352 | Line 413 | public class PriorityQueue<E> extends Ab
413      }
414  
415      /**
416 <     * Returns an array containing all of the elements in this queue.
417 <     * The elements are in no particular order.  The runtime type of
418 <     * the returned array is that of the specified array.  If the queue
419 <     * fits in the specified array, it is returned therein.
420 <     * Otherwise, a new array is allocated with the runtime type of
421 <     * the specified array and the size of this queue.
416 >     * Returns an array containing all of the elements in this queue; the
417 >     * runtime type of the returned array is that of the specified array.
418 >     * The returned array elements are in no particular order.
419 >     * If the queue fits in the specified array, it is returned therein.
420 >     * Otherwise, a new array is allocated with the runtime type of the
421 >     * specified array and the size of this queue.
422       *
423       * <p>If the queue fits in the specified array with room to spare
424       * (i.e., the array has more elements than the queue), the element in
425       * the array immediately following the end of the collection is set to
426 <     * <tt>null</tt>.  (This is useful in determining the length of the
427 <     * queue <i>only</i> if the caller knows that the queue does not contain
428 <     * any null elements.)
426 >     * {@code null}.
427 >     *
428 >     * <p>Like the {@link #toArray()} method, this method acts as bridge between
429 >     * array-based and collection-based APIs.  Further, this method allows
430 >     * precise control over the runtime type of the output array, and may,
431 >     * under certain circumstances, be used to save allocation costs.
432 >     *
433 >     * <p>Suppose <tt>x</tt> is a queue known to contain only strings.
434 >     * The following code can be used to dump the queue into a newly
435 >     * allocated array of <tt>String</tt>:
436 >     *
437 >     *  <pre> {@code String[] y = x.toArray(new String[0]);}</pre>
438 >     *
439 >     * Note that <tt>toArray(new Object[0])</tt> is identical in function to
440 >     * <tt>toArray()</tt>.
441       *
442       * @param a the array into which the elements of the queue are to
443       *          be stored, if it is big enough; otherwise, a new array of the
444       *          same runtime type is allocated for this purpose.
445 <     * @return an array containing the elements of the queue
445 >     * @return an array containing all of the elements in this queue
446       * @throws ArrayStoreException if the runtime type of the specified array
447       *         is not a supertype of the runtime type of every element in
448       *         this queue
# Line 379 | Line 452 | public class PriorityQueue<E> extends Ab
452          if (a.length < size)
453              // Make a new array of a's runtime type, but my contents:
454              return (T[]) Arrays.copyOf(queue, size, a.getClass());
455 <        System.arraycopy(queue, 0, a, 0, size);
455 >        System.arraycopy(queue, 0, a, 0, size);
456          if (a.length > size)
457              a[size] = null;
458          return a;
# Line 418 | Line 491 | public class PriorityQueue<E> extends Ab
491           * after we've completed the "normal" iteration.
492           *
493           * We expect that most iterations, even those involving removals,
494 <         * will not use need to store elements in this field.
494 >         * will not need to store elements in this field.
495           */
496          private ArrayDeque<E> forgetMeNot = null;
497  
# Line 430 | Line 503 | public class PriorityQueue<E> extends Ab
503  
504          /**
505           * The modCount value that the iterator believes that the backing
506 <         * List should have.  If this expectation is violated, the iterator
506 >         * Queue should have.  If this expectation is violated, the iterator
507           * has detected concurrent modification.
508           */
509          private int expectedModCount = modCount;
# Line 457 | Line 530 | public class PriorityQueue<E> extends Ab
530          public void remove() {
531              if (expectedModCount != modCount)
532                  throw new ConcurrentModificationException();
460            if (lastRet == -1 && lastRetElt == null)
461                throw new IllegalStateException();
533              if (lastRet != -1) {
534                  E moved = PriorityQueue.this.removeAt(lastRet);
535                  lastRet = -1;
# Line 469 | Line 540 | public class PriorityQueue<E> extends Ab
540                          forgetMeNot = new ArrayDeque<E>();
541                      forgetMeNot.add(moved);
542                  }
543 <            } else {
543 >            } else if (lastRetElt != null) {
544                  PriorityQueue.this.removeEq(lastRetElt);
545                  lastRetElt = null;
546 +            } else {
547 +                throw new IllegalStateException();
548              }
549              expectedModCount = modCount;
550          }
478
551      }
552  
553      public int size() {
# Line 498 | Line 570 | public class PriorityQueue<E> extends Ab
570              return null;
571          int s = --size;
572          modCount++;
573 <        E result = (E)queue[0];
574 <        E x = (E)queue[s];
573 >        E result = (E) queue[0];
574 >        E x = (E) queue[s];
575          queue[s] = null;
576          if (s != 0)
577              siftDown(0, x);
# Line 516 | Line 588 | public class PriorityQueue<E> extends Ab
588       * i.  Under these circumstances, this method returns the element
589       * that was previously at the end of the list and is now at some
590       * position before i. This fact is used by iterator.remove so as to
591 <     * avoid missing traverseing elements.
591 >     * avoid missing traversing elements.
592       */
593      private E removeAt(int i) {
594          assert i >= 0 && i < size;
# Line 561 | Line 633 | public class PriorityQueue<E> extends Ab
633          while (k > 0) {
634              int parent = (k - 1) >>> 1;
635              Object e = queue[parent];
636 <            if (key.compareTo((E)e) >= 0)
636 >            if (key.compareTo((E) e) >= 0)
637                  break;
638              queue[k] = e;
639              k = parent;
# Line 573 | Line 645 | public class PriorityQueue<E> extends Ab
645          while (k > 0) {
646              int parent = (k - 1) >>> 1;
647              Object e = queue[parent];
648 <            if (comparator.compare(x, (E)e) >= 0)
648 >            if (comparator.compare(x, (E) e) >= 0)
649                  break;
650              queue[k] = e;
651              k = parent;
# Line 604 | Line 676 | public class PriorityQueue<E> extends Ab
676              Object c = queue[child];
677              int right = child + 1;
678              if (right < size &&
679 <                ((Comparable<? super E>)c).compareTo((E)queue[right]) > 0)
679 >                ((Comparable<? super E>) c).compareTo((E) queue[right]) > 0)
680                  c = queue[child = right];
681 <            if (key.compareTo((E)c) <= 0)
681 >            if (key.compareTo((E) c) <= 0)
682                  break;
683              queue[k] = c;
684              k = child;
# Line 621 | Line 693 | public class PriorityQueue<E> extends Ab
693              Object c = queue[child];
694              int right = child + 1;
695              if (right < size &&
696 <                comparator.compare((E)c, (E)queue[right]) > 0)
696 >                comparator.compare((E) c, (E) queue[right]) > 0)
697                  c = queue[child = right];
698 <            if (comparator.compare(x, (E)c) <= 0)
698 >            if (comparator.compare(x, (E) c) <= 0)
699                  break;
700              queue[k] = c;
701              k = child;
# Line 637 | Line 709 | public class PriorityQueue<E> extends Ab
709       */
710      private void heapify() {
711          for (int i = (size >>> 1) - 1; i >= 0; i--)
712 <            siftDown(i, (E)queue[i]);
712 >            siftDown(i, (E) queue[i]);
713      }
714  
715      /**
716       * Returns the comparator used to order the elements in this
717 <     * queue, or <tt>null</tt> if this queue is sorted according to
717 >     * queue, or {@code null} if this queue is sorted according to
718       * the {@linkplain Comparable natural ordering} of its elements.
719       *
720       * @return the comparator used to order this queue, or
721 <     *         <tt>null</tt> if this queue is sorted according to the
722 <     *         natural ordering of its elements.
721 >     *         {@code null} if this queue is sorted according to the
722 >     *         natural ordering of its elements
723       */
724      public Comparator<? super E> comparator() {
725          return comparator;
726      }
727  
728      /**
729 <     * Save the state of the instance to a stream (that
730 <     * is, serialize it).
729 >     * Saves the state of the instance to a stream (that
730 >     * is, serializes it).
731       *
732       * @serialData The length of the array backing the instance is
733 <     * emitted (int), followed by all of its elements (each an
734 <     * <tt>Object</tt>) in the proper order.
733 >     *             emitted (int), followed by all of its elements
734 >     *             (each an {@code Object}) in the proper order.
735       * @param s the stream
736       */
737      private void writeObject(java.io.ObjectOutputStream s)
# Line 667 | Line 739 | public class PriorityQueue<E> extends Ab
739          // Write out element count, and any hidden stuff
740          s.defaultWriteObject();
741  
742 <        // Write out array length
743 <        // For compatibility with 1.5 version, must be at least 2.
672 <        s.writeInt(Math.max(2, queue.length));
742 >        // Write out array length, for compatibility with 1.5 version
743 >        s.writeInt(Math.max(2, size + 1));
744  
745 <        // Write out all elements in the proper order.
746 <        for (int i=0; i<size; i++)
745 >        // Write out all elements in the "proper order".
746 >        for (int i = 0; i < size; i++)
747              s.writeObject(queue[i]);
748      }
749  
750      /**
751 <     * Reconstitute the <tt>PriorityQueue</tt> instance from a stream
752 <     * (that is, deserialize it).
751 >     * Reconstitutes the {@code PriorityQueue} instance from a stream
752 >     * (that is, deserializes it).
753 >     *
754       * @param s the stream
755       */
756      private void readObject(java.io.ObjectInputStream s)
# Line 686 | Line 758 | public class PriorityQueue<E> extends Ab
758          // Read in size, and any hidden stuff
759          s.defaultReadObject();
760  
761 <        // Read in array length and allocate array
762 <        int arrayLength = s.readInt();
763 <        queue = new Object[arrayLength];
764 <
693 <        // Read in all elements in the proper order.
694 <        for (int i=0; i<size; i++)
695 <            queue[i] = (E) s.readObject();
696 <    }
761 >        // Read in (and discard) array length
762 >        s.readInt();
763 >
764 >        queue = new Object[size];
765  
766 +        // Read in all elements.
767 +        for (int i = 0; i < size; i++)
768 +            queue[i] = s.readObject();
769 +
770 +        // Elements are guaranteed to be in "proper order", but the
771 +        // spec has never explained what that might be.
772 +        heapify();
773 +    }
774   }

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines