@Generated(date="2017-07-11T19:16:26+0200",
value="KTypeLinkedList.java")
public class ShortLinkedList
extends AbstractShortCollection
implements ShortIndexedContainer, ShortDeque, java.lang.Cloneable
ShortDeque and ShortIndexedContainer,
with the ability to push or remove values from either head or tail, in constant time.
The drawback is the double-linked list ones, i.e insert(index), remove(index) are O(N)
since they must traverse the collection to reach the index.
In addition, elements could by pushed or removed from the middle of the list without moving
big amounts of memory, contrary to ShortArrayLists. Like ShortDeques, the double-linked list
can also be iterated in reverse.
Plus, the Iterator or reversed-iterator supports powerful methods to modify/delete/set the neighbors,
in replacement of the error-prone java.util.Iterator ones.
A compact representation is used to store and manipulate
all elements, without creating Objects for links. Reallocations are governed by a ArraySizingStrategy
and may be expensive if they move around really large chunks of memory.
Important note: NEVER USE java.util.Iterator methods ! They are here only for enhanced-loop syntax, and using them directly will only lead to unpredictable results. Use the specialized methods ofShortLinkedList.ValueIteratororShortLinkedList.DescendingValueIteratorinstead.
| Modifier and Type | Class and Description |
|---|---|
class |
ShortLinkedList.DescendingValueIterator
A specialized iterator implementation for
descendingIterator()s. |
class |
ShortLinkedList.ValueIterator
A specialized iterator implementation for
iterator()s. |
| Modifier and Type | Field and Description |
|---|---|
protected long[] |
beforeAfterPointers
Represent the before / after nodes for each element of the buffer,
such as buffer[i] nodes are beforeAfterPointers[i] where
the 32 highest bits represent the unsigned before index in buffer : (beforeAfterPointers[i] & 0xFFFFFFFF00000000) >> 32
the 32 lowest bits represent the unsigned after index in buffer : (beforeAfterPointers[i] & 0x00000000FFFFFFFF)
|
short[] |
buffer
Internal array for storing the list.
|
protected IteratorPool<ShortCursor,ShortLinkedList.DescendingValueIterator> |
descendingValueIteratorPool
internal pool of DescendingValueIterator (must be created in constructor)
|
protected int |
elementsCount
Current number of elements stored in
buffer. |
protected static int |
HEAD_POSITION
Respective positions of head and tail elements of the list,
as a position in buffer, such as
after head is the actual first element of the list,
before tail is the actual last element of the list.
|
protected ArraySizingStrategy |
resizer
Buffer resizing strategy.
|
protected static int |
TAIL_POSITION |
protected IteratorPool<ShortCursor,ShortLinkedList.ValueIterator> |
valueIteratorPool
internal pool of ValueIterator (must be created in constructor)
|
containsNegateTestPredicate, containsTestPredicate, negatePredicate, testContainer, testPredicate| Constructor and Description |
|---|
ShortLinkedList()
Default constructor: Create with default sizing strategy and initial capacity for storing
Containers.DEFAULT_EXPECTED_ELEMENTS elements. |
ShortLinkedList(int initialCapacity)
Create with default sizing strategy and the given initial capacity.
|
ShortLinkedList(int initialCapacity,
ArraySizingStrategy resizer)
Create with a custom buffer resizing strategy.
|
ShortLinkedList(ShortContainer container)
Creates a new list from elements of another container.
|
| Modifier and Type | Method and Description |
|---|---|
void |
add(short... elements)
Vararg-signature method for adding elements at the end of the list.
|
void |
add(short e1)
Adds an element to the end of this container (the last index is incremented by one).
|
void |
add(short[] elements,
int start,
int length)
Add all elements from a range of given array to the list, equivalent to addLast()
|
void |
add(short e1,
short e2)
Appends two elements at the end of the list.
|
int |
addAll(java.lang.Iterable<? extends ShortCursor> iterable)
Adds all elements from another iterable, equivalent to addLast()
|
int |
addAll(ShortContainer container)
Adds all elements from another container, equivalent to addLast()
|
int |
addFirst(java.lang.Iterable<? extends ShortCursor> iterable)
Inserts all elements from the given iterable to the front of this list.
|
void |
addFirst(short... elements)
Vararg-signature method for adding elements at the front of this deque.
|
void |
addFirst(short e1)
Inserts the specified element at the front of this deque.
|
int |
addFirst(ShortContainer container)
Inserts all elements from the given container to the front of this list.
|
int |
addLast(java.lang.Iterable<? extends ShortCursor> iterable)
Inserts all elements from the given iterable to the end of this list.
|
void |
addLast(short... elements)
Add all elements (var-args signature) to the list, equivalent of add(final short... elements)
|
void |
addLast(short e1)
Inserts the specified element at the end of this deque.
|
void |
addLast(short[] elements,
int start,
int length)
Add all elements from a range of given array to the list.
|
int |
addLast(ShortContainer container)
Inserts all elements from the given container to the end of this list.
|
int |
capacity()
Return the maximum number of elements this container is guaranteed to hold without reallocating.
|
void |
clear()
Sets the number of stored elements to zero.
|
ShortLinkedList |
clone()
Clone this object.
|
boolean |
contains(short e1)
Lookup a given element in the container.
|
<T extends ShortPredicate> |
descendingForEach(T predicate)
Applies a
predicate to container elements as long, as the predicate
returns true. |
<T extends ShortProcedure> |
descendingForEach(T procedure)
Applies a
procedure to all container elements. |
ShortLinkedList.DescendingValueIterator |
descendingIterator()
Returns an iterator over the values of this list (in tail to head order).
|
protected boolean |
ensureBufferSpace(int expectedAdditions)
Ensures the internal buffer has enough free slots to store
expectedAdditions. |
void |
ensureCapacity(int minCapacity)
Increases the capacity of this instance, if necessary, to ensure
that it can hold at least the number of elements specified by
the minimum capacity argument.
|
boolean |
equals(java.lang.Object obj) |
<T extends ShortPredicate> |
forEach(T predicate)
Applies a
predicate to container elements, as long as the predicate
returns true. |
<T extends ShortProcedure> |
forEach(T procedure)
Applies a
procedure to all container elements. |
<T extends ShortPredicate> |
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 ShortProcedure> |
forEach(T procedure,
int fromIndex,
int toIndex)
Applies
procedure to a slice of the container,
fromIndex, inclusive, to toIndex, exclusive. |
static ShortLinkedList |
from(short... elements)
Create a list from a variable number of arguments or an array of
short. |
static ShortLinkedList |
from(ShortContainer container)
Create a list from elements of another container.
|
short |
get(int index) |
short |
getFirst()
Retrieves, but does not remove, the first element of this deque.
|
short |
getLast()
Retrieves, but does not remove, the last element of this deque.
|
protected int |
gotoIndex(int index)
Traverse the list to index, return the position in buffer
when reached.
|
int |
hashCode() |
int |
indexOf(short 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,
short e1)
Inserts the specified element at the specified position in this list.
|
ShortLinkedList.ValueIterator |
iterator()
The iterator is implemented as a cursor and it returns the same cursor instance
on every call, to avoid boxing of primitive types.
|
int |
lastIndexOf(short 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 ShortLinkedList |
newInstance()
Returns a new object of this class with no need to declare generic type (shortcut
instead of using a constructor).
|
static ShortLinkedList |
newInstance(int initialCapacity)
Returns a new object of this class with no need to declare generic type (shortcut
instead of using a constructor).
|
short |
remove(int index)
Removes the element at the specified position in this list and returns it.
|
int |
removeAll(short e1)
Removes all occurrences of
e from this collection. |
int |
removeAll(ShortPredicate predicate)
Removes all elements in this collection for which the
given predicate returns
true. |
short |
removeFirst()
Retrieves and removes the first element of this deque.
|
int |
removeFirst(short e1)
Removes the first element that equals
e1, returning its
deleted position or -1 if the element was not found. |
short |
removeLast()
Retrieves and removes the last element of this deque.
|
int |
removeLast(short 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. |
short |
set(int index,
short 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 list by natural ordering (smaller first)
|
void |
sort(int beginIndex,
int endIndex)
In-place sort the list from [beginIndex, endIndex[
by natural ordering (smaller first)
WARNING: This method runs in O(n*n*log(n)).
|
void |
sort(int beginIndex,
int endIndex,
ShortComparator comp)
In-place sort the list from [beginIndex, endIndex[
using a
ShortComparator *
WARNING: This method runs in O(n*n*log(n)). |
void |
sort(ShortComparator comp)
In-place sort the whole list
using a
ShortComparator |
short[] |
toArray(short[] target)
Default implementation for:
Copies all elements of this container to an existing array of the same type.
|
isEmpty, removeAll, retainAll, retainAll, toArray, toStringfinalize, getClass, notify, notifyAll, wait, wait, waitremoveAll, retainAll, retainAllisEmpty, toArraypublic short[] buffer
size()).
Direct list iteration: iterate buffer[i] for i in [2; size()+2[, but beware, it is out of order w.r.t the real list order !
protected long[] beforeAfterPointers
protected static final int HEAD_POSITION
protected static final int TAIL_POSITION
protected int elementsCount
buffer.
Beware, the real number of elements is elementsCount - 2protected final ArraySizingStrategy resizer
protected final IteratorPool<ShortCursor,ShortLinkedList.ValueIterator> valueIteratorPool
protected final IteratorPool<ShortCursor,ShortLinkedList.DescendingValueIterator> descendingValueIteratorPool
public ShortLinkedList()
Containers.DEFAULT_EXPECTED_ELEMENTS elements.BoundedProportionalArraySizingStrategypublic ShortLinkedList(int initialCapacity)
BoundedProportionalArraySizingStrategypublic ShortLinkedList(int initialCapacity,
ArraySizingStrategy resizer)
public ShortLinkedList(ShortContainer container)
public void add(short e1)
add in interface ShortIndexedContainerpublic void add(short e1,
short e2)
add (vararg-version) or access the buffer directly (tight
loop).public void addLast(short... elements)
elements - add(short[])public void addLast(short[] elements,
int start,
int length)
public void add(short[] elements,
int start,
int length)
public void add(short... elements)
This method is handy, but costly if used in tight loops (anonymous array passing)
public int addAll(ShortContainer container)
public int addAll(java.lang.Iterable<? extends ShortCursor> iterable)
public void insert(int index,
short e1)
insert in interface ShortIndexedContainerindex - The index at which the element should be inserted, shifting
any existing and subsequent elements to the right.
Precondition : index must be valid !public short get(int index)
get in interface ShortIndexedContainerindex from the list.
Precondition : index must be valid !public short set(int index,
short e1)
set in interface ShortIndexedContainerpublic short remove(int index)
Careful. Do not confuse this method with the overridden signature in
Java Collections (List.remove(Object)). Use: ShortCollection.removeAll(short),
ShortIndexedContainer.removeFirst(short) or ShortIndexedContainer.removeLast(short) depending
on the actual need.
remove in interface ShortIndexedContainerpublic void removeRange(int fromIndex,
int toIndex)
fromIndex, inclusive, and toIndex, exclusive.removeRange in interface ShortIndexedContainerpublic int removeFirst(short e1)
e1, returning its
deleted position or -1 if the element was not found.removeFirst in interface ShortDequeremoveFirst in interface ShortIndexedContainerpublic int removeLast(short e1)
e1, returning its
deleted position or -1 if the element was not found.removeLast in interface ShortDequeremoveLast in interface ShortIndexedContainerpublic int removeAll(short e1)
e from this collection.removeAll in interface ShortCollectione1 - Element to be removed from this collection, if present.public boolean contains(short e1)
contains in interface ShortContainertrue if this container has an element
equal to e.public int indexOf(short e1)
indexOf in interface ShortIndexedContainerpublic int lastIndexOf(short e1)
lastIndexOf in interface ShortIndexedContainerpublic void ensureCapacity(int minCapacity)
protected boolean ensureBufferSpace(int expectedAdditions)
expectedAdditions. Increases internal buffer size if needed.public int size()
O(n) time, although implementing classes
should try to maintain the current size and return in constant time.size in interface ShortContainerpublic int capacity()
O(n) time.capacity in interface ShortContainerpublic void clear()
clear in interface ShortCollectionpublic short[] toArray(short[] target)
toArray in interface ShortContainertoArray in class AbstractShortCollectiontarget - The target array must be large enough to hold all elements, i.e >= ShortContainer.size().public ShortLinkedList clone()
clone in class java.lang.Objectpublic int hashCode()
hashCode in class java.lang.Objectpublic boolean equals(java.lang.Object obj)
equals in class java.lang.Objectprotected int gotoIndex(int index)
index - public ShortLinkedList.ValueIterator iterator()
get(int), use the cursor's public
fields.
The iterator points to "head", such as ValueIterator.gotoNext()
is the first element of the list.
Enhanced-loop syntax:
for (ShortCursor c : container) {
System.out.println("index=" + c.index + " value=" + c.value);
}
Or :
ValueIterator it = list.iterator();
while (it.hasAfter())
{
final ShortCursor c = it.gotoNext().cursor;
System.out.println("buffer index="
+ c.index + " value=" + c.value);
}
// release the iterator at the end !
it.release()
iterator in interface ShortContaineriterator in interface java.lang.Iterable<ShortCursor>ShortLinkedList.ValueIteratorpublic ShortLinkedList.DescendingValueIterator descendingIterator()
get(int), use the cursor's public
fields. An example is shown below.
*
DescendingValueIterator it = list.descendingIterator();
while (it.hasAfter())
{
final ShortCursor c = it.gotoNext().cursor;
System.out.println("buffer index="
+ c.index + " value=" + c.value);
}
// release the iterator at the end !
it.release()
descendingIterator in interface ShortDequeShortLinkedList.DescendingValueIteratorpublic <T extends ShortProcedure> T forEach(T procedure)
procedure to all container elements. Returns the argument (any
subclass of ShortProcedure. 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 ShortContainerpublic <T extends ShortProcedure> T forEach(T procedure, int fromIndex, int toIndex)
procedure to a slice of the container,
fromIndex, inclusive, to toIndex, exclusive.forEach in interface ShortIndexedContainerpublic <T extends ShortPredicate> T forEach(T predicate)
predicate to container elements, as long as the predicate
returns true. The iteration is interrupted otherwise.forEach in interface ShortContainerpublic <T extends ShortPredicate> T forEach(T predicate, int fromIndex, int toIndex)
predicate to a slice of the container,
fromIndex, inclusive, to toIndex,
exclusive, or until predicate returns false.forEach in interface ShortIndexedContainerpublic <T extends ShortProcedure> T descendingForEach(T procedure)
procedure to all container elements.descendingForEach in interface ShortDequepublic <T extends ShortPredicate> T descendingForEach(T predicate)
predicate to container elements as long, as the predicate
returns true. The iteration is interrupted otherwise.descendingForEach in interface ShortDequepublic int removeAll(ShortPredicate predicate)
true.removeAll in interface ShortCollectionpublic static ShortLinkedList newInstance()
public static ShortLinkedList newInstance(int initialCapacity)
public static ShortLinkedList from(short... elements)
short.
The elements are copied from the argument to the internal buffer.public static ShortLinkedList from(ShortContainer container)
public void sort(int beginIndex,
int endIndex)
WARNING: This method runs in O(n*n*log(n)). Consider yourself warned.
beginIndex - the start index to be sortedendIndex - the end index to be sorted (excluded)public void sort(int beginIndex,
int endIndex,
ShortComparator comp)
ShortComparator * WARNING: This method runs in O(n*n*log(n)). Consider yourself warned.
beginIndex - the start index to be sortedendIndex - the end index to be sorted (excluded)public void sort()
public void sort(ShortComparator comp)
ShortComparatorpublic void addFirst(short e1)
ShortDequeaddFirst in interface ShortDequee1 - the element to addpublic int addFirst(ShortContainer container)
public void addFirst(short... elements)
This method is handy, but costly if used in tight loops (anonymous array passing)
public int addFirst(java.lang.Iterable<? extends ShortCursor> iterable)
public void addLast(short e1)
ShortDequeaddLast in interface ShortDequee1 - the element to addpublic int addLast(ShortContainer container)
public int addLast(java.lang.Iterable<? extends ShortCursor> iterable)
public short removeFirst()
ShortDequeremoveFirst in interface ShortDequepublic short removeLast()
ShortDequeremoveLast in interface ShortDequepublic short getFirst()
ShortDequegetFirst in interface ShortDequepublic short getLast()
ShortDequegetLast in interface ShortDequeCopyright © 2017. All rights reserved.