Package gnu.trove.list.array
Class TByteArrayList
java.lang.Object
gnu.trove.list.array.TByteArrayList
- All Implemented Interfaces:
TByteList
,TByteCollection
,Externalizable
,Serializable
A resizable, array-backed list of byte primitives.
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected byte[]
the data of the listprotected int
the index after the last entry in the listprotected static final int
the default capacity for new listsprotected byte
the byte value that represents null -
Constructor Summary
ConstructorsModifierConstructorDescriptionCreates a newTByteArrayList
instance with the default capacity.TByteArrayList
(byte[] values) Creates a newTByteArrayList
instance whose capacity is the length of values array and whose initial contents are the specified values.protected
TByteArrayList
(byte[] values, byte no_entry_value, boolean wrap) TByteArrayList
(int capacity) Creates a newTByteArrayList
instance with the specified capacity.TByteArrayList
(int capacity, byte no_entry_value) Creates a newTByteArrayList
instance with the specified capacity.TByteArrayList
(TByteCollection collection) Creates a newTByteArrayList
instance that contains a copy of the collection passed to us. -
Method Summary
Modifier and TypeMethodDescriptionboolean
add
(byte val) Adds val to the end of the list, growing as needed.void
add
(byte[] vals) Adds the values in the array vals to the end of the list, in order.void
add
(byte[] 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
(byte[] array) Adds all of the elements in the array to the collection.boolean
addAll
(TByteCollection collection) Adds all of the elements in the TByteCollection to the collection.boolean
addAll
(Collection<? extends Byte> collection) Adds all of the elements in collection to the collection.int
binarySearch
(byte value) Performs a binary search for value in the entire list.int
binarySearch
(byte 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
clear
(int capacity) Flushes the internal state of the list, setting the capacity of the empty list to capacity.boolean
contains
(byte value) Searches the list for valueboolean
containsAll
(byte[] array) Tests the collection to determine if all of the elements in array are present.boolean
containsAll
(TByteCollection collection) Tests the collection to determine if all of the elements in TByteCollection are present.boolean
containsAll
(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
Compares the specified object with this collection for equality.void
fill
(byte val) Fills every slot in the list with the specified value.void
fill
(int fromIndex, int toIndex, byte val) Fills a range in the list with the specified value.boolean
forEach
(TByteProcedure procedure) Applies the procedure to each value in the list in ascending (front to back) order.boolean
forEachDescending
(TByteProcedure procedure) Applies the procedure to each value in the list in descending (back to front) order.byte
get
(int offset) Returns the value at the specified offset.byte
Returns the value that is used to represent null.byte
getQuick
(int offset) Returns the value at the specified offset without doing any bounds checking.grep
(TByteProcedure 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
(byte value) Searches the list front to back for the index of value.int
indexOf
(int offset, byte value) Searches the list front to back for the index of value, starting at offset.void
insert
(int offset, byte value) Inserts value into the list at offset.void
insert
(int offset, byte[] values) Inserts the array of values into the list at offset.void
insert
(int offset, byte[] values, int valOffset, int len) Inserts a slice of the array of values into the list at offset.inverseGrep
(TByteProcedure condition) Searches the list for values which do not satisfy condition.boolean
isEmpty()
Tests whether this list contains any values.iterator()
Creates an iterator over the values of the collection.int
lastIndexOf
(byte value) Searches the list back to front for the last index of value.int
lastIndexOf
(int offset, byte value) Searches the list back to front for the last index of value, starting at offset.byte
max()
Finds the maximum value in the list.byte
min()
Finds the minimum value in the list.void
boolean
remove
(byte value) Removes value from the list.void
remove
(int offset, int length) Removes length values from the list, starting at offsetboolean
removeAll
(byte[] array) Removes all of the elements in array from the collection.boolean
removeAll
(TByteCollection collection) Removes all of the elements in TByteCollection from the collection.boolean
removeAll
(Collection<?> collection) Removes all of the elements in collection from the collection.byte
removeAt
(int offset) Removes value at a given offset from the list.byte
replace
(int offset, byte val) Sets the value at the specified offset and returns the previously stored value.void
reset()
Sets the size of the list to 0, but does not change its capacity.void
Sets the size of the list to 0, but does not change its capacity.boolean
retainAll
(byte[] array) Removes any values in the collection which are not contained in array.boolean
retainAll
(TByteCollection collection) Removes any values in the collection which are not contained in TByteCollection.boolean
retainAll
(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.byte
set
(int offset, byte val) Sets the value at the specified offset.void
set
(int offset, byte[] values) Replace the values in the list starting at offset with the contents of the values array.void
set
(int offset, byte[] 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, byte val) Sets the value at the specified offset without doing any bounds checking.void
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.subList
(int begin, int end) Returns a sublist of this list.byte
sum()
Calculates the sum of all the values in the list.byte[]
toArray()
Copies the contents of the list into a native array.byte[]
toArray
(byte[] dest) Copies a slice of the list into a native array.byte[]
toArray
(byte[] dest, int offset, int len) Copies a slice of the list into a native array.byte[]
toArray
(byte[] dest, int source_pos, int dest_pos, int len) Copies a slice of the list into a native array.byte[]
toArray
(int offset, int len) Copies a slice of the list into a native array.toString()
void
transformValues
(TByteFunction function) Transform each value in the list using the specified function.void
Sheds any excess capacity above and beyond the current size of the list.static TByteArrayList
wrap
(byte[] values) Returns a primitive List implementation that wraps around the given primitive array.static TByteArrayList
wrap
(byte[] values, byte no_entry_value) Returns a primitive List implementation that wraps around the given primitive array.void
-
Field Details
-
_data
protected byte[] _datathe data of the list -
_pos
protected int _posthe index after the last entry in the list -
DEFAULT_CAPACITY
protected static final int DEFAULT_CAPACITYthe default capacity for new lists- See Also:
-
no_entry_value
protected byte no_entry_valuethe byte value that represents null
-
-
Constructor Details
-
TByteArrayList
public TByteArrayList()Creates a newTByteArrayList
instance with the default capacity. -
TByteArrayList
public TByteArrayList(int capacity) Creates a newTByteArrayList
instance with the specified capacity.- Parameters:
capacity
- anint
value
-
TByteArrayList
public TByteArrayList(int capacity, byte no_entry_value) Creates a newTByteArrayList
instance with the specified capacity.- Parameters:
capacity
- anint
valueno_entry_value
- anbyte
value that represents null.
-
TByteArrayList
Creates a newTByteArrayList
instance that contains a copy of the collection passed to us.- Parameters:
collection
- the collection to copy
-
TByteArrayList
public TByteArrayList(byte[] values) Creates a newTByteArrayList
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
- anbyte[]
value
-
TByteArrayList
protected TByteArrayList(byte[] values, byte no_entry_value, boolean wrap)
-
-
Method Details
-
wrap
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
-- Returns:
-
wrap
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
-- Returns:
-
getNoEntryValue
public byte 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 interfaceTByteCollection
- Specified by:
getNoEntryValue
in interfaceTByteList
- 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 interfaceTByteCollection
- Specified by:
size
in interfaceTByteList
- Returns:
- the number of values in the list.
-
isEmpty
public boolean isEmpty()Tests whether this list contains any values.- Specified by:
isEmpty
in interfaceTByteCollection
- Specified by:
isEmpty
in interfaceTByteList
- 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(byte val) Adds val to the end of the list, growing as needed.- Specified by:
add
in interfaceTByteCollection
- Specified by:
add
in interfaceTByteList
- Parameters:
val
- anbyte
value- Returns:
- true if the list was modified by the add operation
-
add
public void add(byte[] vals) Adds the values in the array vals to the end of the list, in order. -
add
public void add(byte[] 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, byte 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, byte[] 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, byte[] 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 byte get(int offset) Returns the value at the specified offset. -
getQuick
public byte getQuick(int offset) Returns the value at the specified offset without doing any bounds checking. -
set
public byte set(int offset, byte val) Sets the value at the specified offset. -
replace
public byte replace(int offset, byte val) Sets the value at the specified offset and returns the previously stored value. -
set
public void set(int offset, byte[] values) Replace the values in the list starting at offset with the contents of the values array. -
set
public void set(int offset, byte[] 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, byte 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 interfaceTByteCollection
- Specified by:
clear
in interfaceTByteList
-
clear
public void clear(int capacity) Flushes the internal state of the list, setting the capacity of the empty list to capacity. -
reset
public void reset()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 to recycle a list without allocating new backing arrays. -
resetQuick
public void resetQuick()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 to recycle a list without allocating new backing arrays. This method differs fromreset()
in that it does not clear the old values in the backing array. 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(byte value) Removes value from the list.- Specified by:
remove
in interfaceTByteCollection
- Specified by:
remove
in interfaceTByteList
- Parameters:
value
- anbyte
value- Returns:
- true if the list was modified by the remove operation.
-
removeAt
public byte 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
Creates an iterator over the values of the collection. The iterator supports element deletion.- Specified by:
iterator
in interfaceTByteCollection
- Returns:
- an
TByteIterator
value
-
containsAll
Tests the collection to determine if all of the elements in collection are present.- Specified by:
containsAll
in interfaceTByteCollection
- Parameters:
collection
- aCollection
value- Returns:
- true if all elements were present in the collection.
-
containsAll
Tests the collection to determine if all of the elements in TByteCollection are present.- Specified by:
containsAll
in interfaceTByteCollection
- Parameters:
collection
- aTByteCollection
value- Returns:
- true if all elements were present in the collection.
-
containsAll
public boolean containsAll(byte[] array) Tests the collection to determine if all of the elements in array are present.- Specified by:
containsAll
in interfaceTByteCollection
- Parameters:
array
- asarray
of byte primitives.- Returns:
- true if all elements were present in the collection.
-
addAll
Adds all of the elements in collection to the collection.- Specified by:
addAll
in interfaceTByteCollection
- Parameters:
collection
- aCollection
value- Returns:
- true if the collection was modified by the add all operation.
-
addAll
Adds all of the elements in the TByteCollection to the collection.- Specified by:
addAll
in interfaceTByteCollection
- Parameters:
collection
- aTByteCollection
value- Returns:
- true if the collection was modified by the add all operation.
-
addAll
public boolean addAll(byte[] array) Adds all of the elements in the array to the collection.- Specified by:
addAll
in interfaceTByteCollection
- Parameters:
array
- aarray
of byte primitives.- Returns:
- true if the collection was modified by the add all operation.
-
retainAll
Removes any values in the collection which are not contained in collection.- Specified by:
retainAll
in interfaceTByteCollection
- Parameters:
collection
- aCollection
value- Returns:
- true if the collection was modified by the retain all operation
-
retainAll
Removes any values in the collection which are not contained in TByteCollection.- Specified by:
retainAll
in interfaceTByteCollection
- Parameters:
collection
- aTByteCollection
value- Returns:
- true if the collection was modified by the retain all operation
-
retainAll
public boolean retainAll(byte[] array) Removes any values in the collection which are not contained in array.- Specified by:
retainAll
in interfaceTByteCollection
- Parameters:
array
- anarray
of byte primitives.- Returns:
- true if the collection was modified by the retain all operation
-
removeAll
Removes all of the elements in collection from the collection.- Specified by:
removeAll
in interfaceTByteCollection
- Parameters:
collection
- aCollection
value- Returns:
- true if the collection was modified by the remove all operation.
-
removeAll
Removes all of the elements in TByteCollection from the collection.- Specified by:
removeAll
in interfaceTByteCollection
- Parameters:
collection
- aTByteCollection
value- Returns:
- true if the collection was modified by the remove all operation.
-
removeAll
public boolean removeAll(byte[] array) Removes all of the elements in array from the collection.- Specified by:
removeAll
in interfaceTByteCollection
- Parameters:
array
- anarray
of byte primitives.- Returns:
- true if the collection was modified by the remove all operation.
-
transformValues
Transform each value in the list using the specified function.- Specified by:
transformValues
in interfaceTByteList
- Parameters:
function
- aTByteFunction
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
Shuffle the elements of the list using the specified random number generator. -
subList
Returns a sublist of this list. -
toArray
public byte[] toArray()Copies the contents of the list into a native array.- Specified by:
toArray
in interfaceTByteCollection
- Specified by:
toArray
in interfaceTByteList
- Returns:
- an
byte[]
value
-
toArray
public byte[] toArray(int offset, int len) Copies a slice of the list into a native array. -
toArray
public byte[] toArray(byte[] 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
TByteList.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 interfaceTByteCollection
- Specified by:
toArray
in interfaceTByteList
- Parameters:
dest
- the array to copy into.- Returns:
- the array passed in.
-
toArray
public byte[] toArray(byte[] dest, int offset, int len) Copies a slice of the list into a native array. -
toArray
public byte[] toArray(byte[] dest, int source_pos, int dest_pos, int len) Copies a slice of the list into a native array. -
equals
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 interfaceTByteCollection
- Overrides:
equals
in classObject
- 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 interfaceTByteCollection
- Overrides:
hashCode
in classObject
- Returns:
- the hash code value for this collection
- See Also:
-
forEach
Applies the procedure to each value in the list in ascending (front to back) order.- Specified by:
forEach
in interfaceTByteCollection
- Specified by:
forEach
in interfaceTByteList
- Parameters:
procedure
- aTByteProcedure
value- Returns:
- true if the procedure did not terminate prematurely.
-
forEachDescending
Applies the procedure to each value in the list in descending (back to front) order.- Specified by:
forEachDescending
in interfaceTByteList
- Parameters:
procedure
- aTByteProcedure
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(byte val) Fills every slot in the list with the specified value. -
fill
public void fill(int fromIndex, int toIndex, byte val) Fills a range in the list with the specified value. -
binarySearch
public int binarySearch(byte 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 interfaceTByteList
- 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(byte 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 interfaceTByteList
- 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(byte value) Searches the list front to back for the index of value. -
indexOf
public int indexOf(int offset, byte value) Searches the list front to back for the index of value, starting at offset. -
lastIndexOf
public int lastIndexOf(byte value) Searches the list back to front for the last index of value.- Specified by:
lastIndexOf
in interfaceTByteList
- Parameters:
value
- anbyte
value- Returns:
- the last offset of the value, or -1 if it is not in the list.
- See Also:
-
lastIndexOf
public int lastIndexOf(int offset, byte value) Searches the list back to front for the last index of value, starting at offset.- Specified by:
lastIndexOf
in interfaceTByteList
- Parameters:
offset
- the offset at which to start the linear search (exclusive)value
- anbyte
value- Returns:
- the last offset of the value, or -1 if it is not in the list.
- See Also:
-
contains
public boolean contains(byte value) Searches the list for value- Specified by:
contains
in interfaceTByteCollection
- Specified by:
contains
in interfaceTByteList
- Parameters:
value
- anbyte
value- Returns:
- true if value is in the list.
-
grep
Searches the list for values satisfying condition in the manner of the *nix grep utility. -
inverseGrep
Searches the list for values which do not satisfy condition. This is akin to *nixgrep -v
.- Specified by:
inverseGrep
in interfaceTByteList
- 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 byte max()Finds the maximum value in the list. -
min
public byte min()Finds the minimum value in the list. -
sum
public byte sum()Calculates the sum of all the values in the list. -
toString
-
writeExternal
- Specified by:
writeExternal
in interfaceExternalizable
- Throws:
IOException
-
readExternal
- Specified by:
readExternal
in interfaceExternalizable
- Throws:
IOException
ClassNotFoundException
-