IntArrayDeque (HPPC v0.6.0 API Documentation (JavaDoc))

java.lang.Object
- com.carrotsearch.hppc.IntArrayDeque

All Implemented Interfaces:

IntCollection, IntContainer, IntDeque, java.lang.Cloneable, java.lang.Iterable<IntCursor>
```
@Generated(date="2014-04-08T14:32:52+0200",
           value="HPPC generated from: IntArrayDeque.java")
public class IntArrayDeque
extends java.lang.Object
implements IntDeque, java.lang.Cloneable
```
An array-backed deque (doubly linked queue) of ints. A single array is used to store and manipulate all elements. Reallocations are governed by a ArraySizingStrategy and may be expensive if they move around really large chunks of memory.
See ObjectArrayDeque class for API similarities and differences against Java Collections.

Field Summary

Fields
Modifier and Type	Field and Description
`int[]`	`buffer` Internal array for storing elements.
`static int`	`DEFAULT_CAPACITY` Default capacity if no other capacity is given in the constructor.
`int`	`head` The index of the element at the head of the deque or an arbitrary number equal to tail if the deque is empty.
`protected ArraySizingStrategy`	`resizer` Buffer resizing strategy.
`int`	`tail` The index at which the next element would be added to the tail of the deque.

Constructor Summary

Constructors
Constructor and Description
`IntArrayDeque()` Create with default sizing strategy and initial capacity for storing 5 elements.
`IntArrayDeque(int initialCapacity)` Create with default sizing strategy and the given initial capacity.
`IntArrayDeque(int initialCapacity, ArraySizingStrategy resizer)` Create with a custom buffer resizing strategy.
`IntArrayDeque(IntContainer container)` Creates a new deque from elements of another container, appending them at the end of this deque.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addFirst(int... elements)` Vararg-signature method for adding elements at the front of this deque.
`void`	`addFirst(int e1)` Inserts the specified element at the front of this deque.
`int`	`addFirst(IntContainer container)` Inserts all elements from the given container to the front of this deque.
`int`	`addFirst(java.lang.Iterable<? extends IntCursor> iterable)` Inserts all elements from the given iterable to the front of this deque.
`void`	`addLast(int... elements)` Vararg-signature method for adding elements at the end of this deque.
`void`	`addLast(int e1)` Inserts the specified element at the end of this deque.
`int`	`addLast(IntContainer container)` Inserts all elements from the given container to the end of this deque.
`int`	`addLast(java.lang.Iterable<? extends IntCursor> iterable)` Inserts all elements from the given iterable to the end of this deque.
`int`	`bufferIndexOf(int e1)` Return the index of the first (counting from head) element equal to `e1`.
`void`	`clear()` Removes all elements from this collection.
`IntArrayDeque`	`clone()` Clone this object.
`boolean`	`contains(int e)` Lookup a given element in the container.
`<T extends IntPredicate> T`	`descendingForEach(T predicate)` Applies a `predicate` to container elements as long, as the predicate returns `true`.
`<T extends IntProcedure> T`	`descendingForEach(T procedure)` Applies `procedure` to all elements of this deque, tail to head.
`java.util.Iterator<IntCursor>`	`descendingIterator()` 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 store `expectedAdditions`.
`boolean`	`equals(java.lang.Object obj)` Compares the specified object with this deque for equality.
`<T extends IntPredicate> T`	`forEach(T predicate)` Applies a `predicate` to container elements as long, as the predicate returns `true`.
`<T extends IntProcedure> T`	`forEach(T procedure)` Applies a `procedure` to all container elements.
`static IntArrayDeque`	`from(int... elements)` Create a new deque by pushing a variable number of arguments to the end of it.
`static IntArrayDeque`	`from(IntArrayDeque container)` Create a new deque by pushing a variable number of arguments to the end of it.
`int`	`getFirst()` Retrieves, but does not remove, the first element of this deque.
`int`	`getLast()` Retrieves, but does not remove, the last element of this deque.
`int`	`hashCode()`
`boolean`	`isEmpty()` Shortcut for `size() == 0`.
`java.util.Iterator<IntCursor>`	`iterator()` Returns a cursor over the values of this deque (in head to tail order).
`int`	`lastBufferIndexOf(int e1)` Return the index of the last (counting from tail) element equal to `e1`.
`static IntArrayDeque`	`newInstance()` Returns a new object of this class with no need to declare generic type (shortcut instead of using a constructor).
`static IntArrayDeque`	`newInstanceWithCapacity(int initialCapacity)` Returns a new object of this class with no need to declare generic type (shortcut instead of using a constructor).
`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 the smallest buffer possible.
`int`	`removeAll(IntLookupContainer c)` Default implementation uses a predicate for removal.
`int`	`removeAll(IntPredicate predicate)` Removes all elements in this collection for which the given predicate returns `true`.
`int`	`removeAllOccurrences(int e1)` Removes all occurrences of `e` from this collection.
`void`	`removeAtBufferIndex(int index)` Removes the element at `index` in the internal {#link `buffer`} array, returning its value.
`int`	`removeFirst()` Retrieves and removes the first element of this deque.
`int`	`removeFirstOccurrence(int e1)` Removes the first element that equals `e1`, returning its deleted position or `-1` if the element was not found.
`int`	`removeLast()` Retrieves and removes the last element of this deque.
`int`	`removeLastOccurrence(int e1)` Removes the last element that equals `e1`, returning its deleted position or `-1` if the element was not found.
`int`	`retainAll(IntLookupContainer c)` Default implementation uses a predicate for retaining.
`int`	`retainAll(IntPredicate predicate)` Default implementation redirects to `IntCollection.removeAll(IntPredicate)` and negates the predicate.
`int`	`size()` Return the current number of elements in this container.
`int[]`	`toArray()` Default implementation of copying to an array.
`int[]`	`toArray(int[] target)` Copies elements of this deque to an array.
`java.lang.String`	`toString()` Convert the contents of this container to a human-friendly string.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.carrotsearch.hppc.IntCollection
removeAll, retainAll, retainAll

- Field Detail
  - DEFAULT_CAPACITY
```
public static final int DEFAULT_CAPACITY
```
    Default capacity if no other capacity is given in the constructor.
    
    See Also:
    Constant Field Values
  - buffer
```
public int[] buffer
```
    Internal array for storing elements.
  - head
```
public int head
```
    The 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 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 Detail
  - IntArrayDeque
```
public IntArrayDeque()
```
    Create with default sizing strategy and initial capacity for storing 5 elements.
    
    See Also:
    BoundedProportionalArraySizingStrategy
  - IntArrayDeque
```
public IntArrayDeque(int initialCapacity)
```
    Create with default sizing strategy and the given initial capacity.
    
    See Also:
    BoundedProportionalArraySizingStrategy
  - IntArrayDeque
```
public IntArrayDeque(int initialCapacity,
             ArraySizingStrategy resizer)
```
    Create with a custom buffer resizing strategy.
  - IntArrayDeque
```
public IntArrayDeque(IntContainer container)
```
    Creates a new deque from elements of another container, appending them at the end of this deque.
- Method Detail
  - addFirst
```
public void addFirst(int e1)
```
    Inserts the specified element at the front of this deque.
    
    Specified by:
    
    addFirst in interface IntDeque
    
    Parameters:
    e1 - the element to add
  - addFirst
```
public void addFirst(int... 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)
  - addFirst
```
public int addFirst(IntContainer container)
```
    Inserts all elements from the given container to the front of this deque.
    
    Returns:
    Returns the number of elements actually added as a result of this call.
  - addFirst
```
public int addFirst(java.lang.Iterable<? extends IntCursor> iterable)
```
    Inserts all elements from the given iterable to the front of this deque.
    
    Returns:
    Returns the number of elements actually added as a result of this call.
  - addLast
```
public void addLast(int e1)
```
    Inserts the specified element at the end of this deque.
    
    Specified by:
    
    addLast in interface IntDeque
    
    Parameters:
    e1 - the element to add
  - addLast
```
public void addLast(int... 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)
  - addLast
```
public int addLast(IntContainer container)
```
    Inserts all elements from the given container to the end of this deque.
    
    Returns:
    Returns the number of elements actually added as a result of this call.
  - addLast
```
public int addLast(java.lang.Iterable<? extends IntCursor> iterable)
```
    Inserts all elements from the given iterable to the end of this deque.
    
    Returns:
    Returns the number of elements actually added as a result of this call.
  - removeFirst
```
public int removeFirst()
```
    Retrieves and removes the first element of this deque.
    
    Specified by:
    
    removeFirst in interface IntDeque
    
    Returns:
    the head element of this deque.
  - removeLast
```
public int removeLast()
```
    Retrieves and removes the last element of this deque.
    
    Specified by:
    
    removeLast in interface IntDeque
    
    Returns:
    the tail of this deque.
  - getFirst
```
public int getFirst()
```
    Retrieves, but does not remove, the first element of this deque.
    
    Specified by:
    
    getFirst in interface IntDeque
    
    Returns:
    the head of this deque.
  - getLast
```
public int getLast()
```
    Retrieves, but does not remove, the last element of this deque.
    
    Specified by:
    
    getLast in interface IntDeque
    
    Returns:
    the tail of this deque.
  - removeFirstOccurrence
```
public int removeFirstOccurrence(int e1)
```
    Removes the first element that equals e1, returning its deleted position or -1 if the element was not found.
    
    Specified by:
    
    removeFirstOccurrence in interface IntDeque
  - bufferIndexOf
```
public int bufferIndexOf(int 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.
  - removeLastOccurrence
```
public int removeLastOccurrence(int e1)
```
    Removes the last element that equals e1, returning its deleted position or -1 if the element was not found.
    
    Specified by:
    
    removeLastOccurrence in interface IntDeque
  - lastBufferIndexOf
```
public int lastBufferIndexOf(int 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.
  - removeAllOccurrences
```
public int removeAllOccurrences(int e1)
```
    Removes all occurrences of e from this collection.
    
    Specified by:
    
    removeAllOccurrences in interface IntCollection
    
    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 IntContainer
  - 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 IntContainer
  - 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 IntCollection
    
    See Also:
    release()
  - release
```
public void release()
```
    Release internal buffers of this deque and reallocate the smallest buffer possible.
  - 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 int[] toArray()
```
    Default implementation of copying to an array.
    
    Specified by:
    
    toArray in interface IntContainer
  - toArray
```
public int[] toArray(int[] 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 IntArrayDeque clone()
```
    Clone this object. The returned clone will reuse the same hash function and array resizing strategy.
    
    Overrides:
    
    clone in class java.lang.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.
  - iterator
```
public java.util.Iterator<IntCursor> 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 IntContainer
    
    Specified by:
    
    iterator in interface java.lang.Iterable<IntCursor>
  - descendingIterator
```
public java.util.Iterator<IntCursor> 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 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 IntDeque
    
    Returns:
    An iterator over elements in this deque in tail-to-head order.
  - forEach
```
public <T extends IntProcedure> T forEach(T procedure)
```
    Applies a procedure to all container elements. Returns the argument (any subclass of IntProcedure. 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 IntContainer
  - forEach
```
public <T extends IntPredicate> 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 IntContainer
  - descendingForEach
```
public <T extends IntProcedure> T descendingForEach(T procedure)
```
    Applies procedure to all elements of this deque, tail to head.
    
    Specified by:
    
    descendingForEach in interface IntDeque
  - descendingForEach
```
public <T extends IntPredicate> 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 IntDeque
  - removeAll
```
public int removeAll(IntPredicate predicate)
```
    Removes all elements in this collection for which the given predicate returns true.
    
    Specified by:
    
    removeAll in interface IntCollection
  - contains
```
public boolean contains(int 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 IntContainer
    
    Returns:
    Returns true if this container has an element equal to e.
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface IntDeque
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    A hash code of elements stored in the deque. The hash code is defined identically to List.hashCode() (should be implemented with the same algorithm), replacing forward index loop with a forward iterator loop.
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Compares the specified object with this deque for equality. Returns true if and only if the specified object is also a ObjectDeque, and all corresponding pairs of elements acquired from forward iterators are the same. In other words, two indexed containers are defined to be equal if they contain the same elements in the same order of iteration.
    Note that, unlike in List, deques may be of different types and still return true from IntDeque.equals(java.lang.Object). This may be dangerous if you use different hash functions in two containers, but don't override the default implementation of IntDeque.equals(java.lang.Object). It is the programmer's responsibility to enforcing these contracts properly.
    
    Specified by:
    
    equals in interface IntDeque
    
    Overrides:
    
    equals in class java.lang.Object
  - newInstance
```
public static IntArrayDeque newInstance()
```
    Returns a new object of this class with no need to declare generic type (shortcut instead of using a constructor).
  - newInstanceWithCapacity
```
public static IntArrayDeque newInstanceWithCapacity(int initialCapacity)
```
    Returns a new object of this class with no need to declare generic type (shortcut instead of using a constructor).
  - from
```
public static IntArrayDeque from(int... elements)
```
    Create a new deque by pushing a variable number of arguments to the end of it.
  - from
```
public static IntArrayDeque from(IntArrayDeque container)
```
    Create a new deque by pushing a variable number of arguments to the end of it.
  - removeAll
```
public int removeAll(IntLookupContainer c)
```
    Default implementation uses a predicate for removal.
    
    Specified by:
    
    removeAll in interface IntCollection
    
    Returns:
    Returns the number of removed elements.
  - retainAll
```
public int retainAll(IntLookupContainer c)
```
    Default implementation uses a predicate for retaining.
    
    Specified by:
    
    retainAll in interface IntCollection
    
    Returns:
    Returns the number of removed elements.
  - retainAll
```
public int retainAll(IntPredicate predicate)
```
    Default implementation redirects to IntCollection.removeAll(IntPredicate) and negates the predicate.
    
    Specified by:
    
    retainAll in interface IntCollection
  - toString
```
public java.lang.String toString()
```
    Convert the contents of this container to a human-friendly string.
    
    Overrides:
    
    toString in class java.lang.Object

Class IntArrayDeque

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.carrotsearch.hppc.IntCollection

Field Detail

DEFAULT_CAPACITY

buffer

head

tail

resizer

Constructor Detail

IntArrayDeque

IntArrayDeque

IntArrayDeque

IntArrayDeque

Method Detail

addFirst

addFirst

addFirst

addFirst

addLast

addLast

addLast

addLast

removeFirst

removeLast

getFirst

getLast

removeFirstOccurrence

bufferIndexOf

removeLastOccurrence

lastBufferIndexOf

removeAllOccurrences

removeAtBufferIndex

isEmpty

size

clear

release

ensureBufferSpace

toArray

toArray

clone

oneLeft

oneRight

iterator

descendingIterator

forEach

forEach

descendingForEach

descendingForEach

removeAll

contains

hashCode

equals

newInstance

newInstanceWithCapacity

from

from

removeAll

retainAll

retainAll

toString