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.85 by jsr166, Sun Oct 23 19:30:54 2016 UTC vs.
Revision 1.108 by jsr166, Sat Nov 5 14:41:14 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 <        size = elements.length;
191 <        if (elements.getClass() != Object[].class)
192 <            elements = Arrays.copyOf(elements, size, Object[].class);
193 <        for (Object obj : elements)
194 <            Objects.requireNonNull(obj);
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 +     * 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 +    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 the array index of the last element.
248       * May return invalid index -1 if there are no elements.
249       */
250 <    final int tail() {
251 <        return add(head, size - 1, elements.length);
250 >    final int last() {
251 >        return dec(tail, elements.length);
252      }
253  
254      /**
255       * Returns element at array index i.
256 +     * This is a slight abuse of generics, accepted by javac.
257       */
258      @SuppressWarnings("unchecked")
259 <    final E elementAt(int i) {
260 <        return (E) elements[i];
259 >    static final <E> E elementAt(Object[] es, int i) {
260 >        return (E) es[i];
261      }
262  
263      /**
# Line 243 | Line 265 | public class ArrayDeque<E> extends Abstr
265       * This check doesn't catch all possible comodifications,
266       * but does catch ones that corrupt traversal.
267       */
268 <    E checkedElementAt(Object[] elements, int i) {
269 <        @SuppressWarnings("unchecked") E e = (E) elements[i];
268 >    static final <E> E nonNullElementAt(Object[] es, int i) {
269 >        @SuppressWarnings("unchecked") E e = (E) es[i];
270          if (e == null)
271              throw new ConcurrentModificationException();
272          return e;
# Line 261 | Line 283 | public class ArrayDeque<E> extends Abstr
283       * @throws NullPointerException if the specified element is null
284       */
285      public void addFirst(E e) {
286 +        if (e == null)
287 +            throw new NullPointerException();
288 +        final Object[] es = elements;
289 +        es[head = dec(head, es.length)] = e;
290 +        if (head == tail)
291 +            grow(1);
292          // checkInvariants();
265        Objects.requireNonNull(e);
266        final Object[] elements;
267        final int capacity, s;
268        if ((s = size) == (capacity = (elements = this.elements).length))
269            addFirstSlowPath(e);
270        else
271            elements[head = dec(head, capacity)] = e;
272        size = s + 1;
273        // checkInvariants();
274    }
275
276    private void addFirstSlowPath(E e) {
277        grow(1);
278        final Object[] elements = this.elements;
279        elements[head = dec(head, elements.length)] = e;
293      }
294  
295      /**
# Line 288 | Line 301 | public class ArrayDeque<E> extends Abstr
301       * @throws NullPointerException if the specified element is null
302       */
303      public void addLast(E e) {
304 +        if (e == null)
305 +            throw new NullPointerException();
306 +        final Object[] es = elements;
307 +        es[tail] = e;
308 +        if (head == (tail = inc(tail, es.length)))
309 +            grow(1);
310          // 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;
311      }
312  
313      /**
# Line 317 | Line 321 | public class ArrayDeque<E> extends Abstr
321       * @throws NullPointerException if the specified collection or any
322       *         of its elements are null
323       */
320    @Override
324      public boolean addAll(Collection<? extends E> c) {
325 +        final int s = size(), needed;
326 +        if ((needed = s + c.size() - elements.length + 1) > 0)
327 +            grow(needed);
328 +        c.forEach((e) -> addLast(e));
329          // checkInvariants();
330 <        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;
330 >        return size() > s;
331      }
332  
333      /**
# Line 364 | Line 358 | public class ArrayDeque<E> extends Abstr
358       * @throws NoSuchElementException {@inheritDoc}
359       */
360      public E removeFirst() {
367        // checkInvariants();
361          E e = pollFirst();
362          if (e == null)
363              throw new NoSuchElementException();
364 +        // checkInvariants();
365          return e;
366      }
367  
# Line 375 | Line 369 | public class ArrayDeque<E> extends Abstr
369       * @throws NoSuchElementException {@inheritDoc}
370       */
371      public E removeLast() {
378        // checkInvariants();
372          E e = pollLast();
373          if (e == null)
374              throw new NoSuchElementException();
375 +        // checkInvariants();
376          return e;
377      }
378  
379      public E pollFirst() {
380 +        final Object[] es;
381 +        final int h;
382 +        E e = elementAt(es = elements, h = head);
383 +        if (e != null) {
384 +            es[h] = null;
385 +            head = inc(h, es.length);
386 +        }
387          // 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;
388          return e;
389      }
390  
391      public E pollLast() {
392 +        final Object[] es;
393 +        final int t;
394 +        E e = elementAt(es = elements, t = dec(tail, es.length));
395 +        if (e != null)
396 +            es[tail = t] = null;
397          // 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;
398          return e;
399      }
400  
# Line 412 | Line 402 | public class ArrayDeque<E> extends Abstr
402       * @throws NoSuchElementException {@inheritDoc}
403       */
404      public E getFirst() {
405 +        E e = elementAt(elements, head);
406 +        if (e == null)
407 +            throw new NoSuchElementException();
408          // checkInvariants();
409 <        if (size == 0) throw new NoSuchElementException();
417 <        return elementAt(head);
409 >        return e;
410      }
411  
412      /**
413       * @throws NoSuchElementException {@inheritDoc}
414       */
415      public E getLast() {
416 +        final Object[] es = elements;
417 +        E e = elementAt(es, dec(tail, es.length));
418 +        if (e == null)
419 +            throw new NoSuchElementException();
420          // checkInvariants();
421 <        if (size == 0) throw new NoSuchElementException();
426 <        return elementAt(tail());
421 >        return e;
422      }
423  
424      public E peekFirst() {
425          // checkInvariants();
426 <        return (size == 0) ? null : elementAt(head);
426 >        return elementAt(elements, head);
427      }
428  
429      public E peekLast() {
430          // checkInvariants();
431 <        return (size == 0) ? null : elementAt(tail());
431 >        final Object[] es;
432 >        return elementAt(es = elements, dec(tail, es.length));
433      }
434  
435      /**
# Line 449 | Line 445 | public class ArrayDeque<E> extends Abstr
445       * @return {@code true} if the deque contained the specified element
446       */
447      public boolean removeFirstOccurrence(Object o) {
452        // checkInvariants();
448          if (o != null) {
449 <            final Object[] elements = this.elements;
450 <            final int capacity = elements.length;
451 <            for (int k = size, i = head; --k >= 0; i = inc(i, capacity)) {
452 <                if (o.equals(elements[i])) {
453 <                    delete(i);
454 <                    return true;
455 <                }
449 >            final Object[] es = elements;
450 >            for (int i = head, end = tail, to = (i <= end) ? end : es.length;
451 >                 ; i = 0, to = end) {
452 >                for (; i < to; i++)
453 >                    if (o.equals(es[i])) {
454 >                        delete(i);
455 >                        return true;
456 >                    }
457 >                if (to == end) break;
458              }
459          }
460          return false;
# Line 477 | Line 474 | public class ArrayDeque<E> extends Abstr
474       */
475      public boolean removeLastOccurrence(Object o) {
476          if (o != null) {
477 <            final Object[] elements = this.elements;
478 <            final int capacity = elements.length;
479 <            for (int k = size, i = add(head, k - 1, capacity);
480 <                 --k >= 0; i = dec(i, capacity)) {
481 <                if (o.equals(elements[i])) {
482 <                    delete(i);
483 <                    return true;
484 <                }
477 >            final Object[] es = elements;
478 >            for (int i = tail, end = head, to = (i >= end) ? end : 0;
479 >                 ; i = es.length, to = end) {
480 >                while (--i >= to)
481 >                    if (o.equals(es[i])) {
482 >                        delete(i);
483 >                        return true;
484 >                    }
485 >                if (to == end) break;
486              }
487          }
488          return false;
# Line 612 | Line 610 | public class ArrayDeque<E> extends Abstr
610       * <p>This method is called delete rather than remove to emphasize
611       * that its semantics differ from those of {@link List#remove(int)}.
612       *
613 <     * @return true if elements moved backwards
613 >     * @return true if elements near tail moved backwards
614       */
615      boolean delete(int i) {
616          // checkInvariants();
617 <        final Object[] elements = this.elements;
618 <        final int capacity = elements.length;
617 >        final Object[] es = elements;
618 >        final int capacity = es.length;
619          final int h = head;
620 <        int front;              // number of elements before to-be-deleted elt
621 <        if ((front = i - h) < 0) front += capacity;
622 <        final int back = size - front - 1; // number of elements after
620 >        // number of elements before to-be-deleted elt
621 >        final int front = sub(i, h, capacity);
622 >        final int back = size() - front - 1; // number of elements after
623          if (front < back) {
624              // move front elements forwards
625              if (h <= i) {
626 <                System.arraycopy(elements, h, elements, h + 1, front);
626 >                System.arraycopy(es, h, es, h + 1, front);
627              } else { // Wrap around
628 <                System.arraycopy(elements, 0, elements, 1, i);
629 <                elements[0] = elements[capacity - 1];
630 <                System.arraycopy(elements, h, elements, h + 1, front - (i + 1));
628 >                System.arraycopy(es, 0, es, 1, i);
629 >                es[0] = es[capacity - 1];
630 >                System.arraycopy(es, h, es, h + 1, front - (i + 1));
631              }
632 <            elements[h] = null;
632 >            es[h] = null;
633              head = inc(h, capacity);
636            size--;
634              // checkInvariants();
635              return false;
636          } else {
637              // move back elements backwards
638 <            int tail = tail();
638 >            tail = dec(tail, capacity);
639              if (i <= tail) {
640 <                System.arraycopy(elements, i + 1, elements, i, back);
640 >                System.arraycopy(es, i + 1, es, i, back);
641              } else { // Wrap around
642                  int firstLeg = capacity - (i + 1);
643 <                System.arraycopy(elements, i + 1, elements, i, firstLeg);
644 <                elements[capacity - 1] = elements[0];
645 <                System.arraycopy(elements, 1, elements, 0, back - firstLeg - 1);
643 >                System.arraycopy(es, i + 1, es, i, firstLeg);
644 >                es[capacity - 1] = es[0];
645 >                System.arraycopy(es, 1, es, 0, back - firstLeg - 1);
646              }
647 <            elements[tail] = null;
651 <            size--;
647 >            es[tail] = null;
648              // checkInvariants();
649              return true;
650          }
# Line 662 | Line 658 | public class ArrayDeque<E> extends Abstr
658       * @return the number of elements in this deque
659       */
660      public int size() {
661 <        return size;
661 >        return sub(tail, head, elements.length);
662      }
663  
664      /**
# Line 671 | Line 667 | public class ArrayDeque<E> extends Abstr
667       * @return {@code true} if this deque contains no elements
668       */
669      public boolean isEmpty() {
670 <        return size == 0;
670 >        return head == tail;
671      }
672  
673      /**
# Line 695 | Line 691 | public class ArrayDeque<E> extends Abstr
691          int cursor;
692  
693          /** Number of elements yet to be returned. */
694 <        int remaining = size;
694 >        int remaining = size();
695  
696          /**
697           * Index of element returned by most recent call to next.
# Line 710 | Line 706 | public class ArrayDeque<E> extends Abstr
706          }
707  
708          public E next() {
709 <            if (remaining == 0)
709 >            if (remaining <= 0)
710                  throw new NoSuchElementException();
711 <            E e = checkedElementAt(elements, cursor);
711 >            final Object[] es = elements;
712 >            E e = nonNullElementAt(es, cursor);
713              lastRet = cursor;
714 <            cursor = inc(cursor, elements.length);
714 >            cursor = inc(cursor, es.length);
715              remaining--;
716              return e;
717          }
718  
719          void postDelete(boolean leftShifted) {
720              if (leftShifted)
721 <                cursor = dec(cursor, elements.length); // undo inc in next
721 >                cursor = dec(cursor, elements.length);
722          }
723  
724          public final void remove() {
# Line 733 | Line 730 | public class ArrayDeque<E> extends Abstr
730  
731          public void forEachRemaining(Consumer<? super E> action) {
732              Objects.requireNonNull(action);
733 <            final Object[] elements = ArrayDeque.this.elements;
734 <            final int capacity = elements.length;
735 <            int k = remaining;
733 >            int r;
734 >            if ((r = remaining) <= 0)
735 >                return;
736              remaining = 0;
737 <            for (int i = cursor; --k >= 0; i = inc(i, capacity))
738 <                action.accept(checkedElementAt(elements, i));
737 >            final Object[] es = elements;
738 >            if (es[cursor] == null || sub(tail, cursor, es.length) != r)
739 >                throw new ConcurrentModificationException();
740 >            for (int i = cursor, end = tail, to = (i <= end) ? end : es.length;
741 >                 ; i = 0, to = end) {
742 >                for (; i < to; i++)
743 >                    action.accept(elementAt(es, i));
744 >                if (to == end) {
745 >                    if (end != tail)
746 >                        throw new ConcurrentModificationException();
747 >                    lastRet = dec(end, es.length);
748 >                    break;
749 >                }
750 >            }
751          }
752      }
753  
754      private class DescendingIterator extends DeqIterator {
755 <        DescendingIterator() { cursor = tail(); }
755 >        DescendingIterator() { cursor = last(); }
756  
757          public final E next() {
758 <            if (remaining == 0)
758 >            if (remaining <= 0)
759                  throw new NoSuchElementException();
760 <            E e = checkedElementAt(elements, cursor);
760 >            final Object[] es = elements;
761 >            E e = nonNullElementAt(es, cursor);
762              lastRet = cursor;
763 <            cursor = dec(cursor, elements.length);
763 >            cursor = dec(cursor, es.length);
764              remaining--;
765              return e;
766          }
767  
768          void postDelete(boolean leftShifted) {
769              if (!leftShifted)
770 <                cursor = inc(cursor, elements.length); // undo dec in next
770 >                cursor = inc(cursor, elements.length);
771          }
772  
773          public final void forEachRemaining(Consumer<? super E> action) {
774              Objects.requireNonNull(action);
775 <            final Object[] elements = ArrayDeque.this.elements;
776 <            final int capacity = elements.length;
777 <            int k = remaining;
775 >            int r;
776 >            if ((r = remaining) <= 0)
777 >                return;
778              remaining = 0;
779 <            for (int i = cursor; --k >= 0; i = dec(i, capacity))
780 <                action.accept(checkedElementAt(elements, i));
779 >            final Object[] es = elements;
780 >            if (es[cursor] == null || sub(cursor, head, es.length) + 1 != r)
781 >                throw new ConcurrentModificationException();
782 >            for (int i = cursor, end = head, to = (i >= end) ? end : 0;
783 >                 ; i = es.length - 1, to = end) {
784 >                for (; i >= to; i--)
785 >                    action.accept(elementAt(es, i));
786 >                if (to == end) {
787 >                    if (end != head)
788 >                        throw new ConcurrentModificationException();
789 >                    lastRet = head;
790 >                    break;
791 >                }
792 >            }
793          }
794      }
795  
# Line 785 | Line 807 | public class ArrayDeque<E> extends Abstr
807       * @since 1.8
808       */
809      public Spliterator<E> spliterator() {
810 <        return new ArrayDequeSpliterator();
810 >        return new DeqSpliterator();
811      }
812  
813 <    final class ArrayDequeSpliterator implements Spliterator<E> {
814 <        private int cursor;
815 <        private int remaining; // -1 until late-binding first use
813 >    final class DeqSpliterator implements Spliterator<E> {
814 >        private int fence;      // -1 until first use
815 >        private int cursor;     // current index, modified on traverse/split
816  
817          /** Constructs late-binding spliterator over all elements. */
818 <        ArrayDequeSpliterator() {
819 <            this.remaining = -1;
818 >        DeqSpliterator() {
819 >            this.fence = -1;
820          }
821  
822 <        /** Constructs spliterator over the given slice. */
823 <        ArrayDequeSpliterator(int cursor, int count) {
824 <            this.cursor = cursor;
825 <            this.remaining = count;
822 >        /** Constructs spliterator over the given range. */
823 >        DeqSpliterator(int origin, int fence) {
824 >            this.cursor = origin;
825 >            this.fence = fence;
826          }
827  
828 <        /** Ensures late-binding initialization; then returns remaining. */
829 <        private int remaining() {
830 <            if (remaining < 0) {
828 >        /** Ensures late-binding initialization; then returns fence. */
829 >        private int getFence() { // force initialization
830 >            int t;
831 >            if ((t = fence) < 0) {
832 >                t = fence = tail;
833                  cursor = head;
810                remaining = size;
834              }
835 <            return remaining;
835 >            return t;
836          }
837  
838 <        public ArrayDequeSpliterator trySplit() {
839 <            final int mid;
840 <            if ((mid = remaining() >> 1) > 0) {
841 <                int oldCursor = cursor;
842 <                cursor = add(cursor, mid, elements.length);
843 <                remaining -= mid;
821 <                return new ArrayDequeSpliterator(oldCursor, mid);
822 <            }
823 <            return null;
838 >        public DeqSpliterator trySplit() {
839 >            final Object[] es = elements;
840 >            final int i, n;
841 >            return ((n = sub(getFence(), i = cursor, es.length) >> 1) <= 0)
842 >                ? null
843 >                : new DeqSpliterator(i, cursor = add(i, n, es.length));
844          }
845  
846          public void forEachRemaining(Consumer<? super E> action) {
847 <            Objects.requireNonNull(action);
848 <            final Object[] elements = ArrayDeque.this.elements;
849 <            final int capacity = elements.length;
850 <            int k = remaining();
851 <            remaining = 0;
852 <            for (int i = cursor; --k >= 0; i = inc(i, capacity))
853 <                action.accept(checkedElementAt(elements, i));
847 >            if (action == null)
848 >                throw new NullPointerException();
849 >            final int end = getFence(), cursor = this.cursor;
850 >            final Object[] es = elements;
851 >            if (cursor != end) {
852 >                this.cursor = end;
853 >                // null check at both ends of range is sufficient
854 >                if (es[cursor] == null || es[dec(end, es.length)] == null)
855 >                    throw new ConcurrentModificationException();
856 >                for (int i = cursor, to = (i <= end) ? end : es.length;
857 >                     ; i = 0, to = end) {
858 >                    for (; i < to; i++)
859 >                        action.accept(elementAt(es, i));
860 >                    if (to == end) break;
861 >                }
862 >            }
863          }
864  
865          public boolean tryAdvance(Consumer<? super E> action) {
866 <            Objects.requireNonNull(action);
867 <            if (remaining() == 0)
866 >            if (action == null)
867 >                throw new NullPointerException();
868 >            int t, i;
869 >            if ((t = fence) < 0) t = getFence();
870 >            if (t == (i = cursor))
871                  return false;
872 <            action.accept(checkedElementAt(elements, cursor));
873 <            cursor = inc(cursor, elements.length);
874 <            remaining--;
872 >            final Object[] es;
873 >            action.accept(nonNullElementAt(es = elements, i));
874 >            cursor = inc(i, es.length);
875              return true;
876          }
877  
878          public long estimateSize() {
879 <            return remaining();
879 >            return sub(getFence(), cursor, elements.length);
880          }
881  
882          public int characteristics() {
# Line 855 | Line 887 | public class ArrayDeque<E> extends Abstr
887          }
888      }
889  
858    @Override
890      public void forEach(Consumer<? super E> action) {
860        // checkInvariants();
891          Objects.requireNonNull(action);
892 <        final Object[] elements = this.elements;
893 <        final int capacity = elements.length;
894 <        for (int k = size, i = head; --k >= 0; i = inc(i, capacity))
895 <            action.accept(elementAt(i));
892 >        final Object[] es = elements;
893 >        for (int i = head, end = tail, to = (i <= end) ? end : es.length;
894 >             ; i = 0, to = end) {
895 >            for (; i < to; i++)
896 >                action.accept(elementAt(es, i));
897 >            if (to == end) {
898 >                if (end != tail) throw new ConcurrentModificationException();
899 >                break;
900 >            }
901 >        }
902          // checkInvariants();
903      }
904  
# Line 875 | Line 911 | public class ArrayDeque<E> extends Abstr
911       */
912      /* public */ void replaceAll(UnaryOperator<E> operator) {
913          Objects.requireNonNull(operator);
914 <        final Object[] elements = this.elements;
915 <        final int capacity = elements.length;
916 <        for (int k = size, i = head; --k >= 0; i = inc(i, capacity))
917 <            elements[i] = operator.apply(elementAt(i));
914 >        final Object[] es = elements;
915 >        for (int i = head, end = tail, to = (i <= end) ? end : es.length;
916 >             ; i = 0, to = end) {
917 >            for (; i < to; i++)
918 >                es[i] = operator.apply(elementAt(es, i));
919 >            if (to == end) {
920 >                if (end != tail) throw new ConcurrentModificationException();
921 >                break;
922 >            }
923 >        }
924          // checkInvariants();
925      }
926  
927      /**
928       * @throws NullPointerException {@inheritDoc}
929       */
888    @Override
930      public boolean removeIf(Predicate<? super E> filter) {
931          Objects.requireNonNull(filter);
932          return bulkRemove(filter);
# Line 894 | Line 935 | public class ArrayDeque<E> extends Abstr
935      /**
936       * @throws NullPointerException {@inheritDoc}
937       */
897    @Override
938      public boolean removeAll(Collection<?> c) {
939          Objects.requireNonNull(c);
940          return bulkRemove(e -> c.contains(e));
# Line 903 | Line 943 | public class ArrayDeque<E> extends Abstr
943      /**
944       * @throws NullPointerException {@inheritDoc}
945       */
906    @Override
946      public boolean retainAll(Collection<?> c) {
947          Objects.requireNonNull(c);
948          return bulkRemove(e -> !c.contains(e));
# Line 912 | Line 951 | public class ArrayDeque<E> extends Abstr
951      /** Implementation of bulk remove methods. */
952      private boolean bulkRemove(Predicate<? super E> filter) {
953          // checkInvariants();
954 <        final Object[] elements = this.elements;
955 <        final int capacity = elements.length;
956 <        int i = head, j = i, remaining = size, deleted = 0;
954 >        final Object[] es = elements;
955 >        // Optimize for initial run of survivors
956 >        for (int i = head, end = tail, to = (i <= end) ? end : es.length;
957 >             ; i = 0, to = end) {
958 >            for (; i < to; i++)
959 >                if (filter.test(elementAt(es, i)))
960 >                    return bulkRemoveModified(filter, i, to);
961 >            if (to == end) {
962 >                if (end != tail) throw new ConcurrentModificationException();
963 >                break;
964 >            }
965 >        }
966 >        return false;
967 >    }
968 >
969 >    /**
970 >     * Helper for bulkRemove, in case of at least one deletion.
971 >     * @param i valid index of first element to be deleted
972 >     */
973 >    private boolean bulkRemoveModified(
974 >        Predicate<? super E> filter, int i, int to) {
975 >        final Object[] es = elements;
976 >        final int capacity = es.length;
977 >        // a two-finger algorithm, with hare i reading, tortoise j writing
978 >        int j = i++;
979 >        final int end = tail;
980          try {
981 <            for (; remaining > 0; remaining--, i = inc(i, capacity)) {
982 <                @SuppressWarnings("unchecked") E e = (E) elements[i];
983 <                if (filter.test(e))
984 <                    deleted++;
985 <                else {
986 <                    if (j != i)
987 <                        elements[j] = e;
988 <                    j = inc(j, capacity);
981 >            for (;; j = 0) {    // j rejoins i on second leg
982 >                E e;
983 >                // In this loop, i and j are on the same leg, with i > j
984 >                for (; i < to; i++)
985 >                    if (!filter.test(e = elementAt(es, i)))
986 >                        es[j++] = e;
987 >                if (to == end) break;
988 >                // In this loop, j is on the first leg, i on the second
989 >                for (i = 0, to = end; i < to && j < capacity; i++)
990 >                    if (!filter.test(e = elementAt(es, i)))
991 >                        es[j++] = e;
992 >                if (i >= to) {
993 >                    if (j == capacity) j = 0; // "corner" case
994 >                    break;
995                  }
996              }
997 <            return deleted > 0;
997 >            return true;
998          } catch (Throwable ex) {
999 <            if (deleted > 0)
1000 <                for (; remaining > 0;
1001 <                     remaining--, i = inc(i, capacity), j = inc(j, capacity))
934 <                    elements[j] = elements[i];
999 >            // copy remaining elements
1000 >            for (; i != end; i = inc(i, capacity), j = inc(j, capacity))
1001 >                es[j] = es[i];
1002              throw ex;
1003          } finally {
1004 <            size -= deleted;
1005 <            for (; --deleted >= 0; j = inc(j, capacity))
939 <                elements[j] = null;
1004 >            if (end != tail) throw new ConcurrentModificationException();
1005 >            circularClear(es, tail = j, end);
1006              // checkInvariants();
1007          }
1008      }
# Line 951 | Line 1017 | public class ArrayDeque<E> extends Abstr
1017       */
1018      public boolean contains(Object o) {
1019          if (o != null) {
1020 <            final Object[] elements = this.elements;
1021 <            final int capacity = elements.length;
1022 <            for (int k = size, i = head; --k >= 0; i = inc(i, capacity))
1023 <                if (o.equals(elements[i]))
1024 <                    return true;
1020 >            final Object[] es = elements;
1021 >            for (int i = head, end = tail, to = (i <= end) ? end : es.length;
1022 >                 ; i = 0, to = end) {
1023 >                for (; i < to; i++)
1024 >                    if (o.equals(es[i]))
1025 >                        return true;
1026 >                if (to == end) break;
1027 >            }
1028          }
1029          return false;
1030      }
# Line 982 | Line 1051 | public class ArrayDeque<E> extends Abstr
1051       * The deque will be empty after this call returns.
1052       */
1053      public void clear() {
1054 <        final Object[] elements = this.elements;
1055 <        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;
1054 >        circularClear(elements, head, tail);
1055 >        head = tail = 0;
1056          // checkInvariants();
1057      }
1058  
1059      /**
1060 +     * Nulls out slots starting at array index i, upto index end.
1061 +     */
1062 +    private static void circularClear(Object[] es, int i, int end) {
1063 +        for (int to = (i <= end) ? end : es.length;
1064 +             ; i = 0, to = end) {
1065 +            Arrays.fill(es, i, to, null);
1066 +            if (to == end) break;
1067 +        }
1068 +    }
1069 +
1070 +    /**
1071       * Returns an array containing all of the elements in this deque
1072       * in proper sequence (from first to last element).
1073       *
# Line 1010 | Line 1081 | public class ArrayDeque<E> extends Abstr
1081       * @return an array containing all of the elements in this deque
1082       */
1083      public Object[] toArray() {
1084 <        final int head = this.head;
1085 <        final int firstLeg;
1086 <        Object[] a = Arrays.copyOfRange(elements, head, head + size);
1087 <        if ((firstLeg = elements.length - head) < size)
1088 <            System.arraycopy(elements, 0, a, firstLeg, size - firstLeg);
1084 >        return toArray(Object[].class);
1085 >    }
1086 >
1087 >    private <T> T[] toArray(Class<T[]> klazz) {
1088 >        final Object[] es = elements;
1089 >        final T[] a;
1090 >        final int size = size(), head = this.head, end;
1091 >        final int len = Math.min(size, es.length - head);
1092 >        if ((end = head + size) >= 0) {
1093 >            a = Arrays.copyOfRange(es, head, end, klazz);
1094 >        } else {
1095 >            // integer overflow!
1096 >            a = Arrays.copyOfRange(es, 0, size, klazz);
1097 >            System.arraycopy(es, head, a, 0, len);
1098 >        }
1099 >        if (tail < head)
1100 >            System.arraycopy(es, 0, a, len, tail);
1101          return a;
1102      }
1103  
# Line 1056 | Line 1139 | public class ArrayDeque<E> extends Abstr
1139       */
1140      @SuppressWarnings("unchecked")
1141      public <T> T[] toArray(T[] a) {
1142 <        final Object[] elements = this.elements;
1143 <        final int head = this.head;
1144 <        final int firstLeg;
1145 <        boolean wrap = (firstLeg = elements.length - head) < size;
1146 <        if (size > a.length) {
1147 <            a = (T[]) Arrays.copyOfRange(elements, head, head + size,
1148 <                                         a.getClass());
1149 <        } else {
1067 <            System.arraycopy(elements, head, a, 0, wrap ? firstLeg : size);
1068 <            if (size < a.length)
1069 <                a[size] = null;
1142 >        final int size;
1143 >        if ((size = size()) > a.length)
1144 >            return toArray((Class<T[]>) a.getClass());
1145 >        final Object[] es = elements;
1146 >        for (int i = head, j = 0, len = Math.min(size, es.length - i);
1147 >             ; i = 0, len = tail) {
1148 >            System.arraycopy(es, i, a, j, len);
1149 >            if ((j += len) == size) break;
1150          }
1151 <        if (wrap)
1152 <            System.arraycopy(elements, 0, a, firstLeg, size - firstLeg);
1151 >        if (size < a.length)
1152 >            a[size] = null;
1153          return a;
1154      }
1155  
# Line 1107 | Line 1187 | public class ArrayDeque<E> extends Abstr
1187          s.defaultWriteObject();
1188  
1189          // Write out size
1190 <        s.writeInt(size);
1190 >        s.writeInt(size());
1191  
1192          // Write out elements in order.
1193 <        final Object[] elements = this.elements;
1194 <        final int capacity = elements.length;
1195 <        for (int k = size, i = head; --k >= 0; i = inc(i, capacity))
1196 <            s.writeObject(elements[i]);
1193 >        final Object[] es = elements;
1194 >        for (int i = head, end = tail, to = (i <= end) ? end : es.length;
1195 >             ; i = 0, to = end) {
1196 >            for (; i < to; i++)
1197 >                s.writeObject(es[i]);
1198 >            if (to == end) break;
1199 >        }
1200      }
1201  
1202      /**
# Line 1128 | Line 1211 | public class ArrayDeque<E> extends Abstr
1211          s.defaultReadObject();
1212  
1213          // Read in size and allocate array
1214 <        elements = new Object[size = s.readInt()];
1214 >        int size = s.readInt();
1215 >        elements = new Object[size + 1];
1216 >        this.tail = size;
1217  
1218          // Read in all elements in the proper order.
1219          for (int i = 0; i < size; i++)
# Line 1136 | Line 1221 | public class ArrayDeque<E> extends Abstr
1221      }
1222  
1223      /** debugging */
1224 <    private void checkInvariants() {
1224 >    void checkInvariants() {
1225          try {
1226              int capacity = elements.length;
1227 <            assert size >= 0 && size <= capacity;
1228 <            assert head >= 0 && ((capacity == 0 && head == 0 && size == 0)
1229 <                                 || head < capacity);
1230 <            assert size == 0
1231 <                || (elements[head] != null && elements[tail()] != null);
1232 <            assert size == capacity
1233 <                || (elements[dec(head, capacity)] == null
1149 <                    && elements[inc(tail(), capacity)] == null);
1227 >            // assert head >= 0 && head < capacity;
1228 >            // assert tail >= 0 && tail < capacity;
1229 >            // assert capacity > 0;
1230 >            // assert size() < capacity;
1231 >            // assert head == tail || elements[head] != null;
1232 >            // assert elements[tail] == null;
1233 >            // assert head == tail || elements[dec(tail, capacity)] != null;
1234          } catch (Throwable t) {
1235 <            System.err.printf("head=%d size=%d capacity=%d%n",
1236 <                              head, size, elements.length);
1235 >            System.err.printf("head=%d tail=%d capacity=%d%n",
1236 >                              head, tail, elements.length);
1237              System.err.printf("elements=%s%n",
1238                                Arrays.toString(elements));
1239              throw t;

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines