com.carrotsearch.hppc

Class KTypeArrayList<KType>

java.lang.Object

com.carrotsearch.hppc.KTypeArrayList<KType>

All Implemented Interfaces:

KTypeCollection<KType>, KTypeContainer<KType>, KTypeIndexedContainer<KType>, java.lang.Cloneable, java.lang.Iterable<KTypeCursor<KType>>, java.util.RandomAccess

Direct Known Subclasses:

KTypeStack

public class KTypeArrayList<KType>
extends java.lang.Object
implements KTypeIndexedContainer<KType>, java.lang.Cloneable

An array-backed list of KTypes. 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. #if ($TemplateOptions.KTypeGeneric) A brief comparison of the API against the Java Collections framework:

Java Collections ArrayList and HPPC ObjectArrayList, related methods.

java.util.ArrayList	ObjectArrayList
add	add
add(index,v)	insert(index,v)
get	get
removeRange, removeElementAt	removeRange, remove
remove(Object)	removeFirstOccurrence, removeLastOccurrence, removeAllOccurrences
clear	clear, release
size	size
ensureCapacity	ensureCapacity, resize
indexOf	indexOf
lastIndexOf	lastIndexOf
trimToSize	trimtoSize
Object[] toArray()	KType[] toArray()
iterator	cursor over values

#else

See ObjectArrayList class for API similarities and differences against Java Collections. #end

Field Summary

Fields

Modifier and Type	Field and Description
KType[]	buffer Internal array for storing the list.
static int	DEFAULT_CAPACITY Default capacity if no other capacity is given in the constructor.
int	elementsCount Current number of elements stored in buffer.
protected ArraySizingStrategy	resizer Buffer resizing strategy.

Constructor Summary

Constructors

Constructor and Description
KTypeArrayList() Create with default sizing strategy and initial capacity for storing 5 elements.
KTypeArrayList(int initialCapacity) Create with default sizing strategy and the given initial capacity.
KTypeArrayList(int initialCapacity, ArraySizingStrategy resizer) Create with a custom buffer resizing strategy.
KTypeArrayList(KTypeContainer<? extends KType> container) Creates a new list from elements of another container.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(KType... elements) Vararg-signature method for adding elements at the end of the list.
void	add(KType e1) Adds an element to the end of this container (the last index is incremented by one).
void	add(KType[] elements, int start, int length) Add all elements from a range of given array to the list.
void	add(KType e1, KType e2) Appends two elements at the end of the list.
int	addAll(java.lang.Iterable<? extends KTypeCursor<? extends KType>> iterable) Adds all elements from another iterable.
int	addAll(KTypeContainer<? extends KType> container) Adds all elements from another container.
void	clear() Sets the number of stored elements to zero.
KTypeArrayList<KType>	clone() Clone this object.
boolean	contains(KType e1) Lookup a given element in the container.
protected void	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) Compares the specified object with this container for equality.
<T extends KTypePredicate<? super KType>> T	forEach(T predicate) Applies a predicate to container elements as long, as the predicate returns true.
<T extends KTypeProcedure<? super KType>> T	forEach(T procedure) Applies a procedure to all container elements.
<T extends KTypePredicate<? super KType>> T	forEach(T predicate, int fromIndex, int toIndex) Applies predicate to a slice of the list, fromIndex, inclusive, to toIndex, exclusive, or until predicate returns false.
<T extends KTypeProcedure<? super KType>> T	forEach(T procedure, int fromIndex, int toIndex) Applies procedure to a slice of the list, fromIndex, inclusive, to toIndex, exclusive.
static <KType> KTypeArrayList<KType>	from(KType... elements) Create a list from a variable number of arguments or an array of KType.
static <KType> KTypeArrayList<KType>	from(KTypeContainer<KType> container) Create a list from elements of another container.
KType	get(int index)
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) Inserts the specified element at the specified position in this list.
boolean	isEmpty() Shortcut for size() == 0.
java.util.Iterator<KTypeCursor<KType>>	iterator() Returns an iterator to a cursor traversing the collection.
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> KTypeArrayList<KType>	newInstance() Returns a new object of this class with no need to declare generic type (shortcut instead of using a constructor).
static <KType> KTypeArrayList<KType>	newInstanceWithCapacity(int initialCapacity) Returns a new object of this class with no need to declare generic type (shortcut instead of using a constructor).
void	release() Sets the number of stored elements to zero and releases the internal storage array.
KType	remove(int index) Removes the element at the specified position in this list and returns it.
int	removeAll(KTypeLookupContainer<? extends KType> c) Default implementation uses a predicate for removal.
int	removeAll(KTypePredicate<? 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.
int	removeFirstOccurrence(KType e1) Removes the first element that equals e1, returning its deleted position or -1 if the element was not found.
int	removeLastOccurrence(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.
void	resize(int newSize) Truncate or expand the list to the new size.
int	retainAll(KTypeLookupContainer<? extends KType> c) Default implementation uses a predicate for retaining.
int	retainAll(KTypePredicate<? super KType> predicate) Default implementation redirects to KTypeCollection.removeAll(KTypePredicate) and negates the predicate.
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.
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.
java.lang.String	toString() Convert the contents of this container to a human-friendly string.
void	trimToSize() Trim the internal buffer to the current size.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.carrotsearch.hppc.KTypeCollection

removeAll, retainAll, retainAll

Methods inherited from interface com.carrotsearch.hppc.KTypeContainer

toArray

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 KType[] buffer

Internal array for storing the list. The array may be larger than the current size (size()). #if ($TemplateOptions.KTypeGeneric)

Important! The actual value in this field is always an instance of Object[], regardless of the generic type used. The JDK is inconsistent here too: ArrayList declares internal Object[] buffer, but ArrayDeque declares an array of generic type objects like we do. The tradeoff is probably minimal, but you should be aware of additional casts generated by javac when buffer is directly accessed; these casts may also result in exceptions at runtime. A workaround is to cast directly to Object[] before accessing the buffer's elements, as shown in the following code snippet.

 Object[] buf = list.buffer;
 for (int i = list.size(); --i >= 0;) {
   doSomething(buf[i]);
 }
 

#end

elementsCount

public int elementsCount

Current number of elements stored in buffer.

resizer

protected final ArraySizingStrategy resizer

Buffer resizing strategy.

Constructor Detail

KTypeArrayList

public KTypeArrayList()

Create with default sizing strategy and initial capacity for storing 5 elements.

See Also:

BoundedProportionalArraySizingStrategy

KTypeArrayList

public KTypeArrayList(int initialCapacity)

Create with default sizing strategy and the given initial capacity.

See Also:

BoundedProportionalArraySizingStrategy

KTypeArrayList

public KTypeArrayList(int initialCapacity,
              ArraySizingStrategy resizer)

Create with a custom buffer resizing strategy.

KTypeArrayList

public KTypeArrayList(KTypeContainer<? extends KType> container)

Creates a new list from elements of another container.

Method Detail

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 KTypeIndexedContainer<KType>

add

public void add(KType e1,
       KType e2)

Appends two elements at the end of the list. To add more than two elements, use add (vararg-version) or access the buffer directly (tight loop).

add

public void add(KType[] elements,
       int start,
       int length)

Add all elements from a range of given array to the list.

add

public void add(KType... elements)

Vararg-signature method for adding elements at the end of the list.

This method is handy, but costly if used in tight loops (anonymous array passing)

addAll

public int addAll(KTypeContainer<? extends KType> container)

Adds all elements from another container.

addAll

public int addAll(java.lang.Iterable<? extends KTypeCursor<? extends KType>> iterable)

Adds all elements from another iterable.

insert

public void insert(int index,
          KType e1)

Inserts the specified element at the specified position in this list.

Specified by:

insert in interface KTypeIndexedContainer<KType>

Parameters:

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

get

public KType get(int index)

Specified by:

get in interface KTypeIndexedContainer<KType>

Returns:

Returns the element at index index from the list.

set

public KType set(int index,
        KType e1)

Replaces the element at the specified position in this list with the specified element.

Specified by:

set in interface KTypeIndexedContainer<KType>

Returns:

Returns the previous value in the list.

remove

public KType remove(int index)

Removes the element at the specified position in this list and returns it.

Careful. Do not confuse this method with the overridden signature in Java Collections (List.remove(Object)). Use: KTypeCollection.removeAll(com.carrotsearch.hppc.KTypeLookupContainer<? extends KType>), KTypeIndexedContainer.removeFirstOccurrence(KType) or KTypeIndexedContainer.removeLastOccurrence(KType) depending on the actual need.

Specified by:

remove in interface KTypeIndexedContainer<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.

Specified by:

removeRange in interface KTypeIndexedContainer<KType>

removeFirstOccurrence

public int removeFirstOccurrence(KType 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 KTypeIndexedContainer<KType>

removeLastOccurrence

public int removeLastOccurrence(KType 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 KTypeIndexedContainer<KType>

removeAllOccurrences

public int removeAllOccurrences(KType e1)

Removes all occurrences of e from this collection.

Specified by:

removeAllOccurrences in interface KTypeCollection<KType>

Parameters:

e1 - Element to be removed from this collection, if present.

Returns:

The number of removed elements as a result of this call.

contains

public boolean contains(KType e1)

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 KTypeContainer<KType>

Returns:

Returns true if this container has an element equal to e.

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.

Specified by:

indexOf in interface KTypeIndexedContainer<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.

Specified by:

lastIndexOf in interface KTypeIndexedContainer<KType>

isEmpty

public boolean isEmpty()

Shortcut for size() == 0.

Specified by:

isEmpty in interface KTypeContainer<KType>

ensureCapacity

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

ensureBufferSpace

protected void ensureBufferSpace(int expectedAdditions)

Ensures the internal buffer has enough free slots to store expectedAdditions. Increases internal buffer size if needed.

resize

public void resize(int newSize)

Truncate or expand the list to the new size. If the list is truncated, the buffer will not be reallocated (use trimToSize() if you need a truncated buffer), but the truncated values will be reset to the default value (zero). If the list is expanded, the elements beyond the current size are initialized with JVM-defaults (zero or null values).

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 KTypeContainer<KType>

trimToSize

public void trimToSize()

Trim the internal buffer to the current size.

clear

public void clear()

Sets the number of stored elements to zero. Releases and initializes the internal storage array to default values. To clear the list without cleaning the buffer, simply set the elementsCount field to zero.

Specified by:

clear in interface KTypeCollection<KType>

release

public void release()

Sets the number of stored elements to zero and releases the internal storage array.

toArray

public java.lang.Object[] toArray()

Copies all elements from this container to an Object array. If you need an array of the type identical with this container's generic type, use KTypeContainer.toArray(Class).

The returned array is sized to match exactly the number of elements of the stack.

Specified by:

toArray in interface KTypeContainer<KType>

See Also:

KTypeContainer.toArray(Class)

clone

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

hashCode

public int hashCode()

Specified by:

hashCode in interface KTypeIndexedContainer<KType>

Overrides:

hashCode in class java.lang.Object

Returns:

A hash code of elements stored in the container. The hash code is defined identically to List.hashCode() (should be implemented with the same algorithm).

equals

public boolean equals(java.lang.Object obj)

Compares the specified object with this container for equality. Returns true if and only if the specified object is also a KTypeIndexedContainer, both have the same size, and all corresponding pairs of elements at the same index are equal. In other words, two indexed containers are defined to be equal if they contain the same elements in the same order.

Note that, unlike in List, containers may be of different types and still return true from KTypeIndexedContainer.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 KTypeIndexedContainer.equals(java.lang.Object). It is the programmer's responsibility to enforcing these contracts properly.

Specified by:

equals in interface KTypeIndexedContainer<KType>

Overrides:

equals in class java.lang.Object

iterator

public java.util.Iterator<KTypeCursor<KType>> iterator()

Returns an iterator to a cursor traversing the collection. The order of traversal is not defined. More than one cursor may be active at a time. The behavior of iterators is undefined if structural changes are made to the underlying collection.

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 list's value (or index in the list) use the cursor's public fields. An example is shown below.

 for (KTypeCursor<KType> c : container) {
   System.out.println("index=" + c.index + " value=" + c.value);
 }
 

Specified by:

iterator in interface KTypeContainer<KType>

Specified by:

iterator in interface java.lang.Iterable<KTypeCursor<KType>>

forEach

public <T extends KTypeProcedure<? super KType>> T forEach(T procedure)

Applies a procedure to all container elements. Returns the argument (any subclass of KTypeProcedure. 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 KTypeContainer<KType>

forEach

public <T extends KTypeProcedure<? super KType>> T forEach(T procedure,
                                                  int fromIndex,
                                                  int toIndex)

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

removeAll

public int removeAll(KTypePredicate<? super KType> predicate)

Removes all elements in this collection for which the given predicate returns true.

Specified by:

removeAll in interface KTypeCollection<KType>

forEach

public <T extends KTypePredicate<? 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 KTypeContainer<KType>

forEach

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

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

newInstance

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

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

newInstanceWithCapacity

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

Create a list from a variable number of arguments or an array of KType. The elements are copied from the argument to the internal buffer.

from

public static <KType> KTypeArrayList<KType> from(KTypeContainer<KType> container)

Create a list from elements of another container.

removeAll

public int removeAll(KTypeLookupContainer<? extends KType> c)

Default implementation uses a predicate for removal.

Specified by:

removeAll in interface KTypeCollection<KType>

Returns:

Returns the number of removed elements.

retainAll

public int retainAll(KTypeLookupContainer<? extends KType> c)

Default implementation uses a predicate for retaining.

Specified by:

retainAll in interface KTypeCollection<KType>

Returns:

Returns the number of removed elements.

retainAll

public int retainAll(KTypePredicate<? super KType> predicate)

Default implementation redirects to KTypeCollection.removeAll(KTypePredicate) and negates the predicate.

Specified by:

retainAll in interface KTypeCollection<KType>

toArray

public KType[] toArray(java.lang.Class<? super KType> clazz)

Default implementation of copying to an array.

Specified by:

toArray in interface KTypeContainer<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