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