Module com.carrotsearch.hppc
Package com.carrotsearch.hppc

Class ObjectArrayDeque<KType>

java.lang.Object
com.carrotsearch.hppc.ObjectArrayDeque<KType>
All Implemented Interfaces:
Accountable, ObjectCollection<KType>, ObjectContainer<KType>, ObjectDeque<KType>, Preallocable, Cloneable, Iterable<ObjectCursor<KType>>
@Generated(date="2024-06-04T15:20:17+0200", value="KTypeArrayDeque.java") public class ObjectArrayDeque<KType> extends Object implements ObjectDeque<KType>, Preallocable, Cloneable, Accountable
An array-backed ObjectDeque.

  • Field Details

    • buffer

      public Object[] buffer
      Internal array for storing elements of the deque.

    • tail

      public int tail
      The index at which the next element would be added to the tail of the deque.

    • resizer

      protected final ArraySizingStrategy 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

      public ObjectArrayDeque(int expectedElements, ArraySizingStrategy resizer)
      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

      public 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 Details

    • addFirst

      public void addFirst(KType e1)
      Inserts the specified element at the front of this deque.
      Specified by:
      addFirst in interface ObjectDeque<KType>

    • addFirst

      @SafeVarargs public final void addFirst(KType... elements)
      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

      public int addFirst(ObjectContainer<? extends KType> container)
      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

      public int addFirst(Iterable<? extends ObjectCursor<? extends KType>> iterable)
      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

      public void addLast(KType e1)
      Inserts the specified element at the end of this deque.
      Specified by:
      addLast in interface ObjectDeque<KType>

    • addLast

      @SafeVarargs public final void addLast(KType... elements)
      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

      public int addLast(ObjectContainer<? extends KType> container)
      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

      public int addLast(Iterable<? extends ObjectCursor<? extends KType>> iterable)
      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

      public KType removeFirst()
      Retrieves and removes the first element of this deque.
      Specified by:
      removeFirst in interface ObjectDeque<KType>
      Returns:
      the head (first) element of this deque.

    • removeLast

      public KType removeLast()
      Retrieves and removes the last element of this deque.
      Specified by:
      removeLast in interface ObjectDeque<KType>
      Returns:
      the tail of this deque.

    • getFirst

      public KType getFirst()
      Retrieves the first element of this deque but does not remove it.
      Specified by:
      getFirst in interface ObjectDeque<KType>
      Returns:
      the head of this deque.

    • getLast

      public KType getLast()
      Retrieves the last element of this deque but does not remove it.
      Specified by:
      getLast in interface ObjectDeque<KType>
      Returns:
      the head of this deque.

    • removeFirst

      public int removeFirst(KType e1)
      Removes the first element that equals e.
      Specified by:
      removeFirst in interface ObjectDeque<KType>
      Returns:
      The deleted element's index or -1 if the element was not found.

    • bufferIndexOf

      public int bufferIndexOf(KType e1)
      Return the index of the first (counting from head) element equal to e1. The index points to the buffer 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

      public int removeLast(KType e1)
      Removes the last element that equals e.
      Specified by:
      removeLast in interface ObjectDeque<KType>
      Returns:
      The deleted element's index or -1 if the element was not found.

    • lastBufferIndexOf

      public int lastBufferIndexOf(KType e1)
      Return the index of the last (counting from tail) element equal to e1. The index points to the buffer 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

      public int removeAll(KType e1)
      Removes all occurrences of e from this collection.
      Specified by:
      removeAll in interface ObjectCollection<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 at index in the internal {#link buffer array, returning its value.
      Parameters:
      index - Index of the element to remove. The index must be located between head and tail in modulo buffer arithmetic.

    • isEmpty

      public boolean isEmpty()
      Shortcut for size() == 0.
      Specified by:
      isEmpty in interface ObjectContainer<KType>

    • size

      public int size()
      Return the current number of elements in this container. The time for calculating the container's size may take O(n) time, although implementing classes should try to maintain the current size and return in constant time.
      Specified by:
      size in interface ObjectContainer<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 interface ObjectCollection<KType>
      See Also:

    • release

      public void release()
      Release internal buffers of this deque and reallocate with the default buffer.
      Specified by:
      release in interface ObjectCollection<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 interface Preallocable
      Parameters:
      expectedElements - The total number of elements, inclusive.

    • ensureBufferSpace

      protected void ensureBufferSpace(int expectedAdditions)
      Ensures the internal buffer has enough free slots to store expectedAdditions. Increases internal buffer size if needed.

    • toArray

      public Object[] toArray()
      Default implementation of copying to an array.
      Specified by:
      toArray in interface ObjectContainer<KType>

    • toArray

      public KType[] toArray(KType[] target)
      Copies elements of this deque to an array. The content of the target array is filled from index 0 (head of the queue) to index size() - 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

      public ObjectArrayDeque<KType> clone()
      Clone this object. The returned clone will reuse the same hash function and array resizing strategy.
      Overrides:
      clone in class Object

    • 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.

    • ramBytesAllocated

      public long ramBytesAllocated()
      Description copied from interface: Accountable
      Allocated memory estimation
      Specified by:
      ramBytesAllocated in interface Accountable
      Returns:
      Ram allocated in bytes

    • ramBytesUsed

      public long ramBytesUsed()
      Description copied from interface: Accountable
      Bytes that is actually been used
      Specified by:
      ramBytesUsed in interface Accountable
      Returns:
      Ram used in bytes

    • iterator

      public Iterator<ObjectCursor<KType>> 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 to Iterator.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);
 }
      Specified by:
      iterator in interface Iterable<KType>
      Specified by:
      iterator in interface ObjectContainer<KType>

    • descendingIterator

      public Iterator<ObjectCursor<KType>> 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 to Iterator.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 interface ObjectDeque<KType>
      Returns:
      An iterator over elements in this deque in tail-to-head order.

    • forEach

      public <T extends ObjectProcedure<? super KType>> T forEach(T procedure)
      Applies a procedure to all container elements. Returns the argument (any subclass of ObjectProcedure. 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 interface ObjectContainer<KType>

    • forEach

      public <T extends ObjectPredicate<? super KType>> T forEach(T predicate)
      Applies a predicate to container elements as long, as the predicate returns true. The iteration is interrupted otherwise.
      Specified by:
      forEach in interface ObjectContainer<KType>

    • descendingForEach

      public <T extends ObjectProcedure<? super KType>> T descendingForEach(T procedure)
      Applies procedure to all elements of this deque, tail to head.
      Specified by:
      descendingForEach in interface ObjectDeque<KType>

    • descendingForEach

      public <T extends ObjectPredicate<? super KType>> T descendingForEach(T predicate)
      Applies a predicate to container elements as long, as the predicate returns true. The iteration is interrupted otherwise.
      Specified by:
      descendingForEach in interface ObjectDeque<KType>

    • removeAll

      public int removeAll(ObjectPredicate<? super KType> predicate)
      Removes all elements in this collection for which the given predicate returns true .
      Specified by:
      removeAll in interface ObjectCollection<KType>
      Returns:
      Returns the number of removed elements.

    • contains

      public boolean contains(KType e)
      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 interface ObjectContainer<KType>
      Returns:
      Returns true if this container has an element equal to e.

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object obj)
      Returns true only if the other object is an instance of the same class and with the same elements. Equality comparison is performed with this object's equals(Object, Object) method.
      Overrides:
      equals in class Object

    • equalElements

      protected boolean equalElements(ObjectArrayDeque<?> other)
      Compare order-aligned elements against another ObjectDeque. Equality comparison is performed with this object's equals(Object, Object) method.

    • from

      @SafeVarargs public static <KType> ObjectArrayDeque<KType> from(KType... elements)
      Create a new deque by pushing a variable number of arguments to the end of it.

    • removeAll

      public int removeAll(ObjectLookupContainer<? super KType> c)
      Default implementation uses a predicate for removal.
      Specified by:
      removeAll in interface ObjectCollection<KType>
      Returns:
      Returns the number of removed elements.

    • retainAll

      public int retainAll(ObjectLookupContainer<? super KType> c)
      Default implementation uses a predicate for retaining.
      Specified by:
      retainAll in interface ObjectCollection<KType>
      Returns:
      Returns the number of removed elements.

    • retainAll

      public int retainAll(ObjectPredicate<? super KType> predicate)
      Default implementation redirects to ObjectCollection.removeAll(ObjectPredicate) and negates the predicate.
      Specified by:
      retainAll in interface ObjectCollection<KType>
      Returns:
      Returns the number of removed elements.

    • toArray

      public <T> T[] toArray(Class<T> componentClass)
      Description copied from interface: ObjectContainer
      Copies all elements of this container to a dynamically created array of the given component type.
      Specified by:
      toArray in interface ObjectContainer<KType>

    • toString

      public String toString()
      Convert the contents of this container to a human-friendly string.
      Overrides:
      toString in class Object

    • equals

      protected boolean equals(Object v1, Object v2)