Class TLongArrayList
- java.lang.Object
-
- gnu.trove.list.array.TLongArrayList
-
- All Implemented Interfaces:
TLongList
,TLongCollection
,java.io.Externalizable
,java.io.Serializable
public class TLongArrayList extends java.lang.Object implements TLongList, java.io.Externalizable
A resizable, array-backed list of long primitives.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected long[]
_data
the data of the listprotected int
_pos
the index after the last entry in the listprotected static int
DEFAULT_CAPACITY
the default capacity for new listsprotected long
no_entry_value
the long value that represents null
-
Constructor Summary
Constructors Modifier Constructor Description TLongArrayList()
Creates a newTLongArrayList
instance with the default capacity.TLongArrayList(int capacity)
Creates a newTLongArrayList
instance with the specified capacity.TLongArrayList(int capacity, long no_entry_value)
Creates a newTLongArrayList
instance with the specified capacity.TLongArrayList(long[] values)
Creates a newTLongArrayList
instance whose capacity is the length of values array and whose initial contents are the specified values.protected
TLongArrayList(long[] values, long no_entry_value, boolean wrap)
TLongArrayList(TLongCollection collection)
Creates a newTLongArrayList
instance 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 boolean
add(long val)
Adds val to the end of the list, growing as needed.void
add(long[] vals)
Adds the values in the array vals to the end of the list, in order.void
add(long[] vals, int offset, int length)
Adds a subset of the values in the array vals to the end of the list, in order.boolean
addAll(long[] array)
Adds all of the elements in the array to the collection.boolean
addAll(TLongCollection collection)
Adds all of the elements in the TLongCollection to the collection.boolean
addAll(java.util.Collection<? extends java.lang.Long> collection)
Adds all of the elements in collection to the collection.int
binarySearch(long value)
Performs a binary search for value in the entire list.int
binarySearch(long value, int fromIndex, int toIndex)
Performs a binary search for value in the specified range.void
clear()
Flushes the internal state of the list, resetting the capacity to the default.void
clearQuick()
Sets the size of the list to 0, but does not change its capacity.boolean
contains(long value)
Searches the list for valueboolean
containsAll(long[] array)
Tests the collection to determine if all of the elements in array are present.boolean
containsAll(TLongCollection collection)
Tests the collection to determine if all of the elements in TLongCollection are present.boolean
containsAll(java.util.Collection<?> collection)
Tests the collection to determine if all of the elements in collection are present.void
ensureCapacity(int capacity)
Grow the internal array as needed to accommodate the specified number of elements.boolean
equals(java.lang.Object other)
Compares the specified object with this collection for equality.void
fill(int fromIndex, int toIndex, long val)
Fills a range in the list with the specified value.void
fill(long val)
Fills every slot in the list with the specified value.boolean
forEach(TLongProcedure procedure)
Applies the procedure to each value in the list in ascending (front to back) order.boolean
forEachDescending(TLongProcedure procedure)
Applies the procedure to each value in the list in descending (back to front) order.long
get(int offset)
Returns the value at the specified offset.long
getNoEntryValue()
Returns the value that is used to represent null.long
getQuick(int offset)
Returns the value at the specified offset without doing any bounds checking.TLongList
grep(TLongProcedure condition)
Searches the list for values satisfying condition in the manner of the *nix grep utility.int
hashCode()
Returns the hash code value for this collection.int
indexOf(int offset, long value)
Searches the list front to back for the index of value, starting at offset.int
indexOf(long value)
Searches the list front to back for the index of value.void
insert(int offset, long value)
Inserts value into the list at offset.void
insert(int offset, long[] values)
Inserts the array of values into the list at offset.void
insert(int offset, long[] values, int valOffset, int len)
Inserts a slice of the array of values into the list at offset.TLongList
inverseGrep(TLongProcedure condition)
Searches the list for values which do not satisfy condition.boolean
isEmpty()
Tests whether this list contains any values.TLongIterator
iterator()
Creates an iterator over the values of the collection.int
lastIndexOf(int offset, long value)
Searches the list back to front for the last index of value, starting at offset.int
lastIndexOf(long value)
Searches the list back to front for the last index of value.long
max()
Finds the maximum value in the list.long
min()
Finds the minimum value in the list.void
readExternal(java.io.ObjectInput in)
void
remove(int offset, int length)
Removes length values from the list, starting at offsetboolean
remove(long value)
Removes value from the list.boolean
removeAll(long[] array)
Removes all of the elements in array from the collection.boolean
removeAll(TLongCollection collection)
Removes all of the elements in TLongCollection from the collection.boolean
removeAll(java.util.Collection<?> collection)
Removes all of the elements in collection from the collection.long
removeAt(int offset)
Removes value at a given offset from the list.long
replace(int offset, long val)
Sets the value at the specified offset and returns the previously stored value.boolean
retainAll(long[] array)
Removes any values in the collection which are not contained in array.boolean
retainAll(TLongCollection collection)
Removes any values in the collection which are not contained in TLongCollection.boolean
retainAll(java.util.Collection<?> collection)
Removes any values in the collection which are not contained in collection.void
reverse()
Reverse the order of the elements in the list.void
reverse(int from, int to)
Reverse the order of the elements in the range of the list.long
set(int offset, long val)
Sets the value at the specified offset.void
set(int offset, long[] values)
Replace the values in the list starting at offset with the contents of the values array.void
set(int offset, long[] values, int valOffset, int length)
Replace the values in the list starting at offset with length values from the values array, starting at valOffset.void
setQuick(int offset, long val)
Sets the value at the specified offset without doing any bounds checking.void
shuffle(java.util.Random rand)
Shuffle the elements of the list using the specified random number generator.int
size()
Returns the number of values in the list.void
sort()
Sort the values in the list (ascending) using the Sun quicksort implementation.void
sort(int fromIndex, int toIndex)
Sort a slice of the list (ascending) using the Sun quicksort implementation.TLongList
subList(int begin, int end)
Returns a sublist of this list.long
sum()
Calculates the sum of all the values in the list.long[]
toArray()
Copies the contents of the list into a native array.long[]
toArray(int offset, int len)
Copies a slice of the list into a native array.long[]
toArray(long[] dest)
Copies a slice of the list into a native array.long[]
toArray(long[] dest, int offset, int len)
Copies a slice of the list into a native array.long[]
toArray(long[] dest, int source_pos, int dest_pos, int len)
Copies a slice of the list into a native array.java.lang.String
toString()
void
transformValues(TLongFunction function)
Transform each value in the list using the specified function.void
trimToSize()
Sheds any excess capacity above and beyond the current size of the list.static TLongArrayList
wrap(long[] values)
Returns a primitive List implementation that wraps around the given primitive array.static TLongArrayList
wrap(long[] values, long no_entry_value)
Returns a primitive List implementation that wraps around the given primitive array.void
writeExternal(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 long[] _data
the data of the list
-
_pos
protected int _pos
the index after the last entry in the list
-
no_entry_value
protected long no_entry_value
the long value that represents null
-
-
Constructor Detail
-
TLongArrayList
public TLongArrayList()
Creates a newTLongArrayList
instance with the default capacity.
-
TLongArrayList
public TLongArrayList(int capacity)
Creates a newTLongArrayList
instance with the specified capacity.- Parameters:
capacity
- anint
value
-
TLongArrayList
public TLongArrayList(int capacity, long no_entry_value)
Creates a newTLongArrayList
instance with the specified capacity.- Parameters:
capacity
- anint
valueno_entry_value
- anlong
value that represents null.
-
TLongArrayList
public TLongArrayList(TLongCollection collection)
Creates a newTLongArrayList
instance that contains a copy of the collection passed to us.- Parameters:
collection
- the collection to copy
-
TLongArrayList
public TLongArrayList(long[] values)
Creates a newTLongArrayList
instance 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
- anlong[]
value
-
TLongArrayList
protected TLongArrayList(long[] values, long no_entry_value, boolean wrap)
-
-
Method Detail
-
wrap
public static TLongArrayList wrap(long[] 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 TLongArrayList wrap(long[] values, long 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 long 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:
getNoEntryValue
in interfaceTLongCollection
- Specified by:
getNoEntryValue
in interfaceTLongList
- 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:
size
in interfaceTLongCollection
- Specified by:
size
in interfaceTLongList
- Returns:
- the number of values in the list.
-
isEmpty
public boolean isEmpty()
Tests whether this list contains any values.- Specified by:
isEmpty
in interfaceTLongCollection
- Specified by:
isEmpty
in interfaceTLongList
- 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(long val)
Adds val to the end of the list, growing as needed.- Specified by:
add
in interfaceTLongCollection
- Specified by:
add
in interfaceTLongList
- Parameters:
val
- anlong
value- Returns:
- true if the list was modified by the add operation
-
add
public void add(long[] vals)
Adds the values in the array vals to the end of the list, in order.
-
add
public void add(long[] 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, long 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, long[] 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, long[] 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 long get(int offset)
Returns the value at the specified offset.
-
getQuick
public long getQuick(int offset)
Returns the value at the specified offset without doing any bounds checking.
-
set
public long set(int offset, long val)
Sets the value at the specified offset.
-
replace
public long replace(int offset, long val)
Sets the value at the specified offset and returns the previously stored value.
-
set
public void set(int offset, long[] values)
Replace the values in the list starting at offset with the contents of the values array.
-
set
public void set(int offset, long[] 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, long 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:
clear
in interfaceTLongCollection
- Specified by:
clear
in interfaceTLongList
-
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(long value)
Removes value from the list.- Specified by:
remove
in interfaceTLongCollection
- Specified by:
remove
in interfaceTLongList
- Parameters:
value
- anlong
value- Returns:
- true if the list was modified by the remove operation.
-
removeAt
public long 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 TLongIterator iterator()
Creates an iterator over the values of the collection. The iterator supports element deletion.- Specified by:
iterator
in interfaceTLongCollection
- Returns:
- an
TLongIterator
value
-
containsAll
public boolean containsAll(java.util.Collection<?> collection)
Tests the collection to determine if all of the elements in collection are present.- Specified by:
containsAll
in interfaceTLongCollection
- Parameters:
collection
- aCollection
value- Returns:
- true if all elements were present in the collection.
-
containsAll
public boolean containsAll(TLongCollection collection)
Tests the collection to determine if all of the elements in TLongCollection are present.- Specified by:
containsAll
in interfaceTLongCollection
- Parameters:
collection
- aTLongCollection
value- Returns:
- true if all elements were present in the collection.
-
containsAll
public boolean containsAll(long[] array)
Tests the collection to determine if all of the elements in array are present.- Specified by:
containsAll
in interfaceTLongCollection
- Parameters:
array
- asarray
of long primitives.- Returns:
- true if all elements were present in the collection.
-
addAll
public boolean addAll(java.util.Collection<? extends java.lang.Long> collection)
Adds all of the elements in collection to the collection.- Specified by:
addAll
in interfaceTLongCollection
- Parameters:
collection
- aCollection
value- Returns:
- true if the collection was modified by the add all operation.
-
addAll
public boolean addAll(TLongCollection collection)
Adds all of the elements in the TLongCollection to the collection.- Specified by:
addAll
in interfaceTLongCollection
- Parameters:
collection
- aTLongCollection
value- Returns:
- true if the collection was modified by the add all operation.
-
addAll
public boolean addAll(long[] array)
Adds all of the elements in the array to the collection.- Specified by:
addAll
in interfaceTLongCollection
- Parameters:
array
- aarray
of long 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:
retainAll
in interfaceTLongCollection
- Parameters:
collection
- aCollection
value- Returns:
- true if the collection was modified by the retain all operation
-
retainAll
public boolean retainAll(TLongCollection collection)
Removes any values in the collection which are not contained in TLongCollection.- Specified by:
retainAll
in interfaceTLongCollection
- Parameters:
collection
- aTLongCollection
value- Returns:
- true if the collection was modified by the retain all operation
-
retainAll
public boolean retainAll(long[] array)
Removes any values in the collection which are not contained in array.- Specified by:
retainAll
in interfaceTLongCollection
- Parameters:
array
- anarray
of long 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:
removeAll
in interfaceTLongCollection
- Parameters:
collection
- aCollection
value- Returns:
- true if the collection was modified by the remove all operation.
-
removeAll
public boolean removeAll(TLongCollection collection)
Removes all of the elements in TLongCollection from the collection.- Specified by:
removeAll
in interfaceTLongCollection
- Parameters:
collection
- aTLongCollection
value- Returns:
- true if the collection was modified by the remove all operation.
-
removeAll
public boolean removeAll(long[] array)
Removes all of the elements in array from the collection.- Specified by:
removeAll
in interfaceTLongCollection
- Parameters:
array
- anarray
of long primitives.- Returns:
- true if the collection was modified by the remove all operation.
-
transformValues
public void transformValues(TLongFunction function)
Transform each value in the list using the specified function.- Specified by:
transformValues
in interfaceTLongList
- Parameters:
function
- aTLongFunction
value
-
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 TLongList subList(int begin, int end)
Returns a sublist of this list.
-
toArray
public long[] toArray()
Copies the contents of the list into a native array.- Specified by:
toArray
in interfaceTLongCollection
- Specified by:
toArray
in interfaceTLongList
- Returns:
- an
long[]
value
-
toArray
public long[] toArray(int offset, int len)
Copies a slice of the list into a native array.
-
toArray
public long[] toArray(long[] 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
TLongList.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:
toArray
in interfaceTLongCollection
- Specified by:
toArray
in interfaceTLongList
- Parameters:
dest
- the array to copy into.- Returns:
- the array passed in.
-
toArray
public long[] toArray(long[] dest, int offset, int len)
Copies a slice of the list into a native array.
-
toArray
public long[] toArray(long[] 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:
equals
in interfaceTLongCollection
- Overrides:
equals
in 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:
hashCode
in interfaceTLongCollection
- Overrides:
hashCode
in classjava.lang.Object
- Returns:
- the hash code value for this collection
- See Also:
Object.equals(Object)
,Collection.equals(Object)
-
forEach
public boolean forEach(TLongProcedure procedure)
Applies the procedure to each value in the list in ascending (front to back) order.- Specified by:
forEach
in interfaceTLongCollection
- Specified by:
forEach
in interfaceTLongList
- Parameters:
procedure
- aTLongProcedure
value- Returns:
- true if the procedure did not terminate prematurely.
-
forEachDescending
public boolean forEachDescending(TLongProcedure procedure)
Applies the procedure to each value in the list in descending (back to front) order.- Specified by:
forEachDescending
in interfaceTLongList
- Parameters:
procedure
- aTLongProcedure
value- 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(long val)
Fills every slot in the list with the specified value.
-
fill
public void fill(int fromIndex, int toIndex, long val)
Fills a range in the list with the specified value.
-
binarySearch
public int binarySearch(long 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:
binarySearch
in interfaceTLongList
- 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(long 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:
binarySearch
in interfaceTLongList
- 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(long value)
Searches the list front to back for the index of value.- Specified by:
indexOf
in interfaceTLongList
- Parameters:
value
- anlong
value- 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, long value)
Searches the list front to back for the index of value, starting at offset.- Specified by:
indexOf
in interfaceTLongList
- Parameters:
offset
- the offset at which to start the linear search (inclusive)value
- anlong
value- 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(long value)
Searches the list back to front for the last index of value.- Specified by:
lastIndexOf
in interfaceTLongList
- Parameters:
value
- anlong
value- 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, long value)
Searches the list back to front for the last index of value, starting at offset.- Specified by:
lastIndexOf
in interfaceTLongList
- Parameters:
offset
- the offset at which to start the linear search (exclusive)value
- anlong
value- 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(long value)
Searches the list for value- Specified by:
contains
in interfaceTLongCollection
- Specified by:
contains
in interfaceTLongList
- Parameters:
value
- anlong
value- Returns:
- true if value is in the list.
-
grep
public TLongList grep(TLongProcedure condition)
Searches the list for values satisfying condition in the manner of the *nix grep utility.
-
inverseGrep
public TLongList inverseGrep(TLongProcedure condition)
Searches the list for values which do not satisfy condition. This is akin to *nixgrep -v
.- Specified by:
inverseGrep
in interfaceTLongList
- 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 long max()
Finds the maximum value in the list.
-
min
public long min()
Finds the minimum value in the list.
-
sum
public long sum()
Calculates the sum of all the values in the list.
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
writeExternal
public void writeExternal(java.io.ObjectOutput out) throws java.io.IOException
- Specified by:
writeExternal
in interfacejava.io.Externalizable
- Throws:
java.io.IOException
-
readExternal
public void readExternal(java.io.ObjectInput in) throws java.io.IOException, java.lang.ClassNotFoundException
- Specified by:
readExternal
in interfacejava.io.Externalizable
- Throws:
java.io.IOException
java.lang.ClassNotFoundException
-
-