Class LongBigArrayBigList

  • All Implemented Interfaces:
    BigList<java.lang.Long>, LongBigList, LongCollection, LongIterable, LongStack, Size64, Stack<java.lang.Long>, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<BigList<? extends java.lang.Long>>, java.lang.Iterable<java.lang.Long>, java.util.Collection<java.lang.Long>, java.util.RandomAccess

    public class LongBigArrayBigList
    extends AbstractLongBigList
    implements java.util.RandomAccess, java.lang.Cloneable, java.io.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 doubling the current length), 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:
    ArrayList, Serialized Form
    • 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

      • LongBigArrayBigList

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

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

        public LongBigArrayBigList​(LongCollection 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.
      • LongBigArrayBigList

        public LongBigArrayBigList​(LongBigList 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.
      • LongBigArrayBigList

        public LongBigArrayBigList​(long[][] a)
        Creates a new big-array big list and fills it with the elements of a given big array.

        Note that this constructor makes it easy to build big lists from literal arrays declared as type[][] {{ init_values }}. The only constraint is that the number of initialisation values is below BigArrays.SEGMENT_SIZE.

        Parameters:
        a - a big array whose elements will be used to fill the array list.
      • LongBigArrayBigList

        public LongBigArrayBigList​(long[][] a,
                                   long offset,
                                   long length)
        Creates a new big-array big list and fills it with the elements of a given big array.

        Note that this constructor makes it easy to build big lists from literal arrays declared as type[][] {{ init_values }}. The only constraint is that the number of initialisation values is below BigArrays.SEGMENT_SIZE.

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

        public LongBigArrayBigList​(java.util.Iterator<? extends java.lang.Long> 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.
      • LongBigArrayBigList

        public LongBigArrayBigList​(LongIterator 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 long[][] elements()
        Returns the backing big array of this big list.
        Returns:
        the backing big array.
      • wrap

        public static LongBigArrayBigList wrap​(long[][] 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 LongBigArrayBigList wrap​(long[][] 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

        @SafeVarargs
        public static LongBigArrayBigList of​(long... 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.
        Returns:
        a new big-array big list containing the given elements.
      • 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,
                        long k)
        Description copied from class: AbstractLongBigList
        Inserts the specified element at the specified position in this type-specific big list (optional operation).

        This implementation always throws an UnsupportedOperationException.

        Specified by:
        add in interface LongBigList
        Overrides:
        add in class AbstractLongBigList
        See Also:
        BigList.add(long,Object)
      • add

        public boolean add​(long k)
        Description copied from class: AbstractLongBigList
        Ensures that this collection contains the specified element (optional operation).

        This implementation always throws an UnsupportedOperationException.

        This implementation delegates to the type-specific version of BigList.add(long, Object).

        Specified by:
        add in interface LongCollection
        Overrides:
        add in class AbstractLongBigList
        See Also:
        Collection.add(Object)
      • rem

        public boolean rem​(long k)
        Description copied from class: AbstractLongBigList
        Removes a single instance of the specified element from this collection, if it is present (optional operation).

        This implementation delegates to indexOf().

        Specified by:
        rem in interface LongCollection
        Overrides:
        rem in class AbstractLongBigList
        See Also:
        Collection.remove(Object)
      • set

        public long set​(long index,
                        long k)
        Description copied from class: AbstractLongBigList
        Replaces the element at the specified position in this big list with the specified element (optional operation).

        This implementation always throws an UnsupportedOperationException.

        Specified by:
        set in interface LongBigList
        Overrides:
        set in class AbstractLongBigList
        See Also:
        BigList.set(long,Object)
      • removeAll

        public boolean removeAll​(LongCollection c)
        Description copied from interface: LongCollection
        Remove from this collection all elements in the given type-specific collection.
        Specified by:
        removeAll in interface LongCollection
        Overrides:
        removeAll in class AbstractLongCollection
        Parameters:
        c - a type-specific collection.
        Returns:
        true if this collection changed as a result of the call.
        See Also:
        Collection.removeAll(Collection)
      • removeAll

        public boolean removeAll​(java.util.Collection<?> c)
        Description copied from class: AbstractLongCollection

        This implementation delegates to the type-specific version if given a type-specific collection, otherwise is uses the implementation from AbstractCollection.

        Specified by:
        removeAll in interface java.util.Collection<java.lang.Long>
        Overrides:
        removeAll in class AbstractLongCollection
      • 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<java.lang.Long>
        Overrides:
        size in class AbstractLongBigList
        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<java.lang.Long>
        Specified by:
        isEmpty in interface Stack<java.lang.Long>
        Overrides:
        isEmpty in class java.util.AbstractCollection<java.lang.Long>
        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,
                                long[][] 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 LongBigList
        Overrides:
        getElements in class AbstractLongBigList
        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.
      • removeElements

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

        public void addElements​(long index,
                                long[][] a,
                                long offset,
                                long length)
        Adds elements to this type-specific list using optimized system calls.
        Specified by:
        addElements in interface LongBigList
        Overrides:
        addElements in class AbstractLongBigList
        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.
      • equals

        public boolean equals​(LongBigArrayBigList 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.
      • compareTo

        public int compareTo​(LongBigArrayBigList 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.