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.113 by jsr166, Wed Nov 30 03:31:47 2016 UTC vs.
Revision 1.128 by jsr166, Sun May 6 23:29:25 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 java.util.function.Predicate;
30 + import jdk.internal.misc.SharedSecrets;
31  
32   /**
33   * An unbounded priority {@linkplain Queue queue} based on a priority heap.
# Line 73 | Line 75 | import java.util.function.Consumer;
75   * ({@code peek}, {@code element}, and {@code size}).
76   *
77   * <p>This class is a member of the
78 < * <a href="{@docRoot}/../technotes/guides/collections/index.html">
78 > * <a href="{@docRoot}/java/util/package-summary.html#CollectionsFramework">
79   * Java Collections Framework</a>.
80   *
81   * @since 1.5
82   * @author Josh Bloch, Doug Lea
83   * @param <E> the type of elements held in this queue
84   */
85 + @SuppressWarnings("unchecked")
86   public class PriorityQueue<E> extends AbstractQueue<E>
87      implements java.io.Serializable {
88  
# Line 186 | Line 189 | public class PriorityQueue<E> extends Ab
189       * @throws NullPointerException if the specified collection or any
190       *         of its elements are null
191       */
189    @SuppressWarnings("unchecked")
192      public PriorityQueue(Collection<? extends E> c) {
193          if (c instanceof SortedSet<?>) {
194              SortedSet<? extends E> ss = (SortedSet<? extends E>) c;
# Line 218 | Line 220 | public class PriorityQueue<E> extends Ab
220       * @throws NullPointerException if the specified priority queue or any
221       *         of its elements are null
222       */
221    @SuppressWarnings("unchecked")
223      public PriorityQueue(PriorityQueue<? extends E> c) {
224          this.comparator = (Comparator<? super E>) c.comparator();
225          initFromPriorityQueue(c);
# Line 237 | Line 238 | public class PriorityQueue<E> extends Ab
238       * @throws NullPointerException if the specified sorted set or any
239       *         of its elements are null
240       */
240    @SuppressWarnings("unchecked")
241      public PriorityQueue(SortedSet<? extends E> c) {
242          this.comparator = (Comparator<? super E>) c.comparator();
243          initElementsFromCollection(c);
244      }
245  
246 +    /** Ensures that queue[0] exists, helping peek() and poll(). */
247 +    private static Object[] ensureNonEmpty(Object[] es) {
248 +        return (es.length > 0) ? es : new Object[1];
249 +    }
250 +
251      private void initFromPriorityQueue(PriorityQueue<? extends E> c) {
252          if (c.getClass() == PriorityQueue.class) {
253 <            this.queue = c.toArray();
253 >            this.queue = ensureNonEmpty(c.toArray());
254              this.size = c.size();
255          } else {
256              initFromCollection(c);
# Line 253 | Line 258 | public class PriorityQueue<E> extends Ab
258      }
259  
260      private void initElementsFromCollection(Collection<? extends E> c) {
261 <        Object[] a = c.toArray();
261 >        Object[] es = c.toArray();
262 >        int len = es.length;
263          // If c.toArray incorrectly doesn't return Object[], copy it.
264 <        if (a.getClass() != Object[].class)
265 <            a = Arrays.copyOf(a, a.length, Object[].class);
260 <        int len = a.length;
264 >        if (es.getClass() != Object[].class)
265 >            es = Arrays.copyOf(es, len, Object[].class);
266          if (len == 1 || this.comparator != null)
267 <            for (Object e : a)
267 >            for (Object e : es)
268                  if (e == null)
269                      throw new NullPointerException();
270 <        this.queue = a;
271 <        this.size = a.length;
270 >        this.queue = ensureNonEmpty(es);
271 >        this.size = len;
272      }
273  
274      /**
# Line 343 | Line 348 | public class PriorityQueue<E> extends Ab
348          return true;
349      }
350  
346    @SuppressWarnings("unchecked")
351      public E peek() {
352 <        return (size == 0) ? null : (E) queue[0];
352 >        return (E) queue[0];
353      }
354  
355      private int indexOf(Object o) {
356          if (o != null) {
357 <            for (int i = 0; i < size; i++)
358 <                if (o.equals(queue[i]))
357 >            final Object[] es = queue;
358 >            for (int i = 0, n = size; i < n; i++)
359 >                if (o.equals(es[i]))
360                      return i;
361          }
362          return -1;
# Line 379 | Line 384 | public class PriorityQueue<E> extends Ab
384      }
385  
386      /**
387 <     * Version of remove using reference equality, not equals.
383 <     * Needed by iterator.remove.
387 >     * Identity-based version for use in Itr.remove.
388       *
389       * @param o element to be removed from this queue, if present
386     * @return {@code true} if removed
390       */
391 <    boolean removeEq(Object o) {
392 <        for (int i = 0; i < size; i++) {
393 <            if (o == queue[i]) {
391 >    void removeEq(Object o) {
392 >        final Object[] es = queue;
393 >        for (int i = 0, n = size; i < n; i++) {
394 >            if (o == es[i]) {
395                  removeAt(i);
396 <                return true;
396 >                break;
397              }
398          }
395        return false;
399      }
400  
401      /**
# Line 460 | Line 463 | public class PriorityQueue<E> extends Ab
463       *         this queue
464       * @throws NullPointerException if the specified array is null
465       */
463    @SuppressWarnings("unchecked")
466      public <T> T[] toArray(T[] a) {
467          final int size = this.size;
468          if (a.length < size)
# Line 522 | Line 524 | public class PriorityQueue<E> extends Ab
524           */
525          private int expectedModCount = modCount;
526  
527 +        Itr() {}                        // prevent access constructor creation
528 +
529          public boolean hasNext() {
530              return cursor < size ||
531                  (forgetMeNot != null && !forgetMeNot.isEmpty());
532          }
533  
530        @SuppressWarnings("unchecked")
534          public E next() {
535              if (expectedModCount != modCount)
536                  throw new ConcurrentModificationException();
# Line 575 | Line 578 | public class PriorityQueue<E> extends Ab
578       */
579      public void clear() {
580          modCount++;
581 <        for (int i = 0; i < size; i++)
582 <            queue[i] = null;
581 >        final Object[] es = queue;
582 >        for (int i = 0, n = size; i < n; i++)
583 >            es[i] = null;
584          size = 0;
585      }
586  
583    @SuppressWarnings("unchecked")
587      public E poll() {
588 <        if (size == 0)
589 <            return null;
590 <        int s = --size;
591 <        modCount++;
592 <        E result = (E) queue[0];
593 <        E x = (E) queue[s];
594 <        queue[s] = null;
595 <        if (s != 0)
596 <            siftDown(0, x);
588 >        final Object[] es;
589 >        final E result;
590 >
591 >        if ((result = (E) ((es = queue)[0])) != null) {
592 >            modCount++;
593 >            final int n;
594 >            final E x = (E) es[(n = --size)];
595 >            es[n] = null;
596 >            if (n > 0) {
597 >                final Comparator<? super E> cmp;
598 >                if ((cmp = comparator) == null)
599 >                    siftDownComparable(0, x, es, n);
600 >                else
601 >                    siftDownUsingComparator(0, x, es, n, cmp);
602 >            }
603 >        }
604          return result;
605      }
606  
# Line 606 | Line 616 | public class PriorityQueue<E> extends Ab
616       * position before i. This fact is used by iterator.remove so as to
617       * avoid missing traversing elements.
618       */
609    @SuppressWarnings("unchecked")
619      E removeAt(int i) {
620          // assert i >= 0 && i < size;
621 +        final Object[] es = queue;
622          modCount++;
623          int s = --size;
624          if (s == i) // removed last element
625 <            queue[i] = null;
625 >            es[i] = null;
626          else {
627 <            E moved = (E) queue[s];
628 <            queue[s] = null;
627 >            E moved = (E) es[s];
628 >            es[s] = null;
629              siftDown(i, moved);
630 <            if (queue[i] == moved) {
630 >            if (es[i] == moved) {
631                  siftUp(i, moved);
632 <                if (queue[i] != moved)
632 >                if (es[i] != moved)
633                      return moved;
634              }
635          }
# Line 631 | Line 641 | public class PriorityQueue<E> extends Ab
641       * promoting x up the tree until it is greater than or equal to
642       * its parent, or is the root.
643       *
644 <     * To simplify and speed up coercions and comparisons. the
644 >     * To simplify and speed up coercions and comparisons, the
645       * Comparable and Comparator versions are separated into different
646       * methods that are otherwise identical. (Similarly for siftDown.)
647       *
# Line 640 | Line 650 | public class PriorityQueue<E> extends Ab
650       */
651      private void siftUp(int k, E x) {
652          if (comparator != null)
653 <            siftUpUsingComparator(k, x);
653 >            siftUpUsingComparator(k, x, queue, comparator);
654          else
655 <            siftUpComparable(k, x);
655 >            siftUpComparable(k, x, queue);
656      }
657  
658 <    @SuppressWarnings("unchecked")
659 <    private void siftUpComparable(int k, E x) {
650 <        Comparable<? super E> key = (Comparable<? super E>) x;
658 >    private static <T> void siftUpComparable(int k, T x, Object[] es) {
659 >        Comparable<? super T> key = (Comparable<? super T>) x;
660          while (k > 0) {
661              int parent = (k - 1) >>> 1;
662 <            Object e = queue[parent];
663 <            if (key.compareTo((E) e) >= 0)
662 >            Object e = es[parent];
663 >            if (key.compareTo((T) e) >= 0)
664                  break;
665 <            queue[k] = e;
665 >            es[k] = e;
666              k = parent;
667          }
668 <        queue[k] = key;
668 >        es[k] = key;
669      }
670  
671 <    @SuppressWarnings("unchecked")
672 <    private void siftUpUsingComparator(int k, E x) {
671 >    private static <T> void siftUpUsingComparator(
672 >        int k, T x, Object[] es, Comparator<? super T> cmp) {
673          while (k > 0) {
674              int parent = (k - 1) >>> 1;
675 <            Object e = queue[parent];
676 <            if (comparator.compare(x, (E) e) >= 0)
675 >            Object e = es[parent];
676 >            if (cmp.compare(x, (T) e) >= 0)
677                  break;
678 <            queue[k] = e;
678 >            es[k] = e;
679              k = parent;
680          }
681 <        queue[k] = x;
681 >        es[k] = x;
682      }
683  
684      /**
# Line 682 | Line 691 | public class PriorityQueue<E> extends Ab
691       */
692      private void siftDown(int k, E x) {
693          if (comparator != null)
694 <            siftDownUsingComparator(k, x);
694 >            siftDownUsingComparator(k, x, queue, size, comparator);
695          else
696 <            siftDownComparable(k, x);
696 >            siftDownComparable(k, x, queue, size);
697      }
698  
699 <    @SuppressWarnings("unchecked")
700 <    private void siftDownComparable(int k, E x) {
701 <        Comparable<? super E> key = (Comparable<? super E>)x;
702 <        int half = size >>> 1;        // loop while a non-leaf
699 >    private static <T> void siftDownComparable(int k, T x, Object[] es, int n) {
700 >        // assert n > 0;
701 >        Comparable<? super T> key = (Comparable<? super T>)x;
702 >        int half = n >>> 1;           // loop while a non-leaf
703          while (k < half) {
704              int child = (k << 1) + 1; // assume left child is least
705 <            Object c = queue[child];
705 >            Object c = es[child];
706              int right = child + 1;
707 <            if (right < size &&
708 <                ((Comparable<? super E>) c).compareTo((E) queue[right]) > 0)
709 <                c = queue[child = right];
710 <            if (key.compareTo((E) c) <= 0)
707 >            if (right < n &&
708 >                ((Comparable<? super T>) c).compareTo((T) es[right]) > 0)
709 >                c = es[child = right];
710 >            if (key.compareTo((T) c) <= 0)
711                  break;
712 <            queue[k] = c;
712 >            es[k] = c;
713              k = child;
714          }
715 <        queue[k] = key;
715 >        es[k] = key;
716      }
717  
718 <    @SuppressWarnings("unchecked")
719 <    private void siftDownUsingComparator(int k, E x) {
720 <        int half = size >>> 1;
718 >    private static <T> void siftDownUsingComparator(
719 >        int k, T x, Object[] es, int n, Comparator<? super T> cmp) {
720 >        // assert n > 0;
721 >        int half = n >>> 1;
722          while (k < half) {
723              int child = (k << 1) + 1;
724 <            Object c = queue[child];
724 >            Object c = es[child];
725              int right = child + 1;
726 <            if (right < size &&
727 <                comparator.compare((E) c, (E) queue[right]) > 0)
728 <                c = queue[child = right];
719 <            if (comparator.compare(x, (E) c) <= 0)
726 >            if (right < n && cmp.compare((T) c, (T) es[right]) > 0)
727 >                c = es[child = right];
728 >            if (cmp.compare(x, (T) c) <= 0)
729                  break;
730 <            queue[k] = c;
730 >            es[k] = c;
731              k = child;
732          }
733 <        queue[k] = x;
733 >        es[k] = x;
734      }
735  
736      /**
# Line 729 | Line 738 | public class PriorityQueue<E> extends Ab
738       * assuming nothing about the order of the elements prior to the call.
739       * This classic algorithm due to Floyd (1964) is known to be O(size).
740       */
732    @SuppressWarnings("unchecked")
741      private void heapify() {
742 <        for (int i = (size >>> 1) - 1; i >= 0; i--)
743 <            siftDown(i, (E) queue[i]);
742 >        final Object[] es = queue;
743 >        int n = size, i = (n >>> 1) - 1;
744 >        final Comparator<? super E> cmp;
745 >        if ((cmp = comparator) == null)
746 >            for (; i >= 0; i--)
747 >                siftDownComparable(i, (E) es[i], es, n);
748 >        else
749 >            for (; i >= 0; i--)
750 >                siftDownUsingComparator(i, (E) es[i], es, n, cmp);
751      }
752  
753      /**
# Line 766 | Line 781 | public class PriorityQueue<E> extends Ab
781          s.writeInt(Math.max(2, size + 1));
782  
783          // Write out all elements in the "proper order".
784 <        for (int i = 0; i < size; i++)
785 <            s.writeObject(queue[i]);
784 >        final Object[] es = queue;
785 >        for (int i = 0, n = size; i < n; i++)
786 >            s.writeObject(es[i]);
787      }
788  
789      /**
# Line 787 | Line 803 | public class PriorityQueue<E> extends Ab
803          // Read in (and discard) array length
804          s.readInt();
805  
806 <        queue = new Object[size];
806 >        SharedSecrets.getJavaObjectInputStreamAccess().checkArray(s, Object[].class, size);
807 >        final Object[] es = queue = new Object[Math.max(size, 1)];
808  
809          // Read in all elements.
810 <        for (int i = 0; i < size; i++)
811 <            queue[i] = s.readObject();
810 >        for (int i = 0, n = size; i < n; i++)
811 >            es[i] = s.readObject();
812  
813          // Elements are guaranteed to be in "proper order", but the
814          // spec has never explained what that might be.
# Line 817 | Line 834 | public class PriorityQueue<E> extends Ab
834      }
835  
836      final class PriorityQueueSpliterator implements Spliterator<E> {
820        /*
821         * This is very similar to ArrayList Spliterator, except for
822         * extra null checks.
823         */
837          private int index;            // current index, modified on advance/split
838          private int fence;            // -1 until first use
839          private int expectedModCount; // initialized when fence set
# Line 847 | Line 860 | public class PriorityQueue<E> extends Ab
860                  new PriorityQueueSpliterator(lo, index = mid, expectedModCount);
861          }
862  
850        @SuppressWarnings("unchecked")
863          public void forEachRemaining(Consumer<? super E> action) {
852            int i, hi, mc; // hoist accesses and checks from loop
853            final Object[] a;
864              if (action == null)
865                  throw new NullPointerException();
866 <            if ((a = queue) != null) {
867 <                if ((hi = fence) < 0) {
868 <                    mc = modCount;
869 <                    hi = size;
870 <                }
871 <                else
872 <                    mc = expectedModCount;
863 <                if ((i = index) >= 0 && (index = hi) <= a.length) {
864 <                    for (E e;; ++i) {
865 <                        if (i < hi) {
866 <                            if ((e = (E) a[i]) == null) // must be CME
867 <                                break;
868 <                            action.accept(e);
869 <                        }
870 <                        else if (modCount != mc)
871 <                            break;
872 <                        else
873 <                            return;
874 <                    }
875 <                }
866 >            if (fence < 0) { fence = size; expectedModCount = modCount; }
867 >            final Object[] es = queue;
868 >            int i, hi; E e;
869 >            for (i = index, index = hi = fence; i < hi; i++) {
870 >                if ((e = (E) es[i]) == null)
871 >                    break;      // must be CME
872 >                action.accept(e);
873              }
874 <            throw new ConcurrentModificationException();
874 >            if (modCount != expectedModCount)
875 >                throw new ConcurrentModificationException();
876          }
877  
878          public boolean tryAdvance(Consumer<? super E> action) {
879              if (action == null)
880                  throw new NullPointerException();
881 <            int hi = getFence(), lo = index;
882 <            if (lo >= 0 && lo < hi) {
883 <                index = lo + 1;
884 <                @SuppressWarnings("unchecked") E e = (E)queue[lo];
885 <                if (e == null)
881 >            if (fence < 0) { fence = size; expectedModCount = modCount; }
882 >            int i;
883 >            if ((i = index) < fence) {
884 >                index = i + 1;
885 >                E e;
886 >                if ((e = (E) queue[i]) == null
887 >                    || modCount != expectedModCount)
888                      throw new ConcurrentModificationException();
889                  action.accept(e);
890                if (modCount != expectedModCount)
891                    throw new ConcurrentModificationException();
890                  return true;
891              }
892              return false;
# Line 902 | Line 900 | public class PriorityQueue<E> extends Ab
900              return Spliterator.SIZED | Spliterator.SUBSIZED | Spliterator.NONNULL;
901          }
902      }
903 +
904 +    /**
905 +     * @throws NullPointerException {@inheritDoc}
906 +     */
907 +    public boolean removeIf(Predicate<? super E> filter) {
908 +        Objects.requireNonNull(filter);
909 +        return bulkRemove(filter);
910 +    }
911 +
912 +    /**
913 +     * @throws NullPointerException {@inheritDoc}
914 +     */
915 +    public boolean removeAll(Collection<?> c) {
916 +        Objects.requireNonNull(c);
917 +        return bulkRemove(e -> c.contains(e));
918 +    }
919 +
920 +    /**
921 +     * @throws NullPointerException {@inheritDoc}
922 +     */
923 +    public boolean retainAll(Collection<?> c) {
924 +        Objects.requireNonNull(c);
925 +        return bulkRemove(e -> !c.contains(e));
926 +    }
927 +
928 +    // A tiny bit set implementation
929 +
930 +    private static long[] nBits(int n) {
931 +        return new long[((n - 1) >> 6) + 1];
932 +    }
933 +    private static void setBit(long[] bits, int i) {
934 +        bits[i >> 6] |= 1L << i;
935 +    }
936 +    private static boolean isClear(long[] bits, int i) {
937 +        return (bits[i >> 6] & (1L << i)) == 0;
938 +    }
939 +
940 +    /** Implementation of bulk remove methods. */
941 +    private boolean bulkRemove(Predicate<? super E> filter) {
942 +        final int expectedModCount = ++modCount;
943 +        final Object[] es = queue;
944 +        final int end = size;
945 +        int i;
946 +        // Optimize for initial run of survivors
947 +        for (i = 0; i < end && !filter.test((E) es[i]); i++)
948 +            ;
949 +        if (i >= end) {
950 +            if (modCount != expectedModCount)
951 +                throw new ConcurrentModificationException();
952 +            return false;
953 +        }
954 +        // Tolerate predicates that reentrantly access the collection for
955 +        // read (but writers still get CME), so traverse once to find
956 +        // elements to delete, a second pass to physically expunge.
957 +        final int beg = i;
958 +        final long[] deathRow = nBits(end - beg);
959 +        deathRow[0] = 1L;   // set bit 0
960 +        for (i = beg + 1; i < end; i++)
961 +            if (filter.test((E) es[i]))
962 +                setBit(deathRow, i - beg);
963 +        if (modCount != expectedModCount)
964 +            throw new ConcurrentModificationException();
965 +        int w = beg;
966 +        for (i = beg; i < end; i++)
967 +            if (isClear(deathRow, i - beg))
968 +                es[w++] = es[i];
969 +        for (i = size = w; i < end; i++)
970 +            es[i] = null;
971 +        heapify();
972 +        return true;
973 +    }
974 +
975 +    /**
976 +     * @throws NullPointerException {@inheritDoc}
977 +     */
978 +    public void forEach(Consumer<? super E> action) {
979 +        Objects.requireNonNull(action);
980 +        final int expectedModCount = modCount;
981 +        final Object[] es = queue;
982 +        for (int i = 0, n = size; i < n; i++)
983 +            action.accept((E) es[i]);
984 +        if (expectedModCount != modCount)
985 +            throw new ConcurrentModificationException();
986 +    }
987   }

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines