ObjectArrayDeque

Documentation of 'com.carrotsearch.hppc.ObjectArrayDeque' Java class ObjectArrayDeque

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- com.carrotsearch.hppc.ObjectArrayDeque<KType>

All Implemented Interfaces:: ObjectCollection<KType>, ObjectContainer<KType>, ObjectDeque<KType>, Preallocable, java.lang.Cloneable, java.lang.Iterable<ObjectCursor<KType>>

@Generated(date="2015-05-07T09:33:04+0200",
           value="KTypeArrayDeque.java")
public class ObjectArrayDeque<KType>
extends java.lang.Object
implements ObjectDeque<KType>, Preallocable, java.lang.Cloneable

An array-backed ObjectDeque.

Field Summary

Fields
Modifier and Type	Field and Description
`java.lang.Object[]`	`buffer` Internal array for storing elements of the deque.
`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.
`int`	`tail` The index at which the next element would be added to the tail of the deque.

Constructor Summary

Constructors
Constructor and Description
`ObjectArrayDeque()` New 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

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`addFirst(java.lang.Iterable<? extends ObjectCursor<? extends KType>> iterable)` Inserts all elements from the given iterable to the front of this deque.
`void`	`addFirst(KType... elements)` Vararg-signature method for adding elements at the front of this deque.
`void`	`addFirst(KType e1)` Inserts the specified element at the front of this deque.
`int`	`addFirst(ObjectContainer<? extends KType> container)` Inserts all elements from the given container to the front of this deque.
`int`	`addLast(java.lang.Iterable<? extends ObjectCursor<? extends KType>> iterable)` Inserts all elements from the given iterable to the end of this deque.
`void`	`addLast(KType... elements)` Vararg-signature method for adding elements at the end of this deque.
`void`	`addLast(KType e1)` Inserts the specified element at the end of this deque.
`int`	`addLast(ObjectContainer<? extends KType> container)` Inserts all elements from the given container to the end of this deque.
`int`	`bufferIndexOf(KType e1)` Return the index of the first (counting from head) element equal to `e1`.
`void`	`clear()` Removes all elements from this collection.
`ObjectArrayDeque<KType>`	`clone()` Clone this object.
`boolean`	`contains(KType e)` Lookup a given element in the container.
`<T extends ObjectPredicate<? super KType>> T`	`descendingForEach(T predicate)` Applies a `predicate` to container elements as long, as the predicate returns `true`.
`<T extends ObjectProcedure<? super KType>> T`	`descendingForEach(T procedure)` Applies `procedure` to all elements of this deque, tail to head.
`java.util.Iterator<ObjectCursor<KType>>`	`descendingIterator()` Returns a cursor over the values of this deque (in tail to head order).
`void`	`ensureCapacity(int expectedElements)` Ensure this container can hold at least the given number of elements without resizing its buffers.
`boolean`	`equals(java.lang.Object obj)` Returns `true` only if the other object is an instance of the same class and with the same elements.
`<T extends ObjectPredicate<? super KType>> T`	`forEach(T predicate)` Applies a `predicate` to container elements as long, as the predicate returns `true`.
`<T extends ObjectProcedure<? super KType>> T`	`forEach(T procedure)` Applies a `procedure` 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.
`KType`	`getFirst()` Retrieves the first element of this deque but does not remove it.
`KType`	`getLast()` Retrieves the last element of this deque but does not remove it.
`int`	`hashCode()`
`boolean`	`isEmpty()` Shortcut for `size() == 0`.
`java.util.Iterator<ObjectCursor<KType>>`	`iterator()` Returns a cursor over the values of this deque (in head to tail order).
`int`	`lastBufferIndexOf(KType e1)` Return the index of the last (counting from tail) element equal to `e1`.
`void`	`release()` Release internal buffers of this deque and reallocate with the default buffer.
`int`	`removeAll(KType e1)` Removes all occurrences of `e` from this collection.
`int`	`removeAll(ObjectLookupContainer<? super KType> c)` Default implementation uses a predicate for removal.
`int`	`removeAll(ObjectPredicate<? super KType> predicate)` Removes all elements in this collection for which the given predicate returns `true`.
`void`	`removeAtBufferIndex(int index)` Removes the element at `index` in the internal {#link `buffer` array, returning its value.
`KType`	`removeFirst()` Retrieves and removes the first element of this deque.
`int`	`removeFirst(KType e1)` Removes the first element that equals `e`.
`KType`	`removeLast()` Retrieves and removes the last element of this deque.
`int`	`removeLast(KType e1)` Removes the last element that equals `e`.
`int`	`retainAll(ObjectLookupContainer<? super KType> c)` Default implementation uses a predicate for retaining.
`int`	`retainAll(ObjectPredicate<? super KType> predicate)` Default implementation redirects to `ObjectCollection.removeAll(ObjectPredicate)` and negates the predicate.
`int`	`size()` Return the current number of elements in this container.
`java.lang.Object[]`	`toArray()` Default implementation of copying to an array.
`<T> T[]`	`toArray(java.lang.Class<T> componentClass)` Copies all elements of this container to a dynamically created array of the given component type.
`KType[]`	`toArray(KType[] 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
getClass, notify, notifyAll, wait, wait, wait

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

Methods inherited from interface com.carrotsearch.hppc.ObjectContainer
toArray

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Field Detail
  - buffer
```
public java.lang.Object[] buffer
```
    Internal array for storing elements of the deque.
  - 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.
- Constructor Detail
  - 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 Detail
  - 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(java.lang.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(java.lang.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()
  - 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:
    
    ObjectCollection.clear()
  - 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.
  - toArray
```
public java.lang.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 java.lang.Object
  - iterator
```
public java.util.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 ObjectContainer<KType>
    
    Specified by:
    
    iterator in interface java.lang.Iterable<ObjectCursor<KType>>
  - descendingIterator
```
public java.util.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 java.lang.Object
  - equals
```
public boolean equals(java.lang.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 java.lang.Object
  - 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(java.lang.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 java.lang.String toString()
```
    Convert the contents of this container to a human-friendly string.
    
    Overrides:
    
    toString in class java.lang.Object

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Class ObjectArrayDeque<KType>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.carrotsearch.hppc.ObjectCollection

Methods inherited from interface com.carrotsearch.hppc.ObjectContainer

Methods inherited from interface java.lang.Iterable

Field Detail

buffer

head

tail

Constructor Detail

ObjectArrayDeque

ObjectArrayDeque

ObjectArrayDeque

ObjectArrayDeque

Method Detail

addFirst

addFirst

addFirst

addFirst

addLast

addLast

addLast

addLast

removeFirst

removeLast

getFirst

getLast

removeFirst

bufferIndexOf

removeLast

lastBufferIndexOf

removeAll

removeAtBufferIndex

isEmpty

size

clear

release

ensureCapacity

toArray

toArray

clone

iterator

descendingIterator

forEach

forEach

descendingForEach

descendingForEach

removeAll

contains

hashCode

equals

from

removeAll

retainAll

retainAll

toArray

toString