--- jsr166/src/main/java/util/ArrayDeque.java 2005/09/16 23:59:27 1.22
+++ jsr166/src/main/java/util/ArrayDeque.java 2016/10/20 01:43:31 1.80
@@ -1,11 +1,14 @@
/*
* Written by Josh Bloch of Google Inc. and released to the public domain,
- * as explained at http://creativecommons.org/licenses/publicdomain.
+ * as explained at http://creativecommons.org/publicdomain/zero/1.0/.
*/
package java.util;
-import java.util.*; // for javadoc (till 6280605 is fixed)
-import java.io.*;
+
+import java.io.Serializable;
+import java.util.function.Consumer;
+import java.util.function.Predicate;
+import java.util.function.UnaryOperator;
/**
* Resizable-array implementation of the {@link Deque} interface. Array
@@ -16,17 +19,19 @@ import java.io.*;
* {@link Stack} when used as a stack, and faster than {@link LinkedList}
* when used as a queue.
*
- *
Most 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.
+ *
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.
*
- *
The iterators returned by this class's 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 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
@@ -35,7 +40,7 @@ import java.io.*;
*
Note that the fail-fast behavior of an iterator cannot be guaranteed
* as it is, generally speaking, impossible to make any hard guarantees in the
* presence of unsynchronized concurrent modification. Fail-fast iterators
- * throw ConcurrentModificationException on a best-effort basis.
+ * throw {@code ConcurrentModificationException} on a best-effort basis.
* Therefore, it would be wrong to write a program that depended on this
* exception for its correctness: the fail-fast behavior of iterators
* should be used only to detect bugs.
@@ -45,109 +50,109 @@ import java.io.*;
* Iterator} interfaces.
*
*
This class is a member of the
- *
+ *
* 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.
*/
- private transient E[] elements;
+ 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.
*/
- private transient int head;
+ transient int head;
- /**
- * The index at which the next element would be added to the tail
- * of the deque (via addLast(E), add(E), or push(E)).
- */
- private transient int tail;
+ /** Number of elements in this collection. */
+ transient int size;
/**
- * The minimum capacity that we'll use for a newly created deque.
- * Must be a power of 2.
- */
- private static final int MIN_INITIAL_CAPACITY = 8;
-
- // ****** Array allocation and resizing utilities ******
-
- /**
- * Allocate empty array to hold the given number of elements.
- *
- * @param numElements the number of elements to hold
- */
- 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++;
+ * 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
+ */
+ private static final int MAX_ARRAY_SIZE = Integer.MAX_VALUE - 8;
+
+ /**
+ * Increases the capacity of this deque by at least the given amount.
+ *
+ * @param needed the required minimum extra capacity; must be positive
+ */
+ private void grow(int needed) {
+ // overflow-conscious code
+ // checkInvariants();
+ 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();
+ }
- if (initialCapacity < 0) // Too many elements, must back off
- initialCapacity >>>= 1;// Good luck allocating 2 ^ 30 elements
+ /** Capacity calculation for edge conditions, especially overflow. */
+ private int newCapacity(int needed, int jump) {
+ int oldCapacity = elements.length;
+ int minCapacity;
+ if ((minCapacity = oldCapacity + needed) - MAX_ARRAY_SIZE > 0) {
+ if (minCapacity < 0)
+ throw new IllegalStateException("Sorry, deque too big");
+ return Integer.MAX_VALUE;
}
- elements = (E[]) new Object[initialCapacity];
+ if (needed > jump)
+ return minCapacity;
+ return (oldCapacity + jump - MAX_ARRAY_SIZE < 0)
+ ? oldCapacity + jump
+ : MAX_ARRAY_SIZE;
}
/**
- * Double the capacity of this deque. Call only when full, i.e.,
- * when head and tail have wrapped around to become equal.
+ * Increases the internal storage of this collection, if necessary,
+ * to ensure that it can hold at least the given number of elements.
+ *
+ * @param minCapacity the desired minimum capacity
+ * @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 = (E[])a;
- head = 0;
- tail = n;
+ /* public */ void ensureCapacity(int minCapacity) {
+ if (minCapacity > elements.length)
+ grow(minCapacity - elements.length);
+ // checkInvariants();
}
/**
- * Copies the elements from our element array into the specified array,
- * in order (from first to last element in the deque). It is assumed
- * that the array is large enough to hold all elements in the deque.
+ * Minimizes the internal storage of this collection.
*
- * @return its argument
+ * @since TBD
*/
- private T[] copyElements(T[] a) {
- if (head < tail) {
- System.arraycopy(elements, head, a, 0, size());
- } else if (head > tail) {
- int headPortionLen = elements.length - head;
- System.arraycopy(elements, head, a, 0, headPortionLen);
- System.arraycopy(elements, 0, a, headPortionLen, tail);
+ /* public */ void trimToSize() {
+ if (size < elements.length) {
+ elements = toArray();
+ head = 0;
}
- return a;
+ // checkInvariants();
}
/**
@@ -155,17 +160,17 @@ public class ArrayDeque extends Abstr
* sufficient to hold 16 elements.
*/
public ArrayDeque() {
- elements = (E[]) new Object[16];
+ elements = new Object[16];
}
/**
* 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];
}
/**
@@ -179,8 +184,70 @@ 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[] elements = c.toArray();
+ // defend against c.toArray (incorrectly) not returning Object[]
+ // (see e.g. https://bugs.openjdk.java.net/browse/JDK-6260652)
+ if (elements.getClass() != Object[].class)
+ elements = Arrays.copyOf(elements, size, Object[].class);
+ for (Object obj : elements)
+ Objects.requireNonNull(obj);
+ size = elements.length;
+ this.elements = elements;
+ }
+
+ /**
+ * 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;
+ 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")
+ final 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.
+ */
+ E checkedElementAt(Object[] elements, int i) {
+ @SuppressWarnings("unchecked") E e = (E) elements[i];
+ if (e == null)
+ throw new ConcurrentModificationException();
+ return e;
}
// The main insertion and extraction methods are addFirst,
@@ -194,11 +261,14 @@ 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[] elements;
+ int capacity, s = size;
+ while (s == (capacity = (elements = this.elements).length))
+ grow(1);
+ elements[head = dec(head, capacity)] = e;
+ size = s + 1;
}
/**
@@ -210,18 +280,51 @@ 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[] elements;
+ int capacity, s = size;
+ while (s == (capacity = (elements = this.elements).length))
+ grow(1);
+ elements[add(head, s, capacity)] = e;
+ size = s + 1;
+ }
+
+ /**
+ * 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
+ */
+ @Override
+ public boolean addAll(Collection extends E> c) {
+ // checkInvariants();
+ Object[] a, elements;
+ int newcomers, capacity, s = size;
+ if ((newcomers = (a = c.toArray()).length) == 0)
+ return false;
+ while ((capacity = (elements = this.elements).length) - s < newcomers)
+ grow(newcomers - (capacity - s));
+ int i = add(head, s, capacity);
+ for (Object x : a) {
+ Objects.requireNonNull(x);
+ elements[i] = x;
+ i = inc(i, capacity);
+ size++;
+ }
+ return true;
}
/**
* Inserts the specified element at the front of this deque.
*
* @param e the element to add
- * @return true (as specified by {@link Deque#offerFirst})
+ * @return {@code true} (as specified by {@link Deque#offerFirst})
* @throws NullPointerException if the specified element is null
*/
public boolean offerFirst(E e) {
@@ -233,7 +336,7 @@ public class ArrayDeque extends Abstr
* Inserts the specified element at the end of this deque.
*
* @param e the element to add
- * @return true (as specified by {@link Deque#offerLast})
+ * @return {@code true} (as specified by {@link Deque#offerLast})
* @throws NullPointerException if the specified element is null
*/
public boolean offerLast(E e) {
@@ -245,6 +348,7 @@ public class ArrayDeque extends Abstr
* @throws NoSuchElementException {@inheritDoc}
*/
public E removeFirst() {
+ // checkInvariants();
E x = pollFirst();
if (x == null)
throw new NoSuchElementException();
@@ -255,6 +359,7 @@ public class ArrayDeque extends Abstr
* @throws NoSuchElementException {@inheritDoc}
*/
public E removeLast() {
+ // checkInvariants();
E x = pollLast();
if (x == null)
throw new NoSuchElementException();
@@ -262,77 +367,82 @@ public class ArrayDeque extends Abstr
}
public E pollFirst() {
- int h = head;
- E result = elements[h]; // Element is null if deque empty
- if (result == null)
+ // checkInvariants();
+ final 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[] elements = this.elements;
+ @SuppressWarnings("unchecked") E e = (E) elements[h = head];
+ elements[h] = null;
+ head = inc(h, elements.length);
+ size = s - 1;
+ return e;
}
public E pollLast() {
- int t = (tail - 1) & (elements.length - 1);
- E result = 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[] elements = this.elements;
+ @SuppressWarnings("unchecked")
+ E e = (E) elements[tail = add(head, s - 1, elements.length)];
+ elements[tail] = null;
+ size = s - 1;
+ return e;
}
/**
* @throws NoSuchElementException {@inheritDoc}
*/
public E getFirst() {
- E x = elements[head];
- if (x == null)
- throw new NoSuchElementException();
- return x;
+ // checkInvariants();
+ if (size == 0) throw new NoSuchElementException();
+ return elementAt(head);
}
/**
* @throws NoSuchElementException {@inheritDoc}
*/
public E getLast() {
- E x = elements[(tail - 1) & (elements.length - 1)];
- if (x == null)
- throw new NoSuchElementException();
- return x;
+ // checkInvariants();
+ if (size == 0) throw new NoSuchElementException();
+ return elementAt(tail());
}
public E peekFirst() {
- return elements[head]; // elements[head] is null if deque empty
+ // checkInvariants();
+ return (size == 0) ? null : elementAt(head);
}
public E peekLast() {
- return elements[(tail - 1) & (elements.length - 1)];
+ // checkInvariants();
+ return (size == 0) ? null : elementAt(tail());
}
/**
* Removes the first occurrence of the specified element in this
* deque (when traversing the deque from head to tail).
* If the deque does not contain the element, it is unchanged.
- * More formally, removes the first element e such that
- * o.equals(e) (if such an element exists).
- * Returns true if this deque contained the specified element
+ * More formally, removes the first element {@code e} such that
+ * {@code o.equals(e)} (if such an element exists).
+ * Returns {@code true} if this deque contained the specified element
* (or equivalently, if this deque changed as a result of the call).
*
* @param o element to be removed from this deque, if present
- * @return true if the deque contained the specified element
+ * @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;
- E x;
- while ( (x = elements[i]) != null) {
- if (o.equals(x)) {
- delete(i);
- return true;
+ // checkInvariants();
+ if (o != null) {
+ final Object[] elements = this.elements;
+ final int capacity = elements.length;
+ for (int k = size, i = head; --k >= 0; i = inc(i, capacity)) {
+ if (o.equals(elements[i])) {
+ delete(i);
+ return true;
+ }
}
- i = (i + 1) & mask;
}
return false;
}
@@ -341,26 +451,25 @@ public class ArrayDeque extends Abstr
* Removes the last occurrence of the specified element in this
* deque (when traversing the deque from head to tail).
* If the deque does not contain the element, it is unchanged.
- * More formally, removes the last element e such that
- * o.equals(e) (if such an element exists).
- * Returns true if this deque contained the specified element
+ * More formally, removes the last element {@code e} such that
+ * {@code o.equals(e)} (if such an element exists).
+ * Returns {@code true} if this deque contained the specified element
* (or equivalently, if this deque changed as a result of the call).
*
* @param o element to be removed from this deque, if present
- * @return true if the deque contained the specified element
+ * @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;
- E x;
- while ( (x = elements[i]) != null) {
- if (o.equals(x)) {
- delete(i);
- return true;
+ if (o != null) {
+ final Object[] elements = this.elements;
+ final int capacity = elements.length;
+ for (int k = size, i = add(head, k - 1, capacity);
+ --k >= 0; i = dec(i, capacity)) {
+ if (o.equals(elements[i])) {
+ delete(i);
+ return true;
+ }
}
- i = (i - 1) & mask;
}
return false;
}
@@ -373,7 +482,7 @@ public class ArrayDeque extends Abstr
* This method is equivalent to {@link #addLast}.
*
* @param e the element to add
- * @return true (as specified by {@link Collection#add})
+ * @return {@code true} (as specified by {@link Collection#add})
* @throws NullPointerException if the specified element is null
*/
public boolean add(E e) {
@@ -387,7 +496,7 @@ public class ArrayDeque extends Abstr
* This method is equivalent to {@link #offerLast}.
*
* @param e the element to add
- * @return true (as specified by {@link Queue#offer})
+ * @return {@code true} (as specified by {@link Queue#offer})
* @throws NullPointerException if the specified element is null
*/
public boolean offer(E e) {
@@ -412,12 +521,12 @@ public class ArrayDeque extends Abstr
/**
* Retrieves and removes the head of the queue represented by this deque
* (in other words, the first element of this deque), or returns
- * null if this deque is empty.
+ * {@code null} if this deque is empty.
*
* This method is equivalent to {@link #pollFirst}.
*
* @return the head of the queue represented by this deque, or
- * null if this deque is empty
+ * {@code null} if this deque is empty
*/
public E poll() {
return pollFirst();
@@ -439,12 +548,12 @@ public class ArrayDeque extends Abstr
/**
* Retrieves, but does not remove, the head of the queue represented by
- * this deque, or returns null if this deque is empty.
+ * this deque, or returns {@code null} if this deque is empty.
*
* This method is equivalent to {@link #peekFirst}.
*
* @return the head of the queue represented by this deque, or
- * null if this deque is empty
+ * {@code null} if this deque is empty
*/
public E peek() {
return peekFirst();
@@ -480,48 +589,53 @@ public class ArrayDeque extends Abstr
}
/**
- * 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) {
- int mask = elements.length - 1;
- int front = (i - head) & mask;
- int back = (tail - i) & mask;
-
- // Invariant: head <= i < tail mod circularity
- if (front >= ((tail - head) & mask))
- throw new ConcurrentModificationException();
-
- // Optimize for least element motion
- if (front < back) {
- if (head <= i) {
- System.arraycopy(elements, head, elements, head + 1, front);
- } else { // Wrap around
- System.arraycopy(elements, 0, elements, 1, i);
- elements[0] = elements[mask];
- System.arraycopy(elements, head, elements, head + 1, mask - head);
- }
- elements[head] = null;
- head = (head + 1) & mask;
+ boolean delete(int i) {
+ // checkInvariants();
+ final Object[] elements = this.elements;
+ final int capacity = elements.length;
+ final int h = head;
+ 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);
+ } else { // Wrap around
+ System.arraycopy(elements, 0, elements, 1, i);
+ elements[0] = elements[capacity - 1];
+ System.arraycopy(elements, h, elements, h + 1, front - (i + 1));
+ }
+ elements[h] = null;
+ head = inc(h, capacity);
+ size--;
+ // checkInvariants();
return false;
- } else {
- int t = tail;
- tail = (tail - 1) & mask;
- if (i < t) { // Copy the null tail as well
- System.arraycopy(elements, i + 1, elements, 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);
- }
+ } else {
+ // move back elements backwards
+ int tail = tail();
+ if (i <= tail) {
+ System.arraycopy(elements, i + 1, elements, i, back);
+ } else { // Wrap around
+ int firstLeg = capacity - (i + 1);
+ System.arraycopy(elements, i + 1, elements, i, firstLeg);
+ elements[capacity - 1] = elements[0];
+ System.arraycopy(elements, 1, elements, 0, back - firstLeg - 1);
+ }
+ elements[tail] = null;
+ size--;
+ // checkInvariants();
return true;
- }
+ }
}
// *** Collection Methods ***
@@ -532,16 +646,16 @@ public class ArrayDeque extends Abstr
* @return the number of elements in this deque
*/
public int size() {
- return (tail - head) & (elements.length - 1);
+ return size;
}
/**
- * Returns true if this deque contains no elements.
+ * Returns {@code true} if this deque contains no elements.
*
- * @return true if this deque contains no elements
+ * @return {@code true} if this deque contains no elements
*/
public boolean isEmpty() {
- return head == tail;
+ return size == 0;
}
/**
@@ -561,107 +675,261 @@ 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;
+
+ DeqIterator() { cursor = head; }
+
+ int advance(int i, int modulus) {
+ return inc(i, modulus);
+ }
- public boolean hasNext() {
- return cursor != fence;
+ void doRemove() {
+ if (delete(lastRet))
+ // if left-shifted, undo advance in next()
+ cursor = dec(cursor, elements.length);
}
- public E next() {
- E result;
- if (cursor == fence)
+ public final boolean hasNext() {
+ return remaining > 0;
+ }
+
+ public final E next() {
+ if (remaining == 0)
throw new NoSuchElementException();
- // This check doesn't catch all possible comodifications,
- // but does catch the ones that corrupt traversal
- if (tail != fence || (result = elements[cursor]) == null)
- throw new ConcurrentModificationException();
+ E e = checkedElementAt(elements, cursor);
lastRet = cursor;
- cursor = (cursor + 1) & (elements.length - 1);
- return result;
+ cursor = advance(cursor, elements.length);
+ remaining--;
+ return e;
}
- 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);
+ doRemove();
lastRet = -1;
- fence = tail;
+ }
+
+ public final void forEachRemaining(Consumer super E> action) {
+ Objects.requireNonNull(action);
+ final Object[] elements = ArrayDeque.this.elements;
+ final int capacity = elements.length;
+ int k = remaining;
+ remaining = 0;
+ for (int i = cursor; --k >= 0; i = advance(i, capacity))
+ action.accept(checkedElementAt(elements, i));
}
}
+ private class DescendingIterator extends DeqIterator {
+ DescendingIterator() { cursor = tail(); }
- private class DescendingIterator implements Iterator {
- /*
- * This class is nearly a mirror-image of DeqIterator, using
- * (tail-1) instead of head for initial cursor, (head-1)
- * instead of tail for fence, and elements.length instead of -1
- * for sentinel. It shares the same structure, but not many
- * actual lines of code.
- */
- private int cursor = (tail - 1) & (elements.length - 1);
- private int fence = (head - 1) & (elements.length - 1);
- private int lastRet = elements.length;
+ @Override int advance(int i, int modulus) {
+ return dec(i, modulus);
+ }
- public boolean hasNext() {
- return cursor != fence;
+ @Override void doRemove() {
+ if (!delete(lastRet))
+ // if right-shifted, undo advance in next
+ cursor = inc(cursor, elements.length);
}
+ }
- public E next() {
- E result;
- if (cursor == fence)
- throw new NoSuchElementException();
- if (((head - 1) & (elements.length - 1)) != fence ||
- (result = elements[cursor]) == null)
- throw new ConcurrentModificationException();
- lastRet = cursor;
- cursor = (cursor - 1) & (elements.length - 1);
- return result;
+ /**
+ * 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;
}
- public void remove() {
- if (lastRet >= elements.length)
- throw new IllegalStateException();
- if (!delete(lastRet))
- cursor = (cursor + 1) & (elements.length - 1);
- lastRet = elements.length;
- fence = (head - 1) & (elements.length - 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;
+ }
+ 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 Object[] elements = ArrayDeque.this.elements;
+ final int capacity = elements.length;
+ int k = remaining();
+ remaining = 0;
+ for (int i = cursor; --k >= 0; i = inc(i, capacity))
+ action.accept(checkedElementAt(elements, i));
+ }
+
+ public boolean tryAdvance(Consumer super E> action) {
+ Objects.requireNonNull(action);
+ if (remaining() == 0)
+ return false;
+ action.accept(checkedElementAt(elements, cursor));
+ cursor = inc(cursor, elements.length);
+ remaining--;
+ return true;
+ }
+
+ public long estimateSize() {
+ return remaining();
+ }
+
+ public int characteristics() {
+ return Spliterator.NONNULL
+ | Spliterator.ORDERED
+ | Spliterator.SIZED
+ | Spliterator.SUBSIZED;
}
}
+ @Override
+ public void forEach(Consumer super E> action) {
+ // checkInvariants();
+ Objects.requireNonNull(action);
+ final Object[] elements = this.elements;
+ final int capacity = elements.length;
+ for (int k = size, i = head; --k >= 0; i = inc(i, capacity))
+ action.accept(elementAt(i));
+ // checkInvariants();
+ }
+
/**
- * Returns true if this deque contains the specified element.
- * More formally, returns true if and only if this deque contains
- * at least one element e such that o.equals(e).
+ * 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
+ */
+ /* public */ void replaceAll(UnaryOperator operator) {
+ Objects.requireNonNull(operator);
+ final Object[] elements = this.elements;
+ final int capacity = elements.length;
+ for (int k = size, i = head; --k >= 0; i = inc(i, capacity))
+ elements[i] = operator.apply(elementAt(i));
+ // checkInvariants();
+ }
+
+ /**
+ * @throws NullPointerException {@inheritDoc}
+ */
+ @Override
+ public boolean removeIf(Predicate super E> filter) {
+ Objects.requireNonNull(filter);
+ return bulkRemove(filter);
+ }
+
+ /**
+ * @throws NullPointerException {@inheritDoc}
+ */
+ @Override
+ public boolean removeAll(Collection> c) {
+ Objects.requireNonNull(c);
+ return bulkRemove(e -> c.contains(e));
+ }
+
+ /**
+ * @throws NullPointerException {@inheritDoc}
+ */
+ @Override
+ 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[] elements = this.elements;
+ final int capacity = elements.length;
+ int i = head, j = i, remaining = size, deleted = 0;
+ try {
+ for (; remaining > 0; remaining--, i = inc(i, capacity)) {
+ @SuppressWarnings("unchecked") E e = (E) elements[i];
+ if (filter.test(e))
+ deleted++;
+ else {
+ if (j != i)
+ elements[j] = e;
+ j = inc(j, capacity);
+ }
+ }
+ return deleted > 0;
+ } catch (Throwable ex) {
+ if (deleted > 0)
+ for (; remaining > 0;
+ remaining--, i = inc(i, capacity), j = inc(j, capacity))
+ elements[j] = elements[i];
+ throw ex;
+ } finally {
+ size -= deleted;
+ for (; --deleted >= 0; j = inc(j, capacity))
+ elements[j] = null;
+ // checkInvariants();
+ }
+ }
+
+ /**
+ * Returns {@code true} if this deque contains the specified element.
+ * More formally, returns {@code true} if and only if this deque contains
+ * at least one element {@code e} such that {@code o.equals(e)}.
*
* @param o object to be checked for containment in this deque
- * @return true if this deque contains the specified element
+ * @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;
- E x;
- while ( (x = elements[i]) != null) {
- if (o.equals(x))
- return true;
- i = (i + 1) & mask;
+ if (o != null) {
+ final Object[] elements = this.elements;
+ final int capacity = elements.length;
+ for (int k = size, i = head; --k >= 0; i = inc(i, capacity))
+ if (o.equals(elements[i]))
+ return true;
}
return false;
}
@@ -669,15 +937,15 @@ public class ArrayDeque extends Abstr
/**
* Removes a single instance of the specified element from this deque.
* If the deque does not contain the element, it is unchanged.
- * More formally, removes the first element e such that
- * o.equals(e) (if such an element exists).
- * Returns true if this deque contained the specified element
+ * More formally, removes the first element {@code e} such that
+ * {@code o.equals(e)} (if such an element exists).
+ * Returns {@code true} if this deque contained the specified element
* (or equivalently, if this deque changed as a result of the call).
*
- * This method is equivalent to {@link #removeFirstOccurrence}.
+ *
This method is equivalent to {@link #removeFirstOccurrence(Object)}.
*
* @param o element to be removed from this deque, if present
- * @return true if this deque contained the specified element
+ * @return {@code true} if this deque contained the specified element
*/
public boolean remove(Object o) {
return removeFirstOccurrence(o);
@@ -688,17 +956,18 @@ 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);
+ final Object[] elements = this.elements;
+ final int capacity = elements.length;
+ final int h = this.head;
+ final int s = size;
+ if (capacity - h >= s)
+ Arrays.fill(elements, h, h + s, null);
+ else {
+ Arrays.fill(elements, h, capacity, null);
+ Arrays.fill(elements, 0, s - capacity + h, null);
}
+ size = head = 0;
+ // checkInvariants();
}
/**
@@ -715,7 +984,12 @@ public class ArrayDeque extends Abstr
* @return an array containing all of the elements in this deque
*/
public Object[] toArray() {
- return copyElements(new Object[size()]);
+ final int head = this.head;
+ final int firstLeg;
+ Object[] a = Arrays.copyOfRange(elements, head, head + size);
+ if ((firstLeg = elements.length - head) < size)
+ System.arraycopy(elements, 0, a, firstLeg, size - firstLeg);
+ return a;
}
/**
@@ -729,22 +1003,21 @@ public class ArrayDeque extends Abstr
* If this deque fits in the specified array with room to spare
* (i.e., the array has more elements than this deque), the element in
* the array immediately following the end of the deque is set to
- * null.
+ * {@code null}.
*
*
Like the {@link #toArray()} method, this method acts as bridge between
* array-based and collection-based APIs. Further, this method allows
* precise control over the runtime type of the output array, and may,
* under certain circumstances, be used to save allocation costs.
*
- *
Suppose x is a deque known to contain only strings.
+ *
Suppose {@code x} is a deque known to contain only strings.
* The following code can be used to dump the deque into a newly
- * allocated array of String:
+ * allocated array of {@code String}:
*
- *
- * String[] y = x.toArray(new String[0]);
+ * {@code String[] y = x.toArray(new String[0]);}
*
- * Note that toArray(new Object[0]) is identical in function to
- * toArray().
+ * Note that {@code toArray(new Object[0])} is identical in function to
+ * {@code toArray()}.
*
* @param a the array into which the elements of the deque are to
* be stored, if it is big enough; otherwise, a new array of the
@@ -755,14 +1028,22 @@ public class ArrayDeque extends Abstr
* this deque
* @throws NullPointerException if the specified array is null
*/
+ @SuppressWarnings("unchecked")
public T[] toArray(T[] a) {
- int size = size();
- if (a.length < size)
- a = (T[])java.lang.reflect.Array.newInstance(
- a.getClass().getComponentType(), size);
- copyElements(a);
- if (a.length > size)
- a[size] = null;
+ final Object[] elements = this.elements;
+ final int head = this.head;
+ final int firstLeg;
+ boolean wrap = (firstLeg = elements.length - head) < size;
+ if (size > a.length) {
+ a = (T[]) Arrays.copyOfRange(elements, head, head + size,
+ a.getClass());
+ } else {
+ System.arraycopy(elements, head, a, 0, wrap ? firstLeg : size);
+ if (size < a.length)
+ a[size] = null;
+ }
+ if (wrap)
+ System.arraycopy(elements, 0, a, firstLeg, size - firstLeg);
return a;
}
@@ -775,57 +1056,78 @@ public class ArrayDeque extends Abstr
*/
public ArrayDeque clone() {
try {
+ @SuppressWarnings("unchecked")
ArrayDeque result = (ArrayDeque) super.clone();
- // These two lines are currently faster than cloning the array:
- result.elements = (E[]) new Object[elements.length];
- System.arraycopy(elements, 0, result.elements, 0, elements.length);
+ result.elements = Arrays.copyOf(elements, elements.length);
return result;
-
} catch (CloneNotSupportedException e) {
throw new AssertionError();
}
}
- /**
- * Appease the serialization gods.
- */
private static final long serialVersionUID = 2340985798034038923L;
/**
- * Serialize this deque.
+ * Saves this deque to a stream (that is, serializes it).
*
- * @serialData The current size (int) of the deque,
+ * @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.
*/
- private void writeObject(ObjectOutputStream s) throws IOException {
+ private void writeObject(java.io.ObjectOutputStream s)
+ throws java.io.IOException {
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)
+ final Object[] elements = this.elements;
+ final int capacity = elements.length;
+ for (int k = size, i = head; --k >= 0; i = inc(i, capacity))
s.writeObject(elements[i]);
}
/**
- * Deserialize this deque.
+ * 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(ObjectInputStream s)
- throws IOException, ClassNotFoundException {
+ 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] = (E)s.readObject();
+ elements[i] = s.readObject();
+ }
+ /** debugging */
+ private void checkInvariants() {
+ try {
+ int capacity = elements.length;
+ assert size >= 0 && size <= capacity;
+ assert head >= 0 && ((capacity == 0 && head == 0 && size == 0)
+ || head < capacity);
+ assert size == 0
+ || (elements[head] != null && elements[tail()] != null);
+ assert size == capacity
+ || (elements[dec(head, capacity)] == null
+ && 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;
+ }
}
+
}