@Generated(date="2015-06-17T12:23:39+0000", value="HPPC generated from: ObjectArrayDeque.java") public class ObjectArrayDeque<KType> extends java.lang.Object implements ObjectDeque<KType>, java.lang.Cloneable
ArraySizingStrategy
and may be expensive if they move around really large chunks of memory.
A brief comparison of the API against the Java Collections framework:
java.util.ArrayDeque | ObjectArrayDeque |
---|---|
addFirst | addFirst |
addLast | addLast |
removeFirst | removeLast |
getFirst | getFirst |
getLast | getLast |
removeFirstOccurrence, removeLastOccurrence | removeFirstOccurrence, removeLastOccurrence |
size | size |
Object[] toArray() | KType[] toArray() |
iterator | cursor over values |
other methods inherited from Stack, Queue | not implemented |
Modifier and Type | Field and Description |
---|---|
KType[] |
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 and Description |
---|
ObjectArrayDeque()
Create with default sizing strategy and initial capacity for storing
5 elements.
|
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.
|
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>> |
descendingForEach(T predicate)
Applies a
predicate to container elements as long, as the predicate
returns true . |
<T extends ObjectProcedure<? super KType>> |
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).
|
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 ObjectPredicate<? super KType>> |
forEach(T predicate)
Applies a
predicate to container elements as long, as the predicate
returns true . |
<T extends ObjectProcedure<? super KType>> |
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.
|
static <KType> ObjectArrayDeque<KType> |
from(ObjectArrayDeque<KType> container)
Create a new deque by pushing a variable number of arguments to the end of it.
|
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() |
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 . |
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> |
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(ObjectLookupContainer<? extends 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 . |
int |
removeAllOccurrences(KType 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. |
KType |
removeFirst()
Retrieves and removes the first element of this deque.
|
int |
removeFirstOccurrence(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 |
removeLastOccurrence(KType e1)
Removes the last element that equals
e1 , returning its
deleted position or -1 if the element was not found. |
int |
retainAll(ObjectLookupContainer<? extends 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()
Copies all elements from this container to an Object array.
|
KType[] |
toArray(java.lang.Class<? super KType> clazz)
Default implementation of copying to an array.
|
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.
|
finalize, getClass, notify, notifyAll, wait, wait, wait
removeAll, retainAll, retainAll
toArray
public static final int DEFAULT_CAPACITY
public KType[] buffer
Important!
The actual value in this field is always an instance of Object[]
.
Be warned that javac
emits additional casts when buffer
is directly accessed; these casts
may result in exceptions at runtime. A workaround is to cast directly to
Object[]
before accessing the buffer's elements (although it is highly
recommended to use a iterator()
instead.
public int head
public int tail
protected final ArraySizingStrategy resizer
public ObjectArrayDeque()
BoundedProportionalArraySizingStrategy
public ObjectArrayDeque(int initialCapacity)
BoundedProportionalArraySizingStrategy
public ObjectArrayDeque(int initialCapacity, ArraySizingStrategy resizer)
public ObjectArrayDeque(ObjectContainer<? extends KType> container)
public void addFirst(KType e1)
addFirst
in interface ObjectDeque<KType>
e1
- the element to addpublic void addFirst(KType... elements)
This method is handy, but costly if used in tight loops (anonymous array passing)
public int addFirst(ObjectContainer<? extends KType> container)
public int addFirst(java.lang.Iterable<? extends ObjectCursor<? extends KType>> iterable)
public void addLast(KType e1)
addLast
in interface ObjectDeque<KType>
e1
- the element to addpublic void addLast(KType... elements)
This method is handy, but costly if used in tight loops (anonymous array passing)
public int addLast(ObjectContainer<? extends KType> container)
public int addLast(java.lang.Iterable<? extends ObjectCursor<? extends KType>> iterable)
public KType removeFirst()
removeFirst
in interface ObjectDeque<KType>
public KType removeLast()
removeLast
in interface ObjectDeque<KType>
public KType getFirst()
getFirst
in interface ObjectDeque<KType>
public KType getLast()
getLast
in interface ObjectDeque<KType>
public int removeFirstOccurrence(KType e1)
e1
, returning its
deleted position or -1
if the element was not found.removeFirstOccurrence
in interface ObjectDeque<KType>
public int bufferIndexOf(KType e1)
e1
. The index points to the buffer
array.e1
- The element to look for.e1
or -1
if not found.public int removeLastOccurrence(KType e1)
e1
, returning its
deleted position or -1
if the element was not found.removeLastOccurrence
in interface ObjectDeque<KType>
public int lastBufferIndexOf(KType e1)
e1
. The index points to the buffer
array.e1
- The element to look for.e1
or -1
if not found.public int removeAllOccurrences(KType e1)
e
from this collection.removeAllOccurrences
in interface ObjectCollection<KType>
e1
- Element to be removed from this collection, if present.public void removeAtBufferIndex(int index)
index
in the internal
{#link buffer
} array, returning its value.public boolean isEmpty()
size() == 0
.isEmpty
in interface ObjectContainer<KType>
public int size()
O(n)
time, although implementing classes
should try to maintain the current size and return in constant time.size
in interface ObjectContainer<KType>
public void clear()
The internal array buffers are not released as a result of this call.
clear
in interface ObjectCollection<KType>
release()
public void release()
protected void ensureBufferSpace(int expectedAdditions)
expectedAdditions
. Increases internal buffer size if needed.public java.lang.Object[] toArray()
ObjectContainer.toArray(Class)
.toArray
in interface ObjectContainer<KType>
ObjectContainer.toArray(Class)
public KType[] toArray(KType[] target)
target
array is filled from index 0 (head of the queue) to index size() - 1
(tail of the queue).target
- The target array must be large enough to hold all elements.public ObjectArrayDeque<KType> clone()
clone
in class java.lang.Object
protected static int oneLeft(int index, int modulus)
protected static int oneRight(int index, int modulus)
public java.util.Iterator<ObjectCursor<KType>> iterator()
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); }
iterator
in interface ObjectContainer<KType>
iterator
in interface java.lang.Iterable<ObjectCursor<KType>>
public java.util.Iterator<ObjectCursor<KType>> descendingIterator()
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 (Iteratori = intDeque.descendingIterator(); i.hasNext(); ) { final IntCursor c = i.next(); System.out.println("buffer index=" + c.index + " value=" + c.value); }
descendingIterator
in interface ObjectDeque<KType>
public <T extends ObjectProcedure<? super KType>> T forEach(T procedure)
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;
forEach
in interface ObjectContainer<KType>
public <T extends ObjectPredicate<? super KType>> T forEach(T predicate)
predicate
to container elements as long, as the predicate
returns true
. The iteration is interrupted otherwise.forEach
in interface ObjectContainer<KType>
public <T extends ObjectProcedure<? super KType>> T descendingForEach(T procedure)
procedure
to all elements of this deque, tail to head.descendingForEach
in interface ObjectDeque<KType>
public <T extends ObjectPredicate<? super KType>> T descendingForEach(T predicate)
predicate
to container elements as long, as the predicate
returns true
. The iteration is interrupted otherwise.descendingForEach
in interface ObjectDeque<KType>
public int removeAll(ObjectPredicate<? super KType> predicate)
true
.removeAll
in interface ObjectCollection<KType>
public boolean contains(KType e)
contains
in interface ObjectContainer<KType>
true
if this container has an element
equal to e
.public int hashCode()
hashCode
in interface ObjectDeque<KType>
hashCode
in class java.lang.Object
List.hashCode()
(should be implemented
with the same algorithm), replacing forward index loop with a forward iterator
loop.public boolean equals(java.lang.Object obj)
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 ObjectDeque.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 ObjectDeque.equals(java.lang.Object)
. It is the programmer's responsibility to
enforcing these contracts properly.
equals
in interface ObjectDeque<KType>
equals
in class java.lang.Object
public static <KType> ObjectArrayDeque<KType> newInstance()
public static <KType> ObjectArrayDeque<KType> newInstanceWithCapacity(int initialCapacity)
public static <KType> ObjectArrayDeque<KType> from(KType... elements)
public static <KType> ObjectArrayDeque<KType> from(ObjectArrayDeque<KType> container)
public int removeAll(ObjectLookupContainer<? extends KType> c)
removeAll
in interface ObjectCollection<KType>
public int retainAll(ObjectLookupContainer<? extends KType> c)
retainAll
in interface ObjectCollection<KType>
public int retainAll(ObjectPredicate<? super KType> predicate)
ObjectCollection.removeAll(ObjectPredicate)
and negates the predicate.retainAll
in interface ObjectCollection<KType>
public KType[] toArray(java.lang.Class<? super KType> clazz)
toArray
in interface ObjectContainer<KType>
public java.lang.String toString()
toString
in class java.lang.Object
Copyright © 2015 Carrot Search s.c.. All rights reserved.