Package it.unimi.dsi.fastutil.objects

Class ReferenceBigArrayBigList<K>

java.lang.Object
java.util.AbstractCollection<K>
it.unimi.dsi.fastutil.objects.AbstractReferenceCollection<K>
it.unimi.dsi.fastutil.objects.AbstractReferenceBigList<K>
it.unimi.dsi.fastutil.objects.ReferenceBigArrayBigList<K>
All Implemented Interfaces:
BigList<K>, ObjectIterable<K>, ReferenceBigList<K>, ReferenceCollection<K>, Size64, Stack<K>, Serializable, Cloneable, Iterable<K>, Collection<K>, RandomAccess
public class ReferenceBigArrayBigList<K> extends AbstractReferenceBigList<K> implements RandomAccess, Cloneable, Serializable
A type-specific big-array-based big list; 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 to 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. If an instance of this class was created by wrapping, backing-array reallocations will be performed using reflection, so that elements() can return a big array of the same type of the original big array; the comments about efficiency made in ObjectArrays apply here.

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:

  • Field Details

    • DEFAULT_INITIAL_CAPACITY

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

  • Constructor Details

    • ReferenceBigArrayBigList

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

    • ReferenceBigArrayBigList

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

    • ReferenceBigArrayBigList

      public ReferenceBigArrayBigList(ReferenceCollection<? extends K> 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.

    • ReferenceBigArrayBigList

      public ReferenceBigArrayBigList(Collection<? extends K> c)
      Creates a new big-array big list and fills it with a given collection.
      Parameters:
      c - a collection that will be used to fill the array list.

    • ReferenceBigArrayBigList

      public ReferenceBigArrayBigList(ReferenceBigList<? extends K> 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.

    • ReferenceBigArrayBigList

      public ReferenceBigArrayBigList(K[][] 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.

    • ReferenceBigArrayBigList

      public ReferenceBigArrayBigList(K[][] 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.

    • ReferenceBigArrayBigList

      public ReferenceBigArrayBigList(Iterator<? extends K> 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.

    • ReferenceBigArrayBigList

      public ReferenceBigArrayBigList(ObjectIterator<? extends K> 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 K[][] elements()
      Returns the backing big array of this big list.

      If this big-array big list was created by wrapping a given big array, it is guaranteed that the type of the returned big array will be the same. Otherwise, the returned big array will be an big array of objects.

      Returns:
      the backing big array.

    • wrap

      public static <K> ReferenceBigArrayBigList<K> wrap(K[][] 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 <K> ReferenceBigArrayBigList<K> wrap(K[][] 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 <K> ReferenceBigArrayBigList<K> of()
      Creates a new empty big array list.
      Returns:
      a new empty big-array big list.

    • of

      @SafeVarargs public static <K> ReferenceBigArrayBigList<K> of(K... 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:

    • toBigList

      public static <K> Collector<K,?,ReferenceBigArrayBigList<K>> toBigList()
      Returns a Collector that collects a Stream's elements into a new ArrayList.

    • toBigListWithExpectedSize

      public static <K> Collector<K,?,ReferenceBigArrayBigList<K>> toBigListWithExpectedSize(long expectedSize)
      Returns a Collector that collects a Stream's elements into a new ArrayList.
      Implementation Notes:
      The current implementation preallocates the full size for every worker thread when used on parallel streams. This can be quite wasteful, as worker threads other then the first don't usually handle the contents of the full 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.

    • add

      public void add(long index, K k)
      Description copied from class: AbstractReferenceBigList
      Inserts the specified element at the specified position in this big list (optional operation).
      Specified by:
      add in interface BigList<K>
      Overrides:
      add in class AbstractReferenceBigList<K>
      Parameters:
      index - a position in the big list.
      k - an element to be inserted.
      See Also:

    • add

      public boolean add(K k)
      Description copied from class: AbstractReferenceBigList
      Specified by:
      add in interface Collection<K>
      Overrides:
      add in class AbstractReferenceBigList<K>

    • get

      public K get(long index)
      Description copied from interface: BigList
      Returns the element at the specified position.
      Specified by:
      get in interface BigList<K>
      Parameters:
      index - a position in the big list.
      Returns:
      the element at the specified position.
      See Also:

    • indexOf

      public long indexOf(Object k)
      Description copied from interface: BigList
      Returns the index of the first occurrence of the specified element in this big list, or -1 if this big list does not contain the element.
      Specified by:
      indexOf in interface BigList<K>
      Overrides:
      indexOf in class AbstractReferenceBigList<K>
      Parameters:
      k - the object to search for.
      Returns:
      the index of the first occurrence of the specified element in this big list, or -1 if this big list does not contain the element.
      See Also:

    • lastIndexOf

      public long lastIndexOf(Object k)
      Description copied from interface: BigList
      Returns the index of the last occurrence of the specified element in this big list, or -1 if this big list does not contain the element.
      Specified by:
      lastIndexOf in interface BigList<K>
      Overrides:
      lastIndexOf in class AbstractReferenceBigList<K>
      Parameters:
      k - the object to search for.
      Returns:
      the index of the last occurrence of the specified element in this big list, or -1 if this big list does not contain the element.
      See Also:

    • remove

      public K remove(long index)
      Description copied from class: AbstractReferenceBigList
      Removes the element at the specified position.
      Specified by:
      remove in interface BigList<K>
      Overrides:
      remove in class AbstractReferenceBigList<K>
      Parameters:
      index - a position in the big list.
      Returns:
      the element previously at the specified position.
      See Also:

    • remove

      public boolean remove(Object k)
      Specified by:
      remove in interface Collection<K>
      Overrides:
      remove in class AbstractCollection<K>

    • set

      public K set(long index, K k)
      Description copied from class: AbstractReferenceBigList
      Replaces the element at the specified position in this big list with the specified element (optional operation).
      Specified by:
      set in interface BigList<K>
      Overrides:
      set in class AbstractReferenceBigList<K>
      Parameters:
      index - a position in the big list.
      k - the element to be stored at the specified position.
      Returns:
      the element previously at the specified positions.
      See Also:

    • removeAll

      public boolean removeAll(Collection<?> c)
      Specified by:
      removeAll in interface Collection<K>
      Overrides:
      removeAll in class AbstractCollection<K>

    • addAll

      public boolean addAll(long index, Collection<? extends K> c)
      Description copied from class: AbstractReferenceBigList
      Adds all of the elements in the specified collection to this list (optional operation).
      Specified by:
      addAll in interface BigList<K>
      Overrides:
      addAll in class AbstractReferenceBigList<K>
      Parameters:
      index - index at which to insert the first element from the specified collection.
      c - collection containing elements to be added to this big list.
      Returns:
      true if this big list changed as a result of the call
      See Also:

    • addAll

      public boolean addAll(long index, ReferenceBigList<? extends K> list)
      Description copied from interface: ReferenceBigList
      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 ReferenceBigList<K>
      See Also:

    • addAll

      public boolean addAll(long index, ReferenceList<? extends K> list)
      Description copied from interface: ReferenceBigList
      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 ReferenceBigList<K>
      See Also:

    • clear

      public void clear()
      Description copied from class: AbstractReferenceBigList
      Specified by:
      clear in interface Collection<K>
      Overrides:
      clear in class AbstractReferenceBigList<K>

    • size64

      public long size64()
      Description copied from interface: Size64
      Returns the size of this data structure as a long.
      Specified by:
      size64 in interface Size64
      Returns:
      the size of this data structure.

    • size

      public void size(long size)
      Description copied from interface: BigList
      Sets the size of this big list.

      If the specified size is smaller than the current size, the last elements are discarded. Otherwise, they are filled with 0/null/false.

      Specified by:
      size in interface BigList<K>
      Overrides:
      size in class AbstractReferenceBigList<K>
      Parameters:
      size - the new size.

    • isEmpty

      public boolean isEmpty()
      Description copied from interface: Stack
      Checks whether the stack is empty.
      Specified by:
      isEmpty in interface Collection<K>
      Specified by:
      isEmpty in interface Stack<K>
      Overrides:
      isEmpty in class AbstractCollection<K>
      Returns:
      true if the stack is empty.

    • 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 ReferenceBigList<K> subList(long from, long to)
      Description copied from interface: ReferenceBigList
      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 BigList<K>
      Specified by:
      subList in interface ReferenceBigList<K>
      Overrides:
      subList in class AbstractReferenceBigList<K>
      Parameters:
      from - the starting element (inclusive).
      to - the ending element (exclusive).
      Returns:
      a big sublist view of this big list.
      See Also:

    • getElements

      public void getElements(long from, Object[][] 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 ReferenceBigList<K>
      Overrides:
      getElements in class AbstractReferenceBigList<K>
      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, Object[] 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 ReferenceBigList<K>
      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 ReferenceBigList<K>
      Overrides:
      removeElements in class AbstractReferenceBigList<K>
      Parameters:
      from - the start index (inclusive).
      to - the end index (exclusive).

    • addElements

      public void addElements(long index, K[][] a, long offset, long length)
      Adds elements to this type-specific list using optimized system calls.
      Specified by:
      addElements in interface ReferenceBigList<K>
      Overrides:
      addElements in class AbstractReferenceBigList<K>
      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, Object[][] 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 ReferenceBigList<K>
      Overrides:
      setElements in class AbstractReferenceBigList<K>
      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(Consumer<? super K> action)
      Description copied from class: AbstractReferenceBigList
      Specified by:
      forEach in interface Iterable<K>
      Overrides:
      forEach in class AbstractReferenceBigList<K>

    • listIterator

      public ObjectBigListIterator<K> listIterator(long index)
      Description copied from class: AbstractReferenceBigList
      Returns a type-specific list iterator on this type-specific big list starting at a given index.
      Specified by:
      listIterator in interface BigList<K>
      Specified by:
      listIterator in interface ReferenceBigList<K>
      Overrides:
      listIterator in class AbstractReferenceBigList<K>
      Parameters:
      index - index of first element to be returned from the big-list iterator.
      Returns:
      a big-list iterator of the elements in this big list, starting at the specified position in this big list.
      See Also:

    • spliterator

      public ObjectSpliterator<K> spliterator()
      Description copied from interface: ReferenceBigList
      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<K>
      Specified by:
      spliterator in interface Iterable<K>
      Specified by:
      spliterator in interface ObjectIterable<K>
      Specified by:
      spliterator in interface ReferenceBigList<K>
      Specified by:
      spliterator in interface ReferenceCollection<K>
      Returns:
      a type-specific spliterator on the elements of this collection.

    • clone

      public ReferenceBigArrayBigList<K> clone()

    • equals

      public boolean equals(ReferenceBigArrayBigList<K> 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<K>
      Overrides:
      equals in class AbstractReferenceBigList<K>