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.110 by jsr166, Wed Aug 24 21:46:18 2016 UTC vs.
Revision 1.125 by jsr166, Sun May 6 21:07:41 2018 UTC

# Line 1 | Line 1
1   /*
2 < * Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved.
2 > * Copyright (c) 2003, 2018, Oracle and/or its affiliates. All rights reserved.
3   * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4   *
5   * This code is free software; you can redistribute it and/or modify it
# Line 26 | Line 26
26   package java.util;
27  
28   import java.util.function.Consumer;
29 + import jdk.internal.misc.SharedSecrets;
30  
31   /**
32   * An unbounded priority {@linkplain Queue queue} based on a priority heap.
# Line 54 | Line 55 | import java.util.function.Consumer;
55   * <p>This class and its iterator implement all of the
56   * <em>optional</em> methods of the {@link Collection} and {@link
57   * Iterator} interfaces.  The Iterator provided in method {@link
58 < * #iterator()} is <em>not</em> guaranteed to traverse the elements of
58 > * #iterator()} and the Spliterator provided in method {@link #spliterator()}
59 > * are <em>not</em> guaranteed to traverse the elements of
60   * the priority queue in any particular order. If you need ordered
61   * traversal, consider using {@code Arrays.sort(pq.toArray())}.
62   *
# Line 72 | Line 74 | import java.util.function.Consumer;
74   * ({@code peek}, {@code element}, and {@code size}).
75   *
76   * <p>This class is a member of the
77 < * <a href="{@docRoot}/../technotes/guides/collections/index.html">
77 > * <a href="{@docRoot}/java/util/package-summary.html#CollectionsFramework">
78   * Java Collections Framework</a>.
79   *
80   * @since 1.5
81   * @author Josh Bloch, Doug Lea
82   * @param <E> the type of elements held in this queue
83   */
84 + @SuppressWarnings("unchecked")
85   public class PriorityQueue<E> extends AbstractQueue<E>
86      implements java.io.Serializable {
87  
# Line 185 | Line 188 | public class PriorityQueue<E> extends Ab
188       * @throws NullPointerException if the specified collection or any
189       *         of its elements are null
190       */
188    @SuppressWarnings("unchecked")
191      public PriorityQueue(Collection<? extends E> c) {
192          if (c instanceof SortedSet<?>) {
193              SortedSet<? extends E> ss = (SortedSet<? extends E>) c;
# Line 217 | Line 219 | public class PriorityQueue<E> extends Ab
219       * @throws NullPointerException if the specified priority queue or any
220       *         of its elements are null
221       */
220    @SuppressWarnings("unchecked")
222      public PriorityQueue(PriorityQueue<? extends E> c) {
223          this.comparator = (Comparator<? super E>) c.comparator();
224          initFromPriorityQueue(c);
# Line 236 | Line 237 | public class PriorityQueue<E> extends Ab
237       * @throws NullPointerException if the specified sorted set or any
238       *         of its elements are null
239       */
239    @SuppressWarnings("unchecked")
240      public PriorityQueue(SortedSet<? extends E> c) {
241          this.comparator = (Comparator<? super E>) c.comparator();
242          initElementsFromCollection(c);
243      }
244  
245 +    /** Ensures that queue[0] exists, helping peek() and poll(). */
246 +    private static Object[] ensureNonEmpty(Object[] es) {
247 +        return (es.length > 0) ? es : new Object[1];
248 +    }
249 +
250      private void initFromPriorityQueue(PriorityQueue<? extends E> c) {
251          if (c.getClass() == PriorityQueue.class) {
252 <            this.queue = c.toArray();
252 >            this.queue = ensureNonEmpty(c.toArray());
253              this.size = c.size();
254          } else {
255              initFromCollection(c);
# Line 252 | Line 257 | public class PriorityQueue<E> extends Ab
257      }
258  
259      private void initElementsFromCollection(Collection<? extends E> c) {
260 <        Object[] a = c.toArray();
260 >        Object[] es = c.toArray();
261 >        int len = es.length;
262          // If c.toArray incorrectly doesn't return Object[], copy it.
263 <        if (a.getClass() != Object[].class)
264 <            a = Arrays.copyOf(a, a.length, Object[].class);
259 <        int len = a.length;
263 >        if (es.getClass() != Object[].class)
264 >            es = Arrays.copyOf(es, len, Object[].class);
265          if (len == 1 || this.comparator != null)
266 <            for (Object e : a)
266 >            for (Object e : es)
267                  if (e == null)
268                      throw new NullPointerException();
269 <        this.queue = a;
270 <        this.size = a.length;
269 >        this.queue = ensureNonEmpty(es);
270 >        this.size = len;
271      }
272  
273      /**
# Line 342 | Line 347 | public class PriorityQueue<E> extends Ab
347          return true;
348      }
349  
345    @SuppressWarnings("unchecked")
350      public E peek() {
351 <        return (size == 0) ? null : (E) queue[0];
351 >        return (E) queue[0];
352      }
353  
354      private int indexOf(Object o) {
355          if (o != null) {
356 <            for (int i = 0; i < size; i++)
357 <                if (o.equals(queue[i]))
356 >            final Object[] es = queue;
357 >            for (int i = 0, n = size; i < n; i++)
358 >                if (o.equals(es[i]))
359                      return i;
360          }
361          return -1;
# Line 378 | Line 383 | public class PriorityQueue<E> extends Ab
383      }
384  
385      /**
386 <     * Version of remove using reference equality, not equals.
382 <     * Needed by iterator.remove.
386 >     * Identity-based version for use in Itr.remove.
387       *
388       * @param o element to be removed from this queue, if present
385     * @return {@code true} if removed
389       */
390 <    boolean removeEq(Object o) {
391 <        for (int i = 0; i < size; i++) {
392 <            if (o == queue[i]) {
390 >    void removeEq(Object o) {
391 >        final Object[] es = queue;
392 >        for (int i = 0, n = size; i < n; i++) {
393 >            if (o == es[i]) {
394                  removeAt(i);
395 <                return true;
395 >                break;
396              }
397          }
394        return false;
398      }
399  
400      /**
# Line 459 | Line 462 | public class PriorityQueue<E> extends Ab
462       *         this queue
463       * @throws NullPointerException if the specified array is null
464       */
462    @SuppressWarnings("unchecked")
465      public <T> T[] toArray(T[] a) {
466          final int size = this.size;
467          if (a.length < size)
# Line 521 | Line 523 | public class PriorityQueue<E> extends Ab
523           */
524          private int expectedModCount = modCount;
525  
526 +        Itr() {}                        // prevent access constructor creation
527 +
528          public boolean hasNext() {
529              return cursor < size ||
530                  (forgetMeNot != null && !forgetMeNot.isEmpty());
531          }
532  
529        @SuppressWarnings("unchecked")
533          public E next() {
534              if (expectedModCount != modCount)
535                  throw new ConcurrentModificationException();
# Line 574 | Line 577 | public class PriorityQueue<E> extends Ab
577       */
578      public void clear() {
579          modCount++;
580 <        for (int i = 0; i < size; i++)
581 <            queue[i] = null;
580 >        final Object[] es = queue;
581 >        for (int i = 0, n = size; i < n; i++)
582 >            es[i] = null;
583          size = 0;
584      }
585  
582    @SuppressWarnings("unchecked")
586      public E poll() {
587 <        if (size == 0)
588 <            return null;
589 <        int s = --size;
590 <        modCount++;
591 <        E result = (E) queue[0];
592 <        E x = (E) queue[s];
593 <        queue[s] = null;
594 <        if (s != 0)
595 <            siftDown(0, x);
587 >        final Object[] es;
588 >        final E result;
589 >
590 >        if ((result = (E) ((es = queue)[0])) != null) {
591 >            modCount++;
592 >            final int n;
593 >            final E x = (E) es[(n = --size)];
594 >            es[n] = null;
595 >            if (n > 0) {
596 >                final Comparator<? super E> cmp;
597 >                if ((cmp = comparator) == null)
598 >                    siftDownComparable(0, x, es, n);
599 >                else
600 >                    siftDownUsingComparator(0, x, es, n, cmp);
601 >            }
602 >        }
603          return result;
604      }
605  
# Line 605 | Line 615 | public class PriorityQueue<E> extends Ab
615       * position before i. This fact is used by iterator.remove so as to
616       * avoid missing traversing elements.
617       */
608    @SuppressWarnings("unchecked")
618      E removeAt(int i) {
619          // assert i >= 0 && i < size;
620          modCount++;
# Line 630 | Line 639 | public class PriorityQueue<E> extends Ab
639       * promoting x up the tree until it is greater than or equal to
640       * its parent, or is the root.
641       *
642 <     * To simplify and speed up coercions and comparisons. the
642 >     * To simplify and speed up coercions and comparisons, the
643       * Comparable and Comparator versions are separated into different
644       * methods that are otherwise identical. (Similarly for siftDown.)
645       *
# Line 639 | Line 648 | public class PriorityQueue<E> extends Ab
648       */
649      private void siftUp(int k, E x) {
650          if (comparator != null)
651 <            siftUpUsingComparator(k, x);
651 >            siftUpUsingComparator(k, x, queue, comparator);
652          else
653 <            siftUpComparable(k, x);
653 >            siftUpComparable(k, x, queue);
654      }
655  
656 <    @SuppressWarnings("unchecked")
657 <    private void siftUpComparable(int k, E x) {
649 <        Comparable<? super E> key = (Comparable<? super E>) x;
656 >    private static <T> void siftUpComparable(int k, T x, Object[] es) {
657 >        Comparable<? super T> key = (Comparable<? super T>) x;
658          while (k > 0) {
659              int parent = (k - 1) >>> 1;
660 <            Object e = queue[parent];
661 <            if (key.compareTo((E) e) >= 0)
660 >            Object e = es[parent];
661 >            if (key.compareTo((T) e) >= 0)
662                  break;
663 <            queue[k] = e;
663 >            es[k] = e;
664              k = parent;
665          }
666 <        queue[k] = key;
666 >        es[k] = key;
667      }
668  
669 <    @SuppressWarnings("unchecked")
670 <    private void siftUpUsingComparator(int k, E x) {
669 >    private static <T> void siftUpUsingComparator(
670 >        int k, T x, Object[] es, Comparator<? super T> cmp) {
671          while (k > 0) {
672              int parent = (k - 1) >>> 1;
673 <            Object e = queue[parent];
674 <            if (comparator.compare(x, (E) e) >= 0)
673 >            Object e = es[parent];
674 >            if (cmp.compare(x, (T) e) >= 0)
675                  break;
676 <            queue[k] = e;
676 >            es[k] = e;
677              k = parent;
678          }
679 <        queue[k] = x;
679 >        es[k] = x;
680      }
681  
682      /**
# Line 681 | Line 689 | public class PriorityQueue<E> extends Ab
689       */
690      private void siftDown(int k, E x) {
691          if (comparator != null)
692 <            siftDownUsingComparator(k, x);
692 >            siftDownUsingComparator(k, x, queue, size, comparator);
693          else
694 <            siftDownComparable(k, x);
694 >            siftDownComparable(k, x, queue, size);
695      }
696  
697 <    @SuppressWarnings("unchecked")
698 <    private void siftDownComparable(int k, E x) {
699 <        Comparable<? super E> key = (Comparable<? super E>)x;
700 <        int half = size >>> 1;        // loop while a non-leaf
697 >    private static <T> void siftDownComparable(int k, T x, Object[] es, int n) {
698 >        // assert n > 0;
699 >        Comparable<? super T> key = (Comparable<? super T>)x;
700 >        int half = n >>> 1;           // loop while a non-leaf
701          while (k < half) {
702              int child = (k << 1) + 1; // assume left child is least
703 <            Object c = queue[child];
703 >            Object c = es[child];
704              int right = child + 1;
705 <            if (right < size &&
706 <                ((Comparable<? super E>) c).compareTo((E) queue[right]) > 0)
707 <                c = queue[child = right];
708 <            if (key.compareTo((E) c) <= 0)
705 >            if (right < n &&
706 >                ((Comparable<? super T>) c).compareTo((T) es[right]) > 0)
707 >                c = es[child = right];
708 >            if (key.compareTo((T) c) <= 0)
709                  break;
710 <            queue[k] = c;
710 >            es[k] = c;
711              k = child;
712          }
713 <        queue[k] = key;
713 >        es[k] = key;
714      }
715  
716 <    @SuppressWarnings("unchecked")
717 <    private void siftDownUsingComparator(int k, E x) {
718 <        int half = size >>> 1;
716 >    private static <T> void siftDownUsingComparator(
717 >        int k, T x, Object[] es, int n, Comparator<? super T> cmp) {
718 >        // assert n > 0;
719 >        int half = n >>> 1;
720          while (k < half) {
721              int child = (k << 1) + 1;
722 <            Object c = queue[child];
722 >            Object c = es[child];
723              int right = child + 1;
724 <            if (right < size &&
725 <                comparator.compare((E) c, (E) queue[right]) > 0)
726 <                c = queue[child = right];
718 <            if (comparator.compare(x, (E) c) <= 0)
724 >            if (right < n && cmp.compare((T) c, (T) es[right]) > 0)
725 >                c = es[child = right];
726 >            if (cmp.compare(x, (T) c) <= 0)
727                  break;
728 <            queue[k] = c;
728 >            es[k] = c;
729              k = child;
730          }
731 <        queue[k] = x;
731 >        es[k] = x;
732      }
733  
734      /**
735       * Establishes the heap invariant (described above) in the entire tree,
736       * assuming nothing about the order of the elements prior to the call.
737 +     * This classic algorithm due to Floyd (1964) is known to be O(size).
738       */
730    @SuppressWarnings("unchecked")
739      private void heapify() {
740 <        for (int i = (size >>> 1) - 1; i >= 0; i--)
741 <            siftDown(i, (E) queue[i]);
740 >        final Object[] es = queue;
741 >        int n = size, i = (n >>> 1) - 1;
742 >        final Comparator<? super E> cmp;
743 >        if ((cmp = comparator) == null)
744 >            for (; i >= 0; i--)
745 >                siftDownComparable(i, (E) es[i], es, n);
746 >        else
747 >            for (; i >= 0; i--)
748 >                siftDownUsingComparator(i, (E) es[i], es, n, cmp);
749      }
750  
751      /**
# Line 764 | Line 779 | public class PriorityQueue<E> extends Ab
779          s.writeInt(Math.max(2, size + 1));
780  
781          // Write out all elements in the "proper order".
782 <        for (int i = 0; i < size; i++)
783 <            s.writeObject(queue[i]);
782 >        final Object[] es = queue;
783 >        for (int i = 0, n = size; i < n; i++)
784 >            s.writeObject(es[i]);
785      }
786  
787      /**
# Line 785 | Line 801 | public class PriorityQueue<E> extends Ab
801          // Read in (and discard) array length
802          s.readInt();
803  
804 <        queue = new Object[size];
804 >        SharedSecrets.getJavaObjectInputStreamAccess().checkArray(s, Object[].class, size);
805 >        final Object[] es = queue = new Object[Math.max(size, 1)];
806  
807          // Read in all elements.
808 <        for (int i = 0; i < size; i++)
809 <            queue[i] = s.readObject();
808 >        for (int i = 0, n = size; i < n; i++)
809 >            es[i] = s.readObject();
810  
811          // Elements are guaranteed to be in "proper order", but the
812          // spec has never explained what that might be.
# Line 799 | Line 816 | public class PriorityQueue<E> extends Ab
816      /**
817       * Creates a <em><a href="Spliterator.html#binding">late-binding</a></em>
818       * and <em>fail-fast</em> {@link Spliterator} over the elements in this
819 <     * queue.
819 >     * queue. The spliterator does not traverse elements in any particular order
820 >     * (the {@link Spliterator#ORDERED ORDERED} characteristic is not reported).
821       *
822       * <p>The {@code Spliterator} reports {@link Spliterator#SIZED},
823       * {@link Spliterator#SUBSIZED}, and {@link Spliterator#NONNULL}.
# Line 810 | Line 828 | public class PriorityQueue<E> extends Ab
828       * @since 1.8
829       */
830      public final Spliterator<E> spliterator() {
831 <        return new PriorityQueueSpliterator<>(this, 0, -1, 0);
831 >        return new PriorityQueueSpliterator(0, -1, 0);
832      }
833  
834 <    static final class PriorityQueueSpliterator<E> implements Spliterator<E> {
817 <        /*
818 <         * This is very similar to ArrayList Spliterator, except for
819 <         * extra null checks.
820 <         */
821 <        private final PriorityQueue<E> pq;
834 >    final class PriorityQueueSpliterator implements Spliterator<E> {
835          private int index;            // current index, modified on advance/split
836          private int fence;            // -1 until first use
837          private int expectedModCount; // initialized when fence set
838  
839          /** Creates new spliterator covering the given range. */
840 <        PriorityQueueSpliterator(PriorityQueue<E> pq, int origin, int fence,
828 <                                 int expectedModCount) {
829 <            this.pq = pq;
840 >        PriorityQueueSpliterator(int origin, int fence, int expectedModCount) {
841              this.index = origin;
842              this.fence = fence;
843              this.expectedModCount = expectedModCount;
# Line 835 | Line 846 | public class PriorityQueue<E> extends Ab
846          private int getFence() { // initialize fence to size on first use
847              int hi;
848              if ((hi = fence) < 0) {
849 <                expectedModCount = pq.modCount;
850 <                hi = fence = pq.size;
849 >                expectedModCount = modCount;
850 >                hi = fence = size;
851              }
852              return hi;
853          }
854  
855 <        public PriorityQueueSpliterator<E> trySplit() {
855 >        public PriorityQueueSpliterator trySplit() {
856              int hi = getFence(), lo = index, mid = (lo + hi) >>> 1;
857              return (lo >= mid) ? null :
858 <                new PriorityQueueSpliterator<>(pq, lo, index = mid,
848 <                                               expectedModCount);
858 >                new PriorityQueueSpliterator(lo, index = mid, expectedModCount);
859          }
860  
851        @SuppressWarnings("unchecked")
861          public void forEachRemaining(Consumer<? super E> action) {
853            int i, hi, mc; // hoist accesses and checks from loop
854            PriorityQueue<E> q; Object[] a;
862              if (action == null)
863                  throw new NullPointerException();
864 <            if ((q = pq) != null && (a = q.queue) != null) {
865 <                if ((hi = fence) < 0) {
866 <                    mc = q.modCount;
867 <                    hi = q.size;
868 <                }
869 <                else
870 <                    mc = expectedModCount;
864 <                if ((i = index) >= 0 && (index = hi) <= a.length) {
865 <                    for (E e;; ++i) {
866 <                        if (i < hi) {
867 <                            if ((e = (E) a[i]) == null) // must be CME
868 <                                break;
869 <                            action.accept(e);
870 <                        }
871 <                        else if (q.modCount != mc)
872 <                            break;
873 <                        else
874 <                            return;
875 <                    }
876 <                }
864 >            if (fence < 0) { fence = size; expectedModCount = modCount; }
865 >            final Object[] es = queue;
866 >            int i, hi; E e;
867 >            for (i = index, index = hi = fence; i < hi; i++) {
868 >                if ((e = (E) es[i]) == null)
869 >                    break;      // must be CME
870 >                action.accept(e);
871              }
872 <            throw new ConcurrentModificationException();
872 >            if (modCount != expectedModCount)
873 >                throw new ConcurrentModificationException();
874          }
875  
876          public boolean tryAdvance(Consumer<? super E> action) {
877              if (action == null)
878                  throw new NullPointerException();
879 <            int hi = getFence(), lo = index;
880 <            if (lo >= 0 && lo < hi) {
881 <                index = lo + 1;
882 <                @SuppressWarnings("unchecked") E e = (E)pq.queue[lo];
883 <                if (e == null)
879 >            if (fence < 0) { fence = size; expectedModCount = modCount; }
880 >            int i;
881 >            if ((i = index) < fence) {
882 >                index = i + 1;
883 >                E e;
884 >                if ((e = (E) queue[i]) == null
885 >                    || modCount != expectedModCount)
886                      throw new ConcurrentModificationException();
887                  action.accept(e);
891                if (pq.modCount != expectedModCount)
892                    throw new ConcurrentModificationException();
888                  return true;
889              }
890              return false;
891          }
892  
893          public long estimateSize() {
894 <            return (long) (getFence() - index);
894 >            return getFence() - index;
895          }
896  
897          public int characteristics() {
898              return Spliterator.SIZED | Spliterator.SUBSIZED | Spliterator.NONNULL;
899          }
900      }
901 +
902 +    /**
903 +     * @throws NullPointerException {@inheritDoc}
904 +     */
905 +    public void forEach(Consumer<? super E> action) {
906 +        Objects.requireNonNull(action);
907 +        final int expectedModCount = modCount;
908 +        final Object[] es = queue;
909 +        for (int i = 0, n = size; i < n; i++)
910 +            action.accept((E) es[i]);
911 +        if (expectedModCount != modCount)
912 +            throw new ConcurrentModificationException();
913 +    }
914   }

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines