1 |
/* |
2 |
* Written by Josh Bloch of Google Inc. and released to the public domain, |
3 |
* as explained at http://creativecommons.org/publicdomain/zero/1.0/. |
4 |
*/ |
5 |
|
6 |
package java.util; |
7 |
import java.io.Serializable; |
8 |
import java.util.function.Consumer; |
9 |
import java.util.stream.Stream; |
10 |
import java.util.stream.Streams; |
11 |
|
12 |
/** |
13 |
* Resizable-array implementation of the {@link Deque} interface. Array |
14 |
* deques have no capacity restrictions; they grow as necessary to support |
15 |
* usage. They are not thread-safe; in the absence of external |
16 |
* synchronization, they do not support concurrent access by multiple threads. |
17 |
* Null elements are prohibited. This class is likely to be faster than |
18 |
* {@link Stack} when used as a stack, and faster than {@link LinkedList} |
19 |
* when used as a queue. |
20 |
* |
21 |
* <p>Most {@code ArrayDeque} operations run in amortized constant time. |
22 |
* Exceptions include {@link #remove(Object) remove}, {@link |
23 |
* #removeFirstOccurrence removeFirstOccurrence}, {@link #removeLastOccurrence |
24 |
* removeLastOccurrence}, {@link #contains contains}, {@link #iterator |
25 |
* iterator.remove()}, and the bulk operations, all of which run in linear |
26 |
* time. |
27 |
* |
28 |
* <p>The iterators returned by this class's {@code iterator} method are |
29 |
* <i>fail-fast</i>: If the deque is modified at any time after the iterator |
30 |
* is created, in any way except through the iterator's own {@code remove} |
31 |
* method, the iterator will generally throw a {@link |
32 |
* ConcurrentModificationException}. Thus, in the face of concurrent |
33 |
* modification, the iterator fails quickly and cleanly, rather than risking |
34 |
* arbitrary, non-deterministic behavior at an undetermined time in the |
35 |
* future. |
36 |
* |
37 |
* <p>Note that the fail-fast behavior of an iterator cannot be guaranteed |
38 |
* as it is, generally speaking, impossible to make any hard guarantees in the |
39 |
* presence of unsynchronized concurrent modification. Fail-fast iterators |
40 |
* throw {@code ConcurrentModificationException} on a best-effort basis. |
41 |
* Therefore, it would be wrong to write a program that depended on this |
42 |
* exception for its correctness: <i>the fail-fast behavior of iterators |
43 |
* should be used only to detect bugs.</i> |
44 |
* |
45 |
* <p>This class and its iterator implement all of the |
46 |
* <em>optional</em> methods of the {@link Collection} and {@link |
47 |
* Iterator} interfaces. |
48 |
* |
49 |
* <p>This class is a member of the |
50 |
* <a href="{@docRoot}/../technotes/guides/collections/index.html"> |
51 |
* Java Collections Framework</a>. |
52 |
* |
53 |
* @author Josh Bloch and Doug Lea |
54 |
* @since 1.6 |
55 |
* @param <E> the type of elements held in this collection |
56 |
*/ |
57 |
public class ArrayDeque<E> extends AbstractCollection<E> |
58 |
implements Deque<E>, Cloneable, Serializable |
59 |
{ |
60 |
/** |
61 |
* The array in which the elements of the deque are stored. |
62 |
* The capacity of the deque is the length of this array, which is |
63 |
* always a power of two. The array is never allowed to become |
64 |
* full, except transiently within an addX method where it is |
65 |
* resized (see doubleCapacity) immediately upon becoming full, |
66 |
* thus avoiding head and tail wrapping around to equal each |
67 |
* other. We also guarantee that all array cells not holding |
68 |
* deque elements are always null. |
69 |
*/ |
70 |
transient Object[] elements; // non-private to simplify nested class access |
71 |
|
72 |
/** |
73 |
* The index of the element at the head of the deque (which is the |
74 |
* element that would be removed by remove() or pop()); or an |
75 |
* arbitrary number equal to tail if the deque is empty. |
76 |
*/ |
77 |
transient int head; |
78 |
|
79 |
/** |
80 |
* The index at which the next element would be added to the tail |
81 |
* of the deque (via addLast(E), add(E), or push(E)). |
82 |
*/ |
83 |
transient int tail; |
84 |
|
85 |
/** |
86 |
* The minimum capacity that we'll use for a newly created deque. |
87 |
* Must be a power of 2. |
88 |
*/ |
89 |
private static final int MIN_INITIAL_CAPACITY = 8; |
90 |
|
91 |
// ****** Array allocation and resizing utilities ****** |
92 |
|
93 |
/** |
94 |
* Allocates empty array to hold the given number of elements. |
95 |
* |
96 |
* @param numElements the number of elements to hold |
97 |
*/ |
98 |
private void allocateElements(int numElements) { |
99 |
int initialCapacity = MIN_INITIAL_CAPACITY; |
100 |
// Find the best power of two to hold elements. |
101 |
// Tests "<=" because arrays aren't kept full. |
102 |
if (numElements >= initialCapacity) { |
103 |
initialCapacity = numElements; |
104 |
initialCapacity |= (initialCapacity >>> 1); |
105 |
initialCapacity |= (initialCapacity >>> 2); |
106 |
initialCapacity |= (initialCapacity >>> 4); |
107 |
initialCapacity |= (initialCapacity >>> 8); |
108 |
initialCapacity |= (initialCapacity >>> 16); |
109 |
initialCapacity++; |
110 |
|
111 |
if (initialCapacity < 0) // Too many elements, must back off |
112 |
initialCapacity >>>= 1;// Good luck allocating 2 ^ 30 elements |
113 |
} |
114 |
elements = new Object[initialCapacity]; |
115 |
} |
116 |
|
117 |
/** |
118 |
* Doubles the capacity of this deque. Call only when full, i.e., |
119 |
* when head and tail have wrapped around to become equal. |
120 |
*/ |
121 |
private void doubleCapacity() { |
122 |
assert head == tail; |
123 |
int p = head; |
124 |
int n = elements.length; |
125 |
int r = n - p; // number of elements to the right of p |
126 |
int newCapacity = n << 1; |
127 |
if (newCapacity < 0) |
128 |
throw new IllegalStateException("Sorry, deque too big"); |
129 |
Object[] a = new Object[newCapacity]; |
130 |
System.arraycopy(elements, p, a, 0, r); |
131 |
System.arraycopy(elements, 0, a, r, p); |
132 |
elements = a; |
133 |
head = 0; |
134 |
tail = n; |
135 |
} |
136 |
|
137 |
/** |
138 |
* Constructs an empty array deque with an initial capacity |
139 |
* sufficient to hold 16 elements. |
140 |
*/ |
141 |
public ArrayDeque() { |
142 |
elements = new Object[16]; |
143 |
} |
144 |
|
145 |
/** |
146 |
* Constructs an empty array deque with an initial capacity |
147 |
* sufficient to hold the specified number of elements. |
148 |
* |
149 |
* @param numElements lower bound on initial capacity of the deque |
150 |
*/ |
151 |
public ArrayDeque(int numElements) { |
152 |
allocateElements(numElements); |
153 |
} |
154 |
|
155 |
/** |
156 |
* Constructs a deque containing the elements of the specified |
157 |
* collection, in the order they are returned by the collection's |
158 |
* iterator. (The first element returned by the collection's |
159 |
* iterator becomes the first element, or <i>front</i> of the |
160 |
* deque.) |
161 |
* |
162 |
* @param c the collection whose elements are to be placed into the deque |
163 |
* @throws NullPointerException if the specified collection is null |
164 |
*/ |
165 |
public ArrayDeque(Collection<? extends E> c) { |
166 |
allocateElements(c.size()); |
167 |
addAll(c); |
168 |
} |
169 |
|
170 |
// The main insertion and extraction methods are addFirst, |
171 |
// addLast, pollFirst, pollLast. The other methods are defined in |
172 |
// terms of these. |
173 |
|
174 |
/** |
175 |
* Inserts the specified element at the front of this deque. |
176 |
* |
177 |
* @param e the element to add |
178 |
* @throws NullPointerException if the specified element is null |
179 |
*/ |
180 |
public void addFirst(E e) { |
181 |
if (e == null) |
182 |
throw new NullPointerException(); |
183 |
elements[head = (head - 1) & (elements.length - 1)] = e; |
184 |
if (head == tail) |
185 |
doubleCapacity(); |
186 |
} |
187 |
|
188 |
/** |
189 |
* Inserts the specified element at the end of this deque. |
190 |
* |
191 |
* <p>This method is equivalent to {@link #add}. |
192 |
* |
193 |
* @param e the element to add |
194 |
* @throws NullPointerException if the specified element is null |
195 |
*/ |
196 |
public void addLast(E e) { |
197 |
if (e == null) |
198 |
throw new NullPointerException(); |
199 |
elements[tail] = e; |
200 |
if ( (tail = (tail + 1) & (elements.length - 1)) == head) |
201 |
doubleCapacity(); |
202 |
} |
203 |
|
204 |
/** |
205 |
* Inserts the specified element at the front of this deque. |
206 |
* |
207 |
* @param e the element to add |
208 |
* @return {@code true} (as specified by {@link Deque#offerFirst}) |
209 |
* @throws NullPointerException if the specified element is null |
210 |
*/ |
211 |
public boolean offerFirst(E e) { |
212 |
addFirst(e); |
213 |
return true; |
214 |
} |
215 |
|
216 |
/** |
217 |
* Inserts the specified element at the end of this deque. |
218 |
* |
219 |
* @param e the element to add |
220 |
* @return {@code true} (as specified by {@link Deque#offerLast}) |
221 |
* @throws NullPointerException if the specified element is null |
222 |
*/ |
223 |
public boolean offerLast(E e) { |
224 |
addLast(e); |
225 |
return true; |
226 |
} |
227 |
|
228 |
/** |
229 |
* @throws NoSuchElementException {@inheritDoc} |
230 |
*/ |
231 |
public E removeFirst() { |
232 |
E x = pollFirst(); |
233 |
if (x == null) |
234 |
throw new NoSuchElementException(); |
235 |
return x; |
236 |
} |
237 |
|
238 |
/** |
239 |
* @throws NoSuchElementException {@inheritDoc} |
240 |
*/ |
241 |
public E removeLast() { |
242 |
E x = pollLast(); |
243 |
if (x == null) |
244 |
throw new NoSuchElementException(); |
245 |
return x; |
246 |
} |
247 |
|
248 |
public E pollFirst() { |
249 |
int h = head; |
250 |
@SuppressWarnings("unchecked") |
251 |
E result = (E) elements[h]; |
252 |
// Element is null if deque empty |
253 |
if (result == null) |
254 |
return null; |
255 |
elements[h] = null; // Must null out slot |
256 |
head = (h + 1) & (elements.length - 1); |
257 |
return result; |
258 |
} |
259 |
|
260 |
public E pollLast() { |
261 |
int t = (tail - 1) & (elements.length - 1); |
262 |
@SuppressWarnings("unchecked") |
263 |
E result = (E) elements[t]; |
264 |
if (result == null) |
265 |
return null; |
266 |
elements[t] = null; |
267 |
tail = t; |
268 |
return result; |
269 |
} |
270 |
|
271 |
/** |
272 |
* @throws NoSuchElementException {@inheritDoc} |
273 |
*/ |
274 |
public E getFirst() { |
275 |
@SuppressWarnings("unchecked") |
276 |
E result = (E) elements[head]; |
277 |
if (result == null) |
278 |
throw new NoSuchElementException(); |
279 |
return result; |
280 |
} |
281 |
|
282 |
/** |
283 |
* @throws NoSuchElementException {@inheritDoc} |
284 |
*/ |
285 |
public E getLast() { |
286 |
@SuppressWarnings("unchecked") |
287 |
E result = (E) elements[(tail - 1) & (elements.length - 1)]; |
288 |
if (result == null) |
289 |
throw new NoSuchElementException(); |
290 |
return result; |
291 |
} |
292 |
|
293 |
@SuppressWarnings("unchecked") |
294 |
public E peekFirst() { |
295 |
// elements[head] is null if deque empty |
296 |
return (E) elements[head]; |
297 |
} |
298 |
|
299 |
@SuppressWarnings("unchecked") |
300 |
public E peekLast() { |
301 |
return (E) elements[(tail - 1) & (elements.length - 1)]; |
302 |
} |
303 |
|
304 |
/** |
305 |
* Removes the first occurrence of the specified element in this |
306 |
* deque (when traversing the deque from head to tail). |
307 |
* If the deque does not contain the element, it is unchanged. |
308 |
* More formally, removes the first element {@code e} such that |
309 |
* {@code o.equals(e)} (if such an element exists). |
310 |
* Returns {@code true} if this deque contained the specified element |
311 |
* (or equivalently, if this deque changed as a result of the call). |
312 |
* |
313 |
* @param o element to be removed from this deque, if present |
314 |
* @return {@code true} if the deque contained the specified element |
315 |
*/ |
316 |
public boolean removeFirstOccurrence(Object o) { |
317 |
if (o == null) |
318 |
return false; |
319 |
int mask = elements.length - 1; |
320 |
int i = head; |
321 |
Object x; |
322 |
while ( (x = elements[i]) != null) { |
323 |
if (o.equals(x)) { |
324 |
delete(i); |
325 |
return true; |
326 |
} |
327 |
i = (i + 1) & mask; |
328 |
} |
329 |
return false; |
330 |
} |
331 |
|
332 |
/** |
333 |
* Removes the last occurrence of the specified element in this |
334 |
* deque (when traversing the deque from head to tail). |
335 |
* If the deque does not contain the element, it is unchanged. |
336 |
* More formally, removes the last element {@code e} such that |
337 |
* {@code o.equals(e)} (if such an element exists). |
338 |
* Returns {@code true} if this deque contained the specified element |
339 |
* (or equivalently, if this deque changed as a result of the call). |
340 |
* |
341 |
* @param o element to be removed from this deque, if present |
342 |
* @return {@code true} if the deque contained the specified element |
343 |
*/ |
344 |
public boolean removeLastOccurrence(Object o) { |
345 |
if (o == null) |
346 |
return false; |
347 |
int mask = elements.length - 1; |
348 |
int i = (tail - 1) & mask; |
349 |
Object x; |
350 |
while ( (x = elements[i]) != null) { |
351 |
if (o.equals(x)) { |
352 |
delete(i); |
353 |
return true; |
354 |
} |
355 |
i = (i - 1) & mask; |
356 |
} |
357 |
return false; |
358 |
} |
359 |
|
360 |
// *** Queue methods *** |
361 |
|
362 |
/** |
363 |
* Inserts the specified element at the end of this deque. |
364 |
* |
365 |
* <p>This method is equivalent to {@link #addLast}. |
366 |
* |
367 |
* @param e the element to add |
368 |
* @return {@code true} (as specified by {@link Collection#add}) |
369 |
* @throws NullPointerException if the specified element is null |
370 |
*/ |
371 |
public boolean add(E e) { |
372 |
addLast(e); |
373 |
return true; |
374 |
} |
375 |
|
376 |
/** |
377 |
* Inserts the specified element at the end of this deque. |
378 |
* |
379 |
* <p>This method is equivalent to {@link #offerLast}. |
380 |
* |
381 |
* @param e the element to add |
382 |
* @return {@code true} (as specified by {@link Queue#offer}) |
383 |
* @throws NullPointerException if the specified element is null |
384 |
*/ |
385 |
public boolean offer(E e) { |
386 |
return offerLast(e); |
387 |
} |
388 |
|
389 |
/** |
390 |
* Retrieves and removes the head of the queue represented by this deque. |
391 |
* |
392 |
* This method differs from {@link #poll poll} only in that it throws an |
393 |
* exception if this deque is empty. |
394 |
* |
395 |
* <p>This method is equivalent to {@link #removeFirst}. |
396 |
* |
397 |
* @return the head of the queue represented by this deque |
398 |
* @throws NoSuchElementException {@inheritDoc} |
399 |
*/ |
400 |
public E remove() { |
401 |
return removeFirst(); |
402 |
} |
403 |
|
404 |
/** |
405 |
* Retrieves and removes the head of the queue represented by this deque |
406 |
* (in other words, the first element of this deque), or returns |
407 |
* {@code null} if this deque is empty. |
408 |
* |
409 |
* <p>This method is equivalent to {@link #pollFirst}. |
410 |
* |
411 |
* @return the head of the queue represented by this deque, or |
412 |
* {@code null} if this deque is empty |
413 |
*/ |
414 |
public E poll() { |
415 |
return pollFirst(); |
416 |
} |
417 |
|
418 |
/** |
419 |
* Retrieves, but does not remove, the head of the queue represented by |
420 |
* this deque. This method differs from {@link #peek peek} only in |
421 |
* that it throws an exception if this deque is empty. |
422 |
* |
423 |
* <p>This method is equivalent to {@link #getFirst}. |
424 |
* |
425 |
* @return the head of the queue represented by this deque |
426 |
* @throws NoSuchElementException {@inheritDoc} |
427 |
*/ |
428 |
public E element() { |
429 |
return getFirst(); |
430 |
} |
431 |
|
432 |
/** |
433 |
* Retrieves, but does not remove, the head of the queue represented by |
434 |
* this deque, or returns {@code null} if this deque is empty. |
435 |
* |
436 |
* <p>This method is equivalent to {@link #peekFirst}. |
437 |
* |
438 |
* @return the head of the queue represented by this deque, or |
439 |
* {@code null} if this deque is empty |
440 |
*/ |
441 |
public E peek() { |
442 |
return peekFirst(); |
443 |
} |
444 |
|
445 |
// *** Stack methods *** |
446 |
|
447 |
/** |
448 |
* Pushes an element onto the stack represented by this deque. In other |
449 |
* words, inserts the element at the front of this deque. |
450 |
* |
451 |
* <p>This method is equivalent to {@link #addFirst}. |
452 |
* |
453 |
* @param e the element to push |
454 |
* @throws NullPointerException if the specified element is null |
455 |
*/ |
456 |
public void push(E e) { |
457 |
addFirst(e); |
458 |
} |
459 |
|
460 |
/** |
461 |
* Pops an element from the stack represented by this deque. In other |
462 |
* words, removes and returns the first element of this deque. |
463 |
* |
464 |
* <p>This method is equivalent to {@link #removeFirst()}. |
465 |
* |
466 |
* @return the element at the front of this deque (which is the top |
467 |
* of the stack represented by this deque) |
468 |
* @throws NoSuchElementException {@inheritDoc} |
469 |
*/ |
470 |
public E pop() { |
471 |
return removeFirst(); |
472 |
} |
473 |
|
474 |
private void checkInvariants() { |
475 |
assert elements[tail] == null; |
476 |
assert head == tail ? elements[head] == null : |
477 |
(elements[head] != null && |
478 |
elements[(tail - 1) & (elements.length - 1)] != null); |
479 |
assert elements[(head - 1) & (elements.length - 1)] == null; |
480 |
} |
481 |
|
482 |
/** |
483 |
* Removes the element at the specified position in the elements array, |
484 |
* adjusting head and tail as necessary. This can result in motion of |
485 |
* elements backwards or forwards in the array. |
486 |
* |
487 |
* <p>This method is called delete rather than remove to emphasize |
488 |
* that its semantics differ from those of {@link List#remove(int)}. |
489 |
* |
490 |
* @return true if elements moved backwards |
491 |
*/ |
492 |
private boolean delete(int i) { |
493 |
checkInvariants(); |
494 |
final Object[] elements = this.elements; |
495 |
final int mask = elements.length - 1; |
496 |
final int h = head; |
497 |
final int t = tail; |
498 |
final int front = (i - h) & mask; |
499 |
final int back = (t - i) & mask; |
500 |
|
501 |
// Invariant: head <= i < tail mod circularity |
502 |
if (front >= ((t - h) & mask)) |
503 |
throw new ConcurrentModificationException(); |
504 |
|
505 |
// Optimize for least element motion |
506 |
if (front < back) { |
507 |
if (h <= i) { |
508 |
System.arraycopy(elements, h, elements, h + 1, front); |
509 |
} else { // Wrap around |
510 |
System.arraycopy(elements, 0, elements, 1, i); |
511 |
elements[0] = elements[mask]; |
512 |
System.arraycopy(elements, h, elements, h + 1, mask - h); |
513 |
} |
514 |
elements[h] = null; |
515 |
head = (h + 1) & mask; |
516 |
return false; |
517 |
} else { |
518 |
if (i < t) { // Copy the null tail as well |
519 |
System.arraycopy(elements, i + 1, elements, i, back); |
520 |
tail = t - 1; |
521 |
} else { // Wrap around |
522 |
System.arraycopy(elements, i + 1, elements, i, mask - i); |
523 |
elements[mask] = elements[0]; |
524 |
System.arraycopy(elements, 1, elements, 0, t); |
525 |
tail = (t - 1) & mask; |
526 |
} |
527 |
return true; |
528 |
} |
529 |
} |
530 |
|
531 |
// *** Collection Methods *** |
532 |
|
533 |
/** |
534 |
* Returns the number of elements in this deque. |
535 |
* |
536 |
* @return the number of elements in this deque |
537 |
*/ |
538 |
public int size() { |
539 |
return (tail - head) & (elements.length - 1); |
540 |
} |
541 |
|
542 |
/** |
543 |
* Returns {@code true} if this deque contains no elements. |
544 |
* |
545 |
* @return {@code true} if this deque contains no elements |
546 |
*/ |
547 |
public boolean isEmpty() { |
548 |
return head == tail; |
549 |
} |
550 |
|
551 |
/** |
552 |
* Returns an iterator over the elements in this deque. The elements |
553 |
* will be ordered from first (head) to last (tail). This is the same |
554 |
* order that elements would be dequeued (via successive calls to |
555 |
* {@link #remove} or popped (via successive calls to {@link #pop}). |
556 |
* |
557 |
* @return an iterator over the elements in this deque |
558 |
*/ |
559 |
public Iterator<E> iterator() { |
560 |
return new DeqIterator(); |
561 |
} |
562 |
|
563 |
public Iterator<E> descendingIterator() { |
564 |
return new DescendingIterator(); |
565 |
} |
566 |
|
567 |
private class DeqIterator implements Iterator<E> { |
568 |
/** |
569 |
* Index of element to be returned by subsequent call to next. |
570 |
*/ |
571 |
private int cursor = head; |
572 |
|
573 |
/** |
574 |
* Tail recorded at construction (also in remove), to stop |
575 |
* iterator and also to check for comodification. |
576 |
*/ |
577 |
private int fence = tail; |
578 |
|
579 |
/** |
580 |
* Index of element returned by most recent call to next. |
581 |
* Reset to -1 if element is deleted by a call to remove. |
582 |
*/ |
583 |
private int lastRet = -1; |
584 |
|
585 |
public boolean hasNext() { |
586 |
return cursor != fence; |
587 |
} |
588 |
|
589 |
public E next() { |
590 |
if (cursor == fence) |
591 |
throw new NoSuchElementException(); |
592 |
@SuppressWarnings("unchecked") |
593 |
E result = (E) elements[cursor]; |
594 |
// This check doesn't catch all possible comodifications, |
595 |
// but does catch the ones that corrupt traversal |
596 |
if (tail != fence || result == null) |
597 |
throw new ConcurrentModificationException(); |
598 |
lastRet = cursor; |
599 |
cursor = (cursor + 1) & (elements.length - 1); |
600 |
return result; |
601 |
} |
602 |
|
603 |
public void remove() { |
604 |
if (lastRet < 0) |
605 |
throw new IllegalStateException(); |
606 |
if (delete(lastRet)) { // if left-shifted, undo increment in next() |
607 |
cursor = (cursor - 1) & (elements.length - 1); |
608 |
fence = tail; |
609 |
} |
610 |
lastRet = -1; |
611 |
} |
612 |
} |
613 |
|
614 |
private class DescendingIterator implements Iterator<E> { |
615 |
/* |
616 |
* This class is nearly a mirror-image of DeqIterator, using |
617 |
* tail instead of head for initial cursor, and head instead of |
618 |
* tail for fence. |
619 |
*/ |
620 |
private int cursor = tail; |
621 |
private int fence = head; |
622 |
private int lastRet = -1; |
623 |
|
624 |
public boolean hasNext() { |
625 |
return cursor != fence; |
626 |
} |
627 |
|
628 |
public E next() { |
629 |
if (cursor == fence) |
630 |
throw new NoSuchElementException(); |
631 |
cursor = (cursor - 1) & (elements.length - 1); |
632 |
@SuppressWarnings("unchecked") |
633 |
E result = (E) elements[cursor]; |
634 |
if (head != fence || result == null) |
635 |
throw new ConcurrentModificationException(); |
636 |
lastRet = cursor; |
637 |
return result; |
638 |
} |
639 |
|
640 |
public void remove() { |
641 |
if (lastRet < 0) |
642 |
throw new IllegalStateException(); |
643 |
if (!delete(lastRet)) { |
644 |
cursor = (cursor + 1) & (elements.length - 1); |
645 |
fence = head; |
646 |
} |
647 |
lastRet = -1; |
648 |
} |
649 |
} |
650 |
|
651 |
/** |
652 |
* Returns {@code true} if this deque contains the specified element. |
653 |
* More formally, returns {@code true} if and only if this deque contains |
654 |
* at least one element {@code e} such that {@code o.equals(e)}. |
655 |
* |
656 |
* @param o object to be checked for containment in this deque |
657 |
* @return {@code true} if this deque contains the specified element |
658 |
*/ |
659 |
public boolean contains(Object o) { |
660 |
if (o == null) |
661 |
return false; |
662 |
int mask = elements.length - 1; |
663 |
int i = head; |
664 |
Object x; |
665 |
while ( (x = elements[i]) != null) { |
666 |
if (o.equals(x)) |
667 |
return true; |
668 |
i = (i + 1) & mask; |
669 |
} |
670 |
return false; |
671 |
} |
672 |
|
673 |
/** |
674 |
* Removes a single instance of the specified element from this deque. |
675 |
* If the deque does not contain the element, it is unchanged. |
676 |
* More formally, removes the first element {@code e} such that |
677 |
* {@code o.equals(e)} (if such an element exists). |
678 |
* Returns {@code true} if this deque contained the specified element |
679 |
* (or equivalently, if this deque changed as a result of the call). |
680 |
* |
681 |
* <p>This method is equivalent to {@link #removeFirstOccurrence(Object)}. |
682 |
* |
683 |
* @param o element to be removed from this deque, if present |
684 |
* @return {@code true} if this deque contained the specified element |
685 |
*/ |
686 |
public boolean remove(Object o) { |
687 |
return removeFirstOccurrence(o); |
688 |
} |
689 |
|
690 |
/** |
691 |
* Removes all of the elements from this deque. |
692 |
* The deque will be empty after this call returns. |
693 |
*/ |
694 |
public void clear() { |
695 |
int h = head; |
696 |
int t = tail; |
697 |
if (h != t) { // clear all cells |
698 |
head = tail = 0; |
699 |
int i = h; |
700 |
int mask = elements.length - 1; |
701 |
do { |
702 |
elements[i] = null; |
703 |
i = (i + 1) & mask; |
704 |
} while (i != t); |
705 |
} |
706 |
} |
707 |
|
708 |
/** |
709 |
* Returns an array containing all of the elements in this deque |
710 |
* in proper sequence (from first to last element). |
711 |
* |
712 |
* <p>The returned array will be "safe" in that no references to it are |
713 |
* maintained by this deque. (In other words, this method must allocate |
714 |
* a new array). The caller is thus free to modify the returned array. |
715 |
* |
716 |
* <p>This method acts as bridge between array-based and collection-based |
717 |
* APIs. |
718 |
* |
719 |
* @return an array containing all of the elements in this deque |
720 |
*/ |
721 |
public Object[] toArray() { |
722 |
final int head = this.head; |
723 |
final int tail = this.tail; |
724 |
boolean wrap = (tail < head); |
725 |
int end = wrap ? tail + elements.length : tail; |
726 |
Object[] a = Arrays.copyOfRange(elements, head, end); |
727 |
if (wrap) |
728 |
System.arraycopy(elements, 0, a, elements.length - head, tail); |
729 |
return a; |
730 |
} |
731 |
|
732 |
/** |
733 |
* Returns an array containing all of the elements in this deque in |
734 |
* proper sequence (from first to last element); the runtime type of the |
735 |
* returned array is that of the specified array. If the deque fits in |
736 |
* the specified array, it is returned therein. Otherwise, a new array |
737 |
* is allocated with the runtime type of the specified array and the |
738 |
* size of this deque. |
739 |
* |
740 |
* <p>If this deque fits in the specified array with room to spare |
741 |
* (i.e., the array has more elements than this deque), the element in |
742 |
* the array immediately following the end of the deque is set to |
743 |
* {@code null}. |
744 |
* |
745 |
* <p>Like the {@link #toArray()} method, this method acts as bridge between |
746 |
* array-based and collection-based APIs. Further, this method allows |
747 |
* precise control over the runtime type of the output array, and may, |
748 |
* under certain circumstances, be used to save allocation costs. |
749 |
* |
750 |
* <p>Suppose {@code x} is a deque known to contain only strings. |
751 |
* The following code can be used to dump the deque into a newly |
752 |
* allocated array of {@code String}: |
753 |
* |
754 |
* <pre> {@code String[] y = x.toArray(new String[0]);}</pre> |
755 |
* |
756 |
* Note that {@code toArray(new Object[0])} is identical in function to |
757 |
* {@code toArray()}. |
758 |
* |
759 |
* @param a the array into which the elements of the deque are to |
760 |
* be stored, if it is big enough; otherwise, a new array of the |
761 |
* same runtime type is allocated for this purpose |
762 |
* @return an array containing all of the elements in this deque |
763 |
* @throws ArrayStoreException if the runtime type of the specified array |
764 |
* is not a supertype of the runtime type of every element in |
765 |
* this deque |
766 |
* @throws NullPointerException if the specified array is null |
767 |
*/ |
768 |
@SuppressWarnings("unchecked") |
769 |
public <T> T[] toArray(T[] a) { |
770 |
final int head = this.head; |
771 |
final int tail = this.tail; |
772 |
boolean wrap = (tail < head); |
773 |
int size = (tail - head) + (wrap ? elements.length : 0); |
774 |
int firstLeg = size - (wrap ? tail : 0); |
775 |
int len = a.length; |
776 |
if (size > len) { |
777 |
a = (T[]) Arrays.copyOfRange(elements, head, head + size, |
778 |
a.getClass()); |
779 |
} else { |
780 |
System.arraycopy(elements, head, a, 0, firstLeg); |
781 |
if (size < len) |
782 |
a[size] = null; |
783 |
} |
784 |
if (wrap) |
785 |
System.arraycopy(elements, 0, a, firstLeg, tail); |
786 |
return a; |
787 |
} |
788 |
|
789 |
// *** Object methods *** |
790 |
|
791 |
/** |
792 |
* Returns a copy of this deque. |
793 |
* |
794 |
* @return a copy of this deque |
795 |
*/ |
796 |
public ArrayDeque<E> clone() { |
797 |
try { |
798 |
@SuppressWarnings("unchecked") |
799 |
ArrayDeque<E> result = (ArrayDeque<E>) super.clone(); |
800 |
result.elements = Arrays.copyOf(elements, elements.length); |
801 |
return result; |
802 |
} catch (CloneNotSupportedException e) { |
803 |
throw new AssertionError(); |
804 |
} |
805 |
} |
806 |
|
807 |
private static final long serialVersionUID = 2340985798034038923L; |
808 |
|
809 |
/** |
810 |
* Saves this deque to a stream (that is, serializes it). |
811 |
* |
812 |
* @serialData The current size ({@code int}) of the deque, |
813 |
* followed by all of its elements (each an object reference) in |
814 |
* first-to-last order. |
815 |
*/ |
816 |
private void writeObject(java.io.ObjectOutputStream s) |
817 |
throws java.io.IOException { |
818 |
s.defaultWriteObject(); |
819 |
|
820 |
// Write out size |
821 |
s.writeInt(size()); |
822 |
|
823 |
// Write out elements in order. |
824 |
int mask = elements.length - 1; |
825 |
for (int i = head; i != tail; i = (i + 1) & mask) |
826 |
s.writeObject(elements[i]); |
827 |
} |
828 |
|
829 |
/** |
830 |
* Reconstitutes this deque from a stream (that is, deserializes it). |
831 |
*/ |
832 |
private void readObject(java.io.ObjectInputStream s) |
833 |
throws java.io.IOException, ClassNotFoundException { |
834 |
s.defaultReadObject(); |
835 |
|
836 |
// Read in size and allocate array |
837 |
int size = s.readInt(); |
838 |
allocateElements(size); |
839 |
head = 0; |
840 |
tail = size; |
841 |
|
842 |
// Read in all elements in the proper order. |
843 |
for (int i = 0; i < size; i++) |
844 |
elements[i] = s.readObject(); |
845 |
} |
846 |
|
847 |
Spliterator<E> spliterator() { |
848 |
return new DeqSpliterator<E>(this, -1, -1); |
849 |
} |
850 |
|
851 |
public Stream<E> stream() { |
852 |
return Streams.stream(spliterator()); |
853 |
} |
854 |
|
855 |
public Stream<E> parallelStream() { |
856 |
return Streams.parallelStream(spliterator()); |
857 |
} |
858 |
|
859 |
static final class DeqSpliterator<E> implements Spliterator<E> { |
860 |
private final ArrayDeque<E> deq; |
861 |
private int fence; // -1 until first use |
862 |
private int index; // current index, modified on traverse/split |
863 |
|
864 |
/** Creates new spliterator covering the given array and range */ |
865 |
DeqSpliterator(ArrayDeque<E> deq, int origin, int fence) { |
866 |
this.deq = deq; |
867 |
this.index = origin; |
868 |
this.fence = fence; |
869 |
} |
870 |
|
871 |
private int getFence() { // force initialization |
872 |
int t; |
873 |
if ((t = fence) < 0) { |
874 |
t = fence = deq.tail; |
875 |
index = deq.head; |
876 |
} |
877 |
return t; |
878 |
} |
879 |
|
880 |
public DeqSpliterator<E> trySplit() { |
881 |
int t = getFence(), h = index, n = deq.elements.length; |
882 |
if (h != t && ((h + 1) & (n - 1)) != t) { |
883 |
if (h > t) |
884 |
t += n; |
885 |
int m = ((h + t) >>> 1) & (n - 1); |
886 |
return new DeqSpliterator<>(deq, h, index = m); |
887 |
} |
888 |
return null; |
889 |
} |
890 |
|
891 |
public void forEach(Consumer<? super E> consumer) { |
892 |
if (consumer == null) |
893 |
throw new NullPointerException(); |
894 |
Object[] a = deq.elements; |
895 |
int m = a.length - 1, f = getFence(), i = index; |
896 |
index = f; |
897 |
while (i != f) { |
898 |
@SuppressWarnings("unchecked") E e = (E)a[i]; |
899 |
i = (i + 1) & m; |
900 |
if (e == null) |
901 |
throw new ConcurrentModificationException(); |
902 |
consumer.accept(e); |
903 |
} |
904 |
} |
905 |
|
906 |
public boolean tryAdvance(Consumer<? super E> consumer) { |
907 |
if (consumer == null) |
908 |
throw new NullPointerException(); |
909 |
Object[] a = deq.elements; |
910 |
int m = a.length - 1, f = getFence(), i = index; |
911 |
if (i != fence) { |
912 |
@SuppressWarnings("unchecked") E e = (E)a[i]; |
913 |
index = (i + 1) & m; |
914 |
if (e == null) |
915 |
throw new ConcurrentModificationException(); |
916 |
consumer.accept(e); |
917 |
return true; |
918 |
} |
919 |
return false; |
920 |
} |
921 |
|
922 |
public long estimateSize() { |
923 |
int n = getFence() - index; |
924 |
if (n < 0) |
925 |
n += deq.elements.length; |
926 |
return (long) n; |
927 |
} |
928 |
|
929 |
@Override |
930 |
public int characteristics() { |
931 |
return Spliterator.ORDERED | Spliterator.SIZED | |
932 |
Spliterator.NONNULL | Spliterator.SUBSIZED; |
933 |
} |
934 |
} |
935 |
|
936 |
} |