Class TIntLinkedList

java.lang.Object
gnu.trove.list.linked.TIntLinkedList
All Implemented Interfaces:
TIntList, TIntCollection, Externalizable, Serializable

public class TIntLinkedList extends Object implements TIntList, Externalizable
A resizable, double linked list of int primitives.
See Also:
  • Field Summary

    Fields inherited from interface gnu.trove.TIntCollection

    serialVersionUID
  • Constructor Summary

    Constructors
    Constructor
    Description
     
    TIntLinkedList(int no_entry_value)
     
     
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    add(int val)
    Adds val to the end of the list, growing as needed.
    void
    add(int[] vals)
    Adds the values in the array vals to the end of the list, in order.
    void
    add(int[] 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(int[] array)
    Adds all of the elements in the array to the collection.
    boolean
    addAll(TIntCollection collection)
    Adds all of the elements in the TIntCollection to the collection.
    boolean
    addAll(Collection<? extends Integer> collection)
    Adds all of the elements in collection to the collection.
    int
    binarySearch(int value)
    Performs a binary search for value in the entire list.
    int
    binarySearch(int value, int fromIndex, int toIndex)
    Performs a binary search for value in the specified range.
    void
    Flushes the internal state of the list, resetting the capacity to the default.
    boolean
    contains(int value)
    Searches the list for value
    boolean
    containsAll(int[] array)
    Tests the collection to determine if all of the elements in array are present.
    boolean
    Tests the collection to determine if all of the elements in TIntCollection are present.
    boolean
    containsAll(Collection<?> collection)
    Tests the collection to determine if all of the elements in collection are present.
    boolean
    Compares the specified object with this collection for equality.
    void
    fill(int val)
    Fills every slot in the list with the specified value.
    void
    fill(int fromIndex, int toIndex, int val)
    Fills a range in the list with the specified value.
    boolean
    Applies the procedure to each value in the list in ascending (front to back) order.
    boolean
    Applies the procedure to each value in the list in descending (back to front) order.
    int
    get(int offset)
    Returns the value at the specified offset.
    gnu.trove.list.linked.TIntLinkedList.TIntLink
    getLinkAt(int offset)
    Returns the link at the given offset.
    int
    Returns the value that is used to represent null.
    grep(TIntProcedure condition)
    Searches the list for values satisfying condition in the manner of the *nix grep utility.
    int
    Returns the hash code value for this collection.
    int
    indexOf(int value)
    Searches the list front to back for the index of value.
    int
    indexOf(int offset, int value)
    Searches the list front to back for the index of value, starting at offset.
    void
    insert(int offset, int value)
    Inserts value into the list at offset.
    void
    insert(int offset, int[] values)
    Inserts the array of values into the list at offset.
    void
    insert(int offset, int[] values, int valOffset, int len)
    Inserts a slice of the array of values into the list at offset.
    Searches the list for values which do not satisfy condition.
    boolean
    Tests whether this list contains any values.
    Creates an iterator over the values of the collection.
    int
    lastIndexOf(int value)
    Searches the list back to front for the last index of value.
    int
    lastIndexOf(int offset, int value)
    Searches the list back to front for the last index of value, starting at offset.
    int
    max()
    Finds the maximum value in the list.
    int
    min()
    Finds the minimum value in the list.
    void
    boolean
    remove(int value)
    Removes value from the list.
    void
    remove(int offset, int length)
    Removes length values from the list, starting at offset
    boolean
    removeAll(int[] array)
    Removes all of the elements in array from the collection.
    boolean
    Removes all of the elements in TIntCollection from the collection.
    boolean
    removeAll(Collection<?> collection)
    Removes all of the elements in collection from the collection.
    int
    removeAt(int offset)
    Removes value at a given offset from the list.
    int
    replace(int offset, int val)
    Sets the value at the specified offset and returns the previously stored value.
    boolean
    retainAll(int[] array)
    Removes any values in the collection which are not contained in array.
    boolean
    Removes any values in the collection which are not contained in TIntCollection.
    boolean
    retainAll(Collection<?> collection)
    Removes any values in the collection which are not contained in collection.
    void
    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.
    int
    set(int offset, int val)
    Sets the value at the specified offset.
    void
    set(int offset, int[] values)
    Replace the values in the list starting at offset with the contents of the values array.
    void
    set(int offset, int[] 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 the elements of the list using the specified random number generator.
    int
    Returns the number of values in the list.
    void
    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.
    int
    sum()
    Calculates the sum of all the values in the list.
    int[]
    Copies the contents of the list into a native array.
    int[]
    toArray(int[] dest)
    Copies a slice of the list into a native array.
    int[]
    toArray(int[] dest, int offset, int len)
    Copies a slice of the list into a native array.
    int[]
    toArray(int[] dest, int source_pos, int dest_pos, int len)
    Copies a slice of the list into a native array.
    int[]
    toArray(int offset, int len)
    Copies a slice of the list into a native array.
     
    void
    Transform each value in the list using the specified function.
    void

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait
  • Constructor Details

    • TIntLinkedList

      public TIntLinkedList()
    • TIntLinkedList

      public TIntLinkedList(int no_entry_value)
    • TIntLinkedList

      public TIntLinkedList(TIntList list)
  • Method Details

    • getNoEntryValue

      public int 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 TIntCollection
      Specified by:
      getNoEntryValue in interface TIntList
      Returns:
      the value that represents null
    • size

      public int size()
      Returns the number of values in the list.
      Specified by:
      size in interface TIntCollection
      Specified by:
      size in interface TIntList
      Returns:
      the number of values in the list.
    • isEmpty

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

      public boolean add(int val)
      Adds val to the end of the list, growing as needed.
      Specified by:
      add in interface TIntCollection
      Specified by:
      add in interface TIntList
      Parameters:
      val - an int value
      Returns:
      true if the list was modified by the add operation
    • add

      public void add(int[] vals)
      Adds the values in the array vals to the end of the list, in order.
      Specified by:
      add in interface TIntList
      Parameters:
      vals - an int[] value
    • add

      public void add(int[] 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 TIntList
      Parameters:
      vals - an int[] value
      offset - the offset at which to start copying
      length - the number of values to copy.
    • insert

      public void insert(int offset, int 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 TIntList
      Parameters:
      offset - an int value
      value - an int value
    • insert

      public void insert(int offset, int[] 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 TIntList
      Parameters:
      offset - an int value
      values - an int[] value
    • insert

      public void insert(int offset, int[] 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 TIntList
      Parameters:
      offset - an int value
      values - an int[] 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 int get(int offset)
      Returns the value at the specified offset.
      Specified by:
      get in interface TIntList
      Parameters:
      offset - an int value
      Returns:
      an int value
    • getLinkAt

      public gnu.trove.list.linked.TIntLinkedList.TIntLink 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 int set(int offset, int val)
      Sets the value at the specified offset.
      Specified by:
      set in interface TIntList
      Parameters:
      offset - an int value
      val - an int value
      Returns:
      The value previously at the given index.
    • set

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

      public void set(int offset, int[] 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 TIntList
      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 int replace(int offset, int val)
      Sets the value at the specified offset and returns the previously stored value.
      Specified by:
      replace in interface TIntList
      Parameters:
      offset - an int value
      val - an int 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.
      Specified by:
      clear in interface TIntCollection
      Specified by:
      clear in interface TIntList
    • remove

      public boolean remove(int value)
      Removes value from the list.
      Specified by:
      remove in interface TIntCollection
      Specified by:
      remove in interface TIntList
      Parameters:
      value - an int 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 TIntCollection
      Parameters:
      collection - a Collection value
      Returns:
      true if all elements were present in the collection.
    • containsAll

      public boolean containsAll(TIntCollection collection)
      Tests the collection to determine if all of the elements in TIntCollection are present.
      Specified by:
      containsAll in interface TIntCollection
      Parameters:
      collection - a TIntCollection value
      Returns:
      true if all elements were present in the collection.
    • containsAll

      public boolean containsAll(int[] array)
      Tests the collection to determine if all of the elements in array are present.
      Specified by:
      containsAll in interface TIntCollection
      Parameters:
      array - as array of int primitives.
      Returns:
      true if all elements were present in the collection.
    • addAll

      public boolean addAll(Collection<? extends Integer> collection)
      Adds all of the elements in collection to the collection.
      Specified by:
      addAll in interface TIntCollection
      Parameters:
      collection - a Collection value
      Returns:
      true if the collection was modified by the add all operation.
    • addAll

      public boolean addAll(TIntCollection collection)
      Adds all of the elements in the TIntCollection to the collection.
      Specified by:
      addAll in interface TIntCollection
      Parameters:
      collection - a TIntCollection value
      Returns:
      true if the collection was modified by the add all operation.
    • addAll

      public boolean addAll(int[] array)
      Adds all of the elements in the array to the collection.
      Specified by:
      addAll in interface TIntCollection
      Parameters:
      array - a array of int 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 TIntCollection
      Parameters:
      collection - a Collection value
      Returns:
      true if the collection was modified by the retain all operation
    • retainAll

      public boolean retainAll(TIntCollection collection)
      Removes any values in the collection which are not contained in TIntCollection.
      Specified by:
      retainAll in interface TIntCollection
      Parameters:
      collection - a TIntCollection value
      Returns:
      true if the collection was modified by the retain all operation
    • retainAll

      public boolean retainAll(int[] array)
      Removes any values in the collection which are not contained in array.
      Specified by:
      retainAll in interface TIntCollection
      Parameters:
      array - an array of int 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 TIntCollection
      Parameters:
      collection - a Collection value
      Returns:
      true if the collection was modified by the remove all operation.
    • removeAll

      public boolean removeAll(TIntCollection collection)
      Removes all of the elements in TIntCollection from the collection.
      Specified by:
      removeAll in interface TIntCollection
      Parameters:
      collection - a TIntCollection value
      Returns:
      true if the collection was modified by the remove all operation.
    • removeAll

      public boolean removeAll(int[] array)
      Removes all of the elements in array from the collection.
      Specified by:
      removeAll in interface TIntCollection
      Parameters:
      array - an array of int primitives.
      Returns:
      true if the collection was modified by the remove all operation.
    • removeAt

      public int removeAt(int offset)
      Removes value at a given offset from the list.
      Specified by:
      removeAt in interface TIntList
      Parameters:
      offset - an int value that represents the offset to the element to be removed
      Returns:
      an int 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 TIntList
      Parameters:
      offset - an int value
      length - an int value
    • transformValues

      public void transformValues(TIntFunction function)
      Transform each value in the list using the specified function.
      Specified by:
      transformValues in interface TIntList
      Parameters:
      function - a TIntFunction value
    • reverse

      public void reverse()
      Reverse the order of the elements in the list.
      Specified by:
      reverse in interface TIntList
    • 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 TIntList
      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 TIntList
      Parameters:
      rand - a Random value
    • subList

      public TIntList subList(int begin, int end)
      Returns a sublist of this list.
      Specified by:
      subList in interface TIntList
      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 int[] toArray()
      Copies the contents of the list into a native array.
      Specified by:
      toArray in interface TIntCollection
      Specified by:
      toArray in interface TIntList
      Returns:
      an int[] value
    • toArray

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

      public int[] toArray(int[] 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 TIntList.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 TIntCollection
      Specified by:
      toArray in interface TIntList
      Parameters:
      dest - the array to copy into.
      Returns:
      the array passed in.
    • toArray

      public int[] toArray(int[] dest, int offset, int len)
      Copies a slice of the list into a native array.
      Specified by:
      toArray in interface TIntList
      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 int[] toArray(int[] dest, int source_pos, int dest_pos, int len)
      Copies a slice of the list into a native array.
      Specified by:
      toArray in interface TIntList
      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(TIntProcedure procedure)
      Applies the procedure to each value in the list in ascending (front to back) order.
      Specified by:
      forEach in interface TIntCollection
      Specified by:
      forEach in interface TIntList
      Parameters:
      procedure - a TIntProcedure value
      Returns:
      true if the procedure did not terminate prematurely.
    • forEachDescending

      public boolean forEachDescending(TIntProcedure procedure)
      Applies the procedure to each value in the list in descending (back to front) order.
      Specified by:
      forEachDescending in interface TIntList
      Parameters:
      procedure - a TIntProcedure 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 TIntList
      See Also:
    • 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 TIntList
      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(int val)
      Fills every slot in the list with the specified value.
      Specified by:
      fill in interface TIntList
      Parameters:
      val - the value to use when filling
    • fill

      public void fill(int fromIndex, int toIndex, int val)
      Fills a range in the list with the specified value.
      Specified by:
      fill in interface TIntList
      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(int 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 TIntList
      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(int 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 TIntList
      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(int value)
      Searches the list front to back for the index of value.
      Specified by:
      indexOf in interface TIntList
      Parameters:
      value - an int 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, int value)
      Searches the list front to back for the index of value, starting at offset.
      Specified by:
      indexOf in interface TIntList
      Parameters:
      offset - the offset at which to start the linear search (inclusive)
      value - an int value
      Returns:
      the first offset of the value, or -1 if it is not in the list.
      See Also:
    • lastIndexOf

      public int lastIndexOf(int value)
      Searches the list back to front for the last index of value.
      Specified by:
      lastIndexOf in interface TIntList
      Parameters:
      value - an int 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, int value)
      Searches the list back to front for the last index of value, starting at offset.
      Specified by:
      lastIndexOf in interface TIntList
      Parameters:
      offset - the offset at which to start the linear search (exclusive)
      value - an int value
      Returns:
      the last offset of the value, or -1 if it is not in the list.
      See Also:
    • contains

      public boolean contains(int value)
      Searches the list for value
      Specified by:
      contains in interface TIntCollection
      Specified by:
      contains in interface TIntList
      Parameters:
      value - an int value
      Returns:
      true if value is in the list.
    • iterator

      public TIntIterator iterator()
      Creates an iterator over the values of the collection. The iterator supports element deletion.
      Specified by:
      iterator in interface TIntCollection
      Returns:
      an TIntIterator value
    • grep

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

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

      public int min()
      Finds the minimum value in the list.
      Specified by:
      min in interface TIntList
      Returns:
      the smallest value in the list.
    • sum

      public int sum()
      Calculates the sum of all the values in the list.
      Specified by:
      sum in interface TIntList
      Returns:
      the sum of the values in the list (zero if the list is empty).
    • writeExternal

      public void writeExternal(ObjectOutput out) throws IOException
      Specified by:
      writeExternal in interface Externalizable
      Throws:
      IOException
    • readExternal

      public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException
      Specified by:
      readExternal in interface Externalizable
      Throws:
      IOException
      ClassNotFoundException
    • equals

      public boolean equals(Object o)
      Description copied from interface: TIntCollection
      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 TIntCollection
      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: TIntCollection
      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 TIntCollection
      Overrides:
      hashCode in class Object
      Returns:
      the hash code value for this collection
      See Also:
    • toString

      public String toString()
      Overrides:
      toString in class Object