Class CharBigArrayBigList

  • All Implemented Interfaces:
    BigList<java.lang.Character>, CharBigList, CharCollection, CharIterable, CharStack, Size64, Stack<java.lang.Character>, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<BigList<? extends java.lang.Character>>, java.lang.Iterable<java.lang.Character>, java.util.Collection<java.lang.Character>, java.util.RandomAccess

    public class CharBigArrayBigList
    extends AbstractCharBigList
    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 increasing its current length by 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.

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

      Constructors 
      Constructor Description
      CharBigArrayBigList()
      Creates a new big-array big list with DEFAULT_INITIAL_CAPACITY capacity.
      CharBigArrayBigList​(char[][] a)
      Creates a new big-array big list and fills it with the elements of a given big array.
      CharBigArrayBigList​(char[][] a, long offset, long length)
      Creates a new big-array big list and fills it with the elements of a given big array.
      CharBigArrayBigList​(long capacity)
      Creates a new big-array big list with given capacity.
      CharBigArrayBigList​(CharBigList l)
      Creates a new big-array big list and fills it with a given type-specific list.
      CharBigArrayBigList​(CharCollection c)
      Creates a new big-array big list and fills it with a given type-specific collection.
      CharBigArrayBigList​(CharIterator i)
      Creates a new big-array big list and fills it with the elements returned by a type-specific iterator..
      CharBigArrayBigList​(java.util.Iterator<? extends java.lang.Character> i)
      Creates a new big-array big list and fills it with the elements returned by an iterator..
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean add​(char k)
      Ensures that this collection contains the specified element (optional operation).
      void add​(long index, char k)
      Inserts the specified element at the specified position in this type-specific big list (optional operation).
      boolean addAll​(long index, CharBigList 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, CharCollection c)
      Inserts all of the elements in the specified type-specific collection into this type-specific big list at the specified position (optional operation).
      boolean addAll​(long index, CharList list)
      Inserts all of the elements in the specified type-specific list into this type-specific big list at the specified position (optional operation).
      void addElements​(long index, char[][] a, long offset, long length)
      Adds elements to this type-specific list using optimized system calls.
      void clear()
      CharBigArrayBigList clone()  
      int compareTo​(BigList<? extends java.lang.Character> l)
      Compares this big list to another object.
      int compareTo​(CharBigArrayBigList l)
      Compares this big list to another big list.
      char[][] 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​(CharBigArrayBigList l)
      Compares this type-specific big-array list to another one.
      boolean equals​(java.lang.Object o)  
      void forEach​(CharConsumer action)
      Performs the given action for each element of this type-specific Iterable until all elements have been processed or the action throws an exception.
      char getChar​(long index)
      Returns the element at the specified position.
      void getElements​(long from, char[][] 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, char[] a, int offset, int length)
      Copies element of this type-specific list into the given array using optimized system calls.
      long indexOf​(char k)
      Returns the index of the first occurrence of the specified element in this type-specific big list, or -1 if this big list does not contain the element.
      boolean isEmpty()
      Checks whether the stack is empty.
      long lastIndexOf​(char k)
      Returns the index of the last occurrence of the specified element in this type-specific big list, or -1 if this big list does not contain the element.
      CharBigListIterator listIterator​(long index)
      Returns a type-specific list iterator on this type-specific big list starting at a given index.
      static CharBigArrayBigList of()
      Creates a new empty big array list.
      static CharBigArrayBigList of​(char... init)
      Creates a big array list using a list of elements.
      boolean rem​(char k)
      Removes a single instance of the specified element from this collection, if it is present (optional operation).
      boolean removeAll​(CharCollection c)
      Remove from this collection all elements in the given type-specific collection.
      boolean removeAll​(java.util.Collection<?> c)
      char removeChar​(long index)
      Removes the element at the specified position.
      void removeElements​(long from, long to)
      Removes elements of this type-specific list using optimized system calls.
      char set​(long index, char k)
      Replaces the element at the specified position in this big list with the specified element (optional operation).
      void setElements​(long index, char[][] 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.
      CharSpliterator spliterator()
      Returns a type-specific spliterator on the elements of this big-list.
      CharBigList 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.
      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 CharBigArrayBigList wrap​(char[][] a)
      Wraps a given big array into a big-array big list.
      static CharBigArrayBigList wrap​(char[][] a, long length)
      Wraps a given big array into a big-array list of given size.
      • Methods inherited from class java.util.AbstractCollection

        toArray, toArray
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
      • Methods inherited from interface java.util.Collection

        containsAll, retainAll, 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

      • CharBigArrayBigList

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

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

        public CharBigArrayBigList​(CharCollection 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.
      • CharBigArrayBigList

        public CharBigArrayBigList​(CharBigList 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.
      • CharBigArrayBigList

        public CharBigArrayBigList​(char[][] 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.
      • CharBigArrayBigList

        public CharBigArrayBigList​(char[][] 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.
      • CharBigArrayBigList

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

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

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

        public static CharBigArrayBigList of​(char... 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[])
      • 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 boolean add​(char k)
        Description copied from class: AbstractCharBigList
        Ensures that this collection contains the specified element (optional operation).
        Specified by:
        add in interface CharCollection
        Overrides:
        add in class AbstractCharBigList
        See Also:
        Collection.add(Object)
      • rem

        public boolean rem​(char k)
        Description copied from class: AbstractCharBigList
        Removes a single instance of the specified element from this collection, if it is present (optional operation).
        Specified by:
        rem in interface CharCollection
        Overrides:
        rem in class AbstractCharBigList
        See Also:
        Collection.remove(Object)
      • removeAll

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

        public boolean addAll​(long index,
                              CharCollection c)
        Description copied from class: AbstractCharBigList
        Inserts all of the elements in the specified type-specific collection into this type-specific big list at the specified position (optional operation).
        Specified by:
        addAll in interface CharBigList
        Overrides:
        addAll in class AbstractCharBigList
        See Also:
        List.addAll(int,java.util.Collection)
      • addAll

        public boolean addAll​(long index,
                              CharBigList list)
        Description copied from interface: CharBigList
        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 CharBigList
        See Also:
        BigList.addAll(long,Collection)
      • addAll

        public boolean addAll​(long index,
                              CharList list)
        Description copied from interface: CharBigList
        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 CharBigList
        See Also:
        BigList.addAll(long,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<java.lang.Character>
        Overrides:
        size in class AbstractCharBigList
        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.Character>
        Specified by:
        isEmpty in interface Stack<java.lang.Character>
        Overrides:
        isEmpty in class java.util.AbstractCollection<java.lang.Character>
        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.
      • subList

        public CharBigList subList​(long from,
                                   long to)
        Description copied from interface: CharBigList
        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<java.lang.Character>
        Specified by:
        subList in interface CharBigList
        Overrides:
        subList in class AbstractCharBigList
        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)
      • getElements

        public void getElements​(long from,
                                char[][] 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 CharBigList
        Overrides:
        getElements in class AbstractCharBigList
        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,
                                char[] 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 CharBigList
        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 CharBigList
        Overrides:
        removeElements in class AbstractCharBigList
        Parameters:
        from - the start index (inclusive).
        to - the end index (exclusive).
      • addElements

        public void addElements​(long index,
                                char[][] a,
                                long offset,
                                long length)
        Adds elements to this type-specific list using optimized system calls.
        Specified by:
        addElements in interface CharBigList
        Overrides:
        addElements in class AbstractCharBigList
        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,
                                char[][] 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 CharBigList
        Overrides:
        setElements in class AbstractCharBigList
        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​(CharConsumer action)
        Description copied from class: AbstractCharBigList
        Performs the given action for each element of this type-specific Iterable until all elements have been processed or the action throws an exception.
        Specified by:
        forEach in interface CharIterable
        Overrides:
        forEach in class AbstractCharBigList
        Parameters:
        action - the action to be performed for each element.
        See Also:
        Iterable.forEach(java.util.function.Consumer)
      • spliterator

        public CharSpliterator spliterator()
        Description copied from interface: CharBigList
        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 CharBigList
        Specified by:
        spliterator in interface CharCollection
        Specified by:
        spliterator in interface CharIterable
        Specified by:
        spliterator in interface java.util.Collection<java.lang.Character>
        Specified by:
        spliterator in interface java.lang.Iterable<java.lang.Character>
        Returns:
        a type-specific spliterator on the elements of this collection.
      • equals

        public boolean equals​(CharBigArrayBigList 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<java.lang.Character>
        Overrides:
        equals in class AbstractCharBigList
      • compareTo

        public int compareTo​(CharBigArrayBigList 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 java.lang.Character> l)
        Description copied from class: AbstractCharBigList
        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<BigList<? extends java.lang.Character>>
        Overrides:
        compareTo in class AbstractCharBigList
        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.