Package it.unimi.dsi.fastutil.objects

Class AbstractObjectBigList<K>

java.lang.Object
java.util.AbstractCollection<K>
it.unimi.dsi.fastutil.objects.AbstractObjectCollection<K>
it.unimi.dsi.fastutil.objects.AbstractObjectBigList<K>
All Implemented Interfaces:
BigList<K>, ObjectBigList<K>, ObjectCollection<K>, ObjectIterable<K>, Size64, Stack<K>, java.lang.Comparable<BigList<? extends K>>, java.lang.Iterable<K>, java.util.Collection<K>
Direct Known Subclasses:
AbstractObjectBigList.ObjectSubList, IntArrayFrontCodedBigList, LongArrayFrontCodedBigList, ObjectBigArrayBigList, ObjectBigLists.ListBigList, ObjectBigLists.Singleton
public abstract class AbstractObjectBigList<K>
extends AbstractObjectCollection<K>
implements ObjectBigList<K>, Stack<K>
An abstract class providing basic methods for big lists implementing a type-specific big list interface.

Most of the methods in this class are optimized with the assumption that the List will have have constant-time random access. If this is not the case, you should probably at least override listIterator(long) and the xAll() methods (such as addAll(long, java.util.Collection<? extends K>)) with a more appropriate iteration scheme. Note the subList(long, long) method is cognizant of random-access or not, so that need not be reimplemented.

  • Nested Class Summary

    Nested Classes
    Modifier and Type Class Description
    static class  AbstractObjectBigList.ObjectRandomAccessSubList<K>  
    static class  AbstractObjectBigList.ObjectSubList<K>
    A class implementing a sublist view.

  • Method Summary

    Modifier and Type Method Description
    void add​(long index, K k)
    Inserts the specified element at the specified position in this big list (optional operation).
    boolean add​(K k)
    boolean addAll​(long index, java.util.Collection<? extends K> c)
    Adds all of the elements in the specified collection to this list (optional operation).
    boolean addAll​(java.util.Collection<? extends K> c)
    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 clear()
    int compareTo​(BigList<? extends K> l)
    Compares this big list to another object.
    boolean contains​(java.lang.Object k)
    Returns true if this list contains the specified element.
    boolean equals​(java.lang.Object o)  
    void forEach​(java.util.function.Consumer<? super K> action)
    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.
    int hashCode()
    Returns the hash code for this big list, which is identical to List.hashCode().
    long indexOf​(java.lang.Object k)
    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.
    ObjectBigListIterator<K> iterator()
    Returns a type-specific iterator on the elements of this collection.
    long lastIndexOf​(java.lang.Object k)
    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.
    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.
    K peek​(int i)
    Peeks at an element on the stack (optional operation).
    K pop()
    Pops the top off the stack.
    void push​(K o)
    Pushes the given object on the stack.
    K remove​(long i)
    Removes the element at the specified position.
    void removeElements​(long from, long to)
    Removes (hopefully quickly) elements of this type-specific big list.
    K set​(long index, K k)
    Replaces the element at the specified position in this big list with the specified element (optional operation).
    void setElements​(long index, K[][] a, long offset, long length)
    Set (hopefully quickly) elements to match the array given.
    int size()
    Deprecated.
    Please use Size64.size64() instead.
    void size​(long size)
    Sets the size of this big list.
    ObjectBigList<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.
    K top()
    Peeks at the top of the stack (optional operation).
    java.lang.String toString()  

    Methods inherited from class java.util.AbstractCollection

    containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

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

    get

    Methods inherited from interface java.util.Collection

    containsAll, isEmpty, parallelStream, remove, removeAll, removeIf, retainAll, stream, toArray, toArray, toArray

    Methods inherited from interface it.unimi.dsi.fastutil.objects.ObjectBigList

    addAll, addAll, addAll, addAll, setElements, setElements, spliterator

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

    size64

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

    isEmpty

  • Method Details

    • add

      public void add​(long index, K k)
      Inserts the specified element at the specified position in this big list (optional operation).
      Specified by:
      add in interface BigList<K>
      Parameters:
      index - a position in the big list.
      k - an element to be inserted.
      See Also:
      List.add(int,Object)
      Implementation Specification:
      This implementation always throws an UnsupportedOperationException.

    • add

      public boolean add​(K k)
      Specified by:
      add in interface java.util.Collection<K>
      Overrides:
      add in class java.util.AbstractCollection<K>
      Implementation Specification:
      This implementation delegates to the type-specific version of BigList.add(long, Object).

    • remove

      public K remove​(long i)
      Removes the element at the specified position.
      Specified by:
      remove in interface BigList<K>
      Parameters:
      i - a position in the big list.
      Returns:
      the element previously at the specified position.
      See Also:
      List.remove(int)
      Implementation Specification:
      This implementation always throws an UnsupportedOperationException.

    • set

      public K set​(long index, K k)
      Replaces the element at the specified position in this big list with the specified element (optional operation).
      Specified by:
      set in interface BigList<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:
      List.set(int,Object)
      Implementation Specification:
      This implementation always throws an UnsupportedOperationException.

    • addAll

      public boolean addAll​(long index, java.util.Collection<? extends K> c)
      Adds all of the elements in the specified collection to this list (optional operation).
      Specified by:
      addAll in interface BigList<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:
      List.addAll(int, Collection)

    • addAll

      public boolean addAll​(java.util.Collection<? extends K> c)
      Specified by:
      addAll in interface java.util.Collection<K>
      Overrides:
      addAll in class java.util.AbstractCollection<K>
      Implementation Specification:
      This implementation delegates to the type-specific version of BigList.addAll(long, Collection).

    • iterator

      public ObjectBigListIterator<K> iterator()
      Returns a type-specific iterator on the elements of this collection.
      Specified by:
      iterator in interface java.util.Collection<K>
      Specified by:
      iterator in interface java.lang.Iterable<K>
      Specified by:
      iterator in interface ObjectBigList<K>
      Specified by:
      iterator in interface ObjectCollection<K>
      Specified by:
      iterator in interface ObjectIterable<K>
      Specified by:
      iterator in class AbstractObjectCollection<K>
      Returns:
      a type-specific iterator on the elements of this collection.
      See Also:
      Iterable.iterator()
      Implementation Specification:
      This implementation delegates to listIterator().

    • listIterator

      public ObjectBigListIterator<K> listIterator()
      Returns a type-specific big-list iterator on this type-specific big list.
      Specified by:
      listIterator in interface BigList<K>
      Specified by:
      listIterator in interface ObjectBigList<K>
      Returns:
      a big-list iterator over the elements in this big list.
      See Also:
      BigList.listIterator()
      Implementation Specification:
      This implementation delegates to listIterator(0).

    • listIterator

      public 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>
      Specified by:
      listIterator in interface ObjectBigList<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)
      Implementation Specification:
      This implementation is based on the random-access methods.

    • contains

      public boolean contains​(java.lang.Object k)
      Returns true if this list contains the specified element.
      Specified by:
      contains in interface java.util.Collection<K>
      Overrides:
      contains in class java.util.AbstractCollection<K>
      See Also:
      Collection.contains(Object)
      Implementation Specification:
      This implementation delegates to indexOf().

    • indexOf

      public long indexOf​(java.lang.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>
      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:
      List.indexOf(Object)

    • lastIndexOf

      public long lastIndexOf​(java.lang.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>
      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:
      List.lastIndexOf(Object)

    • 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>
      Parameters:
      size - the new size.

    • subList

      public ObjectBigList<K> subList​(long from, long to)
      Description copied from interface: ObjectBigList
      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 ObjectBigList<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)

    • forEach

      public void forEach​(java.util.function.Consumer<? super K> action)
      Specified by:
      forEach in interface java.lang.Iterable<K>
      Implementation Specification:
      If this list is RandomAccess, will iterate using a for loop and the type-specific List.get(int) method. Otherwise it will fallback to using the iterator based loop implementation from the superinterface.

    • removeElements

      public void removeElements​(long from, long to)
      Removes (hopefully quickly) elements of this type-specific big list.

      This is a trivial iterator-based implementation. It is expected that implementations will override this method with a more optimized version.

      Specified by:
      removeElements in interface ObjectBigList<K>
      Parameters:
      from - the start index (inclusive).
      to - the end index (exclusive).

    • addElements

      public void addElements​(long index, K[][] a, long offset, long length)
      Add (hopefully quickly) elements to this type-specific big list.

      This is a trivial iterator-based implementation. It is expected that implementations will override this method with a more optimized version.

      Specified by:
      addElements in interface ObjectBigList<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.

    • addElements

      public void addElements​(long index, K[][] a)
      Add (hopefully quickly) elements to this type-specific big list.
      Specified by:
      addElements in interface ObjectBigList<K>
      Parameters:
      index - the index at which to add elements.
      a - the big array containing the elements.
      Implementation Specification:
      This implementation delegates to the analogous method for big-array fragments.

    • getElements

      public 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.

      This is a trivial iterator-based implementation. It is expected that implementations will override this method with a more optimized version.

      Specified by:
      getElements in interface ObjectBigList<K>
      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.

    • setElements

      public void setElements​(long index, K[][] a, long offset, long length)
      Description copied from interface: ObjectBigList
      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.
      Specified by:
      setElements in interface ObjectBigList<K>
      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.

    • clear

      public void clear()
      Specified by:
      clear in interface java.util.Collection<K>
      Overrides:
      clear in class java.util.AbstractCollection<K>
      Implementation Specification:
      This implementation delegates to removeElements(long, long).

    • size

      @Deprecated public int size()
      Deprecated.
      Please use Size64.size64() instead.
      Returns the size of this data structure, minimized with Integer.MAX_VALUE.

      This default implementation follows the definition above, which is compatible with Collection.size().

      Specified by:
      size in interface BigList<K>
      Specified by:
      size in interface java.util.Collection<K>
      Specified by:
      size in interface Size64
      Specified by:
      size in class java.util.AbstractCollection<K>
      Returns:
      the size of this data structure, minimized with Integer.MAX_VALUE.
      See Also:
      Collection.size()
      Implementation Specification:
      This implementation delegates to Size64.size64().

    • hashCode

      public int hashCode()
      Returns the hash code for this big list, which is identical to List.hashCode().
      Specified by:
      hashCode in interface java.util.Collection<K>
      Overrides:
      hashCode in class java.lang.Object
      Returns:
      the hash code for this big list.

    • equals

      public boolean equals​(java.lang.Object o)
      Specified by:
      equals in interface java.util.Collection<K>
      Overrides:
      equals in class java.lang.Object

    • compareTo

      public int compareTo​(BigList<? extends K> l)
      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 java.lang.Comparable<K>
      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.
      Throws:
      java.lang.ClassCastException - if the argument is not a big list.

    • push

      public void push​(K o)
      Description copied from interface: Stack
      Pushes the given object on the stack.
      Specified by:
      push in interface Stack<K>
      Parameters:
      o - the object that will become the new top of the stack.

    • pop

      public K pop()
      Description copied from interface: Stack
      Pops the top off the stack.
      Specified by:
      pop in interface Stack<K>
      Returns:
      the top of the stack.

    • top

      public K top()
      Description copied from interface: Stack
      Peeks at the top of the stack (optional operation).

      This default implementation returns peek(0).

      Specified by:
      top in interface Stack<K>
      Returns:
      the top of the stack.

    • peek

      public K peek​(int i)
      Description copied from interface: Stack
      Peeks at an element on the stack (optional operation).

      This default implementation just throws an UnsupportedOperationException.

      Specified by:
      peek in interface Stack<K>
      Parameters:
      i - an index from the stop of the stack (0 represents the top).
      Returns:
      the i-th element on the stack.

    • toString

      public java.lang.String toString()
      Overrides:
      toString in class AbstractObjectCollection<K>