Interface ReferenceBigList<K>

All Superinterfaces:
BigList<K>, java.util.Collection<K>, java.lang.Iterable<K>, ObjectIterable<K>, ReferenceCollection<K>, Size64
All Known Implementing Classes:
AbstractReferenceBigList, AbstractReferenceBigList.ReferenceRandomAccessSubList, AbstractReferenceBigList.ReferenceSubList, ReferenceBigArrayBigList, ReferenceBigLists.EmptyBigList, ReferenceBigLists.ListBigList, ReferenceBigLists.Singleton, ReferenceBigLists.SynchronizedBigList, ReferenceBigLists.UnmodifiableBigList

public interface ReferenceBigList<K>
extends BigList<K>, ReferenceCollection<K>
A type-specific BigList; provides some additional methods that use polymorphism to avoid (un)boxing.

Additionally, this interface strengthens iterator(), listIterator(), listIterator(long) and subList(long,long).

This interface specifies reference equality semantics (members will be compared equal with == instead of equals), which may result in breaks in contract if attempted to be used with non reference-equality semantics based BigLists. For example, a aReferenceBigList.equals(aObjectBigList) may return different a different result then aObjectBigList.equals(aReferenceBigList), in violation of equals's contract requiring it being symmetric.

Besides polymorphic methods, this interfaces specifies methods to copy into an array or remove contiguous sublists. Although the abstract implementation of this interface provides simple, one-by-one implementations of these methods, it is expected that concrete implementation override them with optimized versions.

See Also:
List
  • Method Summary

    Modifier and Type Method Description
    default boolean addAll​(long index, ReferenceBigList<? extends K> l)
    Inserts all of the elements in the specified type-specific big list into this type-specific big list at the specified position (optional operation).
    default boolean addAll​(long index, ReferenceList<? extends K> l)
    Inserts all of the elements in the specified type-specific list into this type-specific big list at the specified position (optional operation).
    default boolean addAll​(ReferenceBigList<? extends K> l)
    Appends all of the elements in the specified type-specific big list to the end of this type-specific big list (optional operation).
    default boolean addAll​(ReferenceList<? extends K> l)
    Appends all of the elements in the specified type-specific list to the end of this type-specific big list (optional operation).
    void addElements​(long index, K[][] a)
    Add (hopefully quickly) elements to this type-specific big list.
    void addElements​(long index, K[][] a, long offset, long length)
    Add (hopefully quickly) elements to this type-specific big list.
    void getElements​(long from, java.lang.Object[][] a, long offset, long length)
    Copies (hopefully quickly) elements of this type-specific big list into the given big array.
    ObjectBigListIterator<K> iterator()
    Returns a type-specific iterator on the elements of this list.
    ObjectBigListIterator<K> listIterator()
    Returns a type-specific big-list iterator on this type-specific big list.
    ObjectBigListIterator<K> listIterator​(long index)
    Returns a type-specific list iterator on this type-specific big list starting at a given index.
    void removeElements​(long from, long to)
    Removes (hopefully quickly) elements of this type-specific big list.
    default void setElements​(long index, K[][] a)
    Set (hopefully quickly) elements to match the array given.
    default void setElements​(long index, K[][] a, long offset, long length)
    Set (hopefully quickly) elements to match the array given.
    default void setElements​(K[][] a)
    Set (hopefully quickly) elements to match the array given.
    default ObjectSpliterator<K> spliterator()
    Returns a type-specific spliterator on the elements of this big-list.
    ReferenceBigList<K> 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.

    Methods inherited from interface it.unimi.dsi.fastutil.BigList

    add, addAll, get, indexOf, lastIndexOf, remove, set, size, size

    Methods inherited from interface java.util.Collection

    add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, parallelStream, remove, removeAll, removeIf, retainAll, stream, toArray, toArray, toArray

    Methods inherited from interface java.lang.Iterable

    forEach

    Methods inherited from interface it.unimi.dsi.fastutil.Size64

    size64
  • Method Details

    • iterator

      Returns a type-specific iterator on the elements of this list.
      Specified by:
      iterator in interface java.util.Collection<K>
      Specified by:
      iterator in interface java.lang.Iterable<K>
      Specified by:
      iterator in interface ObjectIterable<K>
      Specified by:
      iterator in interface ReferenceCollection<K>
      Returns:
      a type-specific iterator on the elements of this collection.
      See Also:
      Collection.iterator()
      API Notes:
      This specification strengthens the one given in Collection.iterator().
    • listIterator

      ObjectBigListIterator<K> listIterator()
      Returns a type-specific big-list iterator on this type-specific big list.
      Specified by:
      listIterator in interface BigList<K>
      Returns:
      a big-list iterator over the elements in this big list.
      See Also:
      BigList.listIterator()
      API Notes:
      This specification strengthens the one given in BigList.listIterator().
    • listIterator

      ObjectBigListIterator<K> listIterator​(long index)
      Returns a type-specific list iterator on this type-specific big list starting at a given index.
      Specified by:
      listIterator in interface BigList<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:
      BigList.listIterator(long)
      API Notes:
      This specification strengthens the one given in BigList.listIterator(long).
    • spliterator

      default ObjectSpliterator<K> spliterator()
      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 java.util.Collection<K>
      Specified by:
      spliterator in interface java.lang.Iterable<K>
      Specified by:
      spliterator in interface ObjectIterable<K>
      Specified by:
      spliterator in interface ReferenceCollection<K>
      Returns:
      a type-specific spliterator on the elements of this collection.
      Since:
      8.5.0
      API Notes:
      This is generally the only spliterator method subclasses should override.
      Implementation Specification:
      The default implementation returns a late-binding spliterator (see Spliterator for documentation on what binding policies mean).
      • For RandomAccess lists, this will return a spliterator that calls the type-specific BigList.get(long) method on the appropriate indexes.
      • Otherwise, the spliterator returned will wrap this instance's type specific iterator().

      In either case, the spliterator reports Spliterator.SIZED, Spliterator.SUBSIZED, and Spliterator.ORDERED.

      Implementation Notes:
      As the non-RandomAccess case is based on the iterator, and Iterator is an inherently linear API, the returned spliterator will yield limited performance gains when run in parallel contexts, as the returned spliterator's trySplit() will have linear runtime.

      For RandomAccess lists, the parallel performance should be reasonable assuming BigList.get(long) is truly constant time like RandomAccess suggests.

    • subList

      ReferenceBigList<K> 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.
      Specified by:
      subList in interface BigList<K>
      Parameters:
      from - the starting element (inclusive).
      to - the ending element (exclusive).
      Returns:
      a big sublist view of this big list.
      See Also:
      BigList.subList(long,long)
      API Notes:
      This specification strengthens the one given in BigList.subList(long,long).
    • getElements

      void getElements​(long from, java.lang.Object[][] a, long offset, long length)
      Copies (hopefully quickly) elements of this type-specific big list into the given big array.
      Parameters:
      from - the start index (inclusive).
      a - the destination big array.
      offset - the offset into the destination big array where to store the first element copied.
      length - the number of elements to be copied.
    • removeElements

      void removeElements​(long from, long to)
      Removes (hopefully quickly) elements of this type-specific big list.
      Parameters:
      from - the start index (inclusive).
      to - the end index (exclusive).
    • addElements

      void addElements​(long index, K[][] a)
      Add (hopefully quickly) elements to this type-specific big list.
      Parameters:
      index - the index at which to add elements.
      a - the big array containing the elements.
    • addElements

      void addElements​(long index, K[][] a, long offset, long length)
      Add (hopefully quickly) elements to this type-specific big list.
      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

      default void setElements​(K[][] a)
      Set (hopefully quickly) elements to match the array given.
      Parameters:
      a - the big array containing the elements.
      Since:
      8.5.0
    • setElements

      default void setElements​(long index, K[][] a)
      Set (hopefully quickly) elements to match the array given.
      Parameters:
      index - the index at which to start setting elements.
      a - the big array containing the elements.
      Since:
      8.5.0
    • setElements

      default void setElements​(long index, K[][] a, long offset, long length)
      Set (hopefully quickly) elements to match the array given. Sets each in this list to the corresponding elements in the array, as if by
       ListIterator iter = listIterator(index);
       long i = 0;
       while (i < length) {
         iter.next();
         iter.set(BigArrays.get(a, offset + i++);
       }
       
      However, the exact implementation may be more efficient, taking into account whether random access is faster or not, or at the discretion of subclasses, abuse internals.
      Parameters:
      index - the index at which to start setting elements.
      a - the big array containing the elements.
      offset - the offset of the first element to add.
      length - the number of elements to add.
      Since:
      8.5.0
    • addAll

      default boolean addAll​(long index, ReferenceBigList<? extends K> l)
      Inserts all of the elements in the specified type-specific big list into this type-specific big list at the specified position (optional operation).
      See Also:
      BigList.addAll(long,Collection)
      API Notes:
      This method exists only for the sake of efficiency: override are expected to use getElements(long, java.lang.Object[][], long, long)/addElements(long, K[][]).
      Implementation Specification:
      This method delegates to the one accepting a collection, but it might be implemented more efficiently.
    • addAll

      default boolean addAll​(ReferenceBigList<? extends K> l)
      Appends all of the elements in the specified type-specific big list to the end of this type-specific big list (optional operation).
      See Also:
      Collection.addAll(Collection)
      Implementation Specification:
      This method delegates to the index-based version, passing BigList.size() as first argument.
    • addAll

      default boolean addAll​(long index, ReferenceList<? extends K> l)
      Inserts all of the elements in the specified type-specific list into this type-specific big list at the specified position (optional operation).
      See Also:
      BigList.addAll(long,Collection)
      API Notes:
      This method exists only for the sake of efficiency: override are expected to use getElements(long, java.lang.Object[][], long, long)/addElements(long, K[][]).
      Implementation Specification:
      This method delegates to the one accepting a collection, but it might be implemented more efficiently.
    • addAll

      default boolean addAll​(ReferenceList<? extends K> l)
      Appends all of the elements in the specified type-specific list to the end of this type-specific big list (optional operation).
      See Also:
      Collection.addAll(Collection)
      Implementation Specification:
      This method delegates to the index-based version, passing BigList.size() as first argument.