Package it.unimi.dsi.fastutil.objects

Class ObjectBigArrayBigList<K>

  • All Implemented Interfaces:
    BigList<K>, ObjectBigList<K>, ObjectCollection<K>, ObjectIterable<K>, Size64, Stack<K>, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<BigList<? extends K>>, java.lang.Iterable<K>, java.util.Collection<K>, java.util.RandomAccess
    public class ObjectBigArrayBigList<K>
extends AbstractObjectBigList<K>
implements java.util.RandomAccess, java.lang.Cloneable, java.io.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:
    ArrayList, Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int DEFAULT_INITIAL_CAPACITY
      The initial default capacity of a big-array big list.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      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, ObjectBigList<? extends K> 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, ObjectList<? extends K> list)
      Inserts all of the elements in the specified type-specific list into this type-specific big list at the specified position (optional operation).
      boolean addAll​(long index, java.util.Collection<? extends K> c)
      Adds all of the elements in the specified collection to this list (optional operation).
      void addElements​(long index, K[][] a, long offset, long length)
      Adds elements to this type-specific list using optimized system calls.
      void clear()
      ObjectBigArrayBigList<K> clone()  
      int compareTo​(BigList<? extends K> l)
      Compares this big list to another object.
      int compareTo​(ObjectBigArrayBigList<? extends K> l)
      Compares this big list to another big list.
      K[][] elements()
      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 equals​(ObjectBigArrayBigList<K> l)
      Compares this type-specific big-array list to another one.
      boolean equals​(java.lang.Object o)  
      void forEach​(java.util.function.Consumer<? super K> action)
      K get​(long index)
      Returns the element at the specified position.
      void getElements​(long from, java.lang.Object[][] 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, java.lang.Object[] a, int offset, int length)
      Copies element of this type-specific list into the given array using optimized system calls.
      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.
      boolean isEmpty()
      Checks whether the stack is empty.
      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​(long index)
      Returns a type-specific list iterator on this type-specific big list starting at a given index.
      static <K> ObjectBigArrayBigList<K> of()
      Creates a new empty big array list.
      static <K> ObjectBigArrayBigList<K> of​(K... init)
      Creates a big array list using a list of elements.
      K remove​(long index)
      Removes the element at the specified position.
      boolean remove​(java.lang.Object k)  
      boolean removeAll​(java.util.Collection<?> c)  
      void removeElements​(long from, long to)
      Removes elements of this type-specific list using optimized system calls.
      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, java.lang.Object[][] 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)
      Sets the size of this big list.
      long size64()
      Returns the size of this data structure as a long.
      ObjectSpliterator<K> spliterator()
      Returns a type-specific spliterator on the elements 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.
      static <K> java.util.stream.Collector<K,​?,​ObjectBigArrayBigList<K>> toBigList()
      Returns a Collector that collects a Stream's elements into a new ArrayList.
      static <K> java.util.stream.Collector<K,​?,​ObjectBigArrayBigList<K>> toBigListWithExpectedSize​(long expectedSize)
      Returns a Collector that collects a Stream's elements into a new ArrayList.
      void trim()
      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.
      static <K> ObjectBigArrayBigList<K> wrap​(K[][] a)
      Wraps a given big array into a big-array big list.
      static <K> ObjectBigArrayBigList<K> wrap​(K[][] a, long length)
      Wraps a given big array into a big-array list of given size.

      • Methods inherited from class java.util.AbstractCollection

        containsAll, retainAll, toArray, toArray

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

      • Methods inherited from interface java.util.Collection

        containsAll, parallelStream, removeIf, retainAll, stream, toArray, toArray, toArray

    • Field Detail

      • DEFAULT_INITIAL_CAPACITY

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

    • Constructor Detail

      • ObjectBigArrayBigList

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

      • ObjectBigArrayBigList

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

      • ObjectBigArrayBigList

        public ObjectBigArrayBigList​(ObjectCollection<? 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.

      • ObjectBigArrayBigList

        public ObjectBigArrayBigList​(java.util.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.

      • ObjectBigArrayBigList

        public ObjectBigArrayBigList​(ObjectBigList<? 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.

      • ObjectBigArrayBigList

        public ObjectBigArrayBigList​(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.

      • ObjectBigArrayBigList

        public ObjectBigArrayBigList​(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.

      • ObjectBigArrayBigList

        public ObjectBigArrayBigList​(java.util.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.

      • ObjectBigArrayBigList

        public ObjectBigArrayBigList​(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 Detail

      • 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> ObjectBigArrayBigList<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> ObjectBigArrayBigList<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> ObjectBigArrayBigList<K> of()
        Creates a new empty big array list.
        Returns:
        a new empty big-array big list.

      • of

        @SafeVarargs
public static <K> ObjectBigArrayBigList<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:
        BigArrays.wrap(byte[])

      • toBigList

        public static <K> java.util.stream.Collector<K,​?,​ObjectBigArrayBigList<K>> toBigList()
        Returns a Collector that collects a Stream's elements into a new ArrayList.

      • toBigListWithExpectedSize

        public static <K> java.util.stream.Collector<K,​?,​ObjectBigArrayBigList<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: AbstractObjectBigList
        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 AbstractObjectBigList<K>
        Parameters:
        index - a position in the big list.
        k - an element to be inserted.
        See Also:
        List.add(int,Object)

      • 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:
        List.get(int)

      • 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>
        Overrides:
        indexOf in class AbstractObjectBigList<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>
        Overrides:
        lastIndexOf in class AbstractObjectBigList<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)

      • remove

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

      • remove

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

      • set

        public K set​(long index,
             K k)
        Description copied from class: AbstractObjectBigList
        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 AbstractObjectBigList<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)

      • removeAll

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

      • addAll

        public boolean addAll​(long index,
                      java.util.Collection<? extends K> c)
        Description copied from class: AbstractObjectBigList
        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 AbstractObjectBigList<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)

      • 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 AbstractObjectBigList<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 java.util.Collection<K>
        Specified by:
        isEmpty in interface Stack<K>
        Overrides:
        isEmpty in class java.util.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:
        ArrayList.trimToSize()

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

      • getElements

        public void getElements​(long from,
                        java.lang.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 ObjectBigList<K>
        Overrides:
        getElements in class AbstractObjectBigList<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,
                        java.lang.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 ObjectBigList<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 ObjectBigList<K>
        Overrides:
        removeElements in class AbstractObjectBigList<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 ObjectBigList<K>
        Overrides:
        addElements in class AbstractObjectBigList<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,
                        java.lang.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 ObjectBigList<K>
        Overrides:
        setElements in class AbstractObjectBigList<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.

      • spliterator

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

      • equals

        public boolean equals​(ObjectBigArrayBigList<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​(java.lang.Object o)
        Specified by:
        equals in interface java.util.Collection<K>
        Overrides:
        equals in class AbstractObjectBigList<K>

      • compareTo

        public int compareTo​(ObjectBigArrayBigList<? extends K> 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​(BigList<? extends K> l)
        Description copied from class: AbstractObjectBigList
        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>
        Overrides:
        compareTo in class AbstractObjectBigList<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.