--- jsr166/src/main/java/util/ArrayDeque.java 2013/02/20 12:32:01 1.50
+++ jsr166/src/main/java/util/ArrayDeque.java 2016/10/30 16:32:40 1.99
@@ -4,10 +4,11 @@
*/
package java.util;
+
import java.io.Serializable;
import java.util.function.Consumer;
-import java.util.stream.Stream;
-import java.util.stream.Streams;
+import java.util.function.Predicate;
+import java.util.function.UnaryOperator;
/**
* Resizable-array implementation of the {@link Deque} interface. Array
@@ -19,16 +20,18 @@ import java.util.stream.Streams;
* when used as a queue.
*
*
Most {@code ArrayDeque} operations run in amortized constant time.
- * Exceptions include {@link #remove(Object) remove}, {@link
- * #removeFirstOccurrence removeFirstOccurrence}, {@link #removeLastOccurrence
- * removeLastOccurrence}, {@link #contains contains}, {@link #iterator
- * iterator.remove()}, and the bulk operations, all of which run in linear
- * time.
+ * Exceptions include
+ * {@link #remove(Object) remove},
+ * {@link #removeFirstOccurrence removeFirstOccurrence},
+ * {@link #removeLastOccurrence removeLastOccurrence},
+ * {@link #contains contains},
+ * {@link #iterator iterator.remove()},
+ * and the bulk operations, all of which run in linear time.
*
- *
The iterators returned by this class's {@code iterator} method are
- * fail-fast: If the deque is modified at any time after the iterator
- * is created, in any way except through the iterator's own {@code remove}
- * method, the iterator will generally throw a {@link
+ *
The iterators returned by this class's {@link #iterator() iterator}
+ * method are fail-fast: If the deque is modified at any time after
+ * the iterator is created, in any way except through the iterator's own
+ * {@code remove} method, the iterator will generally throw a {@link
* ConcurrentModificationException}. Thus, in the face of concurrent
* modification, the iterator fails quickly and cleanly, rather than risking
* arbitrary, non-deterministic behavior at an undetermined time in the
@@ -51,87 +54,104 @@ import java.util.stream.Streams;
* Java Collections Framework.
*
* @author Josh Bloch and Doug Lea
+ * @param the type of elements held in this deque
* @since 1.6
- * @param the type of elements held in this collection
*/
public class ArrayDeque extends AbstractCollection
implements Deque, Cloneable, Serializable
{
/**
* The array in which the elements of the deque are stored.
- * The capacity of the deque is the length of this array, which is
- * always a power of two. The array is never allowed to become
- * full, except transiently within an addX method where it is
- * resized (see doubleCapacity) immediately upon becoming full,
- * thus avoiding head and tail wrapping around to equal each
- * other. We also guarantee that all array cells not holding
- * deque elements are always null.
+ * We guarantee that all array cells not holding deque elements
+ * are always null.
*/
- transient Object[] elements; // non-private to simplify nested class access
+ transient Object[] elements;
/**
* The index of the element at the head of the deque (which is the
* element that would be removed by remove() or pop()); or an
- * arbitrary number equal to tail if the deque is empty.
+ * arbitrary number 0 <= head < elements.length if the deque is empty.
*/
transient int head;
+ /** Number of elements in this collection. */
+ transient int size;
+
/**
- * The index at which the next element would be added to the tail
- * of the deque (via addLast(E), add(E), or push(E)).
+ * The maximum size of array to allocate.
+ * Some VMs reserve some header words in an array.
+ * Attempts to allocate larger arrays may result in
+ * OutOfMemoryError: Requested array size exceeds VM limit
*/
- transient int tail;
+ private static final int MAX_ARRAY_SIZE = Integer.MAX_VALUE - 8;
/**
- * The minimum capacity that we'll use for a newly created deque.
- * Must be a power of 2.
+ * Increases the capacity of this deque by at least the given amount.
+ *
+ * @param needed the required minimum extra capacity; must be positive
*/
- private static final int MIN_INITIAL_CAPACITY = 8;
+ private void grow(int needed) {
+ // overflow-conscious code
+ // checkInvariants();
+ final int oldCapacity = elements.length;
+ int newCapacity;
+ // Double size if small; else grow by 50%
+ int jump = (oldCapacity < 64) ? (oldCapacity + 2) : (oldCapacity >> 1);
+ if (jump < needed
+ || (newCapacity = (oldCapacity + jump)) - MAX_ARRAY_SIZE > 0)
+ newCapacity = newCapacity(needed, jump);
+ elements = Arrays.copyOf(elements, newCapacity);
+ if (oldCapacity - head < size) {
+ // wrap around; slide first leg forward to end of array
+ int newSpace = newCapacity - oldCapacity;
+ System.arraycopy(elements, head,
+ elements, head + newSpace,
+ oldCapacity - head);
+ Arrays.fill(elements, head, head + newSpace, null);
+ head += newSpace;
+ }
+ // checkInvariants();
+ }
- // ****** Array allocation and resizing utilities ******
+ /** Capacity calculation for edge conditions, especially overflow. */
+ private int newCapacity(int needed, int jump) {
+ final int oldCapacity = elements.length, minCapacity;
+ if ((minCapacity = oldCapacity + needed) - MAX_ARRAY_SIZE > 0) {
+ if (minCapacity < 0)
+ throw new IllegalStateException("Sorry, deque too big");
+ return Integer.MAX_VALUE;
+ }
+ if (needed > jump)
+ return minCapacity;
+ return (oldCapacity + jump - MAX_ARRAY_SIZE < 0)
+ ? oldCapacity + jump
+ : MAX_ARRAY_SIZE;
+ }
/**
- * Allocates empty array to hold the given number of elements.
+ * Increases the internal storage of this collection, if necessary,
+ * to ensure that it can hold at least the given number of elements.
*
- * @param numElements the number of elements to hold
+ * @param minCapacity the desired minimum capacity
+ * @since TBD
*/
- private void allocateElements(int numElements) {
- int initialCapacity = MIN_INITIAL_CAPACITY;
- // Find the best power of two to hold elements.
- // Tests "<=" because arrays aren't kept full.
- if (numElements >= initialCapacity) {
- initialCapacity = numElements;
- initialCapacity |= (initialCapacity >>> 1);
- initialCapacity |= (initialCapacity >>> 2);
- initialCapacity |= (initialCapacity >>> 4);
- initialCapacity |= (initialCapacity >>> 8);
- initialCapacity |= (initialCapacity >>> 16);
- initialCapacity++;
-
- if (initialCapacity < 0) // Too many elements, must back off
- initialCapacity >>>= 1;// Good luck allocating 2 ^ 30 elements
- }
- elements = new Object[initialCapacity];
+ /* public */ void ensureCapacity(int minCapacity) {
+ if (minCapacity > elements.length)
+ grow(minCapacity - elements.length);
+ // checkInvariants();
}
/**
- * Doubles the capacity of this deque. Call only when full, i.e.,
- * when head and tail have wrapped around to become equal.
+ * Minimizes the internal storage of this collection.
+ *
+ * @since TBD
*/
- private void doubleCapacity() {
- assert head == tail;
- int p = head;
- int n = elements.length;
- int r = n - p; // number of elements to the right of p
- int newCapacity = n << 1;
- if (newCapacity < 0)
- throw new IllegalStateException("Sorry, deque too big");
- Object[] a = new Object[newCapacity];
- System.arraycopy(elements, p, a, 0, r);
- System.arraycopy(elements, 0, a, r, p);
- elements = a;
- head = 0;
- tail = n;
+ /* public */ void trimToSize() {
+ if (size < elements.length) {
+ elements = toArray();
+ head = 0;
+ }
+ // checkInvariants();
}
/**
@@ -146,10 +166,10 @@ public class ArrayDeque extends Abstr
* Constructs an empty array deque with an initial capacity
* sufficient to hold the specified number of elements.
*
- * @param numElements lower bound on initial capacity of the deque
+ * @param numElements lower bound on initial capacity of the deque
*/
public ArrayDeque(int numElements) {
- allocateElements(numElements);
+ elements = new Object[numElements];
}
/**
@@ -163,8 +183,71 @@ public class ArrayDeque extends Abstr
* @throws NullPointerException if the specified collection is null
*/
public ArrayDeque(Collection extends E> c) {
- allocateElements(c.size());
- addAll(c);
+ Object[] es = c.toArray();
+ // defend against c.toArray (incorrectly) not returning Object[]
+ // (see e.g. https://bugs.openjdk.java.net/browse/JDK-6260652)
+ if (es.getClass() != Object[].class)
+ es = Arrays.copyOf(es, es.length, Object[].class);
+ for (Object obj : es)
+ Objects.requireNonNull(obj);
+ this.elements = es;
+ this.size = es.length;
+ }
+
+ /**
+ * Increments i, mod modulus.
+ * Precondition and postcondition: 0 <= i < modulus.
+ */
+ static final int inc(int i, int modulus) {
+ if (++i >= modulus) i = 0;
+ return i;
+ }
+
+ /**
+ * Decrements i, mod modulus.
+ * Precondition and postcondition: 0 <= i < modulus.
+ */
+ static final int dec(int i, int modulus) {
+ if (--i < 0) i = modulus - 1;
+ return i;
+ }
+
+ /**
+ * Adds i and j, mod modulus.
+ * Precondition and postcondition: 0 <= i < modulus, 0 <= j <= modulus.
+ */
+ static final int add(int i, int j, int modulus) {
+ if ((i += j) - modulus >= 0) i -= modulus;
+ return i;
+ }
+
+ /**
+ * Returns the array index of the last element.
+ * May return invalid index -1 if there are no elements.
+ */
+ final int tail() {
+ return add(head, size - 1, elements.length);
+ }
+
+ /**
+ * Returns element at array index i.
+ */
+ @SuppressWarnings("unchecked")
+ private E elementAt(int i) {
+ return (E) elements[i];
+ }
+
+ /**
+ * A version of elementAt that checks for null elements.
+ * This check doesn't catch all possible comodifications,
+ * but does catch ones that corrupt traversal. It's a little
+ * surprising that javac allows this abuse of generics.
+ */
+ static final E nonNullElementAt(Object[] es, int i) {
+ @SuppressWarnings("unchecked") E e = (E) es[i];
+ if (e == null)
+ throw new ConcurrentModificationException();
+ return e;
}
// The main insertion and extraction methods are addFirst,
@@ -178,11 +261,19 @@ public class ArrayDeque extends Abstr
* @throws NullPointerException if the specified element is null
*/
public void addFirst(E e) {
- if (e == null)
- throw new NullPointerException();
- elements[head = (head - 1) & (elements.length - 1)] = e;
- if (head == tail)
- doubleCapacity();
+ // checkInvariants();
+ Objects.requireNonNull(e);
+ Object[] es;
+ int capacity, h;
+ final int s;
+ if ((s = size) == (capacity = (es = elements).length)) {
+ grow(1);
+ capacity = (es = elements).length;
+ }
+ if ((h = head - 1) < 0) h = capacity - 1;
+ es[head = h] = e;
+ size = s + 1;
+ // checkInvariants();
}
/**
@@ -194,11 +285,38 @@ public class ArrayDeque extends Abstr
* @throws NullPointerException if the specified element is null
*/
public void addLast(E e) {
- if (e == null)
- throw new NullPointerException();
- elements[tail] = e;
- if ( (tail = (tail + 1) & (elements.length - 1)) == head)
- doubleCapacity();
+ // checkInvariants();
+ Objects.requireNonNull(e);
+ Object[] es;
+ int capacity;
+ final int s;
+ if ((s = size) == (capacity = (es = elements).length)) {
+ grow(1);
+ capacity = (es = elements).length;
+ }
+ es[add(head, s, capacity)] = e;
+ size = s + 1;
+ // checkInvariants();
+ }
+
+ /**
+ * Adds all of the elements in the specified collection at the end
+ * of this deque, as if by calling {@link #addLast} on each one,
+ * in the order that they are returned by the collection's
+ * iterator.
+ *
+ * @param c the elements to be inserted into this deque
+ * @return {@code true} if this deque changed as a result of the call
+ * @throws NullPointerException if the specified collection or any
+ * of its elements are null
+ */
+ public boolean addAll(Collection extends E> c) {
+ final int s = size, needed = c.size() - (elements.length - s);
+ if (needed > 0)
+ grow(needed);
+ c.forEach((e) -> addLast(e));
+ // checkInvariants();
+ return size > s;
}
/**
@@ -229,76 +347,84 @@ public class ArrayDeque extends Abstr
* @throws NoSuchElementException {@inheritDoc}
*/
public E removeFirst() {
- E x = pollFirst();
- if (x == null)
+ // checkInvariants();
+ E e = pollFirst();
+ if (e == null)
throw new NoSuchElementException();
- return x;
+ return e;
}
/**
* @throws NoSuchElementException {@inheritDoc}
*/
public E removeLast() {
- E x = pollLast();
- if (x == null)
+ // checkInvariants();
+ E e = pollLast();
+ if (e == null)
throw new NoSuchElementException();
- return x;
+ return e;
}
public E pollFirst() {
- int h = head;
- @SuppressWarnings("unchecked")
- E result = (E) elements[h];
- // Element is null if deque empty
- if (result == null)
+ // checkInvariants();
+ int s, h;
+ if ((s = size) <= 0)
return null;
- elements[h] = null; // Must null out slot
- head = (h + 1) & (elements.length - 1);
- return result;
+ final Object[] es = elements;
+ @SuppressWarnings("unchecked") E e = (E) es[h = head];
+ es[h] = null;
+ if (++h >= es.length) h = 0;
+ head = h;
+ size = s - 1;
+ return e;
}
public E pollLast() {
- int t = (tail - 1) & (elements.length - 1);
- @SuppressWarnings("unchecked")
- E result = (E) elements[t];
- if (result == null)
+ // checkInvariants();
+ final int s, tail;
+ if ((s = size) <= 0)
return null;
- elements[t] = null;
- tail = t;
- return result;
+ final Object[] es = elements;
+ @SuppressWarnings("unchecked")
+ E e = (E) es[tail = add(head, s - 1, es.length)];
+ es[tail] = null;
+ size = s - 1;
+ return e;
}
/**
* @throws NoSuchElementException {@inheritDoc}
*/
public E getFirst() {
- @SuppressWarnings("unchecked")
- E result = (E) elements[head];
- if (result == null)
- throw new NoSuchElementException();
- return result;
+ // checkInvariants();
+ if (size <= 0) throw new NoSuchElementException();
+ return elementAt(head);
}
/**
* @throws NoSuchElementException {@inheritDoc}
*/
+ @SuppressWarnings("unchecked")
public E getLast() {
- @SuppressWarnings("unchecked")
- E result = (E) elements[(tail - 1) & (elements.length - 1)];
- if (result == null)
- throw new NoSuchElementException();
- return result;
+ // checkInvariants();
+ final int s;
+ if ((s = size) <= 0) throw new NoSuchElementException();
+ final Object[] es = elements;
+ return (E) es[add(head, s - 1, es.length)];
}
- @SuppressWarnings("unchecked")
public E peekFirst() {
- // elements[head] is null if deque empty
- return (E) elements[head];
+ // checkInvariants();
+ return (size <= 0) ? null : elementAt(head);
}
@SuppressWarnings("unchecked")
public E peekLast() {
- return (E) elements[(tail - 1) & (elements.length - 1)];
+ // checkInvariants();
+ final int s;
+ if ((s = size) <= 0) return null;
+ final Object[] es = elements;
+ return (E) es[add(head, s - 1, es.length)];
}
/**
@@ -314,17 +440,19 @@ public class ArrayDeque extends Abstr
* @return {@code true} if the deque contained the specified element
*/
public boolean removeFirstOccurrence(Object o) {
- if (o == null)
- return false;
- int mask = elements.length - 1;
- int i = head;
- Object x;
- while ( (x = elements[i]) != null) {
- if (o.equals(x)) {
- delete(i);
- return true;
+ if (o != null) {
+ final Object[] es = elements;
+ int i, end, to, todo;
+ todo = (end = (i = head) + size)
+ - (to = (es.length - end >= 0) ? end : es.length);
+ for (;; to = todo, i = 0, todo = 0) {
+ for (; i < to; i++)
+ if (o.equals(es[i])) {
+ delete(i);
+ return true;
+ }
+ if (todo == 0) break;
}
- i = (i + 1) & mask;
}
return false;
}
@@ -342,17 +470,18 @@ public class ArrayDeque extends Abstr
* @return {@code true} if the deque contained the specified element
*/
public boolean removeLastOccurrence(Object o) {
- if (o == null)
- return false;
- int mask = elements.length - 1;
- int i = (tail - 1) & mask;
- Object x;
- while ( (x = elements[i]) != null) {
- if (o.equals(x)) {
- delete(i);
- return true;
+ if (o != null) {
+ final Object[] es = elements;
+ int i, to, end, todo;
+ todo = (to = ((end = (i = tail()) - size) >= -1) ? end : -1) - end;
+ for (;; to = (i = es.length - 1) - todo, todo = 0) {
+ for (; i > to; i--)
+ if (o.equals(es[i])) {
+ delete(i);
+ return true;
+ }
+ if (todo == 0) break;
}
- i = (i - 1) & mask;
}
return false;
}
@@ -471,59 +600,52 @@ public class ArrayDeque extends Abstr
return removeFirst();
}
- private void checkInvariants() {
- assert elements[tail] == null;
- assert head == tail ? elements[head] == null :
- (elements[head] != null &&
- elements[(tail - 1) & (elements.length - 1)] != null);
- assert elements[(head - 1) & (elements.length - 1)] == null;
- }
-
/**
- * Removes the element at the specified position in the elements array,
- * adjusting head and tail as necessary. This can result in motion of
- * elements backwards or forwards in the array.
+ * Removes the element at the specified position in the elements array.
+ * This can result in forward or backwards motion of array elements.
+ * We optimize for least element motion.
*
* This method is called delete rather than remove to emphasize
* that its semantics differ from those of {@link List#remove(int)}.
*
* @return true if elements moved backwards
*/
- private boolean delete(int i) {
- checkInvariants();
- final Object[] elements = this.elements;
- final int mask = elements.length - 1;
+ boolean delete(int i) {
+ // checkInvariants();
+ final Object[] es = elements;
+ final int capacity = es.length;
final int h = head;
- final int t = tail;
- final int front = (i - h) & mask;
- final int back = (t - i) & mask;
-
- // Invariant: head <= i < tail mod circularity
- if (front >= ((t - h) & mask))
- throw new ConcurrentModificationException();
-
- // Optimize for least element motion
+ int front; // number of elements before to-be-deleted elt
+ if ((front = i - h) < 0) front += capacity;
+ final int back = size - front - 1; // number of elements after
if (front < back) {
+ // move front elements forwards
if (h <= i) {
- System.arraycopy(elements, h, elements, h + 1, front);
+ System.arraycopy(es, h, es, h + 1, front);
} else { // Wrap around
- System.arraycopy(elements, 0, elements, 1, i);
- elements[0] = elements[mask];
- System.arraycopy(elements, h, elements, h + 1, mask - h);
+ System.arraycopy(es, 0, es, 1, i);
+ es[0] = es[capacity - 1];
+ System.arraycopy(es, h, es, h + 1, front - (i + 1));
}
- elements[h] = null;
- head = (h + 1) & mask;
+ es[h] = null;
+ if ((head = (h + 1)) >= capacity) head = 0;
+ size--;
+ // checkInvariants();
return false;
} else {
- if (i < t) { // Copy the null tail as well
- System.arraycopy(elements, i + 1, elements, i, back);
- tail = t - 1;
+ // move back elements backwards
+ int tail = tail();
+ if (i <= tail) {
+ System.arraycopy(es, i + 1, es, i, back);
} else { // Wrap around
- System.arraycopy(elements, i + 1, elements, i, mask - i);
- elements[mask] = elements[0];
- System.arraycopy(elements, 1, elements, 0, t);
- tail = (t - 1) & mask;
+ int firstLeg = capacity - (i + 1);
+ System.arraycopy(es, i + 1, es, i, firstLeg);
+ es[capacity - 1] = es[0];
+ System.arraycopy(es, 1, es, 0, back - firstLeg - 1);
}
+ es[tail] = null;
+ size--;
+ // checkInvariants();
return true;
}
}
@@ -536,7 +658,7 @@ public class ArrayDeque extends Abstr
* @return the number of elements in this deque
*/
public int size() {
- return (tail - head) & (elements.length - 1);
+ return size;
}
/**
@@ -545,7 +667,7 @@ public class ArrayDeque extends Abstr
* @return {@code true} if this deque contains no elements
*/
public boolean isEmpty() {
- return head == tail;
+ return size == 0;
}
/**
@@ -565,86 +687,288 @@ public class ArrayDeque extends Abstr
}
private class DeqIterator implements Iterator {
- /**
- * Index of element to be returned by subsequent call to next.
- */
- private int cursor = head;
+ /** Index of element to be returned by subsequent call to next. */
+ int cursor;
- /**
- * Tail recorded at construction (also in remove), to stop
- * iterator and also to check for comodification.
- */
- private int fence = tail;
+ /** Number of elements yet to be returned. */
+ int remaining = size;
/**
* Index of element returned by most recent call to next.
* Reset to -1 if element is deleted by a call to remove.
*/
- private int lastRet = -1;
+ int lastRet = -1;
- public boolean hasNext() {
- return cursor != fence;
+ DeqIterator() { cursor = head; }
+
+ public final boolean hasNext() {
+ return remaining > 0;
}
public E next() {
- if (cursor == fence)
+ if (remaining <= 0)
throw new NoSuchElementException();
- @SuppressWarnings("unchecked")
- E result = (E) elements[cursor];
- // This check doesn't catch all possible comodifications,
- // but does catch the ones that corrupt traversal
- if (tail != fence || result == null)
- throw new ConcurrentModificationException();
+ final Object[] es = elements;
+ E e = nonNullElementAt(es, cursor);
lastRet = cursor;
- cursor = (cursor + 1) & (elements.length - 1);
- return result;
+ if (++cursor >= es.length) cursor = 0;
+ remaining--;
+ return e;
+ }
+
+ void postDelete(boolean leftShifted) {
+ if (leftShifted)
+ if (--cursor < 0) cursor = elements.length - 1;
}
- public void remove() {
+ public final void remove() {
if (lastRet < 0)
throw new IllegalStateException();
- if (delete(lastRet)) { // if left-shifted, undo increment in next()
- cursor = (cursor - 1) & (elements.length - 1);
- fence = tail;
- }
+ postDelete(delete(lastRet));
lastRet = -1;
}
- }
-
- private class DescendingIterator implements Iterator {
- /*
- * This class is nearly a mirror-image of DeqIterator, using
- * tail instead of head for initial cursor, and head instead of
- * tail for fence.
- */
- private int cursor = tail;
- private int fence = head;
- private int lastRet = -1;
- public boolean hasNext() {
- return cursor != fence;
+ public void forEachRemaining(Consumer super E> action) {
+ Objects.requireNonNull(action);
+ final int k;
+ if ((k = remaining) > 0) {
+ remaining = 0;
+ ArrayDeque.forEachRemaining(action, elements, cursor, k);
+ if ((lastRet = cursor + k - 1) >= elements.length)
+ lastRet -= elements.length;
+ }
}
+ }
- public E next() {
- if (cursor == fence)
+ private class DescendingIterator extends DeqIterator {
+ DescendingIterator() { cursor = tail(); }
+
+ public final E next() {
+ if (remaining <= 0)
throw new NoSuchElementException();
- cursor = (cursor - 1) & (elements.length - 1);
- @SuppressWarnings("unchecked")
- E result = (E) elements[cursor];
- if (head != fence || result == null)
- throw new ConcurrentModificationException();
+ final Object[] es = elements;
+ E e = nonNullElementAt(es, cursor);
lastRet = cursor;
- return result;
+ if (--cursor < 0) cursor = es.length - 1;
+ remaining--;
+ return e;
+ }
+
+ void postDelete(boolean leftShifted) {
+ if (!leftShifted)
+ if (++cursor >= elements.length) cursor = 0;
+ }
+
+ public final void forEachRemaining(Consumer super E> action) {
+ Objects.requireNonNull(action);
+ final int k;
+ if ((k = remaining) > 0) {
+ remaining = 0;
+ final Object[] es = elements;
+ int i, end, to, todo;
+ todo = (to = ((end = (i = cursor) - k) >= -1) ? end : -1) - end;
+ for (;; to = (i = es.length - 1) - todo, todo = 0) {
+ for (; i > to; i--)
+ action.accept(nonNullElementAt(es, i));
+ if (todo == 0) break;
+ }
+ if ((lastRet = cursor - (k - 1)) < 0)
+ lastRet += es.length;
+ }
}
+ }
- public void remove() {
- if (lastRet < 0)
- throw new IllegalStateException();
- if (!delete(lastRet)) {
- cursor = (cursor + 1) & (elements.length - 1);
- fence = head;
+ /**
+ * Creates a late-binding
+ * and fail-fast {@link Spliterator} over the elements in this
+ * deque.
+ *
+ * The {@code Spliterator} reports {@link Spliterator#SIZED},
+ * {@link Spliterator#SUBSIZED}, {@link Spliterator#ORDERED}, and
+ * {@link Spliterator#NONNULL}. Overriding implementations should document
+ * the reporting of additional characteristic values.
+ *
+ * @return a {@code Spliterator} over the elements in this deque
+ * @since 1.8
+ */
+ public Spliterator spliterator() {
+ return new ArrayDequeSpliterator();
+ }
+
+ final class ArrayDequeSpliterator implements Spliterator {
+ private int cursor;
+ private int remaining; // -1 until late-binding first use
+
+ /** Constructs late-binding spliterator over all elements. */
+ ArrayDequeSpliterator() {
+ this.remaining = -1;
+ }
+
+ /** Constructs spliterator over the given slice. */
+ ArrayDequeSpliterator(int cursor, int count) {
+ this.cursor = cursor;
+ this.remaining = count;
+ }
+
+ /** Ensures late-binding initialization; then returns remaining. */
+ private int remaining() {
+ if (remaining < 0) {
+ cursor = head;
+ remaining = size;
}
- lastRet = -1;
+ return remaining;
+ }
+
+ public ArrayDequeSpliterator trySplit() {
+ final int mid;
+ if ((mid = remaining() >> 1) > 0) {
+ int oldCursor = cursor;
+ cursor = add(cursor, mid, elements.length);
+ remaining -= mid;
+ return new ArrayDequeSpliterator(oldCursor, mid);
+ }
+ return null;
+ }
+
+ public void forEachRemaining(Consumer super E> action) {
+ Objects.requireNonNull(action);
+ final int k = remaining(); // side effect!
+ remaining = 0;
+ ArrayDeque.forEachRemaining(action, elements, cursor, k);
+ }
+
+ public boolean tryAdvance(Consumer super E> action) {
+ Objects.requireNonNull(action);
+ final int k;
+ if ((k = remaining()) <= 0)
+ return false;
+ action.accept(nonNullElementAt(elements, cursor));
+ if (++cursor >= elements.length) cursor = 0;
+ remaining = k - 1;
+ return true;
+ }
+
+ public long estimateSize() {
+ return remaining();
+ }
+
+ public int characteristics() {
+ return Spliterator.NONNULL
+ | Spliterator.ORDERED
+ | Spliterator.SIZED
+ | Spliterator.SUBSIZED;
+ }
+ }
+
+ @SuppressWarnings("unchecked")
+ public void forEach(Consumer super E> action) {
+ Objects.requireNonNull(action);
+ final Object[] es = elements;
+ int i, end, to, todo;
+ todo = (end = (i = head) + size)
+ - (to = (es.length - end >= 0) ? end : es.length);
+ for (;; to = todo, i = 0, todo = 0) {
+ for (; i < to; i++)
+ action.accept((E) es[i]);
+ if (todo == 0) break;
+ }
+ // checkInvariants();
+ }
+
+ /**
+ * Calls action on remaining elements, starting at index i and
+ * traversing in ascending order. A variant of forEach that also
+ * checks for concurrent modification, for use in iterators.
+ */
+ static void forEachRemaining(
+ Consumer super E> action, Object[] es, int i, int remaining) {
+ int end, to, todo;
+ todo = (end = i + remaining)
+ - (to = (es.length - end >= 0) ? end : es.length);
+ for (;; to = todo, i = 0, todo = 0) {
+ for (; i < to; i++)
+ action.accept(nonNullElementAt(es, i));
+ if (todo == 0) break;
+ }
+ }
+
+ /**
+ * Replaces each element of this deque with the result of applying the
+ * operator to that element, as specified by {@link List#replaceAll}.
+ *
+ * @param operator the operator to apply to each element
+ * @since TBD
+ */
+ @SuppressWarnings("unchecked")
+ /* public */ void replaceAll(UnaryOperator operator) {
+ Objects.requireNonNull(operator);
+ final Object[] es = elements;
+ int i, end, to, todo;
+ todo = (end = (i = head) + size)
+ - (to = (es.length - end >= 0) ? end : es.length);
+ for (;; to = todo, i = 0, todo = 0) {
+ for (; i < to; i++)
+ es[i] = operator.apply((E) es[i]);
+ if (todo == 0) break;
+ }
+ // checkInvariants();
+ }
+
+ /**
+ * @throws NullPointerException {@inheritDoc}
+ */
+ public boolean removeIf(Predicate super E> filter) {
+ Objects.requireNonNull(filter);
+ return bulkRemove(filter);
+ }
+
+ /**
+ * @throws NullPointerException {@inheritDoc}
+ */
+ public boolean removeAll(Collection> c) {
+ Objects.requireNonNull(c);
+ return bulkRemove(e -> c.contains(e));
+ }
+
+ /**
+ * @throws NullPointerException {@inheritDoc}
+ */
+ public boolean retainAll(Collection> c) {
+ Objects.requireNonNull(c);
+ return bulkRemove(e -> !c.contains(e));
+ }
+
+ /** Implementation of bulk remove methods. */
+ private boolean bulkRemove(Predicate super E> filter) {
+ // checkInvariants();
+ final Object[] es = elements;
+ final int capacity = es.length;
+ int i = head, j = i, remaining = size, deleted = 0;
+ try {
+ for (; remaining > 0; remaining--) {
+ @SuppressWarnings("unchecked") E e = (E) es[i];
+ if (filter.test(e))
+ deleted++;
+ else {
+ if (j != i)
+ es[j] = e;
+ if (++j >= capacity) j = 0;
+ }
+ if (++i >= capacity) i = 0;
+ }
+ return deleted > 0;
+ } catch (Throwable ex) {
+ if (deleted > 0)
+ for (; remaining > 0; remaining--) {
+ es[j] = es[i];
+ if (++i >= capacity) i = 0;
+ if (++j >= capacity) j = 0;
+ }
+ throw ex;
+ } finally {
+ size -= deleted;
+ clearSlice(es, j, deleted);
+ // checkInvariants();
}
}
@@ -657,15 +981,17 @@ public class ArrayDeque extends Abstr
* @return {@code true} if this deque contains the specified element
*/
public boolean contains(Object o) {
- if (o == null)
- return false;
- int mask = elements.length - 1;
- int i = head;
- Object x;
- while ( (x = elements[i]) != null) {
- if (o.equals(x))
- return true;
- i = (i + 1) & mask;
+ if (o != null) {
+ final Object[] es = elements;
+ int i, end, to, todo;
+ todo = (end = (i = head) + size)
+ - (to = (es.length - end >= 0) ? end : es.length);
+ for (;; to = todo, i = 0, todo = 0) {
+ for (; i < to; i++)
+ if (o.equals(es[i]))
+ return true;
+ if (todo == 0) break;
+ }
}
return false;
}
@@ -692,16 +1018,21 @@ public class ArrayDeque extends Abstr
* The deque will be empty after this call returns.
*/
public void clear() {
- int h = head;
- int t = tail;
- if (h != t) { // clear all cells
- head = tail = 0;
- int i = h;
- int mask = elements.length - 1;
- do {
- elements[i] = null;
- i = (i + 1) & mask;
- } while (i != t);
+ clearSlice(elements, head, size);
+ size = head = 0;
+ // checkInvariants();
+ }
+
+ /**
+ * Nulls out count elements, starting at array index i.
+ */
+ private static void clearSlice(Object[] es, int i, int count) {
+ int end, to, todo;
+ todo = (end = i + count)
+ - (to = (es.length - end >= 0) ? end : es.length);
+ for (;; to = todo, i = 0, todo = 0) {
+ Arrays.fill(es, i, to, null);
+ if (todo == 0) break;
}
}
@@ -719,13 +1050,23 @@ public class ArrayDeque extends Abstr
* @return an array containing all of the elements in this deque
*/
public Object[] toArray() {
- final int head = this.head;
- final int tail = this.tail;
- boolean wrap = (tail < head);
- int end = wrap ? tail + elements.length : tail;
- Object[] a = Arrays.copyOfRange(elements, head, end);
- if (wrap)
- System.arraycopy(elements, 0, a, elements.length - head, tail);
+ return toArray(Object[].class);
+ }
+
+ private T[] toArray(Class klazz) {
+ final Object[] es = elements;
+ final int capacity = es.length;
+ final int head = this.head, end = head + size;
+ final T[] a;
+ if (end >= 0) {
+ a = Arrays.copyOfRange(es, head, end, klazz);
+ } else {
+ // integer overflow!
+ a = Arrays.copyOfRange(es, 0, size, klazz);
+ System.arraycopy(es, head, a, 0, capacity - head);
+ }
+ if (end - capacity > 0)
+ System.arraycopy(es, 0, a, capacity - head, end - capacity);
return a;
}
@@ -751,7 +1092,7 @@ public class ArrayDeque extends Abstr
* The following code can be used to dump the deque into a newly
* allocated array of {@code String}:
*
- * {@code String[] y = x.toArray(new String[0]);}
+ * {@code String[] y = x.toArray(new String[0]);}
*
* Note that {@code toArray(new Object[0])} is identical in function to
* {@code toArray()}.
@@ -767,22 +1108,17 @@ public class ArrayDeque extends Abstr
*/
@SuppressWarnings("unchecked")
public T[] toArray(T[] a) {
- final int head = this.head;
- final int tail = this.tail;
- boolean wrap = (tail < head);
- int size = (tail - head) + (wrap ? elements.length : 0);
- int firstLeg = size - (wrap ? tail : 0);
- int len = a.length;
- if (size > len) {
- a = (T[]) Arrays.copyOfRange(elements, head, head + size,
- a.getClass());
- } else {
- System.arraycopy(elements, head, a, 0, firstLeg);
- if (size < len)
- a[size] = null;
- }
- if (wrap)
- System.arraycopy(elements, 0, a, firstLeg, tail);
+ final int size;
+ if ((size = this.size) > a.length)
+ return toArray((Class) a.getClass());
+ final Object[] es = elements;
+ final int head = this.head, end = head + size;
+ final int front = (es.length - end >= 0) ? size : es.length - head;
+ System.arraycopy(es, head, a, 0, front);
+ if (front < size)
+ System.arraycopy(es, 0, a, front, size - front);
+ if (size < a.length)
+ a[size] = null;
return a;
}
@@ -809,6 +1145,8 @@ public class ArrayDeque extends Abstr
/**
* Saves this deque to a stream (that is, serializes it).
*
+ * @param s the stream
+ * @throws java.io.IOException if an I/O error occurs
* @serialData The current size ({@code int}) of the deque,
* followed by all of its elements (each an object reference) in
* first-to-last order.
@@ -818,118 +1156,56 @@ public class ArrayDeque extends Abstr
s.defaultWriteObject();
// Write out size
- s.writeInt(size());
+ s.writeInt(size);
// Write out elements in order.
- int mask = elements.length - 1;
- for (int i = head; i != tail; i = (i + 1) & mask)
- s.writeObject(elements[i]);
+ final Object[] es = elements;
+ int i, end, to, todo;
+ todo = (end = (i = head) + size)
+ - (to = (es.length - end >= 0) ? end : es.length);
+ for (;; to = todo, i = 0, todo = 0) {
+ for (; i < to; i++)
+ s.writeObject(es[i]);
+ if (todo == 0) break;
+ }
}
/**
* Reconstitutes this deque from a stream (that is, deserializes it).
+ * @param s the stream
+ * @throws ClassNotFoundException if the class of a serialized object
+ * could not be found
+ * @throws java.io.IOException if an I/O error occurs
*/
private void readObject(java.io.ObjectInputStream s)
throws java.io.IOException, ClassNotFoundException {
s.defaultReadObject();
// Read in size and allocate array
- int size = s.readInt();
- allocateElements(size);
- head = 0;
- tail = size;
+ elements = new Object[size = s.readInt()];
// Read in all elements in the proper order.
for (int i = 0; i < size; i++)
elements[i] = s.readObject();
}
- Spliterator spliterator() {
- return new DeqSpliterator(this, -1, -1);
- }
-
- public Stream stream() {
- return Streams.stream(spliterator());
- }
-
- public Stream parallelStream() {
- return Streams.parallelStream(spliterator());
- }
-
- static final class DeqSpliterator implements Spliterator {
- private final ArrayDeque deq;
- private int fence; // -1 until first use
- private int index; // current index, modified on traverse/split
-
- /** Creates new spliterator covering the given array and range */
- DeqSpliterator(ArrayDeque deq, int origin, int fence) {
- this.deq = deq;
- this.index = origin;
- this.fence = fence;
- }
-
- private int getFence() { // force initialization
- int t;
- if ((t = fence) < 0) {
- t = fence = deq.tail;
- index = deq.head;
- }
- return t;
- }
-
- public DeqSpliterator trySplit() {
- int t = getFence(), h = index, n = deq.elements.length;
- if (h != t && ((h + 1) & (n - 1)) != t) {
- if (h > t)
- t += n;
- int m = ((h + t) >>> 1) & (n - 1);
- return new DeqSpliterator<>(deq, h, index = m);
- }
- return null;
- }
-
- public void forEach(Consumer super E> consumer) {
- if (consumer == null)
- throw new NullPointerException();
- Object[] a = deq.elements;
- int m = a.length - 1, f = getFence(), i = index;
- index = f;
- while (i != f) {
- @SuppressWarnings("unchecked") E e = (E)a[i];
- i = (i + 1) & m;
- if (e == null)
- throw new ConcurrentModificationException();
- consumer.accept(e);
- }
- }
-
- public boolean tryAdvance(Consumer super E> consumer) {
- if (consumer == null)
- throw new NullPointerException();
- Object[] a = deq.elements;
- int m = a.length - 1, f = getFence(), i = index;
- if (i != fence) {
- @SuppressWarnings("unchecked") E e = (E)a[i];
- index = (i + 1) & m;
- if (e == null)
- throw new ConcurrentModificationException();
- consumer.accept(e);
- return true;
- }
- return false;
- }
-
- public long estimateSize() {
- int n = getFence() - index;
- if (n < 0)
- n += deq.elements.length;
- return (long) n;
- }
-
- @Override
- public int characteristics() {
- return Spliterator.ORDERED | Spliterator.SIZED |
- Spliterator.NONNULL | Spliterator.SUBSIZED;
+ /** debugging */
+ void checkInvariants() {
+ try {
+ int capacity = elements.length;
+ // assert size >= 0 && size <= capacity;
+ // assert head >= 0;
+ // assert capacity == 0 || head < capacity;
+ // assert size == 0 || elements[head] != null;
+ // assert size == 0 || elements[tail()] != null;
+ // assert size == capacity || elements[dec(head, capacity)] == null;
+ // assert size == capacity || elements[inc(tail(), capacity)] == null;
+ } catch (Throwable t) {
+ System.err.printf("head=%d size=%d capacity=%d%n",
+ head, size, elements.length);
+ System.err.printf("elements=%s%n",
+ Arrays.toString(elements));
+ throw t;
}
}