Class TShortLinkedList

java.lang.Object
gnu.trove.list.linked.TShortLinkedList
All Implemented Interfaces:
TShortList, TShortCollection, Externalizable, Serializable

public class TShortLinkedList extends Object implements TShortList, Externalizable
A resizable, double linked list of short primitives.
See Also:
  • Field Summary

    Fields inherited from interface gnu.trove.TShortCollection

    serialVersionUID
  • Constructor Summary

    Constructors
    Constructor
    Description
     
    TShortLinkedList(short no_entry_value)
     
     
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    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.
    boolean
    addAll(short[] array)
    Adds all of the elements in the array to the collection.
    boolean
    Adds all of the elements in the TShortCollection to the collection.
    boolean
    addAll(Collection<? extends Short> collection)
    Adds all of the elements in collection to the collection.
    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
    Flushes the internal state of the list, resetting the capacity to the default.
    boolean
    contains(short value)
    Searches the list for value
    boolean
    containsAll(short[] 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 TShortCollection 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 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
    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.
    short
    get(int offset)
    Returns the value at the specified offset.
    gnu.trove.list.linked.TShortLinkedList.TShortLink
    getLinkAt(int offset)
    Returns the link at the given offset.
    short
    Returns the value that is used to represent null.
    grep(TShortProcedure 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 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.
    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 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
    void
    remove(int offset, int length)
    Removes length values from the list, starting at offset
    boolean
    remove(short value)
    Removes value from the list.
    boolean
    removeAll(short[] array)
    Removes all of the elements in array from the collection.
    boolean
    Removes all of the elements in TShortCollection from the collection.
    boolean
    removeAll(Collection<?> collection)
    Removes all of the elements in collection from the collection.
    short
    removeAt(int offset)
    Removes value at a given offset from the list.
    short
    replace(int offset, short val)
    Sets the value at the specified offset and returns the previously stored value.
    boolean
    retainAll(short[] 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 TShortCollection.
    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.
    short
    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
    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.
    short
    sum()
    Calculates the sum of all the values in the list.
    short[]
    Copies the contents of the list into a native array.
    short[]
    toArray(int offset, int len)
    Copies a slice of the list into a native array.
    short[]
    toArray(short[] dest)
    Copies a slice of the list into a native array.
    short[]
    toArray(short[] dest, int offset, int len)
    Copies a slice of the list into a native array.
    short[]
    toArray(short[] dest, int source_pos, int dest_pos, 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

    • TShortLinkedList

      public TShortLinkedList()
    • TShortLinkedList

      public TShortLinkedList(short no_entry_value)
    • TShortLinkedList

      public TShortLinkedList(TShortList list)
  • Method Details

    • getNoEntryValue

      public short 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 TShortCollection
      Specified by:
      getNoEntryValue in interface TShortList
      Returns:
      the value that represents null
    • size

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

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

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

      public void add(short[] vals)
      Adds the values in the array vals to the end of the list, in order.
      Specified by:
      add in interface TShortList
      Parameters:
      vals - an short[] 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.
      Specified by:
      add in interface TShortList
      Parameters:
      vals - an short[] value
      offset - the offset at which to start copying
      length - 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.
      Specified by:
      insert in interface TShortList
      Parameters:
      offset - an int value
      value - an short 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.
      Specified by:
      insert in interface TShortList
      Parameters:
      offset - an int value
      values - an short[] 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.
      Specified by:
      insert in interface TShortList
      Parameters:
      offset - an int value
      values - an short[] 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 short get(int offset)
      Returns the value at the specified offset.
      Specified by:
      get in interface TShortList
      Parameters:
      offset - an int value
      Returns:
      an short value
    • getLinkAt

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

      public void set(int offset, short[] values)
      Replace the values in the list starting at offset with the contents of the values array.
      Specified by:
      set in interface TShortList
      Parameters:
      offset - the first offset to replace
      values - 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.
      Specified by:
      set in interface TShortList
      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 short replace(int offset, short val)
      Sets the value at the specified offset and returns the previously stored value.
      Specified by:
      replace in interface TShortList
      Parameters:
      offset - an int value
      val - an short 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 TShortCollection
      Specified by:
      clear in interface TShortList
    • remove

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

      public boolean forEachDescending(TShortProcedure procedure)
      Applies the procedure to each value in the list in descending (back to front) order.
      Specified by:
      forEachDescending in interface TShortList
      Parameters:
      procedure - a TShortProcedure 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 TShortList
      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 TShortList
      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.
      Specified by:
      fill in interface TShortList
      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.
      Specified by:
      fill in interface TShortList
      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.
      Specified by:
      binarySearch in interface TShortList
      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.
      Specified by:
      binarySearch in interface TShortList
      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(short value)
      Searches the list front to back for the index of value.
      Specified by:
      indexOf in interface TShortList
      Parameters:
      value - an short 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.
      Specified by:
      indexOf in interface TShortList
      Parameters:
      offset - the offset at which to start the linear search (inclusive)
      value - an short 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.
      Specified by:
      lastIndexOf in interface TShortList
      Parameters:
      value - an short 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.
      Specified by:
      lastIndexOf in interface TShortList
      Parameters:
      offset - the offset at which to start the linear search (exclusive)
      value - an short 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
      Specified by:
      contains in interface TShortCollection
      Specified by:
      contains in interface TShortList
      Parameters:
      value - an short value
      Returns:
      true if value is in the list.
    • iterator

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

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

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

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

      public short sum()
      Calculates the sum of all the values in the list.
      Specified by:
      sum in interface TShortList
      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: TShortCollection
      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 TShortCollection
      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: TShortCollection
      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 TShortCollection
      Overrides:
      hashCode in class Object
      Returns:
      the hash code value for this collection
      See Also:
    • toString

      public String toString()
      Overrides:
      toString in class Object