ViewVC Help
View File | Revision Log | Show Annotations | Download File | Root Listing
root/jsr166/jsr166/src/main/java/util/ArrayDeque.java
(Generate patch)

Comparing jsr166/src/main/java/util/ArrayDeque.java (file contents):
Revision 1.84 by jsr166, Sun Oct 23 16:08:46 2016 UTC vs.
Revision 1.112 by jsr166, Tue Nov 8 18:23:10 2016 UTC

# Line 60 | Line 60 | import java.util.function.UnaryOperator;
60   public class ArrayDeque<E> extends AbstractCollection<E>
61                             implements Deque<E>, Cloneable, Serializable
62   {
63 +    /*
64 +     * VMs excel at optimizing simple array loops where indices are
65 +     * incrementing or decrementing over a valid slice, e.g.
66 +     *
67 +     * for (int i = start; i < end; i++) ... elements[i]
68 +     *
69 +     * Because in a circular array, elements are in general stored in
70 +     * two disjoint such slices, we help the VM by writing unusual
71 +     * nested loops for all traversals over the elements.
72 +     */
73 +
74      /**
75       * The array in which the elements of the deque are stored.
76       * We guarantee that all array cells not holding deque elements
# Line 70 | Line 81 | public class ArrayDeque<E> extends Abstr
81      /**
82       * The index of the element at the head of the deque (which is the
83       * element that would be removed by remove() or pop()); or an
84 <     * arbitrary number 0 <= head < elements.length if the deque is empty.
84 >     * arbitrary number 0 <= head < elements.length equal to tail if
85 >     * the deque is empty.
86       */
87      transient int head;
88  
89 <    /** Number of elements in this collection. */
90 <    transient int size;
89 >    /**
90 >     * The index at which the next element would be added to the tail
91 >     * of the deque (via addLast(E), add(E), or push(E)).
92 >     */
93 >    transient int tail;
94  
95      /**
96       * The maximum size of array to allocate.
# Line 92 | Line 107 | public class ArrayDeque<E> extends Abstr
107       */
108      private void grow(int needed) {
109          // overflow-conscious code
110 <        // checkInvariants();
96 <        int oldCapacity = elements.length;
110 >        final int oldCapacity = elements.length;
111          int newCapacity;
112 <        // Double size if small; else grow by 50%
112 >        // Double capacity if small; else grow by 50%
113          int jump = (oldCapacity < 64) ? (oldCapacity + 2) : (oldCapacity >> 1);
114          if (jump < needed
115              || (newCapacity = (oldCapacity + jump)) - MAX_ARRAY_SIZE > 0)
116              newCapacity = newCapacity(needed, jump);
117          elements = Arrays.copyOf(elements, newCapacity);
118 <        if (oldCapacity - head < size) {
118 >        // Exceptionally, here tail == head needs to be disambiguated
119 >        if (tail < head || (tail == head && elements[head] != null)) {
120              // wrap around; slide first leg forward to end of array
121              int newSpace = newCapacity - oldCapacity;
122              System.arraycopy(elements, head,
# Line 115 | Line 130 | public class ArrayDeque<E> extends Abstr
130  
131      /** Capacity calculation for edge conditions, especially overflow. */
132      private int newCapacity(int needed, int jump) {
133 <        int oldCapacity = elements.length;
119 <        int minCapacity;
133 >        final int oldCapacity = elements.length, minCapacity;
134          if ((minCapacity = oldCapacity + needed) - MAX_ARRAY_SIZE > 0) {
135              if (minCapacity < 0)
136                  throw new IllegalStateException("Sorry, deque too big");
# Line 137 | Line 151 | public class ArrayDeque<E> extends Abstr
151       * @since TBD
152       */
153      /* public */ void ensureCapacity(int minCapacity) {
154 <        if (minCapacity > elements.length)
155 <            grow(minCapacity - elements.length);
154 >        int needed;
155 >        if ((needed = (minCapacity + 1 - elements.length)) > 0)
156 >            grow(needed);
157          // checkInvariants();
158      }
159  
# Line 148 | Line 163 | public class ArrayDeque<E> extends Abstr
163       * @since TBD
164       */
165      /* public */ void trimToSize() {
166 <        if (size < elements.length) {
167 <            elements = toArray();
166 >        int size;
167 >        if ((size = size()) + 1 < elements.length) {
168 >            elements = toArray(new Object[size + 1]);
169              head = 0;
170 +            tail = size;
171          }
172          // checkInvariants();
173      }
# Line 170 | Line 187 | public class ArrayDeque<E> extends Abstr
187       * @param numElements lower bound on initial capacity of the deque
188       */
189      public ArrayDeque(int numElements) {
190 <        elements = new Object[numElements];
190 >        elements = new Object[Math.max(1, numElements + 1)];
191      }
192  
193      /**
# Line 184 | Line 201 | public class ArrayDeque<E> extends Abstr
201       * @throws NullPointerException if the specified collection is null
202       */
203      public ArrayDeque(Collection<? extends E> c) {
204 <        Object[] elements = c.toArray();
205 <        // defend against c.toArray (incorrectly) not returning Object[]
189 <        // (see e.g. https://bugs.openjdk.java.net/browse/JDK-6260652)
190 <        if (elements.getClass() != Object[].class)
191 <            elements = Arrays.copyOf(elements, size, Object[].class);
192 <        for (Object obj : elements)
193 <            Objects.requireNonNull(obj);
194 <        size = elements.length;
195 <        this.elements = elements;
204 >        elements = new Object[c.size() + 1];
205 >        addAll(c);
206      }
207  
208      /**
# Line 200 | Line 210 | public class ArrayDeque<E> extends Abstr
210       * Precondition and postcondition: 0 <= i < modulus.
211       */
212      static final int inc(int i, int modulus) {
213 <        if (++i == modulus) i = 0;
213 >        if (++i >= modulus) i = 0;
214          return i;
215      }
216  
# Line 209 | Line 219 | public class ArrayDeque<E> extends Abstr
219       * Precondition and postcondition: 0 <= i < modulus.
220       */
221      static final int dec(int i, int modulus) {
222 <        if (--i < 0) i += modulus;
222 >        if (--i < 0) i = modulus - 1;
223          return i;
224      }
225  
# Line 223 | Line 233 | public class ArrayDeque<E> extends Abstr
233      }
234  
235      /**
236 <     * Returns the array index of the last element.
237 <     * May return invalid index -1 if there are no elements.
236 >     * Subtracts j from i, mod modulus.
237 >     * Index i must be logically ahead of j.
238 >     * Returns the "circular distance" from j to i.
239 >     * Precondition and postcondition: 0 <= i < modulus, 0 <= j < modulus.
240       */
241 <    final int tail() {
242 <        return add(head, size - 1, elements.length);
241 >    static final int sub(int i, int j, int modulus) {
242 >        if ((i -= j) < 0) i += modulus;
243 >        return i;
244      }
245  
246      /**
247       * Returns element at array index i.
248 +     * This is a slight abuse of generics, accepted by javac.
249       */
250      @SuppressWarnings("unchecked")
251 <    final E elementAt(int i) {
252 <        return (E) elements[i];
251 >    static final <E> E elementAt(Object[] es, int i) {
252 >        return (E) es[i];
253      }
254  
255      /**
# Line 243 | Line 257 | public class ArrayDeque<E> extends Abstr
257       * This check doesn't catch all possible comodifications,
258       * but does catch ones that corrupt traversal.
259       */
260 <    E checkedElementAt(Object[] elements, int i) {
261 <        @SuppressWarnings("unchecked") E e = (E) elements[i];
260 >    static final <E> E nonNullElementAt(Object[] es, int i) {
261 >        @SuppressWarnings("unchecked") E e = (E) es[i];
262          if (e == null)
263              throw new ConcurrentModificationException();
264          return e;
# Line 261 | Line 275 | public class ArrayDeque<E> extends Abstr
275       * @throws NullPointerException if the specified element is null
276       */
277      public void addFirst(E e) {
278 <        // checkInvariants();
279 <        Objects.requireNonNull(e);
280 <        final Object[] elements;
281 <        final int capacity, s;
282 <        if ((s = size) == (capacity = (elements = this.elements).length))
283 <            addFirstSlowPath(e);
270 <        else
271 <            elements[head = dec(head, capacity)] = e;
272 <        size = s + 1;
278 >        if (e == null)
279 >            throw new NullPointerException();
280 >        final Object[] es = elements;
281 >        es[head = dec(head, es.length)] = e;
282 >        if (head == tail)
283 >            grow(1);
284          // checkInvariants();
285      }
286  
276    private void addFirstSlowPath(E e) {
277        grow(1);
278        final Object[] elements = this.elements;
279        elements[head = dec(head, elements.length)] = e;
280    }
281
287      /**
288       * Inserts the specified element at the end of this deque.
289       *
# Line 288 | Line 293 | public class ArrayDeque<E> extends Abstr
293       * @throws NullPointerException if the specified element is null
294       */
295      public void addLast(E e) {
296 +        if (e == null)
297 +            throw new NullPointerException();
298 +        final Object[] es = elements;
299 +        es[tail] = e;
300 +        if (head == (tail = inc(tail, es.length)))
301 +            grow(1);
302          // checkInvariants();
292        Objects.requireNonNull(e);
293        final Object[] elements;
294        final int capacity, s;
295        if ((s = size) == (capacity = (elements = this.elements).length))
296            addLastSlowPath(e);
297        else
298            elements[add(head, s, capacity)] = e;
299        size = s + 1;
300        // checkInvariants();
301    }
302
303    private void addLastSlowPath(E e) {
304        grow(1);
305        final Object[] elements = this.elements;
306        elements[add(head, size, elements.length)] = e;
303      }
304  
305      /**
# Line 317 | Line 313 | public class ArrayDeque<E> extends Abstr
313       * @throws NullPointerException if the specified collection or any
314       *         of its elements are null
315       */
320    @Override
316      public boolean addAll(Collection<? extends E> c) {
317 +        final int s = size(), needed;
318 +        if ((needed = s + c.size() - elements.length + 1) > 0)
319 +            grow(needed);
320 +        c.forEach(e -> addLast(e));
321          // checkInvariants();
322 <        Object[] a, elements;
324 <        int newcomers, capacity, s = size;
325 <        if ((newcomers = (a = c.toArray()).length) == 0)
326 <            return false;
327 <        while ((capacity = (elements = this.elements).length) - s < newcomers)
328 <            grow(newcomers - (capacity - s));
329 <        int i = add(head, s, capacity);
330 <        for (Object x : a) {
331 <            Objects.requireNonNull(x);
332 <            elements[i] = x;
333 <            i = inc(i, capacity);
334 <            size++;
335 <        }
336 <        return true;
322 >        return size() > s;
323      }
324  
325      /**
# Line 364 | Line 350 | public class ArrayDeque<E> extends Abstr
350       * @throws NoSuchElementException {@inheritDoc}
351       */
352      public E removeFirst() {
367        // checkInvariants();
353          E e = pollFirst();
354          if (e == null)
355              throw new NoSuchElementException();
356 +        // checkInvariants();
357          return e;
358      }
359  
# Line 375 | Line 361 | public class ArrayDeque<E> extends Abstr
361       * @throws NoSuchElementException {@inheritDoc}
362       */
363      public E removeLast() {
378        // checkInvariants();
364          E e = pollLast();
365          if (e == null)
366              throw new NoSuchElementException();
367 +        // checkInvariants();
368          return e;
369      }
370  
371      public E pollFirst() {
372 +        final Object[] es;
373 +        final int h;
374 +        E e = elementAt(es = elements, h = head);
375 +        if (e != null) {
376 +            es[h] = null;
377 +            head = inc(h, es.length);
378 +        }
379          // checkInvariants();
387        final int s, h;
388        if ((s = size) == 0)
389            return null;
390        final Object[] elements = this.elements;
391        @SuppressWarnings("unchecked") E e = (E) elements[h = head];
392        elements[h] = null;
393        head = inc(h, elements.length);
394        size = s - 1;
380          return e;
381      }
382  
383      public E pollLast() {
384 +        final Object[] es;
385 +        final int t;
386 +        E e = elementAt(es = elements, t = dec(tail, es.length));
387 +        if (e != null)
388 +            es[tail = t] = null;
389          // checkInvariants();
400        final int s, tail;
401        if ((s = size) == 0)
402            return null;
403        final Object[] elements = this.elements;
404        @SuppressWarnings("unchecked")
405        E e = (E) elements[tail = add(head, s - 1, elements.length)];
406        elements[tail] = null;
407        size = s - 1;
390          return e;
391      }
392  
# Line 412 | Line 394 | public class ArrayDeque<E> extends Abstr
394       * @throws NoSuchElementException {@inheritDoc}
395       */
396      public E getFirst() {
397 +        E e = elementAt(elements, head);
398 +        if (e == null)
399 +            throw new NoSuchElementException();
400          // checkInvariants();
401 <        if (size == 0) throw new NoSuchElementException();
417 <        return elementAt(head);
401 >        return e;
402      }
403  
404      /**
405       * @throws NoSuchElementException {@inheritDoc}
406       */
407      public E getLast() {
408 +        final Object[] es = elements;
409 +        E e = elementAt(es, dec(tail, es.length));
410 +        if (e == null)
411 +            throw new NoSuchElementException();
412          // checkInvariants();
413 <        if (size == 0) throw new NoSuchElementException();
426 <        return elementAt(tail());
413 >        return e;
414      }
415  
416      public E peekFirst() {
417          // checkInvariants();
418 <        return (size == 0) ? null : elementAt(head);
418 >        return elementAt(elements, head);
419      }
420  
421      public E peekLast() {
422          // checkInvariants();
423 <        return (size == 0) ? null : elementAt(tail());
423 >        final Object[] es;
424 >        return elementAt(es = elements, dec(tail, es.length));
425      }
426  
427      /**
# Line 449 | Line 437 | public class ArrayDeque<E> extends Abstr
437       * @return {@code true} if the deque contained the specified element
438       */
439      public boolean removeFirstOccurrence(Object o) {
452        // checkInvariants();
440          if (o != null) {
441 <            final Object[] elements = this.elements;
442 <            final int capacity = elements.length;
443 <            for (int k = size, i = head; --k >= 0; i = inc(i, capacity)) {
444 <                if (o.equals(elements[i])) {
445 <                    delete(i);
446 <                    return true;
447 <                }
441 >            final Object[] es = elements;
442 >            for (int i = head, end = tail, to = (i <= end) ? end : es.length;
443 >                 ; i = 0, to = end) {
444 >                for (; i < to; i++)
445 >                    if (o.equals(es[i])) {
446 >                        delete(i);
447 >                        return true;
448 >                    }
449 >                if (to == end) break;
450              }
451          }
452          return false;
# Line 477 | Line 466 | public class ArrayDeque<E> extends Abstr
466       */
467      public boolean removeLastOccurrence(Object o) {
468          if (o != null) {
469 <            final Object[] elements = this.elements;
470 <            final int capacity = elements.length;
471 <            for (int k = size, i = add(head, k - 1, capacity);
472 <                 --k >= 0; i = dec(i, capacity)) {
473 <                if (o.equals(elements[i])) {
474 <                    delete(i);
475 <                    return true;
476 <                }
469 >            final Object[] es = elements;
470 >            for (int i = tail, end = head, to = (i >= end) ? end : 0;
471 >                 ; i = es.length, to = end) {
472 >                for (i--; i > to - 1; i--)
473 >                    if (o.equals(es[i])) {
474 >                        delete(i);
475 >                        return true;
476 >                    }
477 >                if (to == end) break;
478              }
479          }
480          return false;
# Line 612 | Line 602 | public class ArrayDeque<E> extends Abstr
602       * <p>This method is called delete rather than remove to emphasize
603       * that its semantics differ from those of {@link List#remove(int)}.
604       *
605 <     * @return true if elements moved backwards
605 >     * @return true if elements near tail moved backwards
606       */
607      boolean delete(int i) {
608          // checkInvariants();
609 <        final Object[] elements = this.elements;
610 <        final int capacity = elements.length;
609 >        final Object[] es = elements;
610 >        final int capacity = es.length;
611          final int h = head;
612 <        int front;              // number of elements before to-be-deleted elt
613 <        if ((front = i - h) < 0) front += capacity;
614 <        final int back = size - front - 1; // number of elements after
612 >        // number of elements before to-be-deleted elt
613 >        final int front = sub(i, h, capacity);
614 >        final int back = size() - front - 1; // number of elements after
615          if (front < back) {
616              // move front elements forwards
617              if (h <= i) {
618 <                System.arraycopy(elements, h, elements, h + 1, front);
618 >                System.arraycopy(es, h, es, h + 1, front);
619              } else { // Wrap around
620 <                System.arraycopy(elements, 0, elements, 1, i);
621 <                elements[0] = elements[capacity - 1];
622 <                System.arraycopy(elements, h, elements, h + 1, front - (i + 1));
620 >                System.arraycopy(es, 0, es, 1, i);
621 >                es[0] = es[capacity - 1];
622 >                System.arraycopy(es, h, es, h + 1, front - (i + 1));
623              }
624 <            elements[h] = null;
624 >            es[h] = null;
625              head = inc(h, capacity);
636            size--;
626              // checkInvariants();
627              return false;
628          } else {
629              // move back elements backwards
630 <            int tail = tail();
630 >            tail = dec(tail, capacity);
631              if (i <= tail) {
632 <                System.arraycopy(elements, i + 1, elements, i, back);
632 >                System.arraycopy(es, i + 1, es, i, back);
633              } else { // Wrap around
634                  int firstLeg = capacity - (i + 1);
635 <                System.arraycopy(elements, i + 1, elements, i, firstLeg);
636 <                elements[capacity - 1] = elements[0];
637 <                System.arraycopy(elements, 1, elements, 0, back - firstLeg - 1);
635 >                System.arraycopy(es, i + 1, es, i, firstLeg);
636 >                es[capacity - 1] = es[0];
637 >                System.arraycopy(es, 1, es, 0, back - firstLeg - 1);
638              }
639 <            elements[tail] = null;
651 <            size--;
639 >            es[tail] = null;
640              // checkInvariants();
641              return true;
642          }
# Line 662 | Line 650 | public class ArrayDeque<E> extends Abstr
650       * @return the number of elements in this deque
651       */
652      public int size() {
653 <        return size;
653 >        return sub(tail, head, elements.length);
654      }
655  
656      /**
# Line 671 | Line 659 | public class ArrayDeque<E> extends Abstr
659       * @return {@code true} if this deque contains no elements
660       */
661      public boolean isEmpty() {
662 <        return size == 0;
662 >        return head == tail;
663      }
664  
665      /**
# Line 695 | Line 683 | public class ArrayDeque<E> extends Abstr
683          int cursor;
684  
685          /** Number of elements yet to be returned. */
686 <        int remaining = size;
686 >        int remaining = size();
687  
688          /**
689           * Index of element returned by most recent call to next.
# Line 710 | Line 698 | public class ArrayDeque<E> extends Abstr
698          }
699  
700          public E next() {
701 <            if (remaining == 0)
701 >            if (remaining <= 0)
702                  throw new NoSuchElementException();
703 <            E e = checkedElementAt(elements, cursor);
703 >            final Object[] es = elements;
704 >            E e = nonNullElementAt(es, cursor);
705              lastRet = cursor;
706 <            cursor = inc(cursor, elements.length);
706 >            cursor = inc(cursor, es.length);
707              remaining--;
708              return e;
709          }
710  
711          void postDelete(boolean leftShifted) {
712              if (leftShifted)
713 <                cursor = dec(cursor, elements.length); // undo inc in next
713 >                cursor = dec(cursor, elements.length);
714          }
715  
716          public final void remove() {
# Line 733 | Line 722 | public class ArrayDeque<E> extends Abstr
722  
723          public void forEachRemaining(Consumer<? super E> action) {
724              Objects.requireNonNull(action);
725 <            final Object[] elements = ArrayDeque.this.elements;
726 <            final int capacity = elements.length;
727 <            int k = remaining;
725 >            int r;
726 >            if ((r = remaining) <= 0)
727 >                return;
728              remaining = 0;
729 <            for (int i = cursor; --k >= 0; i = inc(i, capacity))
730 <                action.accept(checkedElementAt(elements, i));
729 >            final Object[] es = elements;
730 >            if (es[cursor] == null || sub(tail, cursor, es.length) != r)
731 >                throw new ConcurrentModificationException();
732 >            for (int i = cursor, end = tail, to = (i <= end) ? end : es.length;
733 >                 ; i = 0, to = end) {
734 >                for (; i < to; i++)
735 >                    action.accept(elementAt(es, i));
736 >                if (to == end) {
737 >                    if (end != tail)
738 >                        throw new ConcurrentModificationException();
739 >                    lastRet = dec(end, es.length);
740 >                    break;
741 >                }
742 >            }
743          }
744      }
745  
746      private class DescendingIterator extends DeqIterator {
747 <        DescendingIterator() { cursor = tail(); }
747 >        DescendingIterator() { cursor = dec(tail, elements.length); }
748  
749          public final E next() {
750 <            if (remaining == 0)
750 >            if (remaining <= 0)
751                  throw new NoSuchElementException();
752 <            E e = checkedElementAt(elements, cursor);
752 >            final Object[] es = elements;
753 >            E e = nonNullElementAt(es, cursor);
754              lastRet = cursor;
755 <            cursor = dec(cursor, elements.length);
755 >            cursor = dec(cursor, es.length);
756              remaining--;
757              return e;
758          }
759  
760          void postDelete(boolean leftShifted) {
761              if (!leftShifted)
762 <                cursor = inc(cursor, elements.length); // undo dec in next
762 >                cursor = inc(cursor, elements.length);
763          }
764  
765          public final void forEachRemaining(Consumer<? super E> action) {
766              Objects.requireNonNull(action);
767 <            final Object[] elements = ArrayDeque.this.elements;
768 <            final int capacity = elements.length;
769 <            int k = remaining;
767 >            int r;
768 >            if ((r = remaining) <= 0)
769 >                return;
770              remaining = 0;
771 <            for (int i = cursor; --k >= 0; i = dec(i, capacity))
772 <                action.accept(checkedElementAt(elements, i));
771 >            final Object[] es = elements;
772 >            if (es[cursor] == null || sub(cursor, head, es.length) + 1 != r)
773 >                throw new ConcurrentModificationException();
774 >            for (int i = cursor, end = head, to = (i >= end) ? end : 0;
775 >                 ; i = es.length - 1, to = end) {
776 >                // hotspot generates faster code than for: i >= to !
777 >                for (; i > to - 1; i--)
778 >                    action.accept(elementAt(es, i));
779 >                if (to == end) {
780 >                    if (end != head)
781 >                        throw new ConcurrentModificationException();
782 >                    lastRet = end;
783 >                    break;
784 >                }
785 >            }
786          }
787      }
788  
# Line 785 | Line 800 | public class ArrayDeque<E> extends Abstr
800       * @since 1.8
801       */
802      public Spliterator<E> spliterator() {
803 <        return new ArrayDequeSpliterator();
803 >        return new DeqSpliterator();
804      }
805  
806 <    final class ArrayDequeSpliterator implements Spliterator<E> {
807 <        private int cursor;
808 <        private int remaining; // -1 until late-binding first use
806 >    final class DeqSpliterator implements Spliterator<E> {
807 >        private int fence;      // -1 until first use
808 >        private int cursor;     // current index, modified on traverse/split
809  
810          /** Constructs late-binding spliterator over all elements. */
811 <        ArrayDequeSpliterator() {
812 <            this.remaining = -1;
811 >        DeqSpliterator() {
812 >            this.fence = -1;
813          }
814  
815 <        /** Constructs spliterator over the given slice. */
816 <        ArrayDequeSpliterator(int cursor, int count) {
817 <            this.cursor = cursor;
818 <            this.remaining = count;
815 >        /** Constructs spliterator over the given range. */
816 >        DeqSpliterator(int origin, int fence) {
817 >            this.cursor = origin;
818 >            this.fence = fence;
819          }
820  
821 <        /** Ensures late-binding initialization; then returns remaining. */
822 <        private int remaining() {
823 <            if (remaining < 0) {
821 >        /** Ensures late-binding initialization; then returns fence. */
822 >        private int getFence() { // force initialization
823 >            int t;
824 >            if ((t = fence) < 0) {
825 >                t = fence = tail;
826                  cursor = head;
810                remaining = size;
827              }
828 <            return remaining;
828 >            return t;
829          }
830  
831 <        public ArrayDequeSpliterator trySplit() {
832 <            final int mid;
833 <            if ((mid = remaining() >> 1) > 0) {
834 <                int oldCursor = cursor;
835 <                cursor = add(cursor, mid, elements.length);
836 <                remaining -= mid;
821 <                return new ArrayDequeSpliterator(oldCursor, mid);
822 <            }
823 <            return null;
831 >        public DeqSpliterator trySplit() {
832 >            final Object[] es = elements;
833 >            final int i, n;
834 >            return ((n = sub(getFence(), i = cursor, es.length) >> 1) <= 0)
835 >                ? null
836 >                : new DeqSpliterator(i, cursor = add(i, n, es.length));
837          }
838  
839          public void forEachRemaining(Consumer<? super E> action) {
840 <            Objects.requireNonNull(action);
841 <            final Object[] elements = ArrayDeque.this.elements;
842 <            final int capacity = elements.length;
843 <            int k = remaining();
844 <            remaining = 0;
845 <            for (int i = cursor; --k >= 0; i = inc(i, capacity))
846 <                action.accept(checkedElementAt(elements, i));
840 >            if (action == null)
841 >                throw new NullPointerException();
842 >            final int end = getFence(), cursor = this.cursor;
843 >            final Object[] es = elements;
844 >            if (cursor != end) {
845 >                this.cursor = end;
846 >                // null check at both ends of range is sufficient
847 >                if (es[cursor] == null || es[dec(end, es.length)] == null)
848 >                    throw new ConcurrentModificationException();
849 >                for (int i = cursor, to = (i <= end) ? end : es.length;
850 >                     ; i = 0, to = end) {
851 >                    for (; i < to; i++)
852 >                        action.accept(elementAt(es, i));
853 >                    if (to == end) break;
854 >                }
855 >            }
856          }
857  
858          public boolean tryAdvance(Consumer<? super E> action) {
859 <            Objects.requireNonNull(action);
860 <            if (remaining() == 0)
859 >            if (action == null)
860 >                throw new NullPointerException();
861 >            int t, i;
862 >            if ((t = fence) < 0) t = getFence();
863 >            if (t == (i = cursor))
864                  return false;
865 <            action.accept(checkedElementAt(elements, cursor));
866 <            cursor = inc(cursor, elements.length);
867 <            remaining--;
865 >            final Object[] es;
866 >            action.accept(nonNullElementAt(es = elements, i));
867 >            cursor = inc(i, es.length);
868              return true;
869          }
870  
871          public long estimateSize() {
872 <            return remaining();
872 >            return sub(getFence(), cursor, elements.length);
873          }
874  
875          public int characteristics() {
# Line 855 | Line 880 | public class ArrayDeque<E> extends Abstr
880          }
881      }
882  
858    @Override
883      public void forEach(Consumer<? super E> action) {
860        // checkInvariants();
884          Objects.requireNonNull(action);
885 <        final Object[] elements = this.elements;
886 <        final int capacity = elements.length;
887 <        for (int k = size, i = head; --k >= 0; i = inc(i, capacity))
888 <            action.accept(elementAt(i));
885 >        final Object[] es = elements;
886 >        for (int i = head, end = tail, to = (i <= end) ? end : es.length;
887 >             ; i = 0, to = end) {
888 >            for (; i < to; i++)
889 >                action.accept(elementAt(es, i));
890 >            if (to == end) {
891 >                if (end != tail) throw new ConcurrentModificationException();
892 >                break;
893 >            }
894 >        }
895          // checkInvariants();
896      }
897  
# Line 875 | Line 904 | public class ArrayDeque<E> extends Abstr
904       */
905      /* public */ void replaceAll(UnaryOperator<E> operator) {
906          Objects.requireNonNull(operator);
907 <        final Object[] elements = this.elements;
908 <        final int capacity = elements.length;
909 <        for (int k = size, i = head; --k >= 0; i = inc(i, capacity))
910 <            elements[i] = operator.apply(elementAt(i));
907 >        final Object[] es = elements;
908 >        for (int i = head, end = tail, to = (i <= end) ? end : es.length;
909 >             ; i = 0, to = end) {
910 >            for (; i < to; i++)
911 >                es[i] = operator.apply(elementAt(es, i));
912 >            if (to == end) {
913 >                if (end != tail) throw new ConcurrentModificationException();
914 >                break;
915 >            }
916 >        }
917          // checkInvariants();
918      }
919  
920      /**
921       * @throws NullPointerException {@inheritDoc}
922       */
888    @Override
923      public boolean removeIf(Predicate<? super E> filter) {
924          Objects.requireNonNull(filter);
925          return bulkRemove(filter);
# Line 894 | Line 928 | public class ArrayDeque<E> extends Abstr
928      /**
929       * @throws NullPointerException {@inheritDoc}
930       */
897    @Override
931      public boolean removeAll(Collection<?> c) {
932          Objects.requireNonNull(c);
933          return bulkRemove(e -> c.contains(e));
# Line 903 | Line 936 | public class ArrayDeque<E> extends Abstr
936      /**
937       * @throws NullPointerException {@inheritDoc}
938       */
906    @Override
939      public boolean retainAll(Collection<?> c) {
940          Objects.requireNonNull(c);
941          return bulkRemove(e -> !c.contains(e));
# Line 912 | Line 944 | public class ArrayDeque<E> extends Abstr
944      /** Implementation of bulk remove methods. */
945      private boolean bulkRemove(Predicate<? super E> filter) {
946          // checkInvariants();
947 <        final Object[] elements = this.elements;
948 <        final int capacity = elements.length;
949 <        int i = head, j = i, remaining = size, deleted = 0;
947 >        final Object[] es = elements;
948 >        // Optimize for initial run of survivors
949 >        for (int i = head, end = tail, to = (i <= end) ? end : es.length;
950 >             ; i = 0, to = end) {
951 >            for (; i < to; i++)
952 >                if (filter.test(elementAt(es, i)))
953 >                    return bulkRemoveModified(filter, i, to);
954 >            if (to == end) {
955 >                if (end != tail) throw new ConcurrentModificationException();
956 >                break;
957 >            }
958 >        }
959 >        return false;
960 >    }
961 >
962 >    /**
963 >     * Helper for bulkRemove, in case of at least one deletion.
964 >     * @param i valid index of first element to be deleted
965 >     */
966 >    private boolean bulkRemoveModified(
967 >        Predicate<? super E> filter, int i, int to) {
968 >        final Object[] es = elements;
969 >        final int capacity = es.length;
970 >        // a two-finger algorithm, with hare i reading, tortoise j writing
971 >        int j = i++;
972 >        final int end = tail;
973          try {
974 <            for (; remaining > 0; remaining--, i = inc(i, capacity)) {
975 <                @SuppressWarnings("unchecked") E e = (E) elements[i];
976 <                if (filter.test(e))
977 <                    deleted++;
978 <                else {
979 <                    if (j != i)
980 <                        elements[j] = e;
981 <                    j = inc(j, capacity);
974 >            for (;; j = 0) {    // j rejoins i on second leg
975 >                E e;
976 >                // In this loop, i and j are on the same leg, with i > j
977 >                for (; i < to; i++)
978 >                    if (!filter.test(e = elementAt(es, i)))
979 >                        es[j++] = e;
980 >                if (to == end) break;
981 >                // In this loop, j is on the first leg, i on the second
982 >                for (i = 0, to = end; i < to && j < capacity; i++)
983 >                    if (!filter.test(e = elementAt(es, i)))
984 >                        es[j++] = e;
985 >                if (i >= to) {
986 >                    if (j == capacity) j = 0; // "corner" case
987 >                    break;
988                  }
989              }
990 <            return deleted > 0;
990 >            return true;
991          } catch (Throwable ex) {
992 <            if (deleted > 0)
993 <                for (; remaining > 0;
994 <                     remaining--, i = inc(i, capacity), j = inc(j, capacity))
934 <                    elements[j] = elements[i];
992 >            // copy remaining elements
993 >            for (; i != end; i = inc(i, capacity), j = inc(j, capacity))
994 >                es[j] = es[i];
995              throw ex;
996          } finally {
997 <            size -= deleted;
998 <            for (; --deleted >= 0; j = inc(j, capacity))
939 <                elements[j] = null;
997 >            if (end != tail) throw new ConcurrentModificationException();
998 >            circularClear(es, tail = j, end);
999              // checkInvariants();
1000          }
1001      }
# Line 951 | Line 1010 | public class ArrayDeque<E> extends Abstr
1010       */
1011      public boolean contains(Object o) {
1012          if (o != null) {
1013 <            final Object[] elements = this.elements;
1014 <            final int capacity = elements.length;
1015 <            for (int k = size, i = head; --k >= 0; i = inc(i, capacity))
1016 <                if (o.equals(elements[i]))
1017 <                    return true;
1013 >            final Object[] es = elements;
1014 >            for (int i = head, end = tail, to = (i <= end) ? end : es.length;
1015 >                 ; i = 0, to = end) {
1016 >                for (; i < to; i++)
1017 >                    if (o.equals(es[i]))
1018 >                        return true;
1019 >                if (to == end) break;
1020 >            }
1021          }
1022          return false;
1023      }
# Line 982 | Line 1044 | public class ArrayDeque<E> extends Abstr
1044       * The deque will be empty after this call returns.
1045       */
1046      public void clear() {
1047 <        final Object[] elements = this.elements;
1048 <        final int capacity = elements.length;
987 <        final int h = this.head;
988 <        final int s = size;
989 <        if (capacity - h >= s)
990 <            Arrays.fill(elements, h, h + s, null);
991 <        else {
992 <            Arrays.fill(elements, h, capacity, null);
993 <            Arrays.fill(elements, 0, s - capacity + h, null);
994 <        }
995 <        size = head = 0;
1047 >        circularClear(elements, head, tail);
1048 >        head = tail = 0;
1049          // checkInvariants();
1050      }
1051  
1052      /**
1053 +     * Nulls out slots starting at array index i, upto index end.
1054 +     */
1055 +    private static void circularClear(Object[] es, int i, int end) {
1056 +        for (int to = (i <= end) ? end : es.length;
1057 +             ; i = 0, to = end) {
1058 +            Arrays.fill(es, i, to, null);
1059 +            if (to == end) break;
1060 +        }
1061 +    }
1062 +
1063 +    /**
1064       * Returns an array containing all of the elements in this deque
1065       * in proper sequence (from first to last element).
1066       *
# Line 1010 | Line 1074 | public class ArrayDeque<E> extends Abstr
1074       * @return an array containing all of the elements in this deque
1075       */
1076      public Object[] toArray() {
1077 <        final int head = this.head;
1078 <        final int firstLeg;
1079 <        Object[] a = Arrays.copyOfRange(elements, head, head + size);
1080 <        if ((firstLeg = elements.length - head) < size)
1081 <            System.arraycopy(elements, 0, a, firstLeg, size - firstLeg);
1077 >        return toArray(Object[].class);
1078 >    }
1079 >
1080 >    private <T> T[] toArray(Class<T[]> klazz) {
1081 >        final Object[] es = elements;
1082 >        final T[] a;
1083 >        final int size = size(), head = this.head, end;
1084 >        final int len = Math.min(size, es.length - head);
1085 >        if ((end = head + size) >= 0) {
1086 >            a = Arrays.copyOfRange(es, head, end, klazz);
1087 >        } else {
1088 >            // integer overflow!
1089 >            a = Arrays.copyOfRange(es, 0, size, klazz);
1090 >            System.arraycopy(es, head, a, 0, len);
1091 >        }
1092 >        if (tail < head)
1093 >            System.arraycopy(es, 0, a, len, tail);
1094          return a;
1095      }
1096  
# Line 1056 | Line 1132 | public class ArrayDeque<E> extends Abstr
1132       */
1133      @SuppressWarnings("unchecked")
1134      public <T> T[] toArray(T[] a) {
1135 <        final Object[] elements = this.elements;
1136 <        final int head = this.head;
1137 <        final int firstLeg;
1138 <        boolean wrap = (firstLeg = elements.length - head) < size;
1139 <        if (size > a.length) {
1140 <            a = (T[]) Arrays.copyOfRange(elements, head, head + size,
1141 <                                         a.getClass());
1142 <        } else {
1067 <            System.arraycopy(elements, head, a, 0, wrap ? firstLeg : size);
1068 <            if (size < a.length)
1069 <                a[size] = null;
1135 >        final int size;
1136 >        if ((size = size()) > a.length)
1137 >            return toArray((Class<T[]>) a.getClass());
1138 >        final Object[] es = elements;
1139 >        for (int i = head, j = 0, len = Math.min(size, es.length - i);
1140 >             ; i = 0, len = tail) {
1141 >            System.arraycopy(es, i, a, j, len);
1142 >            if ((j += len) == size) break;
1143          }
1144 <        if (wrap)
1145 <            System.arraycopy(elements, 0, a, firstLeg, size - firstLeg);
1144 >        if (size < a.length)
1145 >            a[size] = null;
1146          return a;
1147      }
1148  
# Line 1107 | Line 1180 | public class ArrayDeque<E> extends Abstr
1180          s.defaultWriteObject();
1181  
1182          // Write out size
1183 <        s.writeInt(size);
1183 >        s.writeInt(size());
1184  
1185          // Write out elements in order.
1186 <        final Object[] elements = this.elements;
1187 <        final int capacity = elements.length;
1188 <        for (int k = size, i = head; --k >= 0; i = inc(i, capacity))
1189 <            s.writeObject(elements[i]);
1186 >        final Object[] es = elements;
1187 >        for (int i = head, end = tail, to = (i <= end) ? end : es.length;
1188 >             ; i = 0, to = end) {
1189 >            for (; i < to; i++)
1190 >                s.writeObject(es[i]);
1191 >            if (to == end) break;
1192 >        }
1193      }
1194  
1195      /**
# Line 1128 | Line 1204 | public class ArrayDeque<E> extends Abstr
1204          s.defaultReadObject();
1205  
1206          // Read in size and allocate array
1207 <        elements = new Object[size = s.readInt()];
1207 >        int size = s.readInt();
1208 >        elements = new Object[size + 1];
1209 >        this.tail = size;
1210  
1211          // Read in all elements in the proper order.
1212          for (int i = 0; i < size; i++)
# Line 1136 | Line 1214 | public class ArrayDeque<E> extends Abstr
1214      }
1215  
1216      /** debugging */
1217 <    private void checkInvariants() {
1217 >    void checkInvariants() {
1218          try {
1219              int capacity = elements.length;
1220 <            assert size >= 0 && size <= capacity;
1221 <            assert head >= 0 && ((capacity == 0 && head == 0 && size == 0)
1222 <                                 || head < capacity);
1223 <            assert size == 0
1224 <                || (elements[head] != null && elements[tail()] != null);
1225 <            assert size == capacity
1226 <                || (elements[dec(head, capacity)] == null
1149 <                    && elements[inc(tail(), capacity)] == null);
1220 >            // assert head >= 0 && head < capacity;
1221 >            // assert tail >= 0 && tail < capacity;
1222 >            // assert capacity > 0;
1223 >            // assert size() < capacity;
1224 >            // assert head == tail || elements[head] != null;
1225 >            // assert elements[tail] == null;
1226 >            // assert head == tail || elements[dec(tail, capacity)] != null;
1227          } catch (Throwable t) {
1228 <            System.err.printf("head=%d size=%d capacity=%d%n",
1229 <                              head, size, elements.length);
1228 >            System.err.printf("head=%d tail=%d capacity=%d%n",
1229 >                              head, tail, elements.length);
1230              System.err.printf("elements=%s%n",
1231                                Arrays.toString(elements));
1232              throw t;

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines