com.carrotsearch.hppcrt.lists

Class ObjectArrayDeque<KType>

java.lang.Object

com.carrotsearch.hppcrt.AbstractObjectCollection<KType>

com.carrotsearch.hppcrt.lists.ObjectArrayDeque<KType>

All Implemented Interfaces:

ObjectCollection<KType>, ObjectContainer<KType>, ObjectDeque<KType>, ObjectIndexedContainer<KType>, java.lang.Cloneable, java.lang.Iterable<ObjectCursor<KType>>, java.util.RandomAccess

@Generated(date="2017-07-11T19:16:24+0200",
           value="KTypeArrayDeque.java")
public class ObjectArrayDeque<KType>
extends AbstractObjectCollection<KType>
implements ObjectDeque<KType>, ObjectIndexedContainer<KType>, java.lang.Cloneable

An array-backed deque (double-ended queue) of Objects. 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. This dequeue is also a ObjectIndexedContainer, where index 0 is the head of the queue, and size() - 1 index is the last element. A brief comparison of the API against the Java Collections framework:

Java Collections ArrayDeque and HPPC ObjectArrayDeque, related methods.

java.util.ArrayDeque	ObjectArrayDeque
addFirst	addFirst
addLast	addLast
removeFirst	removeLast
getFirst	getFirst
getLast	getLast
removeFirstOccurrence, removeLastOccurrence	removeFirstOccurrence, removeLastOccurrence
size	size
Object[] toArray()	Object[] toArray()
iterator	cursor over values
other methods inherited from Stack, Queue	not implemented

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ObjectArrayDeque.DescendingValueIterator An iterator implementation for descendingIterator().
class	ObjectArrayDeque.ValueIterator An iterator implementation for iterator().

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.Object[]	buffer Internal array for storing elements.
protected IteratorPool<ObjectCursor<KType>,ObjectArrayDeque.DescendingValueIterator>	descendingValueIteratorPool internal pool of DescendingValueIterator (must be created in 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.
protected IteratorPool<ObjectCursor<KType>,ObjectArrayDeque.ValueIterator>	valueIteratorPool internal pool of ValueIterator (must be created in constructor)

Fields inherited from class com.carrotsearch.hppcrt.AbstractObjectCollection

containsNegateTestPredicate, containsTestPredicate, negatePredicate, testContainer, testPredicate

Constructor Summary

Constructors

Constructor and Description
ObjectArrayDeque() Default constructor.
ObjectArrayDeque(int initialCapacity) Create with default sizing strategy and the given initial capacity.
ObjectArrayDeque(int initialCapacity, ArraySizingStrategy resizer) Create with a custom buffer resizing strategy.
ObjectArrayDeque(ObjectContainer<? extends KType> container) Creates a new deque from elements of another container, appending them at the end of this deque.

Method Summary

Modifier and Type	Method and Description
void	add(KType e1) Adds an element to the end of this container (the last index is incremented by one).
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 element equal to e1.
int	capacity() Return the maximum number of elements this container is guaranteed to hold without reallocating.
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.
ObjectArrayDeque.DescendingValueIterator	descendingIterator() Returns an iterator 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)
<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.
<T extends ObjectPredicate<? super KType>> T	forEach(T predicate, int fromIndex, int toIndex) Applies predicate to a slice of the container, fromIndex, inclusive, to toIndex, exclusive, or until predicate returns false.
<T extends ObjectProcedure<? super KType>> T	forEach(T procedure, int fromIndex, int toIndex) Applies procedure to a slice of the container, fromIndex, inclusive, to toIndex, exclusive.
static <KType> ObjectArrayDeque<KType>	from(KType... elements) Create a new deque by pushing a variable number of arguments to the end of it.
static <KType> ObjectArrayDeque<KType>	from(ObjectContainer<KType> container) Create a new deque by pushing a variable number of arguments to the end of it.
KType	get(int index) The position is relative to the head, i.e w.r.t the ObjectIndexedContainer, index 0 is the head of the queue, size() - 1 is the last element position.
KType	getFirst() Retrieves, but does not remove, the first element of this deque.
KType	getLast() Retrieves, but does not remove, the last element of this deque.
int	hashCode()
int	indexOf(KType e1) Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element.
void	insert(int index, KType e1) This operation is not supported on array deques, throwing UnsupportedOperationException.
ObjectArrayDeque.ValueIterator	iterator() Returns an iterator over the values of this deque (in head to tail order).
int	lastBufferIndexOf(KType e1) Return the index of the last element equal to e1.
int	lastIndexOf(KType e1) Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element.
static <KType> ObjectArrayDeque<KType>	newInstance() Returns a new object of this class with no need to declare generic type (shortcut instead of using a constructor).
static <KType> ObjectArrayDeque<KType>	newInstance(int initialCapacity) Returns a new object of this class with no need to declare generic type (shortcut instead of using a constructor).
void	release() Release internal buffers of this deque and reallocate the smallest buffer possible.
KType	remove(int index) Removes the element at the specified position in this list and returns it.
int	removeAll(KType e1) Removes all occurrences of e from this collection.
int	removeAll(ObjectPredicate<? super KType> predicate) Removes all elements in this collection for which the given predicate returns true.
KType	removeFirst() Retrieves and removes the first element of this deque.
int	removeFirst(KType e1) Removes the first element that equals e1, returning its deleted position or -1 if the element was not found.
KType	removeLast() Retrieves and removes the last element of this deque.
int	removeLast(KType e1) Removes the last element that equals e1, returning its deleted position or -1 if the element was not found.
void	removeRange(int fromIndex, int toIndex) Removes from this list all of the elements whose index is between fromIndex, inclusive, and toIndex, exclusive.
KType	set(int index, KType e1) Replaces the element at the specified position in this list with the specified element.
int	size() Return the current number of elements in this container.
void	sort() In-place sort the whole dequeue by natural ordering (smaller first) This sort is NOT stable.
void	sort(java.util.Comparator<? super KType> comp) In-place sort the whole dequeue using a Comparator * This sort is NOT stable.
void	sort(int beginIndex, int endIndex) In-place sort the dequeue from [beginIndex, endIndex[ by natural ordering (smaller first)
void	sort(int beginIndex, int endIndex, java.util.Comparator<? super KType> comp) In-place sort the dequeue from [beginIndex, endIndex[ using a Comparator * This sort is NOT stable.
KType[]	toArray(KType[] target) Copies elements of this deque to an array.

Methods inherited from class com.carrotsearch.hppcrt.AbstractObjectCollection

isEmpty, removeAll, retainAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.carrotsearch.hppcrt.ObjectCollection

removeAll, retainAll, retainAll

Methods inherited from interface com.carrotsearch.hppcrt.ObjectContainer

isEmpty, toArray, toArray

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

buffer

public java.lang.Object[] buffer

Internal array for storing elements.

Direct deque iteration from head to tail: iterate buffer[i % buffer.length] for i in [this.head; this.head + size()[

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. (this is a valid index in buffer !)

resizer

protected final ArraySizingStrategy resizer

Buffer resizing strategy.

descendingValueIteratorPool

protected final IteratorPool<ObjectCursor<KType>,ObjectArrayDeque.DescendingValueIterator> descendingValueIteratorPool

internal pool of DescendingValueIterator (must be created in constructor)

valueIteratorPool

protected final IteratorPool<ObjectCursor<KType>,ObjectArrayDeque.ValueIterator> valueIteratorPool

internal pool of ValueIterator (must be created in constructor)

Constructor Detail

ObjectArrayDeque

public ObjectArrayDeque()

Default constructor.

ObjectArrayDeque

public ObjectArrayDeque(int initialCapacity)

Create with default sizing strategy and the given initial capacity.

See Also:

BoundedProportionalArraySizingStrategy

ObjectArrayDeque

public ObjectArrayDeque(int initialCapacity,
                        ArraySizingStrategy resizer)

Create with a custom buffer resizing strategy.

ObjectArrayDeque

public ObjectArrayDeque(ObjectContainer<? extends KType> container)

Creates a new deque from elements of another container, appending them at the end of this deque.

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>

Parameters:

e1 - the element to add

addFirst

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

addFirst

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

Inserts the specified element at the end of this deque.

Specified by:

addLast in interface ObjectDeque<KType>

Parameters:

e1 - the element to add

addLast

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

addLast

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

Retrieves and removes the first element of this deque. Precondition : the deque is not empty !

Specified by:

removeFirst in interface ObjectDeque<KType>

Returns:

the head element of this deque.

removeLast

public KType removeLast()

Retrieves and removes the last element of this deque. Precondition : the deque is not empty !

Specified by:

removeLast in interface ObjectDeque<KType>

Returns:

the tail of this deque.

getFirst

public KType getFirst()

Retrieves, but does not remove, the first element of this deque. Precondition : the deque is not empty !

Specified by:

getFirst in interface ObjectDeque<KType>

Returns:

the head of this deque.

getLast

public KType getLast()

Retrieves, but does not remove, the last element of this deque. Precondition : the deque is not empty !

Specified by:

getLast in interface ObjectDeque<KType>

Returns:

the tail of this deque.

removeFirst

public int removeFirst(KType e1)

Removes the first element that equals e1, returning its deleted position or -1 if the element was not found. The returned position is relative to the head, i.e w.r.t the ObjectIndexedContainer, index 0 is the head of the queue, size() - 1 is the last element position.

Specified by:

removeFirst in interface ObjectDeque<KType>

Specified by:

removeFirst in interface ObjectIndexedContainer<KType>

bufferIndexOf

public int bufferIndexOf(KType e1)

Return the index of the first element equal to e1. The index points to the buffer array.

Parameters:

e1 - The element to look for.

Returns:

Returns the index in buffer of the first element equal to e1 or -1 if not found.

removeLast

public int removeLast(KType e1)

Removes the last element that equals e1, returning its deleted position or -1 if the element was not found. The returned position is relative to the head, i.e w.r.t the ObjectIndexedContainer, index 0 is the head of the queue, size() - 1 is the last element position.

Specified by:

removeLast in interface ObjectDeque<KType>

Specified by:

removeLast in interface ObjectIndexedContainer<KType>

lastBufferIndexOf

public int lastBufferIndexOf(KType e1)

Return the index of the last element equal to e1. The index points to the buffer array.

Parameters:

e1 - The element to look for.

Returns:

Returns the index in buffer of the first element equal to e1 or -1 if not found.

indexOf

public int indexOf(KType e1)

Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element. The returned position is relative to the head, i.e w.r.t the ObjectIndexedContainer, index 0 is the head of the queue, size() - 1 is the last element position.

Specified by:

indexOf in interface ObjectIndexedContainer<KType>

lastIndexOf

public int lastIndexOf(KType e1)

Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element. The returned position is relative to the head, i.e w.r.t the ObjectIndexedContainer, index 0 is the head of the queue, size() - 1 is the last element position.

Specified by:

lastIndexOf in interface ObjectIndexedContainer<KType>

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.

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>

capacity

public int capacity()

Return the maximum number of elements this container is guaranteed to hold without reallocating. The time for calculating the container's capacity may take O(n) time.

Specified by:

capacity 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>

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

Specified by:

toArray in interface ObjectContainer<KType>

Overrides:

toArray in class AbstractObjectCollection<KType>

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 array resizing strategy.

Overrides:

clone in class java.lang.Object

iterator

public ObjectArrayDeque.ValueIterator iterator()

Returns an iterator 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 ObjectArrayDeque.DescendingValueIterator descendingIterator()

Returns an iterator 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 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 ObjectProcedure<? super KType>> T forEach(T procedure,
                                                            int fromIndex,
                                                            int toIndex)

Applies procedure to a slice of the container, fromIndex, inclusive, to toIndex, exclusive.

Specified by:

forEach in interface ObjectIndexedContainer<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>

forEach

public <T extends ObjectPredicate<? super KType>> T forEach(T predicate,
                                                            int fromIndex,
                                                            int toIndex)

Applies predicate to a slice of the container, fromIndex, inclusive, to toIndex, exclusive, or until predicate returns false.

Specified by:

forEach in interface ObjectIndexedContainer<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)

Overrides:

equals in class java.lang.Object

newInstance

public static <KType> ObjectArrayDeque<KType> newInstance()

Returns a new object of this class with no need to declare generic type (shortcut instead of using a constructor).

newInstance

public static <KType> ObjectArrayDeque<KType> newInstance(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 <KType> ObjectArrayDeque<KType> from(KType... elements)

Create a new deque by pushing a variable number of arguments to the end of it.

from

public static <KType> ObjectArrayDeque<KType> from(ObjectContainer<KType> container)

Create a new deque by pushing a variable number of arguments to the end of it.

sort

public void sort(int beginIndex,
                 int endIndex)

In-place sort the dequeue from [beginIndex, endIndex[ by natural ordering (smaller first)

Parameters:

beginIndex - the start index to be sorted

endIndex - the end index to be sorted (excluded)

This sort is NOT stable.

Throws:

java.lang.ClassCastException - if the deque contains elements that are not mutually Comparable.

sort

public void sort(int beginIndex,
                 int endIndex,
                 java.util.Comparator<? super KType> comp)

In-place sort the dequeue from [beginIndex, endIndex[ using a Comparator *

This sort is NOT stable.

Parameters:

beginIndex - the start index to be sorted

endIndex - the end index to be sorted (excluded)

sort

public void sort()

In-place sort the whole dequeue by natural ordering (smaller first)

This sort is NOT stable.

Throws:

java.lang.ClassCastException - if the deque contains elements that are not mutually Comparable.

sort

public void sort(java.util.Comparator<? super KType> comp)

In-place sort the whole dequeue using a Comparator *

This sort is NOT stable.

add

public void add(KType e1)

Adds an element to the end of this container (the last index is incremented by one).

Specified by:

add in interface ObjectIndexedContainer<KType>

insert

public void insert(int index,
                   KType e1)

This operation is not supported on array deques, throwing UnsupportedOperationException.

Specified by:

insert in interface ObjectIndexedContainer<KType>

Parameters:

index - The index at which the element should be inserted, shifting any existing and subsequent elements to the right. Precondition : index must be valid !

Throws:

java.lang.UnsupportedOperationException

set

public KType set(int index,
                 KType e1)

Replaces the element at the specified position in this list with the specified element. Precondition : index must be valid ! The position is relative to the head, i.e w.r.t the ObjectIndexedContainer, index 0 is the head of the queue, size() - 1 is the last element position.

Specified by:

set in interface ObjectIndexedContainer<KType>

Returns:

Returns the previous value in the list.

get

public KType get(int index)

The position is relative to the head, i.e w.r.t the ObjectIndexedContainer, index 0 is the head of the queue, size() - 1 is the last element position.

Specified by:

get in interface ObjectIndexedContainer<KType>

Returns:

Returns the element at index index from the list. Precondition : index must be valid !

remove

public KType remove(int index)

Removes the element at the specified position in this list and returns it. Precondition : index must be valid !

Careful. Do not confuse this method with the overridden signature in Java Collections (List.remove(Object)). Use: ObjectCollection.removeAll(KType), ObjectIndexedContainer.removeFirst(KType) or ObjectIndexedContainer.removeLast(KType) depending on the actual need.

The position is relative to the head, i.e w.r.t the ObjectIndexedContainer, index 0 is the head of the queue, size() - 1 is the last element position.

Specified by:

remove in interface ObjectIndexedContainer<KType>

removeRange

public void removeRange(int fromIndex,
                        int toIndex)

Removes from this list all of the elements whose index is between fromIndex, inclusive, and toIndex, exclusive. The position is relative to the head, i.e w.r.t the ObjectIndexedContainer, index 0 is the head of the queue, size() - 1 is the last element position.

Specified by:

removeRange in interface ObjectIndexedContainer<KType>