1 |
|
/* |
2 |
< |
* Copyright (c) 2003, 2018, Oracle and/or its affiliates. All rights reserved. |
2 |
> |
* Copyright (c) 2003, 2019, 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 |
26 |
|
package java.util; |
27 |
|
|
28 |
|
import java.util.function.Consumer; |
29 |
< |
import jdk.internal.misc.SharedSecrets; |
29 |
> |
import java.util.function.Predicate; |
30 |
> |
// OPENJDK import jdk.internal.access.SharedSecrets; |
31 |
> |
import jdk.internal.util.ArraysSupport; |
32 |
|
|
33 |
|
/** |
34 |
|
* An unbounded priority {@linkplain Queue queue} based on a priority heap. |
76 |
|
* ({@code peek}, {@code element}, and {@code size}). |
77 |
|
* |
78 |
|
* <p>This class is a member of the |
79 |
< |
* <a href="{@docRoot}/java/util/package-summary.html#CollectionsFramework"> |
79 |
> |
* <a href="{@docRoot}/java.base/java/util/package-summary.html#CollectionsFramework"> |
80 |
|
* Java Collections Framework</a>. |
81 |
|
* |
82 |
|
* @since 1.5 |
87 |
|
public class PriorityQueue<E> extends AbstractQueue<E> |
88 |
|
implements java.io.Serializable { |
89 |
|
|
90 |
+ |
// OPENJDK @java.io.Serial |
91 |
|
private static final long serialVersionUID = -7720805057305804111L; |
92 |
|
|
93 |
|
private static final int DEFAULT_INITIAL_CAPACITY = 11; |
245 |
|
initElementsFromCollection(c); |
246 |
|
} |
247 |
|
|
248 |
+ |
/** Ensures that queue[0] exists, helping peek() and poll(). */ |
249 |
+ |
private static Object[] ensureNonEmpty(Object[] es) { |
250 |
+ |
return (es.length > 0) ? es : new Object[1]; |
251 |
+ |
} |
252 |
+ |
|
253 |
|
private void initFromPriorityQueue(PriorityQueue<? extends E> c) { |
254 |
|
if (c.getClass() == PriorityQueue.class) { |
255 |
< |
this.queue = c.toArray(); |
255 |
> |
this.queue = ensureNonEmpty(c.toArray()); |
256 |
|
this.size = c.size(); |
257 |
|
} else { |
258 |
|
initFromCollection(c); |
269 |
|
for (Object e : es) |
270 |
|
if (e == null) |
271 |
|
throw new NullPointerException(); |
272 |
< |
this.queue = es; |
272 |
> |
this.queue = ensureNonEmpty(es); |
273 |
|
this.size = len; |
274 |
|
} |
275 |
|
|
284 |
|
} |
285 |
|
|
286 |
|
/** |
279 |
– |
* The maximum size of array to allocate. |
280 |
– |
* Some VMs reserve some header words in an array. |
281 |
– |
* Attempts to allocate larger arrays may result in |
282 |
– |
* OutOfMemoryError: Requested array size exceeds VM limit |
283 |
– |
*/ |
284 |
– |
private static final int MAX_ARRAY_SIZE = Integer.MAX_VALUE - 8; |
285 |
– |
|
286 |
– |
/** |
287 |
|
* Increases the capacity of the array. |
288 |
|
* |
289 |
|
* @param minCapacity the desired minimum capacity |
291 |
|
private void grow(int minCapacity) { |
292 |
|
int oldCapacity = queue.length; |
293 |
|
// Double size if small; else grow by 50% |
294 |
< |
int newCapacity = oldCapacity + ((oldCapacity < 64) ? |
295 |
< |
(oldCapacity + 2) : |
296 |
< |
(oldCapacity >> 1)); |
297 |
< |
// overflow-conscious code |
298 |
< |
if (newCapacity - MAX_ARRAY_SIZE > 0) |
299 |
< |
newCapacity = hugeCapacity(minCapacity); |
294 |
> |
int newCapacity = ArraysSupport.newLength(oldCapacity, |
295 |
> |
minCapacity - oldCapacity, /* minimum growth */ |
296 |
> |
oldCapacity < 64 ? oldCapacity + 2 : oldCapacity >> 1 |
297 |
> |
/* preferred growth */); |
298 |
|
queue = Arrays.copyOf(queue, newCapacity); |
299 |
|
} |
300 |
|
|
303 |
– |
private static int hugeCapacity(int minCapacity) { |
304 |
– |
if (minCapacity < 0) // overflow |
305 |
– |
throw new OutOfMemoryError(); |
306 |
– |
return (minCapacity > MAX_ARRAY_SIZE) ? |
307 |
– |
Integer.MAX_VALUE : |
308 |
– |
MAX_ARRAY_SIZE; |
309 |
– |
} |
310 |
– |
|
301 |
|
/** |
302 |
|
* Inserts the specified element into this priority queue. |
303 |
|
* |
333 |
|
} |
334 |
|
|
335 |
|
public E peek() { |
336 |
< |
return (size == 0) ? null : (E) queue[0]; |
336 |
> |
return (E) queue[0]; |
337 |
|
} |
338 |
|
|
339 |
|
private int indexOf(Object o) { |
569 |
|
} |
570 |
|
|
571 |
|
public E poll() { |
572 |
< |
if (size == 0) |
573 |
< |
return null; |
574 |
< |
int s = --size; |
575 |
< |
modCount++; |
576 |
< |
E result = (E) queue[0]; |
577 |
< |
E x = (E) queue[s]; |
578 |
< |
queue[s] = null; |
579 |
< |
if (s != 0) |
580 |
< |
siftDown(0, x); |
572 |
> |
final Object[] es; |
573 |
> |
final E result; |
574 |
> |
|
575 |
> |
if ((result = (E) ((es = queue)[0])) != null) { |
576 |
> |
modCount++; |
577 |
> |
final int n; |
578 |
> |
final E x = (E) es[(n = --size)]; |
579 |
> |
es[n] = null; |
580 |
> |
if (n > 0) { |
581 |
> |
final Comparator<? super E> cmp; |
582 |
> |
if ((cmp = comparator) == null) |
583 |
> |
siftDownComparable(0, x, es, n); |
584 |
> |
else |
585 |
> |
siftDownUsingComparator(0, x, es, n, cmp); |
586 |
> |
} |
587 |
> |
} |
588 |
|
return result; |
589 |
|
} |
590 |
|
|
602 |
|
*/ |
603 |
|
E removeAt(int i) { |
604 |
|
// assert i >= 0 && i < size; |
605 |
+ |
final Object[] es = queue; |
606 |
|
modCount++; |
607 |
|
int s = --size; |
608 |
|
if (s == i) // removed last element |
609 |
< |
queue[i] = null; |
609 |
> |
es[i] = null; |
610 |
|
else { |
611 |
< |
E moved = (E) queue[s]; |
612 |
< |
queue[s] = null; |
611 |
> |
E moved = (E) es[s]; |
612 |
> |
es[s] = null; |
613 |
|
siftDown(i, moved); |
614 |
< |
if (queue[i] == moved) { |
614 |
> |
if (es[i] == moved) { |
615 |
|
siftUp(i, moved); |
616 |
< |
if (queue[i] != moved) |
616 |
> |
if (es[i] != moved) |
617 |
|
return moved; |
618 |
|
} |
619 |
|
} |
725 |
|
private void heapify() { |
726 |
|
final Object[] es = queue; |
727 |
|
int n = size, i = (n >>> 1) - 1; |
728 |
< |
Comparator<? super E> cmp = comparator; |
729 |
< |
if (cmp == null) |
728 |
> |
final Comparator<? super E> cmp; |
729 |
> |
if ((cmp = comparator) == null) |
730 |
|
for (; i >= 0; i--) |
731 |
|
siftDownComparable(i, (E) es[i], es, n); |
732 |
|
else |
756 |
|
* emitted (int), followed by all of its elements |
757 |
|
* (each an {@code Object}) in the proper order. |
758 |
|
*/ |
759 |
+ |
// OPENJDK @java.io.Serial |
760 |
|
private void writeObject(java.io.ObjectOutputStream s) |
761 |
|
throws java.io.IOException { |
762 |
|
// Write out element count, and any hidden stuff |
780 |
|
* could not be found |
781 |
|
* @throws java.io.IOException if an I/O error occurs |
782 |
|
*/ |
783 |
+ |
// OPENJDK @java.io.Serial |
784 |
|
private void readObject(java.io.ObjectInputStream s) |
785 |
|
throws java.io.IOException, ClassNotFoundException { |
786 |
|
// Read in size, and any hidden stuff |
789 |
|
// Read in (and discard) array length |
790 |
|
s.readInt(); |
791 |
|
|
792 |
< |
SharedSecrets.getJavaObjectInputStreamAccess().checkArray(s, Object[].class, size); |
793 |
< |
queue = new Object[size]; |
792 |
> |
jsr166.Platform.checkArray(s, Object[].class, size); |
793 |
> |
final Object[] es = queue = new Object[Math.max(size, 1)]; |
794 |
|
|
795 |
|
// Read in all elements. |
796 |
– |
final Object[] es = queue; |
796 |
|
for (int i = 0, n = size; i < n; i++) |
797 |
|
es[i] = s.readObject(); |
798 |
|
|
888 |
|
} |
889 |
|
|
890 |
|
/** |
891 |
+ |
* @throws NullPointerException {@inheritDoc} |
892 |
+ |
*/ |
893 |
+ |
public boolean removeIf(Predicate<? super E> filter) { |
894 |
+ |
Objects.requireNonNull(filter); |
895 |
+ |
return bulkRemove(filter); |
896 |
+ |
} |
897 |
+ |
|
898 |
+ |
/** |
899 |
+ |
* @throws NullPointerException {@inheritDoc} |
900 |
+ |
*/ |
901 |
+ |
public boolean removeAll(Collection<?> c) { |
902 |
+ |
Objects.requireNonNull(c); |
903 |
+ |
return bulkRemove(e -> c.contains(e)); |
904 |
+ |
} |
905 |
+ |
|
906 |
+ |
/** |
907 |
+ |
* @throws NullPointerException {@inheritDoc} |
908 |
+ |
*/ |
909 |
+ |
public boolean retainAll(Collection<?> c) { |
910 |
+ |
Objects.requireNonNull(c); |
911 |
+ |
return bulkRemove(e -> !c.contains(e)); |
912 |
+ |
} |
913 |
+ |
|
914 |
+ |
// A tiny bit set implementation |
915 |
+ |
|
916 |
+ |
private static long[] nBits(int n) { |
917 |
+ |
return new long[((n - 1) >> 6) + 1]; |
918 |
+ |
} |
919 |
+ |
private static void setBit(long[] bits, int i) { |
920 |
+ |
bits[i >> 6] |= 1L << i; |
921 |
+ |
} |
922 |
+ |
private static boolean isClear(long[] bits, int i) { |
923 |
+ |
return (bits[i >> 6] & (1L << i)) == 0; |
924 |
+ |
} |
925 |
+ |
|
926 |
+ |
/** Implementation of bulk remove methods. */ |
927 |
+ |
private boolean bulkRemove(Predicate<? super E> filter) { |
928 |
+ |
final int expectedModCount = ++modCount; |
929 |
+ |
final Object[] es = queue; |
930 |
+ |
final int end = size; |
931 |
+ |
int i; |
932 |
+ |
// Optimize for initial run of survivors |
933 |
+ |
for (i = 0; i < end && !filter.test((E) es[i]); i++) |
934 |
+ |
; |
935 |
+ |
if (i >= end) { |
936 |
+ |
if (modCount != expectedModCount) |
937 |
+ |
throw new ConcurrentModificationException(); |
938 |
+ |
return false; |
939 |
+ |
} |
940 |
+ |
// Tolerate predicates that reentrantly access the collection for |
941 |
+ |
// read (but writers still get CME), so traverse once to find |
942 |
+ |
// elements to delete, a second pass to physically expunge. |
943 |
+ |
final int beg = i; |
944 |
+ |
final long[] deathRow = nBits(end - beg); |
945 |
+ |
deathRow[0] = 1L; // set bit 0 |
946 |
+ |
for (i = beg + 1; i < end; i++) |
947 |
+ |
if (filter.test((E) es[i])) |
948 |
+ |
setBit(deathRow, i - beg); |
949 |
+ |
if (modCount != expectedModCount) |
950 |
+ |
throw new ConcurrentModificationException(); |
951 |
+ |
int w = beg; |
952 |
+ |
for (i = beg; i < end; i++) |
953 |
+ |
if (isClear(deathRow, i - beg)) |
954 |
+ |
es[w++] = es[i]; |
955 |
+ |
for (i = size = w; i < end; i++) |
956 |
+ |
es[i] = null; |
957 |
+ |
heapify(); |
958 |
+ |
return true; |
959 |
+ |
} |
960 |
+ |
|
961 |
+ |
/** |
962 |
|
* @throws NullPointerException {@inheritDoc} |
963 |
|
*/ |
964 |
|
public void forEach(Consumer<? super E> action) { |