Class TCharArrayList
- java.lang.Object
-
- gnu.trove.list.array.TCharArrayList
-
- All Implemented Interfaces:
TCharList,TCharCollection,java.io.Externalizable,java.io.Serializable
public class TCharArrayList extends java.lang.Object implements TCharList, java.io.Externalizable
A resizable, array-backed list of char primitives.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected char[]_datathe data of the listprotected int_posthe index after the last entry in the listprotected static intDEFAULT_CAPACITYthe default capacity for new listsprotected charno_entry_valuethe char value that represents null
-
Constructor Summary
Constructors Modifier Constructor Description TCharArrayList()Creates a newTCharArrayListinstance with the default capacity.TCharArrayList(char[] values)Creates a newTCharArrayListinstance whose capacity is the length of values array and whose initial contents are the specified values.protectedTCharArrayList(char[] values, char no_entry_value, boolean wrap)TCharArrayList(int capacity)Creates a newTCharArrayListinstance with the specified capacity.TCharArrayList(int capacity, char no_entry_value)Creates a newTCharArrayListinstance with the specified capacity.TCharArrayList(TCharCollection collection)Creates a newTCharArrayListinstance 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(char val)Adds val to the end of the list, growing as needed.voidadd(char[] vals)Adds the values in the array vals to the end of the list, in order.voidadd(char[] vals, int offset, int length)Adds a subset of the values in the array vals to the end of the list, in order.booleanaddAll(char[] array)Adds all of the elements in the array to the collection.booleanaddAll(TCharCollection collection)Adds all of the elements in the TCharCollection to the collection.booleanaddAll(java.util.Collection<? extends java.lang.Character> collection)Adds all of the elements in collection to the collection.intbinarySearch(char value)Performs a binary search for value in the entire list.intbinarySearch(char 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(char value)Searches the list for valuebooleancontainsAll(char[] array)Tests the collection to determine if all of the elements in array are present.booleancontainsAll(TCharCollection collection)Tests the collection to determine if all of the elements in TCharCollection 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(char val)Fills every slot in the list with the specified value.voidfill(int fromIndex, int toIndex, char val)Fills a range in the list with the specified value.booleanforEach(TCharProcedure procedure)Applies the procedure to each value in the list in ascending (front to back) order.booleanforEachDescending(TCharProcedure procedure)Applies the procedure to each value in the list in descending (back to front) order.charget(int offset)Returns the value at the specified offset.chargetNoEntryValue()Returns the value that is used to represent null.chargetQuick(int offset)Returns the value at the specified offset without doing any bounds checking.TCharListgrep(TCharProcedure 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(char value)Searches the list front to back for the index of value.intindexOf(int offset, char value)Searches the list front to back for the index of value, starting at offset.voidinsert(int offset, char value)Inserts value into the list at offset.voidinsert(int offset, char[] values)Inserts the array of values into the list at offset.voidinsert(int offset, char[] values, int valOffset, int len)Inserts a slice of the array of values into the list at offset.TCharListinverseGrep(TCharProcedure condition)Searches the list for values which do not satisfy condition.booleanisEmpty()Tests whether this list contains any values.TCharIteratoriterator()Creates an iterator over the values of the collection.intlastIndexOf(char value)Searches the list back to front for the last index of value.intlastIndexOf(int offset, char value)Searches the list back to front for the last index of value, starting at offset.charmax()Finds the maximum value in the list.charmin()Finds the minimum value in the list.voidreadExternal(java.io.ObjectInput in)booleanremove(char value)Removes value from the list.voidremove(int offset, int length)Removes length values from the list, starting at offsetbooleanremoveAll(char[] array)Removes all of the elements in array from the collection.booleanremoveAll(TCharCollection collection)Removes all of the elements in TCharCollection from the collection.booleanremoveAll(java.util.Collection<?> collection)Removes all of the elements in collection from the collection.charremoveAt(int offset)Removes value at a given offset from the list.charreplace(int offset, char val)Sets the value at the specified offset and returns the previously stored value.booleanretainAll(char[] array)Removes any values in the collection which are not contained in array.booleanretainAll(TCharCollection collection)Removes any values in the collection which are not contained in TCharCollection.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.charset(int offset, char val)Sets the value at the specified offset.voidset(int offset, char[] values)Replace the values in the list starting at offset with the contents of the values array.voidset(int offset, char[] 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, char 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.TCharListsubList(int begin, int end)Returns a sublist of this list.charsum()Calculates the sum of all the values in the list.char[]toArray()Copies the contents of the list into a native array.char[]toArray(char[] dest)Copies a slice of the list into a native array.char[]toArray(char[] dest, int offset, int len)Copies a slice of the list into a native array.char[]toArray(char[] dest, int source_pos, int dest_pos, int len)Copies a slice of the list into a native array.char[]toArray(int offset, int len)Copies a slice of the list into a native array.java.lang.StringtoString()voidtransformValues(TCharFunction 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 TCharArrayListwrap(char[] values)Returns a primitive List implementation that wraps around the given primitive array.static TCharArrayListwrap(char[] values, char 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 char[] _data
the data of the list
-
_pos
protected int _pos
the index after the last entry in the list
-
no_entry_value
protected char no_entry_value
the char value that represents null
-
-
Constructor Detail
-
TCharArrayList
public TCharArrayList()
Creates a newTCharArrayListinstance with the default capacity.
-
TCharArrayList
public TCharArrayList(int capacity)
Creates a newTCharArrayListinstance with the specified capacity.- Parameters:
capacity- anintvalue
-
TCharArrayList
public TCharArrayList(int capacity, char no_entry_value)Creates a newTCharArrayListinstance with the specified capacity.- Parameters:
capacity- anintvalueno_entry_value- ancharvalue that represents null.
-
TCharArrayList
public TCharArrayList(TCharCollection collection)
Creates a newTCharArrayListinstance that contains a copy of the collection passed to us.- Parameters:
collection- the collection to copy
-
TCharArrayList
public TCharArrayList(char[] values)
Creates a newTCharArrayListinstance 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- anchar[]value
-
TCharArrayList
protected TCharArrayList(char[] values, char no_entry_value, boolean wrap)
-
-
Method Detail
-
wrap
public static TCharArrayList wrap(char[] 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 TCharArrayList wrap(char[] values, char 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 char 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 interfaceTCharCollection- Specified by:
getNoEntryValuein interfaceTCharList- 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 interfaceTCharCollection- Specified by:
sizein interfaceTCharList- Returns:
- the number of values in the list.
-
isEmpty
public boolean isEmpty()
Tests whether this list contains any values.- Specified by:
isEmptyin interfaceTCharCollection- Specified by:
isEmptyin interfaceTCharList- 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(char val)
Adds val to the end of the list, growing as needed.- Specified by:
addin interfaceTCharCollection- Specified by:
addin interfaceTCharList- Parameters:
val- ancharvalue- Returns:
- true if the list was modified by the add operation
-
add
public void add(char[] vals)
Adds the values in the array vals to the end of the list, in order.
-
add
public void add(char[] 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, char 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, char[] 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, char[] 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 char get(int offset)
Returns the value at the specified offset.
-
getQuick
public char getQuick(int offset)
Returns the value at the specified offset without doing any bounds checking.
-
set
public char set(int offset, char val)Sets the value at the specified offset.
-
replace
public char replace(int offset, char val)Sets the value at the specified offset and returns the previously stored value.
-
set
public void set(int offset, char[] values)Replace the values in the list starting at offset with the contents of the values array.
-
set
public void set(int offset, char[] 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, char 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 interfaceTCharCollection- Specified by:
clearin interfaceTCharList
-
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(char value)
Removes value from the list.- Specified by:
removein interfaceTCharCollection- Specified by:
removein interfaceTCharList- Parameters:
value- ancharvalue- Returns:
- true if the list was modified by the remove operation.
-
removeAt
public char 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 TCharIterator iterator()
Creates an iterator over the values of the collection. The iterator supports element deletion.- Specified by:
iteratorin interfaceTCharCollection- Returns:
- an
TCharIteratorvalue
-
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 interfaceTCharCollection- Parameters:
collection- aCollectionvalue- Returns:
- true if all elements were present in the collection.
-
containsAll
public boolean containsAll(TCharCollection collection)
Tests the collection to determine if all of the elements in TCharCollection are present.- Specified by:
containsAllin interfaceTCharCollection- Parameters:
collection- aTCharCollectionvalue- Returns:
- true if all elements were present in the collection.
-
containsAll
public boolean containsAll(char[] array)
Tests the collection to determine if all of the elements in array are present.- Specified by:
containsAllin interfaceTCharCollection- Parameters:
array- asarrayof char primitives.- Returns:
- true if all elements were present in the collection.
-
addAll
public boolean addAll(java.util.Collection<? extends java.lang.Character> collection)
Adds all of the elements in collection to the collection.- Specified by:
addAllin interfaceTCharCollection- Parameters:
collection- aCollectionvalue- Returns:
- true if the collection was modified by the add all operation.
-
addAll
public boolean addAll(TCharCollection collection)
Adds all of the elements in the TCharCollection to the collection.- Specified by:
addAllin interfaceTCharCollection- Parameters:
collection- aTCharCollectionvalue- Returns:
- true if the collection was modified by the add all operation.
-
addAll
public boolean addAll(char[] array)
Adds all of the elements in the array to the collection.- Specified by:
addAllin interfaceTCharCollection- Parameters:
array- aarrayof char 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 interfaceTCharCollection- Parameters:
collection- aCollectionvalue- Returns:
- true if the collection was modified by the retain all operation
-
retainAll
public boolean retainAll(TCharCollection collection)
Removes any values in the collection which are not contained in TCharCollection.- Specified by:
retainAllin interfaceTCharCollection- Parameters:
collection- aTCharCollectionvalue- Returns:
- true if the collection was modified by the retain all operation
-
retainAll
public boolean retainAll(char[] array)
Removes any values in the collection which are not contained in array.- Specified by:
retainAllin interfaceTCharCollection- Parameters:
array- anarrayof char 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 interfaceTCharCollection- Parameters:
collection- aCollectionvalue- Returns:
- true if the collection was modified by the remove all operation.
-
removeAll
public boolean removeAll(TCharCollection collection)
Removes all of the elements in TCharCollection from the collection.- Specified by:
removeAllin interfaceTCharCollection- Parameters:
collection- aTCharCollectionvalue- Returns:
- true if the collection was modified by the remove all operation.
-
removeAll
public boolean removeAll(char[] array)
Removes all of the elements in array from the collection.- Specified by:
removeAllin interfaceTCharCollection- Parameters:
array- anarrayof char primitives.- Returns:
- true if the collection was modified by the remove all operation.
-
transformValues
public void transformValues(TCharFunction function)
Transform each value in the list using the specified function.- Specified by:
transformValuesin interfaceTCharList- Parameters:
function- aTCharFunctionvalue
-
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 TCharList subList(int begin, int end)
Returns a sublist of this list.
-
toArray
public char[] toArray()
Copies the contents of the list into a native array.- Specified by:
toArrayin interfaceTCharCollection- Specified by:
toArrayin interfaceTCharList- Returns:
- an
char[]value
-
toArray
public char[] toArray(int offset, int len)Copies a slice of the list into a native array.
-
toArray
public char[] toArray(char[] 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
TCharList.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 interfaceTCharCollection- Specified by:
toArrayin interfaceTCharList- Parameters:
dest- the array to copy into.- Returns:
- the array passed in.
-
toArray
public char[] toArray(char[] dest, int offset, int len)Copies a slice of the list into a native array.
-
toArray
public char[] toArray(char[] 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 interfaceTCharCollection- 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 interfaceTCharCollection- 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(TCharProcedure procedure)
Applies the procedure to each value in the list in ascending (front to back) order.- Specified by:
forEachin interfaceTCharCollection- Specified by:
forEachin interfaceTCharList- Parameters:
procedure- aTCharProcedurevalue- Returns:
- true if the procedure did not terminate prematurely.
-
forEachDescending
public boolean forEachDescending(TCharProcedure procedure)
Applies the procedure to each value in the list in descending (back to front) order.- Specified by:
forEachDescendingin interfaceTCharList- Parameters:
procedure- aTCharProcedurevalue- 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(char val)
Fills every slot in the list with the specified value.
-
fill
public void fill(int fromIndex, int toIndex, char val)Fills a range in the list with the specified value.
-
binarySearch
public int binarySearch(char 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 interfaceTCharList- 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(char 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 interfaceTCharList- 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(char value)
Searches the list front to back for the index of value.- Specified by:
indexOfin interfaceTCharList- Parameters:
value- ancharvalue- 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, char value)Searches the list front to back for the index of value, starting at offset.- Specified by:
indexOfin interfaceTCharList- Parameters:
offset- the offset at which to start the linear search (inclusive)value- ancharvalue- 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(char value)
Searches the list back to front for the last index of value.- Specified by:
lastIndexOfin interfaceTCharList- Parameters:
value- ancharvalue- 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, char value)Searches the list back to front for the last index of value, starting at offset.- Specified by:
lastIndexOfin interfaceTCharList- Parameters:
offset- the offset at which to start the linear search (exclusive)value- ancharvalue- 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(char value)
Searches the list for value- Specified by:
containsin interfaceTCharCollection- Specified by:
containsin interfaceTCharList- Parameters:
value- ancharvalue- Returns:
- true if value is in the list.
-
grep
public TCharList grep(TCharProcedure condition)
Searches the list for values satisfying condition in the manner of the *nix grep utility.
-
inverseGrep
public TCharList inverseGrep(TCharProcedure condition)
Searches the list for values which do not satisfy condition. This is akin to *nixgrep -v.- Specified by:
inverseGrepin interfaceTCharList- 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 char max()
Finds the maximum value in the list.
-
min
public char min()
Finds the minimum value in the list.
-
sum
public char 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
-
-