Class TIntArrayList
- java.lang.Object
-
- gnu.trove.list.array.TIntArrayList
-
- All Implemented Interfaces:
TIntList,TIntCollection,java.io.Externalizable,java.io.Serializable
public class TIntArrayList extends java.lang.Object implements TIntList, java.io.Externalizable
A resizable, array-backed list of int primitives.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected int[]_datathe data of the listprotected int_posthe index after the last entry in the listprotected static intDEFAULT_CAPACITYthe default capacity for new listsprotected intno_entry_valuethe int value that represents null
-
Constructor Summary
Constructors Modifier Constructor Description TIntArrayList()Creates a newTIntArrayListinstance with the default capacity.TIntArrayList(int capacity)Creates a newTIntArrayListinstance with the specified capacity.TIntArrayList(int[] values)Creates a newTIntArrayListinstance whose capacity is the length of values array and whose initial contents are the specified values.protectedTIntArrayList(int[] values, int no_entry_value, boolean wrap)TIntArrayList(int capacity, int no_entry_value)Creates a newTIntArrayListinstance with the specified capacity.TIntArrayList(TIntCollection collection)Creates a newTIntArrayListinstance that contains a copy of the collection passed to us.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanadd(int val)Adds val to the end of the list, growing as needed.voidadd(int[] vals)Adds the values in the array vals to the end of the list, in order.voidadd(int[] vals, int offset, int length)Adds a subset of the values in the array vals to the end of the list, in order.booleanaddAll(int[] array)Adds all of the elements in the array to the collection.booleanaddAll(TIntCollection collection)Adds all of the elements in the TIntCollection to the collection.booleanaddAll(java.util.Collection<? extends java.lang.Integer> collection)Adds all of the elements in collection to the collection.intbinarySearch(int value)Performs a binary search for value in the entire list.intbinarySearch(int value, int fromIndex, int toIndex)Performs a binary search for value in the specified range.voidclear()Flushes the internal state of the list, resetting the capacity to the default.voidclearQuick()Sets the size of the list to 0, but does not change its capacity.booleancontains(int value)Searches the list for valuebooleancontainsAll(int[] array)Tests the collection to determine if all of the elements in array are present.booleancontainsAll(TIntCollection collection)Tests the collection to determine if all of the elements in TIntCollection are present.booleancontainsAll(java.util.Collection<?> collection)Tests the collection to determine if all of the elements in collection are present.voidensureCapacity(int capacity)Grow the internal array as needed to accommodate the specified number of elements.booleanequals(java.lang.Object other)Compares the specified object with this collection for equality.voidfill(int val)Fills every slot in the list with the specified value.voidfill(int fromIndex, int toIndex, int val)Fills a range in the list with the specified value.booleanforEach(TIntProcedure procedure)Applies the procedure to each value in the list in ascending (front to back) order.booleanforEachDescending(TIntProcedure procedure)Applies the procedure to each value in the list in descending (back to front) order.intget(int offset)Returns the value at the specified offset.intgetNoEntryValue()Returns the value that is used to represent null.intgetQuick(int offset)Returns the value at the specified offset without doing any bounds checking.TIntListgrep(TIntProcedure condition)Searches the list for values satisfying condition in the manner of the *nix grep utility.inthashCode()Returns the hash code value for this collection.intindexOf(int value)Searches the list front to back for the index of value.intindexOf(int offset, int value)Searches the list front to back for the index of value, starting at offset.voidinsert(int offset, int value)Inserts value into the list at offset.voidinsert(int offset, int[] values)Inserts the array of values into the list at offset.voidinsert(int offset, int[] values, int valOffset, int len)Inserts a slice of the array of values into the list at offset.TIntListinverseGrep(TIntProcedure condition)Searches the list for values which do not satisfy condition.booleanisEmpty()Tests whether this list contains any values.TIntIteratoriterator()Creates an iterator over the values of the collection.intlastIndexOf(int value)Searches the list back to front for the last index of value.intlastIndexOf(int offset, int value)Searches the list back to front for the last index of value, starting at offset.intmax()Finds the maximum value in the list.intmin()Finds the minimum value in the list.voidreadExternal(java.io.ObjectInput in)booleanremove(int value)Removes value from the list.voidremove(int offset, int length)Removes length values from the list, starting at offsetbooleanremoveAll(int[] array)Removes all of the elements in array from the collection.booleanremoveAll(TIntCollection collection)Removes all of the elements in TIntCollection from the collection.booleanremoveAll(java.util.Collection<?> collection)Removes all of the elements in collection from the collection.intremoveAt(int offset)Removes value at a given offset from the list.intreplace(int offset, int val)Sets the value at the specified offset and returns the previously stored value.booleanretainAll(int[] array)Removes any values in the collection which are not contained in array.booleanretainAll(TIntCollection collection)Removes any values in the collection which are not contained in TIntCollection.booleanretainAll(java.util.Collection<?> collection)Removes any values in the collection which are not contained in collection.voidreverse()Reverse the order of the elements in the list.voidreverse(int from, int to)Reverse the order of the elements in the range of the list.intset(int offset, int val)Sets the value at the specified offset.voidset(int offset, int[] values)Replace the values in the list starting at offset with the contents of the values array.voidset(int offset, int[] values, int valOffset, int length)Replace the values in the list starting at offset with length values from the values array, starting at valOffset.voidsetQuick(int offset, int val)Sets the value at the specified offset without doing any bounds checking.voidshuffle(java.util.Random rand)Shuffle the elements of the list using the specified random number generator.intsize()Returns the number of values in the list.voidsort()Sort the values in the list (ascending) using the Sun quicksort implementation.voidsort(int fromIndex, int toIndex)Sort a slice of the list (ascending) using the Sun quicksort implementation.TIntListsubList(int begin, int end)Returns a sublist of this list.intsum()Calculates the sum of all the values in the list.int[]toArray()Copies the contents of the list into a native array.int[]toArray(int[] dest)Copies a slice of the list into a native array.int[]toArray(int[] dest, int offset, int len)Copies a slice of the list into a native array.int[]toArray(int[] dest, int source_pos, int dest_pos, int len)Copies a slice of the list into a native array.int[]toArray(int offset, int len)Copies a slice of the list into a native array.java.lang.StringtoString()voidtransformValues(TIntFunction function)Transform each value in the list using the specified function.voidtrimToSize()Sheds any excess capacity above and beyond the current size of the list.static TIntArrayListwrap(int[] values)Returns a primitive List implementation that wraps around the given primitive array.static TIntArrayListwrap(int[] values, int no_entry_value)Returns a primitive List implementation that wraps around the given primitive array.voidwriteExternal(java.io.ObjectOutput out)
-
-
-
Field Detail
-
DEFAULT_CAPACITY
protected static final int DEFAULT_CAPACITY
the default capacity for new lists- See Also:
- Constant Field Values
-
_data
protected int[] _data
the data of the list
-
_pos
protected int _pos
the index after the last entry in the list
-
no_entry_value
protected int no_entry_value
the int value that represents null
-
-
Constructor Detail
-
TIntArrayList
public TIntArrayList()
Creates a newTIntArrayListinstance with the default capacity.
-
TIntArrayList
public TIntArrayList(int capacity)
Creates a newTIntArrayListinstance with the specified capacity.- Parameters:
capacity- anintvalue
-
TIntArrayList
public TIntArrayList(int capacity, int no_entry_value)Creates a newTIntArrayListinstance with the specified capacity.- Parameters:
capacity- anintvalueno_entry_value- anintvalue that represents null.
-
TIntArrayList
public TIntArrayList(TIntCollection collection)
Creates a newTIntArrayListinstance that contains a copy of the collection passed to us.- Parameters:
collection- the collection to copy
-
TIntArrayList
public TIntArrayList(int[] values)
Creates a newTIntArrayListinstance whose capacity is the length of values array and whose initial contents are the specified values.A defensive copy of the given values is held by the new instance.
- Parameters:
values- anint[]value
-
TIntArrayList
protected TIntArrayList(int[] values, int no_entry_value, boolean wrap)
-
-
Method Detail
-
wrap
public static TIntArrayList wrap(int[] values)
Returns a primitive List implementation that wraps around the given primitive array.
NOTE: mutating operation are allowed as long as the List does not grow. In that case an IllegalStateException will be thrown
- Parameters:
values-
-
wrap
public static TIntArrayList wrap(int[] values, int no_entry_value)
Returns a primitive List implementation that wraps around the given primitive array.
NOTE: mutating operation are allowed as long as the List does not grow. In that case an IllegalStateException will be thrown
- Parameters:
values-no_entry_value-
-
getNoEntryValue
public int getNoEntryValue()
Returns the value that is used to represent null. The default value is generally zero, but can be changed during construction of the collection.- Specified by:
getNoEntryValuein interfaceTIntCollection- Specified by:
getNoEntryValuein interfaceTIntList- Returns:
- the value that represents null
-
ensureCapacity
public void ensureCapacity(int capacity)
Grow the internal array as needed to accommodate the specified number of elements. The size of the array bytes on each resize unless capacity requires more than twice the current capacity.
-
size
public int size()
Returns the number of values in the list.- Specified by:
sizein interfaceTIntCollection- Specified by:
sizein interfaceTIntList- Returns:
- the number of values in the list.
-
isEmpty
public boolean isEmpty()
Tests whether this list contains any values.- Specified by:
isEmptyin interfaceTIntCollection- Specified by:
isEmptyin interfaceTIntList- Returns:
- true if the list is empty.
-
trimToSize
public void trimToSize()
Sheds any excess capacity above and beyond the current size of the list.
-
add
public boolean add(int val)
Adds val to the end of the list, growing as needed.- Specified by:
addin interfaceTIntCollection- Specified by:
addin interfaceTIntList- Parameters:
val- anintvalue- Returns:
- true if the list was modified by the add operation
-
add
public void add(int[] vals)
Adds the values in the array vals to the end of the list, in order.
-
add
public void add(int[] vals, int offset, int length)Adds a subset of the values in the array vals to the end of the list, in order.
-
insert
public void insert(int offset, int value)Inserts value into the list at offset. All values including and to the right of offset are shifted to the right.
-
insert
public void insert(int offset, int[] values)Inserts the array of values into the list at offset. All values including and to the right of offset are shifted to the right.
-
insert
public void insert(int offset, int[] values, int valOffset, int len)Inserts a slice of the array of values into the list at offset. All values including and to the right of offset are shifted to the right.
-
get
public int get(int offset)
Returns the value at the specified offset.
-
getQuick
public int getQuick(int offset)
Returns the value at the specified offset without doing any bounds checking.
-
set
public int set(int offset, int val)Sets the value at the specified offset.
-
replace
public int replace(int offset, int val)Sets the value at the specified offset and returns the previously stored value.
-
set
public void set(int offset, int[] values)Replace the values in the list starting at offset with the contents of the values array.
-
set
public void set(int offset, int[] values, int valOffset, int length)Replace the values in the list starting at offset with length values from the values array, starting at valOffset.
-
setQuick
public void setQuick(int offset, int val)Sets the value at the specified offset without doing any bounds checking.
-
clear
public void clear()
Flushes the internal state of the list, resetting the capacity to the default.- Specified by:
clearin interfaceTIntCollection- Specified by:
clearin interfaceTIntList
-
clearQuick
public void clearQuick()
Sets the size of the list to 0, but does not change its capacity. This method can be used as an alternative to theclear()method if you want reset the list state without incurring the cost of filling bank data in the list. Thus, it is possible for getQuick to return stale data if this method is used and the caller is careless about bounds checking.
-
remove
public boolean remove(int value)
Removes value from the list.- Specified by:
removein interfaceTIntCollection- Specified by:
removein interfaceTIntList- Parameters:
value- anintvalue- Returns:
- true if the list was modified by the remove operation.
-
removeAt
public int removeAt(int offset)
Removes value at a given offset from the list.
-
remove
public void remove(int offset, int length)Removes length values from the list, starting at offset
-
iterator
public TIntIterator iterator()
Creates an iterator over the values of the collection. The iterator supports element deletion.- Specified by:
iteratorin interfaceTIntCollection- Returns:
- an
TIntIteratorvalue
-
containsAll
public boolean containsAll(java.util.Collection<?> collection)
Tests the collection to determine if all of the elements in collection are present.- Specified by:
containsAllin interfaceTIntCollection- Parameters:
collection- aCollectionvalue- Returns:
- true if all elements were present in the collection.
-
containsAll
public boolean containsAll(TIntCollection collection)
Tests the collection to determine if all of the elements in TIntCollection are present.- Specified by:
containsAllin interfaceTIntCollection- Parameters:
collection- aTIntCollectionvalue- Returns:
- true if all elements were present in the collection.
-
containsAll
public boolean containsAll(int[] array)
Tests the collection to determine if all of the elements in array are present.- Specified by:
containsAllin interfaceTIntCollection- Parameters:
array- asarrayof int primitives.- Returns:
- true if all elements were present in the collection.
-
addAll
public boolean addAll(java.util.Collection<? extends java.lang.Integer> collection)
Adds all of the elements in collection to the collection.- Specified by:
addAllin interfaceTIntCollection- Parameters:
collection- aCollectionvalue- Returns:
- true if the collection was modified by the add all operation.
-
addAll
public boolean addAll(TIntCollection collection)
Adds all of the elements in the TIntCollection to the collection.- Specified by:
addAllin interfaceTIntCollection- Parameters:
collection- aTIntCollectionvalue- Returns:
- true if the collection was modified by the add all operation.
-
addAll
public boolean addAll(int[] array)
Adds all of the elements in the array to the collection.- Specified by:
addAllin interfaceTIntCollection- Parameters:
array- aarrayof int primitives.- Returns:
- true if the collection was modified by the add all operation.
-
retainAll
public boolean retainAll(java.util.Collection<?> collection)
Removes any values in the collection which are not contained in collection.- Specified by:
retainAllin interfaceTIntCollection- Parameters:
collection- aCollectionvalue- Returns:
- true if the collection was modified by the retain all operation
-
retainAll
public boolean retainAll(TIntCollection collection)
Removes any values in the collection which are not contained in TIntCollection.- Specified by:
retainAllin interfaceTIntCollection- Parameters:
collection- aTIntCollectionvalue- Returns:
- true if the collection was modified by the retain all operation
-
retainAll
public boolean retainAll(int[] array)
Removes any values in the collection which are not contained in array.- Specified by:
retainAllin interfaceTIntCollection- Parameters:
array- anarrayof int primitives.- Returns:
- true if the collection was modified by the retain all operation
-
removeAll
public boolean removeAll(java.util.Collection<?> collection)
Removes all of the elements in collection from the collection.- Specified by:
removeAllin interfaceTIntCollection- Parameters:
collection- aCollectionvalue- Returns:
- true if the collection was modified by the remove all operation.
-
removeAll
public boolean removeAll(TIntCollection collection)
Removes all of the elements in TIntCollection from the collection.- Specified by:
removeAllin interfaceTIntCollection- Parameters:
collection- aTIntCollectionvalue- Returns:
- true if the collection was modified by the remove all operation.
-
removeAll
public boolean removeAll(int[] array)
Removes all of the elements in array from the collection.- Specified by:
removeAllin interfaceTIntCollection- Parameters:
array- anarrayof int primitives.- Returns:
- true if the collection was modified by the remove all operation.
-
transformValues
public void transformValues(TIntFunction function)
Transform each value in the list using the specified function.- Specified by:
transformValuesin interfaceTIntList- Parameters:
function- aTIntFunctionvalue
-
reverse
public void reverse()
Reverse the order of the elements in the list.
-
reverse
public void reverse(int from, int to)Reverse the order of the elements in the range of the list.
-
shuffle
public void shuffle(java.util.Random rand)
Shuffle the elements of the list using the specified random number generator.
-
subList
public TIntList subList(int begin, int end)
Returns a sublist of this list.
-
toArray
public int[] toArray()
Copies the contents of the list into a native array.- Specified by:
toArrayin interfaceTIntCollection- Specified by:
toArrayin interfaceTIntList- Returns:
- an
int[]value
-
toArray
public int[] toArray(int offset, int len)Copies a slice of the list into a native array.
-
toArray
public int[] toArray(int[] dest)
Copies a slice of the list into a native array.If the list fits in the specified array with room to spare (i.e., the array has more elements than the list), the element in the array immediately following the end of the list is set to
TIntList.getNoEntryValue(). (This is useful in determining the length of the list only if the caller knows that the list does not contain any "null" elements.)NOTE: Trove does not allocate a new array if the array passed in is not large enough to hold all of the data elements. It will instead fill the array passed in.
- Specified by:
toArrayin interfaceTIntCollection- Specified by:
toArrayin interfaceTIntList- Parameters:
dest- the array to copy into.- Returns:
- the array passed in.
-
toArray
public int[] toArray(int[] dest, int offset, int len)Copies a slice of the list into a native array.
-
toArray
public int[] toArray(int[] dest, int source_pos, int dest_pos, int len)Copies a slice of the list into a native array.
-
equals
public boolean equals(java.lang.Object other)
Compares the specified object with this collection for equality. Returns true if the specified object is also a collection, the two collection have the same size, and every member of the specified collection is contained in this collection (or equivalently, every member of this collection is contained in the specified collection). This definition ensures that the equals method works properly across different implementations of the collection interface.- Specified by:
equalsin interfaceTIntCollection- Overrides:
equalsin classjava.lang.Object- Parameters:
other- object to be compared for equality with this collection- Returns:
- true if the specified object is equal to this collection
-
hashCode
public int hashCode()
Returns the hash code value for this collection. The hash code of a collection is defined to be the sum of the hash codes of the elements in the collection. This ensures that s1.equals(s2) implies that s1.hashCode()==s2.hashCode() for any two collection s1 and s2, as required by the general contract ofObject.hashCode().- Specified by:
hashCodein interfaceTIntCollection- Overrides:
hashCodein classjava.lang.Object- Returns:
- the hash code value for this collection
- See Also:
Object.equals(Object),Collection.equals(Object)
-
forEach
public boolean forEach(TIntProcedure procedure)
Applies the procedure to each value in the list in ascending (front to back) order.- Specified by:
forEachin interfaceTIntCollection- Specified by:
forEachin interfaceTIntList- Parameters:
procedure- aTIntProcedurevalue- Returns:
- true if the procedure did not terminate prematurely.
-
forEachDescending
public boolean forEachDescending(TIntProcedure procedure)
Applies the procedure to each value in the list in descending (back to front) order.- Specified by:
forEachDescendingin interfaceTIntList- Parameters:
procedure- aTIntProcedurevalue- Returns:
- true if the procedure did not terminate prematurely.
-
sort
public void sort()
Sort the values in the list (ascending) using the Sun quicksort implementation.
-
sort
public void sort(int fromIndex, int toIndex)Sort a slice of the list (ascending) using the Sun quicksort implementation.
-
fill
public void fill(int val)
Fills every slot in the list with the specified value.
-
fill
public void fill(int fromIndex, int toIndex, int val)Fills a range in the list with the specified value.
-
binarySearch
public int binarySearch(int value)
Performs a binary search for value in the entire list. Note that you must @{link #sort sort} the list before doing a search.- Specified by:
binarySearchin interfaceTIntList- Parameters:
value- the value to search for- Returns:
- the absolute offset in the list of the value, or its negative insertion point into the sorted list.
-
binarySearch
public int binarySearch(int value, int fromIndex, int toIndex)Performs a binary search for value in the specified range. Note that you must @{link #sort sort} the list or the range before doing a search.- Specified by:
binarySearchin interfaceTIntList- Parameters:
value- the value to search forfromIndex- the lower boundary of the range (inclusive)toIndex- the upper boundary of the range (exclusive)- Returns:
- the absolute offset in the list of the value, or its negative insertion point into the sorted list.
-
indexOf
public int indexOf(int value)
Searches the list front to back for the index of value.- Specified by:
indexOfin interfaceTIntList- Parameters:
value- anintvalue- Returns:
- the first offset of the value, or -1 if it is not in the list.
- See Also:
for faster searches on sorted lists
-
indexOf
public int indexOf(int offset, int value)Searches the list front to back for the index of value, starting at offset.- Specified by:
indexOfin interfaceTIntList- Parameters:
offset- the offset at which to start the linear search (inclusive)value- anintvalue- Returns:
- the first offset of the value, or -1 if it is not in the list.
- See Also:
for faster searches on sorted lists
-
lastIndexOf
public int lastIndexOf(int value)
Searches the list back to front for the last index of value.- Specified by:
lastIndexOfin interfaceTIntList- Parameters:
value- anintvalue- Returns:
- the last offset of the value, or -1 if it is not in the list.
- See Also:
for faster searches on sorted lists
-
lastIndexOf
public int lastIndexOf(int offset, int value)Searches the list back to front for the last index of value, starting at offset.- Specified by:
lastIndexOfin interfaceTIntList- Parameters:
offset- the offset at which to start the linear search (exclusive)value- anintvalue- Returns:
- the last offset of the value, or -1 if it is not in the list.
- See Also:
for faster searches on sorted lists
-
contains
public boolean contains(int value)
Searches the list for value- Specified by:
containsin interfaceTIntCollection- Specified by:
containsin interfaceTIntList- Parameters:
value- anintvalue- Returns:
- true if value is in the list.
-
grep
public TIntList grep(TIntProcedure condition)
Searches the list for values satisfying condition in the manner of the *nix grep utility.
-
inverseGrep
public TIntList inverseGrep(TIntProcedure condition)
Searches the list for values which do not satisfy condition. This is akin to *nixgrep -v.- Specified by:
inverseGrepin interfaceTIntList- Parameters:
condition- a condition to apply to each element in the list- Returns:
- a list of values which do not match the condition.
-
max
public int max()
Finds the maximum value in the list.
-
min
public int min()
Finds the minimum value in the list.
-
sum
public int sum()
Calculates the sum of all the values in the list.
-
toString
public java.lang.String toString()
- Overrides:
toStringin classjava.lang.Object
-
writeExternal
public void writeExternal(java.io.ObjectOutput out) throws java.io.IOException- Specified by:
writeExternalin interfacejava.io.Externalizable- Throws:
java.io.IOException
-
readExternal
public void readExternal(java.io.ObjectInput in) throws java.io.IOException, java.lang.ClassNotFoundException- Specified by:
readExternalin interfacejava.io.Externalizable- Throws:
java.io.IOExceptionjava.lang.ClassNotFoundException
-
-