gnu.trove.list.linked

Class TCharLinkedList

    • Method Summary

      Modifier and Type Method and Description
      boolean add(char val)
      Adds val to the end of the list, growing as needed.
      void add(char[] vals)
      Adds the values in the array vals to the end of the list, in order.
      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.
      boolean addAll(char[] array)
      Adds all of the elements in the array to the collection.
      boolean addAll(Collection<? extends Character> collection)
      Adds all of the elements in collection to the collection.
      boolean addAll(TCharCollection collection)
      Adds all of the elements in the TCharCollection to the collection.
      int binarySearch(char value)
      Performs a binary search for value in the entire list.
      int binarySearch(char 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.
      boolean contains(char value)
      Searches the list for value
      boolean containsAll(char[] array)
      Tests the collection to determine if all of the elements in array are present.
      boolean containsAll(Collection<?> collection)
      Tests the collection to determine if all of the elements in collection are present.
      boolean containsAll(TCharCollection collection)
      Tests the collection to determine if all of the elements in TCharCollection are present.
      boolean equals(Object o)
      Compares the specified object with this collection for equality.
      void fill(char val)
      Fills every slot in the list with the specified value.
      void fill(int fromIndex, int toIndex, char val)
      Fills a range in the list with the specified value.
      boolean forEach(TCharProcedure procedure)
      Applies the procedure to each value in the list in ascending (front to back) order.
      boolean forEachDescending(TCharProcedure procedure)
      Applies the procedure to each value in the list in descending (back to front) order.
      char get(int offset)
      Returns the value at the specified offset.
      gnu.trove.list.linked.TCharLinkedList.TCharLink getLinkAt(int offset)
      Returns the link at the given offset.
      char getNoEntryValue()
      Returns the value that is used to represent null.
      TCharList grep(TCharProcedure 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(char value)
      Searches the list front to back for the index of value.
      int indexOf(int offset, char value)
      Searches the list front to back for the index of value, starting at offset.
      void insert(int offset, char value)
      Inserts value into the list at offset.
      void insert(int offset, char[] values)
      Inserts the array of values into the list at offset.
      void insert(int offset, char[] values, int valOffset, int len)
      Inserts a slice of the array of values into the list at offset.
      TCharList inverseGrep(TCharProcedure condition)
      Searches the list for values which do not satisfy condition.
      boolean isEmpty()
      Tests whether this list contains any values.
      TCharIterator iterator()
      Creates an iterator over the values of the collection.
      int lastIndexOf(char value)
      Searches the list back to front for the last index of value.
      int lastIndexOf(int offset, char value)
      Searches the list back to front for the last index of value, starting at offset.
      char max()
      Finds the maximum value in the list.
      char min()
      Finds the minimum value in the list.
      void readExternal(ObjectInput in)
      boolean remove(char value)
      Removes value from the list.
      void remove(int offset, int length)
      Removes length values from the list, starting at offset
      boolean removeAll(char[] array)
      Removes all of the elements in array from the collection.
      boolean removeAll(Collection<?> collection)
      Removes all of the elements in collection from the collection.
      boolean removeAll(TCharCollection collection)
      Removes all of the elements in TCharCollection from the collection.
      char removeAt(int offset)
      Removes value at a given offset from the list.
      char replace(int offset, char val)
      Sets the value at the specified offset and returns the previously stored value.
      boolean retainAll(char[] array)
      Removes any values in the collection which are not contained in array.
      boolean retainAll(Collection<?> collection)
      Removes any values in the collection which are not contained in collection.
      boolean retainAll(TCharCollection collection)
      Removes any values in the collection which are not contained in TCharCollection.
      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.
      char set(int offset, char val)
      Sets the value at the specified offset.
      void set(int offset, char[] values)
      Replace the values in the list starting at offset with the contents of the values array.
      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.
      void shuffle(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.
      TCharList subList(int begin, int end)
      Returns a sublist of this list.
      char sum()
      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.
      String toString()
       
      void transformValues(TCharFunction function)
      Transform each value in the list using the specified function.
      void writeExternal(ObjectOutput out)

    • Constructor Detail

      • TCharLinkedList

        public TCharLinkedList()

      • TCharLinkedList

        public TCharLinkedList(char no_entry_value)

      • TCharLinkedList

        public TCharLinkedList(TCharList list)

    • Method Detail

      • 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:
        getNoEntryValue in interface  TCharList
        Specified by:
        getNoEntryValue in interface  TCharCollection
        Returns:
        the value that represents null

      • size

        public int size()
        Returns the number of values in the list.
        Specified by:
        size in interface  TCharList
        Specified by:
        size in interface  TCharCollection
        Returns:
        the number of values in the list.

      • isEmpty

        public boolean isEmpty()
        Tests whether this list contains any values.
        Specified by:
        isEmpty in interface  TCharList
        Specified by:
        isEmpty in interface  TCharCollection
        Returns:
        true if the list is empty.

      • add

        public boolean add(char val)
        Adds val to the end of the list, growing as needed.
        Specified by:
        add in interface  TCharList
        Specified by:
        add in interface  TCharCollection
        Parameters:
        val - an char value
        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.
        Specified by:
        add in interface  TCharList
        Parameters:
        vals - an char[] value

      • 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.
        Specified by:
        add in interface  TCharList
        Parameters:
        vals - an char[] value
        offset - the offset at which to start copying
        length - the number of values to copy.

      • 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.
        Specified by:
        insert in interface  TCharList
        Parameters:
        offset - an int value
        value - an char value

      • 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.
        Specified by:
        insert in interface  TCharList
        Parameters:
        offset - an int value
        values - an char[] value

      • 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.
        Specified by:
        insert in interface  TCharList
        Parameters:
        offset - an int value
        values - an char[] value
        valOffset - the offset in the values array at which to start copying.
        len - the number of values to copy from the values array

      • get

        public char get(int offset)
        Returns the value at the specified offset.
        Specified by:
        get in interface  TCharList
        Parameters:
        offset - an int value
        Returns:
        an char value

      • getLinkAt

        public gnu.trove.list.linked.TCharLinkedList.TCharLink getLinkAt(int offset)
        Returns the link at the given offset.

        A simple bisection criteria is used to keep the worst case complexity equal to O(n/2) where n = size(). Simply start from head of list or tail depending on offset and list size.
        Parameters:
        offset - of the link
        Returns:
        link or null if non-existent

      • set

        public char set(int offset,
                char val)
        Sets the value at the specified offset.
        Specified by:
        set in interface  TCharList
        Parameters:
        offset - an int value
        val - an char value
        Returns:
        The value previously at the given index.

      • set

        public void set(int offset,
                char[] values)
        Replace the values in the list starting at offset with the contents of the values array.
        Specified by:
        set in interface  TCharList
        Parameters:
        offset - the first offset to replace
        values - the source of the new values

      • 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.
        Specified by:
        set in interface  TCharList
        Parameters:
        offset - the first offset to replace
        values - the source of the new values
        valOffset - the first value to copy from the values array
        length - the number of values to copy

      • replace

        public char replace(int offset,
                    char val)
        Sets the value at the specified offset and returns the previously stored value.
        Specified by:
        replace in interface  TCharList
        Parameters:
        offset - an int value
        val - an char value
        Returns:
        the value previously stored at offset.

      • clear

        public void clear()
        Flushes the internal state of the list, resetting the capacity to the default.

      • remove

        public boolean remove(char value)
        Removes value from the list.
        Specified by:
        remove in interface  TCharList
        Specified by:
        remove in interface  TCharCollection
        Parameters:
        value - an char value
        Returns:
        true if the list was modified by the remove operation.

      • containsAll

        public boolean containsAll(Collection<?> collection)
        Tests the collection to determine if all of the elements in collection are present.
        Specified by:
        containsAll in interface  TCharCollection
        Parameters:
        collection - a Collection value
        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:
        containsAll in interface  TCharCollection
        Parameters:
        collection - a TCharCollection value
        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:
        containsAll in interface  TCharCollection
        Parameters:
        array - as array of char primitives.
        Returns:
        true if all elements were present in the collection.

      • addAll

        public boolean addAll(Collection<? extends Character> collection)
        Adds all of the elements in collection to the collection.
        Specified by:
        addAll in interface  TCharCollection
        Parameters:
        collection - a Collection value
        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:
        addAll in interface  TCharCollection
        Parameters:
        collection - a TCharCollection value
        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:
        addAll in interface  TCharCollection
        Parameters:
        array - a array of char primitives.
        Returns:
        true if the collection was modified by the add all operation.

      • retainAll

        public boolean retainAll(Collection<?> collection)
        Removes any values in the collection which are not contained in collection.
        Specified by:
        retainAll in interface  TCharCollection
        Parameters:
        collection - a Collection value
        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:
        retainAll in interface  TCharCollection
        Parameters:
        collection - a TCharCollection value
        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:
        retainAll in interface  TCharCollection
        Parameters:
        array - an array of char primitives.
        Returns:
        true if the collection was modified by the retain all operation

      • removeAll

        public boolean removeAll(Collection<?> collection)
        Removes all of the elements in collection from the collection.
        Specified by:
        removeAll in interface  TCharCollection
        Parameters:
        collection - a Collection value
        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:
        removeAll in interface  TCharCollection
        Parameters:
        collection - a TCharCollection value
        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:
        removeAll in interface  TCharCollection
        Parameters:
        array - an array of char primitives.
        Returns:
        true if the collection was modified by the remove all operation.

      • removeAt

        public char removeAt(int offset)
        Removes value at a given offset from the list.
        Specified by:
        removeAt in interface  TCharList
        Parameters:
        offset - an int value that represents the offset to the element to be removed
        Returns:
        an char that is the value removed.

      • remove

        public void remove(int offset,
                   int length)
        Removes length values from the list, starting at offset
        Specified by:
        remove in interface  TCharList
        Parameters:
        offset - an int value
        length - an int value

      • transformValues

        public void transformValues(TCharFunction function)
        Transform each value in the list using the specified function.
        Specified by:
        transformValues in interface  TCharList
        Parameters:
        function - a TCharFunction 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.
        Specified by:
        reverse in interface  TCharList
        Parameters:
        from - the inclusive index at which to start reversing
        to - the exclusive index at which to stop reversing

      • shuffle

        public void shuffle(Random rand)
        Shuffle the elements of the list using the specified random number generator.
        Specified by:
        shuffle in interface  TCharList
        Parameters:
        rand - a Random value

      • subList

        public TCharList subList(int begin,
                         int end)
        Returns a sublist of this list.
        Specified by:
        subList in interface  TCharList
        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.

      • toArray

        public char[] toArray()
        Copies the contents of the list into a native array.
        Specified by:
        toArray in interface  TCharList
        Specified by:
        toArray in interface  TCharCollection
        Returns:
        an char[] value

      • toArray

        public char[] toArray(int offset,
                      int len)
        Copies a slice of the list into a native array.
        Specified by:
        toArray in interface  TCharList
        Parameters:
        offset - the offset at which to start copying
        len - the number of values to copy.
        Returns:
        an char[] value

      • 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:
        toArray in interface  TCharList
        Specified by:
        toArray in interface  TCharCollection
        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.
        Specified by:
        toArray in interface  TCharList
        Parameters:
        dest - the array to copy into.
        offset - the offset where the first value should be copied
        len - the number of values to copy.
        Returns:
        the array passed in.

      • toArray

        public char[] toArray(char[] dest,
                      int source_pos,
                      int dest_pos,
                      int len)
        Copies a slice of the list into a native array.
        Specified by:
        toArray in interface  TCharList
        Parameters:
        dest - the array to copy into.
        source_pos - the offset of the first value to copy
        dest_pos - the offset where the first value should be copied
        len - the number of values to copy.
        Returns:
        the array passed in.

      • forEach

        public boolean forEach(TCharProcedure procedure)
        Applies the procedure to each value in the list in ascending (front to back) order.
        Specified by:
        forEach in interface  TCharList
        Specified by:
        forEach in interface  TCharCollection
        Parameters:
        procedure - a TCharProcedure value
        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:
        forEachDescending in interface  TCharList
        Parameters:
        procedure - a TCharProcedure 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.
        Specified by:
        sort in interface  TCharList
        See Also:
        Arrays.sort(int[])

      • sort

        public void sort(int fromIndex,
                 int toIndex)
        Sort a slice of the list (ascending) using the Sun quicksort implementation.
        Specified by:
        sort in interface  TCharList
        Parameters:
        fromIndex - the index at which to start sorting (inclusive)
        toIndex - the index at which to stop sorting (exclusive)
        See Also:
        Arrays.sort(int[])

      • fill

        public void fill(char val)
        Fills every slot in the list with the specified value.
        Specified by:
        fill in interface  TCharList
        Parameters:
        val - the value to use when filling

      • fill

        public void fill(int fromIndex,
                 int toIndex,
                 char val)
        Fills a range in the list with the specified value.
        Specified by:
        fill in interface  TCharList
        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(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:
        binarySearch in interface  TCharList
        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:
        binarySearch in interface  TCharList
        Parameters:
        value - the value to search for
        fromIndex - 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:
        indexOf in interface  TCharList
        Parameters:
        value - an char 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,
                   char value)
        Searches the list front to back for the index of value, starting at offset.
        Specified by:
        indexOf in interface  TCharList
        Parameters:
        offset - the offset at which to start the linear search (inclusive)
        value - an char 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(char value)
        Searches the list back to front for the last index of value.
        Specified by:
        lastIndexOf in interface  TCharList
        Parameters:
        value - an char 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,
                       char value)
        Searches the list back to front for the last index of value, starting at offset.
        Specified by:
        lastIndexOf in interface  TCharList
        Parameters:
        offset - the offset at which to start the linear search (exclusive)
        value - an char 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(char value)
        Searches the list for value
        Specified by:
        contains in interface  TCharList
        Specified by:
        contains in interface  TCharCollection
        Parameters:
        value - an char value
        Returns:
        true if value is in the list.

      • iterator

        public TCharIterator iterator()
        Creates an iterator over the values of the collection. The iterator supports element deletion.
        Specified by:
        iterator in interface  TCharCollection
        Returns:
        an TCharIterator value

      • grep

        public TCharList grep(TCharProcedure condition)
        Searches the list for values satisfying condition in the manner of the *nix grep utility.
        Specified by:
        grep in interface  TCharList
        Parameters:
        condition - a condition to apply to each element in the list
        Returns:
        a list of values which match the condition.

      • inverseGrep

        public TCharList inverseGrep(TCharProcedure condition)
        Searches the list for values which do not satisfy condition. This is akin to *nix grep -v.
        Specified by:
        inverseGrep in interface  TCharList
        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.
        Specified by:
        max in interface  TCharList
        Returns:
        the largest value in the list.

      • min

        public char min()
        Finds the minimum value in the list.
        Specified by:
        min in interface  TCharList
        Returns:
        the smallest value in the list.

      • sum

        public char sum()
        Calculates the sum of all the values in the list.
        Specified by:
        sum in interface  TCharList
        Returns:
        the sum of the values in the list (zero if the list is empty).

      • equals

        public boolean equals(Object o)
        Description copied from interface: TCharCollection
        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 interface  TCharCollection
        Overrides:
        equals in class  Object
        Parameters:
        o - object to be compared for equality with this collection
        Returns:
        true if the specified object is equal to this collection

      • hashCode

        public int hashCode()
        Description copied from interface: TCharCollection
        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 of Object.hashCode().
        Specified by:
        hashCode in interface  TCharCollection
        Overrides:
        hashCode in class  Object
        Returns:
        the hash code value for this collection
        See Also:
        Object.equals(Object), Collection.equals(Object)

      • toString

        public String toString()