Package gnu.trove
Class TShortArrayList
java.lang.Object
gnu.trove.TShortArrayList
- All Implemented Interfaces:
Externalizable
,Serializable
,Cloneable
A resizable, array-backed list of short primitives.
Created: Sat Dec 29 14:21:12 2001
- Author:
- Eric D. Friedman, Rob Eden
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected short[]
the data of the listprotected int
the index after the last entry in the listprotected static final int
the default capacity for new lists -
Constructor Summary
ConstructorsConstructorDescriptionCreates a newTShortArrayList
instance with the default capacity.TShortArrayList
(int capacity) Creates a newTShortArrayList
instance with the specified capacity.TShortArrayList
(short[] values) Creates a newTShortArrayList
instance whose capacity is the greater of the length of values and DEFAULT_CAPACITY and whose initial contents are the specified values. -
Method Summary
Modifier and TypeMethodDescriptionvoid
add
(short val) Adds val to the end of the list, growing as needed.void
add
(short[] vals) Adds the values in the array vals to the end of the list, in order.void
add
(short[] vals, int offset, int length) Adds a subset of the values in the array vals to the end of the list, in order.int
binarySearch
(short value) Performs a binary search for value in the entire list.int
binarySearch
(short 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.clone()
Returns a clone of this list.boolean
contains
(short value) Searches the list for valuevoid
ensureCapacity
(int capacity) Grow the internal array as needed to accommodate the specified number of elements.boolean
Compares this list to another list, value by value.void
fill
(int fromIndex, int toIndex, short val) Fills a range in the list with the specified value.void
fill
(short val) Fills every slot in the list with the specified value.boolean
forEach
(TShortProcedure procedure) Applies the procedure to each value in the list in ascending (front to back) order.boolean
forEachDescending
(TShortProcedure procedure) Applies the procedure to each value in the list in descending (back to front) order.short
get
(int offset) Returns the value at the specified offset.short
getQuick
(int offset) Returns the value at the specified offset without doing any bounds checking.short
getSet
(int offset, short val) Sets the value at the specified offset and returns the previously stored value.grep
(TShortProcedure condition) Searches the list for values satisfying condition in the manner of the *nix grep utility.int
hashCode()
int
indexOf
(int offset, short value) Searches the list front to back for the index of value, starting at offset.int
indexOf
(short value) Searches the list front to back for the index of value.void
insert
(int offset, short value) Inserts value into the list at offset.void
insert
(int offset, short[] values) Inserts the array of values into the list at offset.void
insert
(int offset, short[] values, int valOffset, int len) Inserts a slice of the array of values into the list at offset.inverseGrep
(TShortProcedure condition) Searches the list for values which do not satisfy condition.boolean
isEmpty()
Tests whether this list contains any values.int
lastIndexOf
(int offset, short value) Searches the list back to front for the last index of value, starting at offset.int
lastIndexOf
(short value) Searches the list back to front for the last index of value.short
max()
Finds the maximum value in the list.short
min()
Finds the minimum value in the list.void
short
remove
(int offset) Removes the value at offset from the list.void
remove
(int offset, int length) Removes length values from the list, starting at offsetvoid
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.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.void
set
(int offset, short val) Sets the value at the specified offset.void
set
(int offset, short[] values) Replace the values in the list starting at offset with the contents of the values array.void
set
(int offset, short[] 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, short 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.short[]
Copies the contents of the list into a native array.short[]
toNativeArray
(int offset, int len) Copies a slice of the list into a native array.void
toNativeArray
(short[] dest, int offset, int len) Copies a slice of the list into a native array.toString()
Returns a String representation of the list, front to back.void
transformValues
(TShortFunction 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.void
-
Field Details
-
_data
protected short[] _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:
-
-
Constructor Details
-
TShortArrayList
public TShortArrayList()Creates a newTShortArrayList
instance with the default capacity. -
TShortArrayList
public TShortArrayList(int capacity) Creates a newTShortArrayList
instance with the specified capacity.- Parameters:
capacity
- anint
value
-
TShortArrayList
public TShortArrayList(short[] values) Creates a newTShortArrayList
instance whose capacity is the greater of the length of values and DEFAULT_CAPACITY and whose initial contents are the specified values.- Parameters:
values
- anshort[]
value
-
-
Method Details
-
ensureCapacity
public void ensureCapacity(int capacity) Grow the internal array as needed to accommodate the specified number of elements. The size of the array shorts on each resize unless capacity requires more than twice the current capacity.- Parameters:
capacity
- anint
value
-
size
public int size()Returns the number of values in the list.- Returns:
- the number of values in the list.
-
isEmpty
public boolean isEmpty()Tests whether this list contains any values.- 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 void add(short val) Adds val to the end of the list, growing as needed.- Parameters:
val
- anshort
value
-
add
public void add(short[] vals) Adds the values in the array vals to the end of the list, in order.- Parameters:
vals
- anshort[]
value
-
add
public void add(short[] vals, int offset, int length) Adds a subset of the values in the array vals to the end of the list, in order.- Parameters:
vals
- anshort[]
valueoffset
- the offset at which to start copyinglength
- the number of values to copy.
-
insert
public void insert(int offset, short value) Inserts value into the list at offset. All values including and to the right of offset are shifted to the right.- Parameters:
offset
- anint
valuevalue
- anshort
value
-
insert
public void insert(int offset, short[] 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.- Parameters:
offset
- anint
valuevalues
- anshort[]
value
-
insert
public void insert(int offset, short[] 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.- Parameters:
offset
- anint
valuevalues
- anshort[]
valuevalOffset
- the offset in the values array at which to start copying.len
- the number of values to copy from the values array
-
get
public short get(int offset) Returns the value at the specified offset.- Parameters:
offset
- anint
value- Returns:
- an
short
value
-
getQuick
public short getQuick(int offset) Returns the value at the specified offset without doing any bounds checking.- Parameters:
offset
- anint
value- Returns:
- an
short
value
-
set
public void set(int offset, short val) Sets the value at the specified offset.- Parameters:
offset
- anint
valueval
- anshort
value
-
getSet
public short getSet(int offset, short val) Sets the value at the specified offset and returns the previously stored value.- Parameters:
offset
- anint
valueval
- anshort
value- Returns:
- the value previously stored at offset.
-
set
public void set(int offset, short[] values) Replace the values in the list starting at offset with the contents of the values array.- Parameters:
offset
- the first offset to replacevalues
- the source of the new values
-
set
public void set(int offset, short[] values, int valOffset, int length) Replace the values in the list starting at offset with length values from the values array, starting at valOffset.- Parameters:
offset
- the first offset to replacevalues
- the source of the new valuesvalOffset
- the first value to copy from the values arraylength
- the number of values to copy
-
setQuick
public void setQuick(int offset, short val) Sets the value at the specified offset without doing any bounds checking.- Parameters:
offset
- anint
valueval
- anshort
value
-
clear
public void clear()Flushes the internal state of the list, resetting the capacity to the default. -
clear
public void clear(int capacity) Flushes the internal state of the list, setting the capacity of the empty list to capacity.- Parameters:
capacity
- anint
value
-
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 recyle a list without allocating new backing arrays.- See Also:
-
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 recyle 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 forgetQuick
to return stale data if this method is used and the caller is careless about bounds checking.- See Also:
-
remove
public short remove(int offset) Removes the value at offset from the list.- Parameters:
offset
- anint
value- Returns:
- the value previously stored at offset.
-
remove
public void remove(int offset, int length) Removes length values from the list, starting at offset- Parameters:
offset
- anint
valuelength
- anint
value
-
transformValues
Transform each value in the list using the specified function.- Parameters:
function
- aTShortFunction
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.- Parameters:
from
- the inclusive index at which to start reversingto
- the exclusive index at which to stop reversing
-
shuffle
Shuffle the elements of the list using the specified random number generator.- Parameters:
rand
- aRandom
value
-
clone
Returns a clone of this list. Since this is a primitive collection, this will be a deep clone. -
subList
Returns a sublist of this list.- Parameters:
begin
- low endpoint (inclusive) of the subList.end
- high endpoint (exclusive) of the subList.- Returns:
- sublist of this list from begin, inclusive to end, exclusive.
- Throws:
IndexOutOfBoundsException
- - endpoint out of rangeIllegalArgumentException
- - endpoints out of order (end > begin)
-
toNativeArray
public short[] toNativeArray()Copies the contents of the list into a native array.- Returns:
- an
short[]
value
-
toNativeArray
public short[] toNativeArray(int offset, int len) Copies a slice of the list into a native array.- Parameters:
offset
- the offset at which to start copyinglen
- the number of values to copy.- Returns:
- an
short[]
value
-
toNativeArray
public void toNativeArray(short[] dest, int offset, int len) Copies a slice of the list into a native array.- Parameters:
dest
- the array to copy into.offset
- the offset of the first value to copylen
- the number of values to copy.
-
equals
Compares this list to another list, value by value. -
hashCode
public int hashCode() -
forEach
Applies the procedure to each value in the list in ascending (front to back) order.- Parameters:
procedure
- aTShortProcedure
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.- Parameters:
procedure
- aTShortProcedure
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.- See Also:
-
sort
public void sort(int fromIndex, int toIndex) Sort a slice of the list (ascending) using the Sun quicksort implementation.- Parameters:
fromIndex
- the index at which to start sorting (inclusive)toIndex
- the index at which to stop sorting (exclusive)- See Also:
-
fill
public void fill(short val) Fills every slot in the list with the specified value.- Parameters:
val
- the value to use when filling
-
fill
public void fill(int fromIndex, int toIndex, short val) Fills a range in the list with the specified value.- Parameters:
fromIndex
- the offset at which to start filling (inclusive)toIndex
- the offset at which to stop filling (exclusive)val
- the value to use when filling
-
binarySearch
public int binarySearch(short value) Performs a binary search for value in the entire list. Note that you must @{link #sort sort} the list before doing a search.- 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(short 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.- 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(short value) Searches the list front to back for the index of value.- Parameters:
value
- anshort
value- Returns:
- the first offset of the value, or -1 if it is not in the list.
- See Also:
-
indexOf
public int indexOf(int offset, short value) Searches the list front to back for the index of value, starting at offset.- Parameters:
offset
- the offset at which to start the linear search (inclusive)value
- anshort
value- Returns:
- the first offset of the value, or -1 if it is not in the list.
- See Also:
-
lastIndexOf
public int lastIndexOf(short value) Searches the list back to front for the last index of value.- Parameters:
value
- anshort
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, short value) Searches the list back to front for the last index of value, starting at offset.- Parameters:
offset
- the offset at which to start the linear search (exclusive)value
- anshort
value- Returns:
- the last offset of the value, or -1 if it is not in the list.
- See Also:
-
contains
public boolean contains(short value) Searches the list for value- Parameters:
value
- anshort
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.- Parameters:
condition
- a condition to apply to each element in the list- Returns:
- a list of values which match the condition.
-
inverseGrep
Searches the list for values which do not satisfy condition. This is akin to *nixgrep -v
.- 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 short max()Finds the maximum value in the list.- Returns:
- the largest value in the list.
- Throws:
IllegalStateException
- if the list is empty
-
min
public short min()Finds the minimum value in the list.- Returns:
- the smallest value in the list.
- Throws:
IllegalStateException
- if the list is empty
-
toString
Returns a String representation of the list, front to back. -
writeExternal
- Specified by:
writeExternal
in interfaceExternalizable
- Throws:
IOException
-
readExternal
- Specified by:
readExternal
in interfaceExternalizable
- Throws:
IOException
ClassNotFoundException
-