ViewVC Help

View File | Revision Log | Show Annotations | Download File | Root Listing

root/jsr166/jsr166/src/main/java/util/ArrayDeque.java

Comparing jsr166/src/main/java/util/ArrayDeque.java (file contents):
Revision 1.65 by jsr166, Sat Feb 28 20:35:47 2015 UTC vs.
Revision 1.98 by jsr166, Sat Oct 29 22:47:55 2016 UTC

#	Line 7 | Line 7 | package java.util;
7
8		import java.io.Serializable;
9		import java.util.function.Consumer;
10	+	import java.util.function.Predicate;
11	+	import java.util.function.UnaryOperator;
12
13		/**
14		* Resizable-array implementation of the {@link Deque} interface.  Array
#	Line 52 | Line 54 | import java.util.function.Consumer;
54		* Java Collections Framework</a>.
55		*
56		* @author  Josh Bloch and Doug Lea
55	–	* @since   1.6
57		* @param <E> the type of elements held in this deque
58	+	* @since   1.6
59		*/
60		public class ArrayDeque<E> extends AbstractCollection<E>
61		implements Deque<E>, Cloneable, Serializable
62		{
63		/**
64		* The array in which the elements of the deque are stored.
65	<	* The capacity of the deque is the length of this array, which is
66	<	* always a power of two. The array is never allowed to become
65	<	* full, except transiently within an addX method where it is
66	<	* resized (see doubleCapacity) immediately upon becoming full,
67	<	* thus avoiding head and tail wrapping around to equal each
68	<	* other.  We also guarantee that all array cells not holding
69	<	* deque elements are always null.
65	>	* We guarantee that all array cells not holding deque elements
66	>	* are always null.
67		*/
68	<	transient Object[] elements; // non-private to simplify nested class access
68	>	transient Object[] elements;
69
70		/**
71		* The index of the element at the head of the deque (which is the
72		* element that would be removed by remove() or pop()); or an
73	<	* arbitrary number equal to tail if the deque is empty.
73	>	* arbitrary number 0 <= head < elements.length if the deque is empty.
74		*/
75		transient int head;
76
77	+	/** Number of elements in this collection. */
78	+	transient int size;
79	+
80		/**
81	<	* The index at which the next element would be added to the tail
82	<	* of the deque (via addLast(E), add(E), or push(E)).
81	>	* The maximum size of array to allocate.
82	>	* Some VMs reserve some header words in an array.
83	>	* Attempts to allocate larger arrays may result in
84	>	* OutOfMemoryError: Requested array size exceeds VM limit
85		*/
86	<	transient int tail;
86	>	private static final int MAX_ARRAY_SIZE = Integer.MAX_VALUE - 8;
87
88		/**
89	<	* The minimum capacity that we'll use for a newly created deque.
90	<	* Must be a power of 2.
89	>	* Increases the capacity of this deque by at least the given amount.
90	>	*
91	>	* @param needed the required minimum extra capacity; must be positive
92		*/
93	<	private static final int MIN_INITIAL_CAPACITY = 8;
93	>	private void grow(int needed) {
94	>	// overflow-conscious code
95	>	// checkInvariants();
96	>	final int oldCapacity = elements.length;
97	>	int newCapacity;
98	>	// Double size if small; else grow by 50%
99	>	int jump = (oldCapacity < 64) ? (oldCapacity + 2) : (oldCapacity >> 1);
100	>	if (jump < needed
101	>	|| (newCapacity = (oldCapacity + jump)) - MAX_ARRAY_SIZE > 0)
102	>	newCapacity = newCapacity(needed, jump);
103	>	elements = Arrays.copyOf(elements, newCapacity);
104	>	if (oldCapacity - head < size) {
105	>	// wrap around; slide first leg forward to end of array
106	>	int newSpace = newCapacity - oldCapacity;
107	>	System.arraycopy(elements, head,
108	>	elements, head + newSpace,
109	>	oldCapacity - head);
110	>	Arrays.fill(elements, head, head + newSpace, null);
111	>	head += newSpace;
112	>	}
113	>	// checkInvariants();
114	>	}
115
116	<	// ******  Array allocation and resizing utilities ******
116	>	/** Capacity calculation for edge conditions, especially overflow. */
117	>	private int newCapacity(int needed, int jump) {
118	>	final int oldCapacity = elements.length, minCapacity;
119	>	if ((minCapacity = oldCapacity + needed) - MAX_ARRAY_SIZE > 0) {
120	>	if (minCapacity < 0)
121	>	throw new IllegalStateException("Sorry, deque too big");
122	>	return Integer.MAX_VALUE;
123	>	}
124	>	if (needed > jump)
125	>	return minCapacity;
126	>	return (oldCapacity + jump - MAX_ARRAY_SIZE < 0)
127	>	? oldCapacity + jump
128	>	: MAX_ARRAY_SIZE;
129	>	}
130
131		/**
132	<	* Allocates empty array to hold the given number of elements.
132	>	* Increases the internal storage of this collection, if necessary,
133	>	* to ensure that it can hold at least the given number of elements.
134		*
135	<	* @param numElements  the number of elements to hold
135	>	* @param minCapacity the desired minimum capacity
136	>	* @since TBD
137		*/
138	<	private void allocateElements(int numElements) {
139	<	int initialCapacity = MIN_INITIAL_CAPACITY;
140	<	// Find the best power of two to hold elements.
141	<	// Tests "<=" because arrays aren't kept full.
103	<	if (numElements >= initialCapacity) {
104	<	initialCapacity = numElements;
105	<	initialCapacity |= (initialCapacity >>>  1);
106	<	initialCapacity |= (initialCapacity >>>  2);
107	<	initialCapacity |= (initialCapacity >>>  4);
108	<	initialCapacity |= (initialCapacity >>>  8);
109	<	initialCapacity |= (initialCapacity >>> 16);
110	<	initialCapacity++;
111	<
112	<	if (initialCapacity < 0)   // Too many elements, must back off
113	<	initialCapacity >>>= 1;// Good luck allocating 2 ^ 30 elements
114	<	}
115	<	elements = new Object[initialCapacity];
138	>	/* public */ void ensureCapacity(int minCapacity) {
139	>	if (minCapacity > elements.length)
140	>	grow(minCapacity - elements.length);
141	>	// checkInvariants();
142		}
143
144		/**
145	<	* Doubles the capacity of this deque.  Call only when full, i.e.,
146	<	* when head and tail have wrapped around to become equal.
145	>	* Minimizes the internal storage of this collection.
146	>	*
147	>	* @since TBD
148		*/
149	<	private void doubleCapacity() {
150	<	assert head == tail;
151	<	int p = head;
152	<	int n = elements.length;
153	<	int r = n - p; // number of elements to the right of p
154	<	int newCapacity = n << 1;
128	<	if (newCapacity < 0)
129	<	throw new IllegalStateException("Sorry, deque too big");
130	<	Object[] a = new Object[newCapacity];
131	<	System.arraycopy(elements, p, a, 0, r);
132	<	System.arraycopy(elements, 0, a, r, p);
133	<	elements = a;
134	<	head = 0;
135	<	tail = n;
149	>	/* public */ void trimToSize() {
150	>	if (size < elements.length) {
151	>	elements = toArray();
152	>	head = 0;
153	>	}
154	>	// checkInvariants();
155		}
156
157		/**
#	Line 147 | Line 166 | public class ArrayDeque<E> extends Abstr
166		* Constructs an empty array deque with an initial capacity
167		* sufficient to hold the specified number of elements.
168		*
169	<	* @param numElements  lower bound on initial capacity of the deque
169	>	* @param numElements lower bound on initial capacity of the deque
170		*/
171		public ArrayDeque(int numElements) {
172	<	allocateElements(numElements);
172	>	elements = new Object[numElements];
173		}
174
175		/**
#	Line 164 | Line 183 | public class ArrayDeque<E> extends Abstr
183		* @throws NullPointerException if the specified collection is null
184		*/
185		public ArrayDeque(Collection<? extends E> c) {
186	<	allocateElements(c.size());
187	<	addAll(c);
186	>	Object[] es = c.toArray();
187	>	// defend against c.toArray (incorrectly) not returning Object[]
188	>	// (see e.g. https://bugs.openjdk.java.net/browse/JDK-6260652)
189	>	if (es.getClass() != Object[].class)
190	>	es = Arrays.copyOf(es, es.length, Object[].class);
191	>	for (Object obj : es)
192	>	Objects.requireNonNull(obj);
193	>	this.elements = es;
194	>	this.size = es.length;
195	>	}
196	>
197	>	/**
198	>	* Increments i, mod modulus.
199	>	* Precondition and postcondition: 0 <= i < modulus.
200	>	*/
201	>	static final int inc(int i, int modulus) {
202	>	if (++i >= modulus) i = 0;
203	>	return i;
204	>	}
205	>
206	>	/**
207	>	* Decrements i, mod modulus.
208	>	* Precondition and postcondition: 0 <= i < modulus.
209	>	*/
210	>	static final int dec(int i, int modulus) {
211	>	if (--i < 0) i = modulus - 1;
212	>	return i;
213	>	}
214	>
215	>	/**
216	>	* Adds i and j, mod modulus.
217	>	* Precondition and postcondition: 0 <= i < modulus, 0 <= j <= modulus.
218	>	*/
219	>	static final int add(int i, int j, int modulus) {
220	>	if ((i += j) - modulus >= 0) i -= modulus;
221	>	return i;
222	>	}
223	>
224	>	/**
225	>	* Returns the array index of the last element.
226	>	* May return invalid index -1 if there are no elements.
227	>	*/
228	>	final int tail() {
229	>	return add(head, size - 1, elements.length);
230	>	}
231	>
232	>	/**
233	>	* Returns element at array index i.
234	>	*/
235	>	@SuppressWarnings("unchecked")
236	>	private E elementAt(int i) {
237	>	return (E) elements[i];
238	>	}
239	>
240	>	/**
241	>	* A version of elementAt that checks for null elements.
242	>	* This check doesn't catch all possible comodifications,
243	>	* but does catch ones that corrupt traversal.  It's a little
244	>	* surprising that javac allows this abuse of generics.
245	>	*/
246	>	static final <E> E nonNullElementAt(Object[] es, int i) {
247	>	@SuppressWarnings("unchecked") E e = (E) es[i];
248	>	if (e == null)
249	>	throw new ConcurrentModificationException();
250	>	return e;
251		}
252
253		// The main insertion and extraction methods are addFirst,
#	Line 179 | Line 261 | public class ArrayDeque<E> extends Abstr
261		* @throws NullPointerException if the specified element is null
262		*/
263		public void addFirst(E e) {
264	<	if (e == null)
265	<	throw new NullPointerException();
266	<	elements[head = (head - 1) & (elements.length - 1)] = e;
267	<	if (head == tail)
268	<	doubleCapacity();
264	>	// checkInvariants();
265	>	Objects.requireNonNull(e);
266	>	Object[] es;
267	>	int capacity, h;
268	>	final int s;
269	>	if ((s = size) == (capacity = (es = elements).length)) {
270	>	grow(1);
271	>	capacity = (es = elements).length;
272	>	}
273	>	if ((h = head - 1) < 0) h = capacity - 1;
274	>	es[head = h] = e;
275	>	size = s + 1;
276	>	// checkInvariants();
277		}
278
279		/**
#	Line 195 | Line 285 | public class ArrayDeque<E> extends Abstr
285		* @throws NullPointerException if the specified element is null
286		*/
287		public void addLast(E e) {
288	<	if (e == null)
289	<	throw new NullPointerException();
290	<	elements[tail] = e;
291	<	if ( (tail = (tail + 1) & (elements.length - 1)) == head)
292	<	doubleCapacity();
288	>	// checkInvariants();
289	>	Objects.requireNonNull(e);
290	>	Object[] es;
291	>	int capacity;
292	>	final int s;
293	>	if ((s = size) == (capacity = (es = elements).length)) {
294	>	grow(1);
295	>	capacity = (es = elements).length;
296	>	}
297	>	es[add(head, s, capacity)] = e;
298	>	size = s + 1;
299	>	// checkInvariants();
300	>	}
301	>
302	>	/**
303	>	* Adds all of the elements in the specified collection at the end
304	>	* of this deque, as if by calling {@link #addLast} on each one,
305	>	* in the order that they are returned by the collection's
306	>	* iterator.
307	>	*
308	>	* @param c the elements to be inserted into this deque
309	>	* @return {@code true} if this deque changed as a result of the call
310	>	* @throws NullPointerException if the specified collection or any
311	>	*         of its elements are null
312	>	*/
313	>	public boolean addAll(Collection<? extends E> c) {
314	>	final int s = size, needed = c.size() - (elements.length - s);
315	>	if (needed > 0)
316	>	grow(needed);
317	>	c.forEach((e) -> addLast(e));
318	>	// checkInvariants();
319	>	return size > s;
320		}
321
322		/**
#	Line 230 | Line 347 | public class ArrayDeque<E> extends Abstr
347		* @throws NoSuchElementException {@inheritDoc}
348		*/
349		public E removeFirst() {
350	<	E x = pollFirst();
351	<	if (x == null)
350	>	// checkInvariants();
351	>	E e = pollFirst();
352	>	if (e == null)
353		throw new NoSuchElementException();
354	<	return x;
354	>	return e;
355		}
356
357		/**
358		* @throws NoSuchElementException {@inheritDoc}
359		*/
360		public E removeLast() {
361	<	E x = pollLast();
362	<	if (x == null)
361	>	// checkInvariants();
362	>	E e = pollLast();
363	>	if (e == null)
364		throw new NoSuchElementException();
365	<	return x;
365	>	return e;
366		}
367
368		public E pollFirst() {
369	<	int h = head;
370	<	@SuppressWarnings("unchecked")
371	<	E result = (E) elements[h];
372	<	// Element is null if deque empty
373	<	if (result != null) {
374	<	elements[h] = null; // Must null out slot
375	<	head = (h + 1) & (elements.length - 1);
376	<	}
377	<	return result;
369	>	// checkInvariants();
370	>	int s, h;
371	>	if ((s = size) <= 0)
372	>	return null;
373	>	final Object[] elements = this.elements;
374	>	@SuppressWarnings("unchecked") E e = (E) elements[h = head];
375	>	elements[h] = null;
376	>	if (++h >= elements.length) h = 0;
377	>	head = h;
378	>	size = s - 1;
379	>	return e;
380		}
381
382		public E pollLast() {
383	<	int t = (tail - 1) & (elements.length - 1);
383	>	// checkInvariants();
384	>	final int s, tail;
385	>	if ((s = size) <= 0)
386	>	return null;
387	>	final Object[] elements = this.elements;
388		@SuppressWarnings("unchecked")
389	<	E result = (E) elements[t];
390	<	if (result != null) {
391	<	elements[t] = null;
392	<	tail = t;
268	<	}
269	<	return result;
389	>	E e = (E) elements[tail = add(head, s - 1, elements.length)];
390	>	elements[tail] = null;
391	>	size = s - 1;
392	>	return e;
393		}
394
395		/**
396		* @throws NoSuchElementException {@inheritDoc}
397		*/
398		public E getFirst() {
399	<	@SuppressWarnings("unchecked")
400	<	E result = (E) elements[head];
401	<	if (result == null)
279	<	throw new NoSuchElementException();
280	<	return result;
399	>	// checkInvariants();
400	>	if (size <= 0) throw new NoSuchElementException();
401	>	return elementAt(head);
402		}
403
404		/**
405		* @throws NoSuchElementException {@inheritDoc}
406		*/
407	+	@SuppressWarnings("unchecked")
408		public E getLast() {
409	<	@SuppressWarnings("unchecked")
410	<	E result = (E) elements[(tail - 1) & (elements.length - 1)];
411	<	if (result == null)
412	<	throw new NoSuchElementException();
413	<	return result;
409	>	// checkInvariants();
410	>	final int s;
411	>	if ((s = size) <= 0) throw new NoSuchElementException();
412	>	final Object[] elements = this.elements;
413	>	return (E) elements[add(head, s - 1, elements.length)];
414		}
415
294	–	@SuppressWarnings("unchecked")
416		public E peekFirst() {
417	<	// elements[head] is null if deque empty
418	<	return (E) elements[head];
417	>	// checkInvariants();
418	>	return (size <= 0) ? null : elementAt(head);
419		}
420
421		@SuppressWarnings("unchecked")
422		public E peekLast() {
423	<	return (E) elements[(tail - 1) & (elements.length - 1)];
423	>	// checkInvariants();
424	>	final int s;
425	>	if ((s = size) <= 0) return null;
426	>	final Object[] elements = this.elements;
427	>	return (E) elements[add(head, s - 1, elements.length)];
428		}
429
430		/**
#	Line 316 | Line 441 | public class ArrayDeque<E> extends Abstr
441		*/
442		public boolean removeFirstOccurrence(Object o) {
443		if (o != null) {
444	<	int mask = elements.length - 1;
445	<	int i = head;
446	<	for (Object x; (x = elements[i]) != null; i = (i + 1) & mask) {
447	<	if (o.equals(x)) {
448	<	delete(i);
449	<	return true;
450	<	}
444	>	final Object[] elements = this.elements;
445	>	final int capacity = elements.length;
446	>	int i, end, to, todo;
447	>	todo = (end = (i = head) + size)
448	>	- (to = (capacity - end >= 0) ? end : capacity);
449	>	for (;; to = todo, i = 0, todo = 0) {
450	>	for (; i < to; i++)
451	>	if (o.equals(elements[i])) {
452	>	delete(i);
453	>	return true;
454	>	}
455	>	if (todo == 0) break;
456		}
457		}
458		return false;
#	Line 342 | Line 472 | public class ArrayDeque<E> extends Abstr
472		*/
473		public boolean removeLastOccurrence(Object o) {
474		if (o != null) {
475	<	int mask = elements.length - 1;
476	<	int i = (tail - 1) & mask;
477	<	for (Object x; (x = elements[i]) != null; i = (i - 1) & mask) {
478	<	if (o.equals(x)) {
479	<	delete(i);
480	<	return true;
481	<	}
475	>	final Object[] elements = this.elements;
476	>	final int capacity = elements.length;
477	>	int i, to, end, todo;
478	>	todo = (to = ((end = (i = tail()) - size) >= -1) ? end : -1) - end;
479	>	for (;; to = (i = capacity - 1) - todo, todo = 0) {
480	>	for (; i > to; i--)
481	>	if (o.equals(elements[i])) {
482	>	delete(i);
483	>	return true;
484	>	}
485	>	if (todo == 0) break;
486		}
487		}
488		return false;
#	Line 468 | Line 602 | public class ArrayDeque<E> extends Abstr
602		return removeFirst();
603		}
604
471	–	private void checkInvariants() {
472	–	assert elements[tail] == null;
473	–	assert head == tail ? elements[head] == null :
474	–	(elements[head] != null &&
475	–	elements[(tail - 1) & (elements.length - 1)] != null);
476	–	assert elements[(head - 1) & (elements.length - 1)] == null;
477	–	}
478	–
605		/**
606	<	* Removes the element at the specified position in the elements array,
607	<	* adjusting head and tail as necessary.  This can result in motion of
608	<	* elements backwards or forwards in the array.
606	>	* Removes the element at the specified position in the elements array.
607	>	* This can result in forward or backwards motion of array elements.
608	>	* We optimize for least element motion.
609		*
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
614		*/
615	<	private boolean delete(int i) {
616	<	checkInvariants();
615	>	boolean delete(int i) {
616	>	// checkInvariants();
617		final Object[] elements = this.elements;
618	<	final int mask = elements.length - 1;
618	>	final int capacity = elements.length;
619		final int h = head;
620	<	final int t = tail;
621	<	final int front = (i - h) & mask;
622	<	final int back  = (t - i) & mask;
497	<
498	<	// Invariant: head <= i < tail mod circularity
499	<	if (front >= ((t - h) & mask))
500	<	throw new ConcurrentModificationException();
501	<
502	<	// Optimize for least element motion
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
623		if (front < back) {
624	+	// move front elements forwards
625		if (h <= i) {
626		System.arraycopy(elements, h, elements, h + 1, front);
627		} else { // Wrap around
628		System.arraycopy(elements, 0, elements, 1, i);
629	<	elements[0] = elements[mask];
630	<	System.arraycopy(elements, h, elements, h + 1, mask - h);
629	>	elements[0] = elements[capacity - 1];
630	>	System.arraycopy(elements, h, elements, h + 1, front - (i + 1));
631		}
632		elements[h] = null;
633	<	head = (h + 1) & mask;
633	>	if ((head = (h + 1)) >= capacity) head = 0;
634	>	size--;
635	>	// checkInvariants();
636		return false;
637		} else {
638	<	if (i < t) { // Copy the null tail as well
638	>	// move back elements backwards
639	>	int tail = tail();
640	>	if (i <= tail) {
641		System.arraycopy(elements, i + 1, elements, i, back);
517	–	tail = t - 1;
642		} else { // Wrap around
643	<	System.arraycopy(elements, i + 1, elements, i, mask - i);
644	<	elements[mask] = elements[0];
645	<	System.arraycopy(elements, 1, elements, 0, t);
646	<	tail = (t - 1) & mask;
643	>	int firstLeg = capacity - (i + 1);
644	>	System.arraycopy(elements, i + 1, elements, i, firstLeg);
645	>	elements[capacity - 1] = elements[0];
646	>	System.arraycopy(elements, 1, elements, 0, back - firstLeg - 1);
647		}
648	+	elements[tail] = null;
649	+	size--;
650	+	// checkInvariants();
651		return true;
652		}
653		}
#	Line 533 | Line 660 | public class ArrayDeque<E> extends Abstr
660		* @return the number of elements in this deque
661		*/
662		public int size() {
663	<	return (tail - head) & (elements.length - 1);
663	>	return size;
664		}
665
666		/**
#	Line 542 | Line 669 | public class ArrayDeque<E> extends Abstr
669		* @return {@code true} if this deque contains no elements
670		*/
671		public boolean isEmpty() {
672	<	return head == tail;
672	>	return size == 0;
673		}
674
675		/**
#	Line 562 | Line 689 | public class ArrayDeque<E> extends Abstr
689		}
690
691		private class DeqIterator implements Iterator<E> {
692	<	/**
693	<	* Index of element to be returned by subsequent call to next.
567	<	*/
568	<	private int cursor = head;
692	>	/** Index of element to be returned by subsequent call to next. */
693	>	int cursor;
694
695	<	/**
696	<	* Tail recorded at construction (also in remove), to stop
572	<	* iterator and also to check for comodification.
573	<	*/
574	<	private int fence = tail;
695	>	/** Number of elements yet to be returned. */
696	>	int remaining = size;
697
698		/**
699		* Index of element returned by most recent call to next.
700		* Reset to -1 if element is deleted by a call to remove.
701		*/
702	<	private int lastRet = -1;
702	>	int lastRet = -1;
703
704	<	public boolean hasNext() {
705	<	return cursor != fence;
704	>	DeqIterator() { cursor = head; }
705	>
706	>	public final boolean hasNext() {
707	>	return remaining > 0;
708		}
709
710		public E next() {
711	<	if (cursor == fence)
711	>	if (remaining <= 0)
712		throw new NoSuchElementException();
713	<	@SuppressWarnings("unchecked")
714	<	E result = (E) elements[cursor];
591	<	// This check doesn't catch all possible comodifications,
592	<	// but does catch the ones that corrupt traversal
593	<	if (tail != fence || result == null)
594	<	throw new ConcurrentModificationException();
713	>	final Object[] elements = ArrayDeque.this.elements;
714	>	E e = nonNullElementAt(elements, cursor);
715		lastRet = cursor;
716	<	cursor = (cursor + 1) & (elements.length - 1);
717	<	return result;
716	>	if (++cursor >= elements.length) cursor = 0;
717	>	remaining--;
718	>	return e;
719		}
720
721	<	public void remove() {
721	>	void postDelete(boolean leftShifted) {
722	>	if (leftShifted)
723	>	if (--cursor < 0) cursor = elements.length - 1;
724	>	}
725	>
726	>	public final void remove() {
727		if (lastRet < 0)
728		throw new IllegalStateException();
729	<	if (delete(lastRet)) { // if left-shifted, undo increment in next()
604	<	cursor = (cursor - 1) & (elements.length - 1);
605	<	fence = tail;
606	<	}
729	>	postDelete(delete(lastRet));
730		lastRet = -1;
731		}
732	+
733	+	public void forEachRemaining(Consumer<? super E> action) {
734	+	Objects.requireNonNull(action);
735	+	final int k;
736	+	if ((k = remaining) > 0) {
737	+	remaining = 0;
738	+	ArrayDeque.forEachRemaining(action, elements, cursor, k);
739	+	if ((lastRet = cursor + k - 1) >= elements.length)
740	+	lastRet -= elements.length;
741	+	}
742	+	}
743	+	}
744	+
745	+	private class DescendingIterator extends DeqIterator {
746	+	DescendingIterator() { cursor = tail(); }
747	+
748	+	public final E next() {
749	+	if (remaining <= 0)
750	+	throw new NoSuchElementException();
751	+	final Object[] elements = ArrayDeque.this.elements;
752	+	E e = nonNullElementAt(elements, cursor);
753	+	lastRet = cursor;
754	+	if (--cursor < 0) cursor = elements.length - 1;
755	+	remaining--;
756	+	return e;
757	+	}
758	+
759	+	void postDelete(boolean leftShifted) {
760	+	if (!leftShifted)
761	+	if (++cursor >= elements.length) cursor = 0;
762	+	}
763	+
764	+	public final void forEachRemaining(Consumer<? super E> action) {
765	+	Objects.requireNonNull(action);
766	+	final int k;
767	+	if ((k = remaining) > 0) {
768	+	remaining = 0;
769	+	final Object[] elements = ArrayDeque.this.elements;
770	+	int i, end, to, todo;
771	+	todo = (to = ((end = (i = cursor) - k) >= -1) ? end : -1) - end;
772	+	for (;; to = (i = elements.length - 1) - todo, todo = 0) {
773	+	for (; i > to; i--)
774	+	action.accept(nonNullElementAt(elements, i));
775	+	if (todo == 0) break;
776	+	}
777	+	if ((lastRet = cursor - (k - 1)) < 0)
778	+	lastRet += elements.length;
779	+	}
780	+	}
781		}
782
783		/**
784	<	* This class is nearly a mirror-image of DeqIterator, using tail
785	<	* instead of head for initial cursor, and head instead of tail
786	<	* for fence.
787	<	*/
788	<	private class DescendingIterator implements Iterator<E> {
789	<	private int cursor = tail;
790	<	private int fence = head;
791	<	private int lastRet = -1;
784	>	* Creates a <em><a href="Spliterator.html#binding">late-binding</a></em>
785	>	* and <em>fail-fast</em> {@link Spliterator} over the elements in this
786	>	* deque.
787	>	*
788	>	* <p>The {@code Spliterator} reports {@link Spliterator#SIZED},
789	>	* {@link Spliterator#SUBSIZED}, {@link Spliterator#ORDERED}, and
790	>	* {@link Spliterator#NONNULL}.  Overriding implementations should document
791	>	* the reporting of additional characteristic values.
792	>	*
793	>	* @return a {@code Spliterator} over the elements in this deque
794	>	* @since 1.8
795	>	*/
796	>	public Spliterator<E> spliterator() {
797	>	return new ArrayDequeSpliterator();
798	>	}
799
800	<	public boolean hasNext() {
801	<	return cursor != fence;
800	>	final class ArrayDequeSpliterator implements Spliterator<E> {
801	>	private int cursor;
802	>	private int remaining; // -1 until late-binding first use
803	>
804	>	/** Constructs late-binding spliterator over all elements. */
805	>	ArrayDequeSpliterator() {
806	>	this.remaining = -1;
807		}
808
809	<	public E next() {
810	<	if (cursor == fence)
811	<	throw new NoSuchElementException();
812	<	cursor = (cursor - 1) & (elements.length - 1);
629	<	@SuppressWarnings("unchecked")
630	<	E result = (E) elements[cursor];
631	<	if (head != fence || result == null)
632	<	throw new ConcurrentModificationException();
633	<	lastRet = cursor;
634	<	return result;
809	>	/** Constructs spliterator over the given slice. */
810	>	ArrayDequeSpliterator(int cursor, int count) {
811	>	this.cursor = cursor;
812	>	this.remaining = count;
813		}
814
815	<	public void remove() {
816	<	if (lastRet < 0)
817	<	throw new IllegalStateException();
818	<	if (!delete(lastRet)) {
819	<	cursor = (cursor + 1) & (elements.length - 1);
642	<	fence = head;
815	>	/** Ensures late-binding initialization; then returns remaining. */
816	>	private int remaining() {
817	>	if (remaining < 0) {
818	>	cursor = head;
819	>	remaining = size;
820		}
821	<	lastRet = -1;
821	>	return remaining;
822	>	}
823	>
824	>	public ArrayDequeSpliterator trySplit() {
825	>	final int mid;
826	>	if ((mid = remaining() >> 1) > 0) {
827	>	int oldCursor = cursor;
828	>	cursor = add(cursor, mid, elements.length);
829	>	remaining -= mid;
830	>	return new ArrayDequeSpliterator(oldCursor, mid);
831	>	}
832	>	return null;
833	>	}
834	>
835	>	public void forEachRemaining(Consumer<? super E> action) {
836	>	Objects.requireNonNull(action);
837	>	final int k = remaining(); // side effect!
838	>	remaining = 0;
839	>	ArrayDeque.forEachRemaining(action, elements, cursor, k);
840	>	}
841	>
842	>	public boolean tryAdvance(Consumer<? super E> action) {
843	>	Objects.requireNonNull(action);
844	>	final int k;
845	>	if ((k = remaining()) <= 0)
846	>	return false;
847	>	action.accept(nonNullElementAt(elements, cursor));
848	>	if (++cursor >= elements.length) cursor = 0;
849	>	remaining = k - 1;
850	>	return true;
851	>	}
852	>
853	>	public long estimateSize() {
854	>	return remaining();
855	>	}
856	>
857	>	public int characteristics() {
858	>	return Spliterator.NONNULL
859	>	| Spliterator.ORDERED
860	>	| Spliterator.SIZED
861	>	| Spliterator.SUBSIZED;
862	>	}
863	>	}
864	>
865	>	@SuppressWarnings("unchecked")
866	>	public void forEach(Consumer<? super E> action) {
867	>	Objects.requireNonNull(action);
868	>	final Object[] elements = this.elements;
869	>	final int capacity = elements.length;
870	>	int i, end, to, todo;
871	>	todo = (end = (i = head) + size)
872	>	- (to = (capacity - end >= 0) ? end : capacity);
873	>	for (;; to = todo, i = 0, todo = 0) {
874	>	for (; i < to; i++)
875	>	action.accept((E) elements[i]);
876	>	if (todo == 0) break;
877	>	}
878	>	// checkInvariants();
879	>	}
880	>
881	>	/**
882	>	* Calls action on remaining elements, starting at index i and
883	>	* traversing in ascending order.  A variant of forEach that also
884	>	* checks for concurrent modification, for use in iterators.
885	>	*/
886	>	static <E> void forEachRemaining(
887	>	Consumer<? super E> action, Object[] es, int i, int remaining) {
888	>	final int capacity = es.length;
889	>	int end, to, todo;
890	>	todo = (end = i + remaining)
891	>	- (to = (capacity - end >= 0) ? end : capacity);
892	>	for (;; to = todo, i = 0, todo = 0) {
893	>	for (; i < to; i++)
894	>	action.accept(nonNullElementAt(es, i));
895	>	if (todo == 0) break;
896	>	}
897	>	}
898	>
899	>	/**
900	>	* Replaces each element of this deque with the result of applying the
901	>	* operator to that element, as specified by {@link List#replaceAll}.
902	>	*
903	>	* @param operator the operator to apply to each element
904	>	* @since TBD
905	>	*/
906	>	/* public */ void replaceAll(UnaryOperator<E> operator) {
907	>	Objects.requireNonNull(operator);
908	>	final Object[] elements = this.elements;
909	>	final int capacity = elements.length;
910	>	int i, end, to, todo;
911	>	todo = (end = (i = head) + size)
912	>	- (to = (capacity - end >= 0) ? end : capacity);
913	>	for (;; to = todo, i = 0, todo = 0) {
914	>	for (; i < to; i++)
915	>	elements[i] = operator.apply(elementAt(i));
916	>	if (todo == 0) break;
917	>	}
918	>	// checkInvariants();
919	>	}
920	>
921	>	/**
922	>	* @throws NullPointerException {@inheritDoc}
923	>	*/
924	>	public boolean removeIf(Predicate<? super E> filter) {
925	>	Objects.requireNonNull(filter);
926	>	return bulkRemove(filter);
927	>	}
928	>
929	>	/**
930	>	* @throws NullPointerException {@inheritDoc}
931	>	*/
932	>	public boolean removeAll(Collection<?> c) {
933	>	Objects.requireNonNull(c);
934	>	return bulkRemove(e -> c.contains(e));
935	>	}
936	>
937	>	/**
938	>	* @throws NullPointerException {@inheritDoc}
939	>	*/
940	>	public boolean retainAll(Collection<?> c) {
941	>	Objects.requireNonNull(c);
942	>	return bulkRemove(e -> !c.contains(e));
943	>	}
944	>
945	>	/** Implementation of bulk remove methods. */
946	>	private boolean bulkRemove(Predicate<? super E> filter) {
947	>	// checkInvariants();
948	>	final Object[] elements = this.elements;
949	>	final int capacity = elements.length;
950	>	int i = head, j = i, remaining = size, deleted = 0;
951	>	try {
952	>	for (; remaining > 0; remaining--) {
953	>	@SuppressWarnings("unchecked") E e = (E) elements[i];
954	>	if (filter.test(e))
955	>	deleted++;
956	>	else {
957	>	if (j != i)
958	>	elements[j] = e;
959	>	if (++j >= capacity) j = 0;
960	>	}
961	>	if (++i >= capacity) i = 0;
962	>	}
963	>	return deleted > 0;
964	>	} catch (Throwable ex) {
965	>	if (deleted > 0)
966	>	for (; remaining > 0; remaining--) {
967	>	elements[j] = elements[i];
968	>	if (++i >= capacity) i = 0;
969	>	if (++j >= capacity) j = 0;
970	>	}
971	>	throw ex;
972	>	} finally {
973	>	size -= deleted;
974	>	clearSlice(elements, j, deleted);
975	>	// checkInvariants();
976		}
977		}
978
#	Line 655 | Line 986 | public class ArrayDeque<E> extends Abstr
986		*/
987		public boolean contains(Object o) {
988		if (o != null) {
989	<	int mask = elements.length - 1;
990	<	int i = head;
991	<	for (Object x; (x = elements[i]) != null; i = (i + 1) & mask) {
992	<	if (o.equals(x))
993	<	return true;
989	>	final Object[] elements = this.elements;
990	>	final int capacity = elements.length;
991	>	int i, end, to, todo;
992	>	todo = (end = (i = head) + size)
993	>	- (to = (capacity - end >= 0) ? end : capacity);
994	>	for (;; to = todo, i = 0, todo = 0) {
995	>	for (; i < to; i++)
996	>	if (o.equals(elements[i]))
997	>	return true;
998	>	if (todo == 0) break;
999		}
1000		}
1001		return false;
#	Line 687 | Line 1023 | public class ArrayDeque<E> extends Abstr
1023		* The deque will be empty after this call returns.
1024		*/
1025		public void clear() {
1026	<	int h = head;
1027	<	int t = tail;
1028	<	if (h != t) { // clear all cells
1029	<	head = tail = 0;
1030	<	int i = h;
1031	<	int mask = elements.length - 1;
1032	<	do {
1033	<	elements[i] = null;
1034	<	i = (i + 1) & mask;
1035	<	} while (i != t);
1036	<	}
1026	>	clearSlice(elements, head, size);
1027	>	size = head = 0;
1028	>	// checkInvariants();
1029	>	}
1030	>
1031	>	/**
1032	>	* Nulls out count elements, starting at array index from.
1033	>	*/
1034	>	private static void clearSlice(Object[] es, int from, int count) {
1035	>	final int capacity = es.length, end = from + count;
1036	>	final int leg = (capacity - end >= 0) ? end : capacity;
1037	>	Arrays.fill(es, from, leg, null);
1038	>	if (leg != end)
1039	>	Arrays.fill(es, 0, end - capacity, null);
1040		}
1041
1042		/**
#	Line 714 | Line 1053 | public class ArrayDeque<E> extends Abstr
1053		* @return an array containing all of the elements in this deque
1054		*/
1055		public Object[] toArray() {
1056	<	final int head = this.head;
1057	<	final int tail = this.tail;
1058	<	boolean wrap = (tail < head);
1059	<	int end = wrap ? tail + elements.length : tail;
1060	<	Object[] a = Arrays.copyOfRange(elements, head, end);
1061	<	if (wrap)
1062	<	System.arraycopy(elements, 0, a, elements.length - head, tail);
1056	>	return toArray(Object[].class);
1057	>	}
1058	>
1059	>	private <T> T[] toArray(Class<T[]> klazz) {
1060	>	final Object[] elements = this.elements;
1061	>	final int capacity = elements.length;
1062	>	final int head = this.head, end = head + size;
1063	>	final T[] a;
1064	>	if (end >= 0) {
1065	>	a = Arrays.copyOfRange(elements, head, end, klazz);
1066	>	} else {
1067	>	// integer overflow!
1068	>	a = Arrays.copyOfRange(elements, 0, size, klazz);
1069	>	System.arraycopy(elements, head, a, 0, capacity - head);
1070	>	}
1071	>	if (end - capacity > 0)
1072	>	System.arraycopy(elements, 0, a, capacity - head, end - capacity);
1073		return a;
1074		}
1075
#	Line 762 | Line 1111 | public class ArrayDeque<E> extends Abstr
1111		*/
1112		@SuppressWarnings("unchecked")
1113		public <T> T[] toArray(T[] a) {
1114	<	final int head = this.head;
1115	<	final int tail = this.tail;
1116	<	boolean wrap = (tail < head);
1117	<	int size = (tail - head) + (wrap ? elements.length : 0);
1118	<	int firstLeg = size - (wrap ? tail : 0);
1119	<	int len = a.length;
1120	<	if (size > len) {
1121	<	a = (T[]) Arrays.copyOfRange(elements, head, head + size,
1122	<	a.getClass());
1123	<	} else {
1124	<	System.arraycopy(elements, head, a, 0, firstLeg);
1125	<	if (size < len)
777	<	a[size] = null;
778	<	}
779	<	if (wrap)
780	<	System.arraycopy(elements, 0, a, firstLeg, tail);
1114	>	final int size = this.size;
1115	>	if (size > a.length)
1116	>	return toArray((Class<T[]>) a.getClass());
1117	>	final Object[] elements = this.elements;
1118	>	final int capacity = elements.length;
1119	>	final int head = this.head, end = head + size;
1120	>	final int front = (capacity - end >= 0) ? size : capacity - head;
1121	>	System.arraycopy(elements, head, a, 0, front);
1122	>	if (front != size)
1123	>	System.arraycopy(elements, 0, a, capacity - head, end - capacity);
1124	>	if (size < a.length)
1125	>	a[size] = null;
1126		return a;
1127		}
1128
#	Line 815 | Line 1160 | public class ArrayDeque<E> extends Abstr
1160		s.defaultWriteObject();
1161
1162		// Write out size
1163	<	s.writeInt(size());
1163	>	s.writeInt(size);
1164
1165		// Write out elements in order.
1166	<	int mask = elements.length - 1;
1167	<	for (int i = head; i != tail; i = (i + 1) & mask)
1168	<	s.writeObject(elements[i]);
1166	>	final Object[] elements = this.elements;
1167	>	final int capacity = elements.length;
1168	>	int i, end, to, todo;
1169	>	todo = (end = (i = head) + size)
1170	>	- (to = (capacity - end >= 0) ? end : capacity);
1171	>	for (;; to = todo, i = 0, todo = 0) {
1172	>	for (; i < to; i++)
1173	>	s.writeObject(elements[i]);
1174	>	if (todo == 0) break;
1175	>	}
1176		}
1177
1178		/**
#	Line 835 | Line 1187 | public class ArrayDeque<E> extends Abstr
1187		s.defaultReadObject();
1188
1189		// Read in size and allocate array
1190	<	int size = s.readInt();
839	<	allocateElements(size);
840	<	head = 0;
841	<	tail = size;
1190	>	elements = new Object[size = s.readInt()];
1191
1192		// Read in all elements in the proper order.
1193		for (int i = 0; i < size; i++)
1194		elements[i] = s.readObject();
1195		}
1196
1197	<	public Spliterator<E> spliterator() {
1198	<	return new DeqSpliterator<E>(this, -1, -1);
1199	<	}
1200	<
1201	<	static final class DeqSpliterator<E> implements Spliterator<E> {
1202	<	private final ArrayDeque<E> deq;
1203	<	private int fence;  // -1 until first use
1204	<	private int index;  // current index, modified on traverse/split
1205	<
1206	<	/** Creates new spliterator covering the given array and range */
1207	<	DeqSpliterator(ArrayDeque<E> deq, int origin, int fence) {
1208	<	this.deq = deq;
1209	<	this.index = origin;
1210	<	this.fence = fence;
1211	<	}
1212	<
1213	<	private int getFence() { // force initialization
865	<	int t;
866	<	if ((t = fence) < 0) {
867	<	t = fence = deq.tail;
868	<	index = deq.head;
869	<	}
870	<	return t;
871	<	}
872	<
873	<	public Spliterator<E> trySplit() {
874	<	int t = getFence(), h = index, n = deq.elements.length;
875	<	if (h != t && ((h + 1) & (n - 1)) != t) {
876	<	if (h > t)
877	<	t += n;
878	<	int m = ((h + t) >>> 1) & (n - 1);
879	<	return new DeqSpliterator<>(deq, h, index = m);
880	<	}
881	<	return null;
882	<	}
883	<
884	<	public void forEachRemaining(Consumer<? super E> consumer) {
885	<	if (consumer == null)
886	<	throw new NullPointerException();
887	<	Object[] a = deq.elements;
888	<	int m = a.length - 1, f = getFence(), i = index;
889	<	index = f;
890	<	while (i != f) {
891	<	@SuppressWarnings("unchecked") E e = (E)a[i];
892	<	i = (i + 1) & m;
893	<	if (e == null)
894	<	throw new ConcurrentModificationException();
895	<	consumer.accept(e);
896	<	}
897	<	}
898	<
899	<	public boolean tryAdvance(Consumer<? super E> consumer) {
900	<	if (consumer == null)
901	<	throw new NullPointerException();
902	<	Object[] a = deq.elements;
903	<	int m = a.length - 1, f = getFence(), i = index;
904	<	if (i != f) {
905	<	@SuppressWarnings("unchecked") E e = (E)a[i];
906	<	index = (i + 1) & m;
907	<	if (e == null)
908	<	throw new ConcurrentModificationException();
909	<	consumer.accept(e);
910	<	return true;
911	<	}
912	<	return false;
913	<	}
914	<
915	<	public long estimateSize() {
916	<	int n = getFence() - index;
917	<	if (n < 0)
918	<	n += deq.elements.length;
919	<	return (long) n;
920	<	}
921	<
922	<	@Override
923	<	public int characteristics() {
924	<	return Spliterator.ORDERED | Spliterator.SIZED |
925	<	Spliterator.NONNULL | Spliterator.SUBSIZED;
1197	>	/** debugging */
1198	>	void checkInvariants() {
1199	>	try {
1200	>	int capacity = elements.length;
1201	>	// assert size >= 0 && size <= capacity;
1202	>	// assert head >= 0;
1203	>	// assert capacity == 0 || head < capacity;
1204	>	// assert size == 0 || elements[head] != null;
1205	>	// assert size == 0 || elements[tail()] != null;
1206	>	// assert size == capacity || elements[dec(head, capacity)] == null;
1207	>	// assert size == capacity || elements[inc(tail(), capacity)] == null;
1208	>	} catch (Throwable t) {
1209	>	System.err.printf("head=%d size=%d capacity=%d%n",
1210	>	head, size, elements.length);
1211	>	System.err.printf("elements=%s%n",
1212	>	Arrays.toString(elements));
1213	>	throw t;
1214		}
1215		}
1216

Diff Legend

–	Removed lines
+	Added lines
<	Changed lines
>	Changed lines