Package com.carrotsearch.hppc
Class ObjectArrayDeque<KType>
java.lang.Object
com.carrotsearch.hppc.AbstractObjectCollection<KType>
com.carrotsearch.hppc.ObjectArrayDeque<KType>
- All Implemented Interfaces:
ObjectCollection<KType>
,ObjectContainer<KType>
,ObjectDeque<KType>
,Preallocable
,Cloneable
,Iterable<ObjectCursor<KType>>
@Generated(date="2023-09-14T00:00:00+0000",
value="KTypeArrayDeque.java")
public class ObjectArrayDeque<KType>
extends AbstractObjectCollection<KType>
implements ObjectDeque<KType>, Preallocable, Cloneable
An array-backed
ObjectDeque
.-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprivate final class
An iterator implementation fordescendingIterator()
.private final class
An iterator implementation foriterator()
. -
Field Summary
FieldsModifier and TypeFieldDescriptionObject[]
Internal array for storing elements of the deque.int
The index of the element at the head of the deque or an arbitrary number equal to tail if the deque is empty.protected final ArraySizingStrategy
Buffer resizing strategy.int
The index at which the next element would be added to the tail of the deque. -
Constructor Summary
ConstructorsConstructorDescriptionNew instance with sane defaults.ObjectArrayDeque
(int expectedElements) New instance with sane defaults.ObjectArrayDeque
(int expectedElements, ArraySizingStrategy resizer) New instance with sane defaults.ObjectArrayDeque
(ObjectContainer<? extends KType> container) Creates a new deque from elements of another container, appending elements at the end of the deque in the iteration order. -
Method Summary
Modifier and TypeMethodDescriptionint
addFirst
(ObjectContainer<? extends KType> container) Inserts all elements from the given container to the front of this deque.int
addFirst
(Iterable<? extends ObjectCursor<? extends KType>> iterable) Inserts all elements from the given iterable to the front of this deque.void
Inserts the specified element at the front of this deque.final void
Vararg-signature method for adding elements at the front of this deque.int
addLast
(ObjectContainer<? extends KType> container) Inserts all elements from the given container to the end of this deque.int
addLast
(Iterable<? extends ObjectCursor<? extends KType>> iterable) Inserts all elements from the given iterable to the end of this deque.void
Inserts the specified element at the end of this deque.final void
Vararg-signature method for adding elements at the end of this deque.int
bufferIndexOf
(KType e1) Return the index of the first (counting from head) element equal toe1
.void
clear()
Removes all elements from this collection.clone()
Clone this object.boolean
Lookup a given element in the container.private void
descendingForEach
(ObjectPredicate<? super KType> predicate, int fromIndex, int toIndex) Appliespredicate
to a slice of the deque,toIndex
, exclusive, down tofromIndex
, inclusive or until the predicate returnsfalse
.private void
descendingForEach
(ObjectProcedure<? super KType> procedure, int fromIndex, int toIndex) Appliesprocedure
to a slice of the deque,toIndex
, exclusive, down tofromIndex
, inclusive.<T extends ObjectProcedure<? super KType>>
TdescendingForEach
(T procedure) Appliesprocedure
to all elements of this deque, tail to head.Returns a cursor over the values of this deque (in tail to head order).protected void
ensureBufferSpace
(int expectedAdditions) Ensures the internal buffer has enough free slots to storeexpectedAdditions
.void
ensureCapacity
(int expectedElements) Ensure this container can hold at least the given number of elements without resizing its buffers.protected boolean
equalElements
(ObjectArrayDeque<?> other) Compare order-aligned elements against anotherObjectDeque
.boolean
Returnstrue
only if the other object is an instance of the same class and with the same elements.private void
forEach
(ObjectProcedure<? super KType> procedure, int fromIndex, int toIndex) Appliesprocedure
to a slice of the deque,fromIndex
, inclusive, totoIndex
, exclusive.<T extends ObjectProcedure<? super KType>>
TforEach
(T procedure) Applies aprocedure
to all container elements.static <KType> ObjectArrayDeque<KType>
from
(KType... elements) Create a new deque by pushing a variable number of arguments to the end of it.getFirst()
Retrieves the first element of this deque but does not remove it.getLast()
Retrieves the last element of this deque but does not remove it.int
hashCode()
boolean
isEmpty()
Shortcut forsize() == 0
.iterator()
Returns a cursor over the values of this deque (in head to tail order).int
Return the index of the last (counting from tail) element equal toe1
.protected static int
oneLeft
(int index, int modulus) Move one index to the left, wrapping around buffer.protected static int
oneRight
(int index, int modulus) Move one index to the right, wrapping around buffer.void
release()
Release internal buffers of this deque and reallocate with the default buffer.int
removeAll
(ObjectPredicate<? super KType> predicate) Removes all elements in this collection for which the given predicate returnstrue
.int
Removes all occurrences ofe
from this collection.void
removeAtBufferIndex
(int index) Removes the element atindex
in the internal {#linkbuffer
array, returning its value.Retrieves and removes the first element of this deque.int
removeFirst
(KType e1) Removes the first element that equalse
.Retrieves and removes the last element of this deque.int
removeLast
(KType e1) Removes the last element that equalse
.int
size()
Return the current number of elements in this container.Object[]
toArray()
Default implementation of copying to an array.KType[]
Copies elements of this deque to an array.Methods inherited from class com.carrotsearch.hppc.AbstractObjectCollection
equals, removeAll, retainAll, retainAll, toArray, toString
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface java.lang.Iterable
forEach, spliterator
Methods inherited from interface com.carrotsearch.hppc.ObjectCollection
removeAll, retainAll, retainAll
Methods inherited from interface com.carrotsearch.hppc.ObjectContainer
toArray
-
Field Details
-
buffer
Internal array for storing elements of the deque. -
head
public int headThe index of the element at the head of the deque or an arbitrary number equal to tail if the deque is empty. -
tail
public int tailThe index at which the next element would be added to the tail of the deque. -
resizer
Buffer resizing strategy.
-
-
Constructor Details
-
ObjectArrayDeque
public ObjectArrayDeque()New instance with sane defaults. -
ObjectArrayDeque
public ObjectArrayDeque(int expectedElements) New instance with sane defaults.- Parameters:
expectedElements
- The expected number of elements guaranteed not to cause buffer expansion (inclusive).
-
ObjectArrayDeque
New instance with sane defaults.- Parameters:
expectedElements
- The expected number of elements guaranteed not to cause buffer expansion (inclusive).resizer
- Underlying buffer sizing strategy.
-
ObjectArrayDeque
Creates a new deque from elements of another container, appending elements at the end of the deque in the iteration order.
-
-
Method Details
-
addFirst
Inserts the specified element at the front of this deque.- Specified by:
addFirst
in interfaceObjectDeque<KType>
-
addFirst
Vararg-signature method for adding elements at the front of this deque.This method is handy, but costly if used in tight loops (anonymous array passing)
- Parameters:
elements
- The elements to add.
-
addFirst
Inserts all elements from the given container to the front of this deque.- Parameters:
container
- The container to iterate over.- Returns:
- Returns the number of elements actually added as a result of this call.
-
addFirst
Inserts all elements from the given iterable to the front of this deque.- Parameters:
iterable
- The iterable to iterate over.- Returns:
- Returns the number of elements actually added as a result of this call.
-
addLast
Inserts the specified element at the end of this deque.- Specified by:
addLast
in interfaceObjectDeque<KType>
-
addLast
Vararg-signature method for adding elements at the end of this deque.This method is handy, but costly if used in tight loops (anonymous array passing)
- Parameters:
elements
- The elements to iterate over.
-
addLast
Inserts all elements from the given container to the end of this deque.- Parameters:
container
- The container to iterate over.- Returns:
- Returns the number of elements actually added as a result of this call.
-
addLast
Inserts all elements from the given iterable to the end of this deque.- Parameters:
iterable
- The iterable to iterate over.- Returns:
- Returns the number of elements actually added as a result of this call.
-
removeFirst
Retrieves and removes the first element of this deque.- Specified by:
removeFirst
in interfaceObjectDeque<KType>
- Returns:
- the head (first) element of this deque.
-
removeLast
Retrieves and removes the last element of this deque.- Specified by:
removeLast
in interfaceObjectDeque<KType>
- Returns:
- the tail of this deque.
-
getFirst
Retrieves the first element of this deque but does not remove it.- Specified by:
getFirst
in interfaceObjectDeque<KType>
- Returns:
- the head of this deque.
-
getLast
Retrieves the last element of this deque but does not remove it.- Specified by:
getLast
in interfaceObjectDeque<KType>
- Returns:
- the head of this deque.
-
removeFirst
Removes the first element that equalse
.- Specified by:
removeFirst
in interfaceObjectDeque<KType>
- Returns:
- The deleted element's index or
-1
if the element was not found.
-
bufferIndexOf
Return the index of the first (counting from head) element equal toe1
. The index points to thebuffer
array.- Parameters:
e1
- The element to look for.- Returns:
- Returns the index of the first element equal to
e1
or-1
if not found.
-
removeLast
Removes the last element that equalse
.- Specified by:
removeLast
in interfaceObjectDeque<KType>
- Returns:
- The deleted element's index or
-1
if the element was not found.
-
lastBufferIndexOf
Return the index of the last (counting from tail) element equal toe1
. The index points to thebuffer
array.- Parameters:
e1
- The element to look for.- Returns:
- Returns the index of the first element equal to
e1
or-1
if not found.
-
removeAll
Removes all occurrences ofe
from this collection.- Specified by:
removeAll
in interfaceObjectCollection<KType>
- Parameters:
e1
- Element to be removed from this collection, if present.- Returns:
- The number of removed elements as a result of this call.
-
removeAtBufferIndex
public void removeAtBufferIndex(int index) Removes the element atindex
in the internal {#linkbuffer
array, returning its value. -
isEmpty
public boolean isEmpty()Shortcut forsize() == 0
.- Specified by:
isEmpty
in interfaceObjectContainer<KType>
-
size
public int size()Return the current number of elements in this container. The time for calculating the container's size may takeO(n)
time, although implementing classes should try to maintain the current size and return in constant time.- Specified by:
size
in interfaceObjectContainer<KType>
-
clear
public void clear()Removes all elements from this collection.The internal array buffers are not released as a result of this call.
- Specified by:
clear
in interfaceObjectCollection<KType>
- See Also:
-
release
public void release()Release internal buffers of this deque and reallocate with the default buffer.- Specified by:
release
in interfaceObjectCollection<KType>
- See Also:
-
ensureCapacity
public void ensureCapacity(int expectedElements) Ensure this container can hold at least the given number of elements without resizing its buffers.- Specified by:
ensureCapacity
in interfacePreallocable
- Parameters:
expectedElements
- The total number of elements, inclusive.
-
ensureBufferSpace
protected void ensureBufferSpace(int expectedAdditions) Ensures the internal buffer has enough free slots to storeexpectedAdditions
. Increases internal buffer size if needed. -
toArray
Default implementation of copying to an array.- Specified by:
toArray
in interfaceObjectContainer<KType>
- Overrides:
toArray
in classAbstractObjectCollection<KType>
-
toArray
Copies elements of this deque to an array. The content of thetarget
array is filled from index 0 (head of the queue) to indexsize() - 1
(tail of the queue).- Parameters:
target
- The target array must be large enough to hold all elements.- Returns:
- Returns the target argument for chaining.
-
clone
Clone this object. The returned clone will reuse the same hash function and array resizing strategy. -
oneLeft
protected static int oneLeft(int index, int modulus) Move one index to the left, wrapping around buffer. -
oneRight
protected static int oneRight(int index, int modulus) Move one index to the right, wrapping around buffer. -
iterator
Returns a cursor over the values of this deque (in head to tail order). The iterator is implemented as a cursor and it returns the same cursor instance on every call toIterator.next()
(to avoid boxing of primitive types). To read the current value (or index in the deque's buffer) use the cursor's public fields. An example is shown below.for (IntValueCursor c : intDeque) { System.out.println("buffer index=" + c.index + " value=" + c.value); }
-
descendingIterator
Returns a cursor over the values of this deque (in tail to head order). The iterator is implemented as a cursor and it returns the same cursor instance on every call toIterator.next()
(to avoid boxing of primitive types). To read the current value (or index in the deque's buffer) use the cursor's public fields. An example is shown below.for (Iterator<IntCursor> i = intDeque.descendingIterator(); i.hasNext();) { final IntCursor c = i.next(); System.out.println("buffer index=" + c.index + " value=" + c.value); }
- Specified by:
descendingIterator
in interfaceObjectDeque<KType>
- Returns:
- An iterator over elements in this deque in tail-to-head order.
-
forEach
Applies aprocedure
to all container elements. Returns the argument (any subclass ofObjectProcedure
. This lets the caller to call methods of the argument by chaining the call (even if the argument is an anonymous type) to retrieve computed values, for example (IntContainer):int count = container.forEach(new IntProcedure() { int count; // this is a field declaration in an anonymous class. public void apply(int value) { count++; } }).count;
- Specified by:
forEach
in interfaceObjectContainer<KType>
-
forEach
Appliesprocedure
to a slice of the deque,fromIndex
, inclusive, totoIndex
, exclusive. -
forEach
Applies apredicate
to container elements as long, as the predicate returnstrue
. The iteration is interrupted otherwise.- Specified by:
forEach
in interfaceObjectContainer<KType>
-
descendingForEach
Appliesprocedure
to all elements of this deque, tail to head.- Specified by:
descendingForEach
in interfaceObjectDeque<KType>
-
descendingForEach
private void descendingForEach(ObjectProcedure<? super KType> procedure, int fromIndex, int toIndex) Appliesprocedure
to a slice of the deque,toIndex
, exclusive, down tofromIndex
, inclusive. -
descendingForEach
Applies apredicate
to container elements as long, as the predicate returnstrue
. The iteration is interrupted otherwise.- Specified by:
descendingForEach
in interfaceObjectDeque<KType>
-
descendingForEach
private void descendingForEach(ObjectPredicate<? super KType> predicate, int fromIndex, int toIndex) Appliespredicate
to a slice of the deque,toIndex
, exclusive, down tofromIndex
, inclusive or until the predicate returnsfalse
. -
removeAll
Removes all elements in this collection for which the given predicate returnstrue
.- Specified by:
removeAll
in interfaceObjectCollection<KType>
- Returns:
- Returns the number of removed elements.
-
contains
Lookup a given element in the container. This operation has no speed guarantees (may be linear with respect to the size of this container).- Specified by:
contains
in interfaceObjectContainer<KType>
- Returns:
- Returns
true
if this container has an element equal toe
.
-
hashCode
public int hashCode() -
equals
Returnstrue
only if the other object is an instance of the same class and with the same elements. Equality comparison is performed with this object'sAbstractObjectCollection.equals(Object, Object)
method. -
equalElements
Compare order-aligned elements against anotherObjectDeque
. Equality comparison is performed with this object'sAbstractObjectCollection.equals(Object, Object)
method. -
from
Create a new deque by pushing a variable number of arguments to the end of it.
-