Class IntBigArrayBigList

java.lang.Object
java.util.AbstractCollection<Integer>
it.unimi.dsi.fastutil.ints.AbstractIntCollection
it.unimi.dsi.fastutil.ints.AbstractIntBigList
it.unimi.dsi.fastutil.ints.IntBigArrayBigList
All Implemented Interfaces:
it.unimi.dsi.fastutil.BigList<Integer>, IntBigList, it.unimi.dsi.fastutil.ints.IntCollection, it.unimi.dsi.fastutil.ints.IntIterable, it.unimi.dsi.fastutil.ints.IntStack, it.unimi.dsi.fastutil.Size64, it.unimi.dsi.fastutil.Stack<Integer>, Serializable, Cloneable, Comparable<it.unimi.dsi.fastutil.BigList<? extends Integer>>, Iterable<Integer>, Collection<Integer>, RandomAccess

public class IntBigArrayBigList extends AbstractIntBigList implements RandomAccess, Cloneable, Serializable
A type-specific big list based on a big array; provides some additional methods that use polymorphism to avoid (un)boxing.

This class implements a lightweight, fast, open, optimized, reuse-oriented version of big-array-based big lists. Instances of this class represent a big list with a big array that is enlarged as needed when new entries are created (by increasing its current length by 50%), but is never made smaller (even on a clear()). A family of trimming methods lets you control the size of the backing big array; this is particularly useful if you reuse instances of this class. Range checks are equivalent to those of java.util's classes, but they are delayed as much as possible. The backing big array is exposed by the elements() method.

This class implements the bulk methods removeElements(), addElements() and getElements() using high-performance system calls (e.g., System.arraycopy()) instead of expensive loops.

See Also:
  • Nested Class Summary

    Nested classes/interfaces inherited from class it.unimi.dsi.fastutil.ints.AbstractIntBigList

    AbstractIntBigList.IntRandomAccessSubList, AbstractIntBigList.IntSubList
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected int[][]
    The backing big array.
    static final int
    The initial default capacity of a big-array big list.
    protected long
    The current actual size of the big list (never greater than the backing-array length).
  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
     
    Creates a new big-array big list with DEFAULT_INITIAL_CAPACITY capacity.
     
    IntBigArrayBigList(int[][] a)
    Creates a new big-array big list and fills it with the elements of a given big array.
    protected
    IntBigArrayBigList(int[][] a, boolean dummy)
    Creates a new big-array big list using a given array.
     
    IntBigArrayBigList(int[][] a, long offset, long length)
    Creates a new big-array big list and fills it with the elements of a given big array.
     
    IntBigArrayBigList(long capacity)
    Creates a new big-array big list with given capacity.
     
    Creates a new big-array big list and fills it with a given type-specific list.
     
    IntBigArrayBigList(it.unimi.dsi.fastutil.ints.IntCollection c)
    Creates a new big-array big list and fills it with a given type-specific collection.
     
    IntBigArrayBigList(it.unimi.dsi.fastutil.ints.IntIterator i)
    Creates a new big-array big list and fills it with the elements returned by a type-specific iterator..
     
    Creates a new big-array big list and fills it with the elements returned by an iterator..
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    add(int k)
    void
    add(long index, int k)
    Inserts the specified element at the specified position in this type-specific big list (optional operation).
    boolean
    addAll(long index, IntBigList list)
    Inserts all of the elements in the specified type-specific big list into this type-specific big list at the specified position (optional operation).
    boolean
    addAll(long index, it.unimi.dsi.fastutil.ints.IntCollection c)
    Inserts all of the elements in the specified type-specific collection into this type-specific big list at the specified position (optional operation).
    boolean
    addAll(long index, it.unimi.dsi.fastutil.ints.IntList list)
    Inserts all of the elements in the specified type-specific list into this type-specific big list at the specified position (optional operation).
    void
    addElements(long index, int[][] a, long offset, long length)
    Adds elements to this type-specific list using optimized system calls.
    void
     
    int
    compareTo(it.unimi.dsi.fastutil.BigList<? extends Integer> l)
    Compares this big list to another object.
    int
    Compares this big list to another big list.
    int[][]
    Returns the backing big array of this big list.
    void
    ensureCapacity(long capacity)
    Ensures that this big-array big list can contain the given number of entries without resizing.
    boolean
    Compares this type-specific big-array list to another one.
    boolean
     
    void
    void
    getElements(long from, int[][] a, long offset, long length)
    Copies element of this type-specific list into the given big array using optimized system calls.
    void
    getElements(long from, int[] a, int offset, int length)
    Copies element of this type-specific list into the given array using optimized system calls.
    int
    getInt(long index)
    Returns the element at the specified position.
    void
    grow(long capacity)
    Grows this big-array big list, ensuring that it can contain the given number of entries without resizing, and in case increasing current capacity at least by a factor of 50%.
    long
    indexOf(int k)
    Returns the index of the first occurrence of the specified element in this type-specific big list, or -1 if this big list does not contain the element.
    boolean
     
    long
    lastIndexOf(int k)
    Returns the index of the last occurrence of the specified element in this type-specific big list, or -1 if this big list does not contain the element.
    it.unimi.dsi.fastutil.ints.IntBigListIterator
    listIterator(long index)
    Returns a type-specific list iterator on this type-specific big list starting at a given index.
    of()
    Creates a new empty big array list.
    of(int... init)
    Creates a big array list using a list of elements.
    boolean
    rem(int k)
    Removes a single instance of the specified element from this collection, if it is present (optional operation).
    boolean
    removeAll(it.unimi.dsi.fastutil.ints.IntCollection c)
     
    boolean
     
    void
    removeElements(long from, long to)
    Removes elements of this type-specific list using optimized system calls.
    int
    removeInt(long index)
    Removes the element at the specified position.
    int
    set(long index, int k)
    Replaces the element at the specified position in this big list with the specified element (optional operation).
    void
    setElements(long index, int[][] a, long offset, long length)
    Copies elements in the given big array into this type-specific list using optimized system calls.
    void
    size(long size)
     
    long
     
    it.unimi.dsi.fastutil.ints.IntSpliterator
    Returns a type-specific spliterator on the elements of this big-list.
    subList(long from, long to)
    Returns a type-specific view of the portion of this type-specific big list from the index from, inclusive, to the index to, exclusive.
    Collects the result of a primitive Stream into a new BigArrayBigList.
    toBigListWithExpectedSize(IntStream stream, long expectedSize)
    Collects the result of a primitive Stream into a new BigArrayBigList.
    void
    Trims this big-array big list so that the capacity is equal to the size.
    void
    trim(long n)
    Trims the backing big array if it is too large.
    wrap(int[][] a)
    Wraps a given big array into a big-array big list.
    wrap(int[][] a, long length)
    Wraps a given big array into a big-array list of given size.

    Methods inherited from class it.unimi.dsi.fastutil.ints.AbstractIntCollection

    add, contains, containsAll, containsAll, forEach, remove, removeIf, retainAll, retainAll, toArray, toIntArray, toIntArray

    Methods inherited from class java.util.AbstractCollection

    toArray, toArray

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface java.util.Collection

    containsAll, retainAll, toArray, toArray, toArray

    Methods inherited from interface it.unimi.dsi.fastutil.ints.IntBigList

    addAll, addAll, setElements, setElements

    Methods inherited from interface it.unimi.dsi.fastutil.ints.IntCollection

    add, contains, containsAll, intIterator, intParallelStream, intSpliterator, intStream, parallelStream, remove, removeIf, removeIf, removeIf, retainAll, stream, toArray, toIntArray, toIntArray

    Methods inherited from interface it.unimi.dsi.fastutil.ints.IntIterable

    forEach, forEach
  • Field Details

    • DEFAULT_INITIAL_CAPACITY

      public static final int DEFAULT_INITIAL_CAPACITY
      The initial default capacity of a big-array big list.
      See Also:
    • a

      protected transient int[][] a
      The backing big array.
    • size

      protected long size
      The current actual size of the big list (never greater than the backing-array length).
  • Constructor Details

    • IntBigArrayBigList

      protected IntBigArrayBigList(int[][] a, boolean dummy)
      Creates a new big-array big list using a given array.

      This constructor is only meant to be used by the wrapping methods.

      Parameters:
      a - the big array that will be used to back this big-array big list.
    • IntBigArrayBigList

      public IntBigArrayBigList(long capacity)
      Creates a new big-array big list with given capacity.
      Parameters:
      capacity - the initial capacity of the array list (may be 0).
    • IntBigArrayBigList

      public IntBigArrayBigList()
      Creates a new big-array big list with DEFAULT_INITIAL_CAPACITY capacity.
    • IntBigArrayBigList

      public IntBigArrayBigList(it.unimi.dsi.fastutil.ints.IntCollection c)
      Creates a new big-array big list and fills it with a given type-specific collection.
      Parameters:
      c - a type-specific collection that will be used to fill the array list.
    • IntBigArrayBigList

      public IntBigArrayBigList(IntBigList l)
      Creates a new big-array big list and fills it with a given type-specific list.
      Parameters:
      l - a type-specific list that will be used to fill the array list.
    • IntBigArrayBigList

      public IntBigArrayBigList(int[][] a)
      Creates a new big-array big list and fills it with the elements of a given big array.
      Parameters:
      a - a big array whose elements will be used to fill the array list.
    • IntBigArrayBigList

      public IntBigArrayBigList(int[][] a, long offset, long length)
      Creates a new big-array big list and fills it with the elements of a given big array.
      Parameters:
      a - a big array whose elements will be used to fill the array list.
      offset - the first element to use.
      length - the number of elements to use.
    • IntBigArrayBigList

      public IntBigArrayBigList(Iterator<? extends Integer> i)
      Creates a new big-array big list and fills it with the elements returned by an iterator..
      Parameters:
      i - an iterator whose returned elements will fill the array list.
    • IntBigArrayBigList

      public IntBigArrayBigList(it.unimi.dsi.fastutil.ints.IntIterator i)
      Creates a new big-array big list and fills it with the elements returned by a type-specific iterator..
      Parameters:
      i - a type-specific iterator whose returned elements will fill the array list.
  • Method Details

    • elements

      public int[][] elements()
      Returns the backing big array of this big list.
      Returns:
      the backing big array.
    • wrap

      public static IntBigArrayBigList wrap(int[][] a, long length)
      Wraps a given big array into a big-array list of given size.
      Parameters:
      a - a big array to wrap.
      length - the length of the resulting big-array list.
      Returns:
      a new big-array list of the given size, wrapping the given big array.
    • wrap

      public static IntBigArrayBigList wrap(int[][] a)
      Wraps a given big array into a big-array big list.
      Parameters:
      a - a big array to wrap.
      Returns:
      a new big-array big list wrapping the given array.
    • of

      public static IntBigArrayBigList of()
      Creates a new empty big array list.
      Returns:
      a new empty big-array big list.
    • of

      public static IntBigArrayBigList of(int... init)
      Creates a big array list using a list of elements.
      Parameters:
      init - a list of elements that will be used to initialize the big list. It is possible (but not assured) that the returned big-array big list will be backed by the given array in one of its segments.
      Returns:
      a new big-array big list containing the given elements.
      See Also:
      • BigArrays.wrap(byte[])
    • toBigList

      public static IntBigArrayBigList toBigList(IntStream stream)
      Collects the result of a primitive Stream into a new BigArrayBigList.

      This method performs a terminal operation on the given Stream

    • toBigListWithExpectedSize

      public static IntBigArrayBigList toBigListWithExpectedSize(IntStream stream, long expectedSize)
      Collects the result of a primitive Stream into a new BigArrayBigList.

      This method performs a terminal operation on the given Stream

    • ensureCapacity

      public void ensureCapacity(long capacity)
      Ensures that this big-array big list can contain the given number of entries without resizing.
      Parameters:
      capacity - the new minimum capacity for this big-array big list.
    • grow

      public void grow(long capacity)
      Grows this big-array big list, ensuring that it can contain the given number of entries without resizing, and in case increasing current capacity at least by a factor of 50%.
      Parameters:
      capacity - the new minimum capacity for this big-array big list.
    • add

      public void add(long index, int k)
      Description copied from class: AbstractIntBigList
      Inserts the specified element at the specified position in this type-specific big list (optional operation).
      Specified by:
      add in interface IntBigList
      Overrides:
      add in class AbstractIntBigList
      See Also:
      • BigList.add(long,Object)
    • add

      public boolean add(int k)
      Description copied from class: AbstractIntBigList
      Specified by:
      add in interface it.unimi.dsi.fastutil.ints.IntCollection
      Overrides:
      add in class AbstractIntBigList
    • getInt

      public int getInt(long index)
      Description copied from interface: IntBigList
      Returns the element at the specified position.
      Specified by:
      getInt in interface IntBigList
      See Also:
      • BigList.get(long)
    • indexOf

      public long indexOf(int k)
      Description copied from interface: IntBigList
      Returns the index of the first occurrence of the specified element in this type-specific big list, or -1 if this big list does not contain the element.
      Specified by:
      indexOf in interface IntBigList
      Overrides:
      indexOf in class AbstractIntBigList
      See Also:
      • BigList.indexOf(Object)
    • lastIndexOf

      public long lastIndexOf(int k)
      Description copied from interface: IntBigList
      Returns the index of the last occurrence of the specified element in this type-specific big list, or -1 if this big list does not contain the element.
      Specified by:
      lastIndexOf in interface IntBigList
      Overrides:
      lastIndexOf in class AbstractIntBigList
      See Also:
      • BigList.lastIndexOf(Object)
    • removeInt

      public int removeInt(long index)
      Description copied from class: AbstractIntBigList
      Removes the element at the specified position.
      Specified by:
      removeInt in interface IntBigList
      Overrides:
      removeInt in class AbstractIntBigList
      See Also:
      • BigList.remove(long)
    • rem

      public boolean rem(int k)
      Description copied from class: AbstractIntBigList
      Removes a single instance of the specified element from this collection, if it is present (optional operation).
      Specified by:
      rem in interface it.unimi.dsi.fastutil.ints.IntCollection
      Overrides:
      rem in class AbstractIntBigList
      See Also:
    • set

      public int set(long index, int k)
      Description copied from class: AbstractIntBigList
      Replaces the element at the specified position in this big list with the specified element (optional operation).
      Specified by:
      set in interface IntBigList
      Overrides:
      set in class AbstractIntBigList
      See Also:
      • BigList.set(long,Object)
    • removeAll

      public boolean removeAll(it.unimi.dsi.fastutil.ints.IntCollection c)
      Specified by:
      removeAll in interface it.unimi.dsi.fastutil.ints.IntCollection
      Overrides:
      removeAll in class it.unimi.dsi.fastutil.ints.AbstractIntCollection
    • removeAll

      public boolean removeAll(Collection<?> c)
      Specified by:
      removeAll in interface Collection<Integer>
      Overrides:
      removeAll in class it.unimi.dsi.fastutil.ints.AbstractIntCollection
    • addAll

      public boolean addAll(long index, it.unimi.dsi.fastutil.ints.IntCollection c)
      Description copied from class: AbstractIntBigList
      Inserts all of the elements in the specified type-specific collection into this type-specific big list at the specified position (optional operation).
      Specified by:
      addAll in interface IntBigList
      Overrides:
      addAll in class AbstractIntBigList
      See Also:
    • addAll

      public boolean addAll(long index, IntBigList list)
      Description copied from interface: IntBigList
      Inserts all of the elements in the specified type-specific big list into this type-specific big list at the specified position (optional operation).
      Specified by:
      addAll in interface IntBigList
      See Also:
      • BigList.addAll(long,Collection)
    • addAll

      public boolean addAll(long index, it.unimi.dsi.fastutil.ints.IntList list)
      Description copied from interface: IntBigList
      Inserts all of the elements in the specified type-specific list into this type-specific big list at the specified position (optional operation).
      Specified by:
      addAll in interface IntBigList
      See Also:
      • BigList.addAll(long,Collection)
    • clear

      public void clear()
      Description copied from class: AbstractIntBigList
      Specified by:
      clear in interface Collection<Integer>
      Overrides:
      clear in class AbstractIntBigList
    • size64

      public long size64()
      Specified by:
      size64 in interface it.unimi.dsi.fastutil.Size64
    • size

      public void size(long size)
      Specified by:
      size in interface it.unimi.dsi.fastutil.BigList<Integer>
      Overrides:
      size in class AbstractIntBigList
    • isEmpty

      public boolean isEmpty()
      Specified by:
      isEmpty in interface Collection<Integer>
      Specified by:
      isEmpty in interface it.unimi.dsi.fastutil.Stack<Integer>
      Overrides:
      isEmpty in class AbstractCollection<Integer>
    • trim

      public void trim()
      Trims this big-array big list so that the capacity is equal to the size.
      See Also:
    • trim

      public void trim(long n)
      Trims the backing big array if it is too large. If the current big array length is smaller than or equal to n, this method does nothing. Otherwise, it trims the big-array length to the maximum between n and size64().

      This method is useful when reusing big lists. Clearing a big list leaves the big-array length untouched. If you are reusing a big list many times, you can call this method with a typical size to avoid keeping around a very large big array just because of a few large transient big lists.

      Parameters:
      n - the threshold for the trimming.
    • subList

      public IntBigList subList(long from, long to)
      Description copied from interface: IntBigList
      Returns a type-specific view of the portion of this type-specific big list from the index from, inclusive, to the index to, exclusive.
      Specified by:
      subList in interface it.unimi.dsi.fastutil.BigList<Integer>
      Specified by:
      subList in interface IntBigList
      Overrides:
      subList in class AbstractIntBigList
      See Also:
      • BigList.subList(long,long)
    • getElements

      public void getElements(long from, int[][] a, long offset, long length)
      Copies element of this type-specific list into the given big array using optimized system calls.
      Specified by:
      getElements in interface IntBigList
      Overrides:
      getElements in class AbstractIntBigList
      Parameters:
      from - the start index (inclusive).
      a - the destination big array.
      offset - the offset into the destination array where to store the first element copied.
      length - the number of elements to be copied.
    • getElements

      public void getElements(long from, int[] a, int offset, int length)
      Copies element of this type-specific list into the given array using optimized system calls.
      Specified by:
      getElements in interface IntBigList
      Parameters:
      from - the start index (inclusive).
      a - the destination array.
      offset - the offset into the destination array where to store the first element copied.
      length - the number of elements to be copied.
    • removeElements

      public void removeElements(long from, long to)
      Removes elements of this type-specific list using optimized system calls.
      Specified by:
      removeElements in interface IntBigList
      Overrides:
      removeElements in class AbstractIntBigList
      Parameters:
      from - the start index (inclusive).
      to - the end index (exclusive).
    • addElements

      public void addElements(long index, int[][] a, long offset, long length)
      Adds elements to this type-specific list using optimized system calls.
      Specified by:
      addElements in interface IntBigList
      Overrides:
      addElements in class AbstractIntBigList
      Parameters:
      index - the index at which to add elements.
      a - the big array containing the elements.
      offset - the offset of the first element to add.
      length - the number of elements to add.
    • setElements

      public void setElements(long index, int[][] a, long offset, long length)
      Copies elements in the given big array into this type-specific list using optimized system calls.
      Specified by:
      setElements in interface IntBigList
      Overrides:
      setElements in class AbstractIntBigList
      Parameters:
      index - the start index (inclusive).
      a - the destination big array.
      offset - the offset into the destination array where to store the first element copied.
      length - the number of elements to be copied.
    • forEach

      public void forEach(IntConsumer action)
      Description copied from class: AbstractIntBigList
      Specified by:
      forEach in interface it.unimi.dsi.fastutil.ints.IntIterable
      Overrides:
      forEach in class AbstractIntBigList
    • listIterator

      public it.unimi.dsi.fastutil.ints.IntBigListIterator listIterator(long index)
      Description copied from class: AbstractIntBigList
      Returns a type-specific list iterator on this type-specific big list starting at a given index.
      Specified by:
      listIterator in interface it.unimi.dsi.fastutil.BigList<Integer>
      Specified by:
      listIterator in interface IntBigList
      Overrides:
      listIterator in class AbstractIntBigList
      See Also:
      • BigList.listIterator(long)
    • spliterator

      public it.unimi.dsi.fastutil.ints.IntSpliterator spliterator()
      Description copied from interface: IntBigList
      Returns a type-specific spliterator on the elements of this big-list.

      BigList spliterators must report at least Spliterator.SIZED and Spliterator.ORDERED.

      See List.spliterator() for more documentation on the requirements of the returned spliterator (despite BigList not being a List, most of the same requirements apply.

      Specified by:
      spliterator in interface Collection<Integer>
      Specified by:
      spliterator in interface IntBigList
      Specified by:
      spliterator in interface it.unimi.dsi.fastutil.ints.IntCollection
      Specified by:
      spliterator in interface it.unimi.dsi.fastutil.ints.IntIterable
      Specified by:
      spliterator in interface Iterable<Integer>
      Returns:
    • clone

      public IntBigArrayBigList clone()
      Overrides:
      clone in class Object
    • equals

      public boolean equals(IntBigArrayBigList l)
      Compares this type-specific big-array list to another one.

      This method exists only for sake of efficiency. The implementation inherited from the abstract implementation would already work.

      Parameters:
      l - a type-specific big-array list.
      Returns:
      true if the argument contains the same elements of this type-specific big-array list.
    • equals

      public boolean equals(Object o)
      Specified by:
      equals in interface Collection<Integer>
      Overrides:
      equals in class AbstractIntBigList
    • compareTo

      public int compareTo(IntBigArrayBigList l)
      Compares this big list to another big list.

      This method exists only for sake of efficiency. The implementation inherited from the abstract implementation would already work.

      Parameters:
      l - a big list.
      Returns:
      a negative integer, zero, or a positive integer as this big list is lexicographically less than, equal to, or greater than the argument.
    • compareTo

      public int compareTo(it.unimi.dsi.fastutil.BigList<? extends Integer> l)
      Description copied from class: AbstractIntBigList
      Compares this big list to another object. If the argument is a BigList, this method performs a lexicographical comparison; otherwise, it throws a ClassCastException.
      Specified by:
      compareTo in interface Comparable<it.unimi.dsi.fastutil.BigList<? extends Integer>>
      Overrides:
      compareTo in class AbstractIntBigList
      Parameters:
      l - a big list.
      Returns:
      if the argument is a BigList, a negative integer, zero, or a positive integer as this list is lexicographically less than, equal to, or greater than the argument.