Package gnu.trove

Class TLongArrayList

java.lang.Object
gnu.trove.TLongArrayList
All Implemented Interfaces:
Externalizable, Serializable, Cloneable
public class TLongArrayList extends Object implements Externalizable, Cloneable
A resizable, array-backed list of long primitives. Created: Sat Dec 29 14:21:12 2001
Author:
Eric D. Friedman, Rob Eden
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected long[]
    _data
    the data of the list
    protected int
    _pos
    the index after the last entry in the list
    protected static final int
    DEFAULT_CAPACITY
    the default capacity for new lists

  • Constructor Summary

    Constructors
    Constructor
    Description
    TLongArrayList()
    Creates a new TLongArrayList instance with the default capacity.
    TLongArrayList(int capacity)
    Creates a new TLongArrayList instance with the specified capacity.
    TLongArrayList(long[] values)
    Creates a new TLongArrayList instance whose capacity is the greater of the length of values and DEFAULT_CAPACITY and whose initial contents are the specified values.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    add(long val)
    Adds val to the end of the list, growing as needed.
    void
    add(long[] vals)
    Adds the values in the array vals to the end of the list, in order.
    void
    add(long[] vals, int offset, int length)
    Adds a subset of the values in the array vals to the end of the list, in order.
    int
    binarySearch(long value)
    Performs a binary search for value in the entire list.
    int
    binarySearch(long value, int fromIndex, int toIndex)
    Performs a binary search for value in the specified range.
    void
    clear()
    Flushes the internal state of the list, resetting the capacity to the default.
    void
    clear(int capacity)
    Flushes the internal state of the list, setting the capacity of the empty list to capacity.
    Object
    clone()
    Returns a clone of this list.
    boolean
    contains(long value)
    Searches the list for value
    void
    ensureCapacity(int capacity)
    Grow the internal array as needed to accommodate the specified number of elements.
    boolean
    equals(Object other)
    Compares this list to another list, value by value.
    void
    fill(int fromIndex, int toIndex, long val)
    Fills a range in the list with the specified value.
    void
    fill(long val)
    Fills every slot in the list with the specified value.
    boolean
    forEach(TLongProcedure procedure)
    Applies the procedure to each value in the list in ascending (front to back) order.
    boolean
    forEachDescending(TLongProcedure procedure)
    Applies the procedure to each value in the list in descending (back to front) order.
    long
    get(int offset)
    Returns the value at the specified offset.
    long
    getQuick(int offset)
    Returns the value at the specified offset without doing any bounds checking.
    long
    getSet(int offset, long val)
    Sets the value at the specified offset and returns the previously stored value.
    TLongArrayList
    grep(TLongProcedure condition)
    Searches the list for values satisfying condition in the manner of the *nix grep utility.
    int
    hashCode()
     
    int
    indexOf(int offset, long value)
    Searches the list front to back for the index of value, starting at offset.
    int
    indexOf(long value)
    Searches the list front to back for the index of value.
    void
    insert(int offset, long value)
    Inserts value into the list at offset.
    void
    insert(int offset, long[] values)
    Inserts the array of values into the list at offset.
    void
    insert(int offset, long[] values, int valOffset, int len)
    Inserts a slice of the array of values into the list at offset.
    TLongArrayList
    inverseGrep(TLongProcedure condition)
    Searches the list for values which do not satisfy condition.
    boolean
    isEmpty()
    Tests whether this list contains any values.
    int
    lastIndexOf(int offset, long value)
    Searches the list back to front for the last index of value, starting at offset.
    int
    lastIndexOf(long value)
    Searches the list back to front for the last index of value.
    long
    max()
    Finds the maximum value in the list.
    long
    min()
    Finds the minimum value in the list.
    void
    readExternal(ObjectInput in)
     
    long
    remove(int offset)
    Removes the value at offset from the list.
    void
    remove(int offset, int length)
    Removes length values from the list, starting at offset
    void
    reset()
    Sets the size of the list to 0, but does not change its capacity.
    void
    resetQuick()
    Sets the size of the list to 0, but does not change its capacity.
    void
    reverse()
    Reverse the order of the elements in the list.
    void
    reverse(int from, int to)
    Reverse the order of the elements in the range of the list.
    void
    set(int offset, long val)
    Sets the value at the specified offset.
    void
    set(int offset, long[] values)
    Replace the values in the list starting at offset with the contents of the values array.
    void
    set(int offset, long[] values, int valOffset, int length)
    Replace the values in the list starting at offset with length values from the values array, starting at valOffset.
    void
    setQuick(int offset, long val)
    Sets the value at the specified offset without doing any bounds checking.
    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.
    TLongArrayList
    subList(int begin, int end)
    Returns a sublist of this list.
    long[]
    toNativeArray()
    Copies the contents of the list into a native array.
    long[]
    toNativeArray(int offset, int len)
    Copies a slice of the list into a native array.
    void
    toNativeArray(long[] dest, int offset, int len)
    Copies a slice of the list into a native array.
    String
    toString()
    Returns a String representation of the list, front to back.
    void
    transformValues(TLongFunction function)
    Transform each value in the list using the specified function.
    void
    trimToSize()
    Sheds any excess capacity above and beyond the current size of the list.
    void
    writeExternal(ObjectOutput out)
     

    Methods inherited from class java.lang.Object

    finalize, getClass, notify, notifyAll, wait, wait, wait

  • Field Details

    • _data

      protected long[] _data
      the data of the list

    • _pos

      protected int _pos
      the index after the last entry in the list

    • DEFAULT_CAPACITY

      protected static final int DEFAULT_CAPACITY
      the default capacity for new lists
      See Also:

  • Constructor Details

    • TLongArrayList

      public TLongArrayList()
      Creates a new TLongArrayList instance with the default capacity.

    • TLongArrayList

      public TLongArrayList(int capacity)
      Creates a new TLongArrayList instance with the specified capacity.
      Parameters:
      capacity - an int value

    • TLongArrayList

      public TLongArrayList(long[] values)
      Creates a new TLongArrayList instance whose capacity is the greater of the length of values and DEFAULT_CAPACITY and whose initial contents are the specified values.
      Parameters:
      values - an long[] value

  • Method Details

    • ensureCapacity

      public void ensureCapacity(int capacity)
      Grow the internal array as needed to accommodate the specified number of elements. The size of the array longs on each resize unless capacity requires more than twice the current capacity.
      Parameters:
      capacity - an int value

    • size

      public int size()
      Returns the number of values in the list.
      Returns:
      the number of values in the list.

    • isEmpty

      public boolean isEmpty()
      Tests whether this list contains any values.
      Returns:
      true if the list is empty.

    • trimToSize

      public void trimToSize()
      Sheds any excess capacity above and beyond the current size of the list.

    • add

      public void add(long val)
      Adds val to the end of the list, growing as needed.
      Parameters:
      val - an long value

    • add

      public void add(long[] vals)
      Adds the values in the array vals to the end of the list, in order.
      Parameters:
      vals - an long[] value

    • add

      public void add(long[] vals, int offset, int length)
      Adds a subset of the values in the array vals to the end of the list, in order.
      Parameters:
      vals - an long[] value
      offset - the offset at which to start copying
      length - the number of values to copy.

    • insert

      public void insert(int offset, long value)
      Inserts value into the list at offset. All values including and to the right of offset are shifted to the right.
      Parameters:
      offset - an int value
      value - an long value

    • insert

      public void insert(int offset, long[] values)
      Inserts the array of values into the list at offset. All values including and to the right of offset are shifted to the right.
      Parameters:
      offset - an int value
      values - an long[] value

    • insert

      public void insert(int offset, long[] values, int valOffset, int len)
      Inserts a slice of the array of values into the list at offset. All values including and to the right of offset are shifted to the right.
      Parameters:
      offset - an int value
      values - an long[] 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 long get(int offset)
      Returns the value at the specified offset.
      Parameters:
      offset - an int value
      Returns:
      an long value

    • getQuick

      public long getQuick(int offset)
      Returns the value at the specified offset without doing any bounds checking.
      Parameters:
      offset - an int value
      Returns:
      an long value

    • set

      public void set(int offset, long val)
      Sets the value at the specified offset.
      Parameters:
      offset - an int value
      val - an long value

    • getSet

      public long getSet(int offset, long val)
      Sets the value at the specified offset and returns the previously stored value.
      Parameters:
      offset - an int value
      val - an long value
      Returns:
      the value previously stored at offset.

    • set

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

    • set

      public void set(int offset, long[] values, int valOffset, int length)
      Replace the values in the list starting at offset with length values from the values array, starting at valOffset.
      Parameters:
      offset - the first offset to 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

    • setQuick

      public void setQuick(int offset, long val)
      Sets the value at the specified offset without doing any bounds checking.
      Parameters:
      offset - an int value
      val - an long value

    • clear

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

    • clear

      public void clear(int capacity)
      Flushes the internal state of the list, setting the capacity of the empty list to capacity.
      Parameters:
      capacity - an int value

    • reset

      public void reset()
      Sets the size of the list to 0, but does not change its capacity. This method can be used as an alternative to the clear method if you want to recyle a list without allocating new backing arrays.
      See Also:

    • resetQuick

      public void resetQuick()
      Sets the size of the list to 0, but does not change its capacity. This method can be used as an alternative to the clear method if you want to recyle a list without allocating new backing arrays. This method differs from reset in that it does not clear the old values in the backing array. Thus, it is possible for getQuick to return stale data if this method is used and the caller is careless about bounds checking.
      See Also:

    • remove

      public long remove(int offset)
      Removes the value at offset from the list.
      Parameters:
      offset - an int value
      Returns:
      the value previously stored at offset.

    • remove

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

    • transformValues

      public void transformValues(TLongFunction function)
      Transform each value in the list using the specified function.
      Parameters:
      function - a TLongFunction value

    • reverse

      public void reverse()
      Reverse the order of the elements in the list.

    • reverse

      public void reverse(int from, int to)
      Reverse the order of the elements in the range of the list.
      Parameters:
      from - the inclusive index at which to start 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.
      Parameters:
      rand - a Random value

    • clone

      public Object clone()
      Returns a clone of this list. Since this is a primitive collection, this will be a deep clone.
      Overrides:
      clone in class Object
      Returns:
      a deep clone of the list.

    • subList

      public TLongArrayList subList(int begin, int end)
      Returns a sublist of this list.
      Parameters:
      begin - low endpoint (inclusive) of the subList.
      end - high endpoint (exclusive) of the subList.
      Returns:
      sublist of this list from begin, inclusive to end, exclusive.
      Throws:
      IndexOutOfBoundsException - - endpoint out of range
      IllegalArgumentException - - endpoints out of order (end > begin)

    • toNativeArray

      public long[] toNativeArray()
      Copies the contents of the list into a native array.
      Returns:
      an long[] value

    • toNativeArray

      public long[] toNativeArray(int offset, int len)
      Copies a slice of the list into a native array.
      Parameters:
      offset - the offset at which to start copying
      len - the number of values to copy.
      Returns:
      an long[] value

    • toNativeArray

      public void toNativeArray(long[] dest, int offset, int len)
      Copies a slice of the list into a native array.
      Parameters:
      dest - the array to copy into.
      offset - the offset of the first value to copy
      len - the number of values to copy.

    • equals

      public boolean equals(Object other)
      Compares this list to another list, value by value.
      Overrides:
      equals in class Object
      Parameters:
      other - the object to compare against
      Returns:
      true if other is a TLongArrayList and has exactly the same values.

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • forEach

      public boolean forEach(TLongProcedure procedure)
      Applies the procedure to each value in the list in ascending (front to back) order.
      Parameters:
      procedure - a TLongProcedure value
      Returns:
      true if the procedure did not terminate prematurely.

    • forEachDescending

      public boolean forEachDescending(TLongProcedure procedure)
      Applies the procedure to each value in the list in descending (back to front) order.
      Parameters:
      procedure - a TLongProcedure value
      Returns:
      true if the procedure did not terminate prematurely.

    • sort

      public void sort()
      Sort the values in the list (ascending) using the Sun quicksort implementation.
      See Also:

    • sort

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

    • fill

      public void fill(long val)
      Fills every slot in the list with the specified value.
      Parameters:
      val - the value to use when filling

    • fill

      public void fill(int fromIndex, int toIndex, long val)
      Fills a range in the list with the specified value.
      Parameters:
      fromIndex - the offset at which to start filling (inclusive)
      toIndex - the offset at which to stop filling (exclusive)
      val - the value to use when filling

    • binarySearch

      public int binarySearch(long value)
      Performs a binary search for value in the entire list. Note that you must @{link #sort sort} the list before doing a search.
      Parameters:
      value - the value to search for
      Returns:
      the absolute offset in the list of the value, or its negative insertion point into the sorted list.

    • binarySearch

      public int binarySearch(long value, int fromIndex, int toIndex)
      Performs a binary search for value in the specified range. Note that you must @{link #sort sort} the list or the range before doing a search.
      Parameters:
      value - the value to search 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(long value)
      Searches the list front to back for the index of value.
      Parameters:
      value - an long 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, long value)
      Searches the list front to back for the index of value, starting at offset.
      Parameters:
      offset - the offset at which to start the linear search (inclusive)
      value - an long value
      Returns:
      the first offset of the value, or -1 if it is not in the list.
      See Also:

    • lastIndexOf

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

    • contains

      public boolean contains(long value)
      Searches the list for value
      Parameters:
      value - an long value
      Returns:
      true if value is in the list.

    • grep

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

    • inverseGrep

      public TLongArrayList inverseGrep(TLongProcedure condition)
      Searches the list for values which do not satisfy condition. This is akin to *nix grep -v.
      Parameters:
      condition - a condition to apply to each element in the list
      Returns:
      a list of values which do not match the condition.

    • max

      public long max()
      Finds the maximum value in the list.
      Returns:
      the largest value in the list.
      Throws:
      IllegalStateException - if the list is empty

    • min

      public long min()
      Finds the minimum value in the list.
      Returns:
      the smallest value in the list.
      Throws:
      IllegalStateException - if the list is empty

    • toString

      public String toString()
      Returns a String representation of the list, front to back.
      Overrides:
      toString in class Object
      Returns:
      a String value

    • 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