Package it.unimi.dsi.fastutil.chars

Class AbstractCharBigList

java.lang.Object
java.util.AbstractCollection<Character>
it.unimi.dsi.fastutil.chars.AbstractCharCollection
it.unimi.dsi.fastutil.chars.AbstractCharBigList
All Implemented Interfaces:
BigList<Character>, CharBigList, CharCollection, CharIterable, CharStack, Size64, Stack<Character>, Comparable<BigList<? extends Character>>, Iterable<Character>, Collection<Character>
Direct Known Subclasses:
AbstractCharBigList.CharSubList, CharBigArrayBigList, CharBigLists.ListBigList, CharBigLists.Singleton, CharMappedBigList
public abstract class AbstractCharBigList extends AbstractCharCollection implements CharBigList, CharStack
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 java.lang.Character>)) 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.

  • Method Details

    • add

      public void add(long index, char k)
      Inserts the specified element at the specified position in this type-specific big list (optional operation).
      Specified by:
      add in interface CharBigList
      See Also:
      Implementation Specification:
      This implementation always throws an UnsupportedOperationException.

    • add

      public boolean add(char k)
      Ensures that this collection contains the specified element (optional operation).
      Specified by:
      add in interface CharCollection
      Overrides:
      add in class AbstractCharCollection
      See Also:
      Implementation Specification:
      This implementation delegates to the type-specific version of BigList.add(long, Object).

    • removeChar

      public char removeChar(long i)
      Removes the element at the specified position.
      Specified by:
      removeChar in interface CharBigList
      See Also:
      Implementation Specification:
      This implementation always throws an UnsupportedOperationException.

    • set

      public char set(long index, char k)
      Replaces the element at the specified position in this big list with the specified element (optional operation).
      Specified by:
      set in interface CharBigList
      See Also:
      Implementation Specification:
      This implementation always throws an UnsupportedOperationException.

    • addAll

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

    • addAll

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

    • iterator

      public CharBigListIterator iterator()
      Returns a type-specific iterator on the elements of this collection.
      Specified by:
      iterator in interface CharBigList
      Specified by:
      iterator in interface CharCollection
      Specified by:
      iterator in interface CharIterable
      Specified by:
      iterator in interface Collection<Character>
      Specified by:
      iterator in interface Iterable<Character>
      Specified by:
      iterator in class AbstractCharCollection
      Returns:
      a type-specific iterator on the elements of this collection.
      See Also:
      Implementation Specification:
      This implementation delegates to listIterator().

    • listIterator

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

    • listIterator

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

    • intSpliterator

      public IntSpliterator intSpliterator()
      Description copied from interface: CharCollection
      Returns widened primitive spliterator on the elements of this collection.

      This method is provided for the purpose of APIs that expect only the JDK's primitive spliterators, of which there are only int, long, and double.

      WARNING: This is not the same as converting the source to a sequence of code points. This returned instance literally performs (int)(charValue) casts. Surrogate pairs will be left as separate elements instead of combined into a single element with the code point it represents. See Character for more discussion on code points, char values, and surrogate pairs.

      Specified by:
      intSpliterator in interface CharCollection
      Specified by:
      intSpliterator in interface CharIterable
      Returns:
      a widened primitive spliterator on the elements of this collection.

    • contains

      public boolean contains(char k)
      Returns true if this list contains the specified element.
      Specified by:
      contains in interface CharCollection
      Overrides:
      contains in class AbstractCharCollection
      See Also:
      Implementation Specification:
      This implementation delegates to indexOf().

    • indexOf

      public long indexOf(char k)
      Description copied from interface: CharBigList
      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.
      Specified by:
      indexOf in interface CharBigList
      See Also:

    • lastIndexOf

      public long lastIndexOf(char k)
      Description copied from interface: CharBigList
      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.
      Specified by:
      lastIndexOf in interface CharBigList
      See Also:

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

    • 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<Character>
      Specified by:
      subList in interface CharBigList
      Parameters:
      from - the starting element (inclusive).
      to - the ending element (exclusive).
      Returns:
      a big sublist view of this big list.
      See Also:

    • forEach

      public 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.
      Specified by:
      forEach in interface CharIterable
      Parameters:
      action - the action to be performed for each element.
      See Also:
      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 CharBigList
      Parameters:
      from - the start index (inclusive).
      to - the end index (exclusive).

    • addElements

      public void addElements(long index, char[][] 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 CharBigList
      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, char[][] a)
      Add (hopefully quickly) elements to this type-specific big list.
      Specified by:
      addElements in interface CharBigList
      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, char[][] 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 CharBigList
      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, char[][] a, long offset, long length)
      Description copied from interface: CharBigList
      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 CharBigList
      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 Collection<Character>
      Overrides:
      clear in class AbstractCollection<Character>
      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<Character>
      Specified by:
      size in interface Collection<Character>
      Specified by:
      size in interface Size64
      Specified by:
      size in class AbstractCollection<Character>
      Returns:
      the size of this data structure, minimized with Integer.MAX_VALUE.
      See Also:
      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 Collection<Character>
      Overrides:
      hashCode in class Object
      Returns:
      the hash code for this big list.

    • equals

      public boolean equals(Object o)
      Specified by:
      equals in interface Collection<Character>
      Overrides:
      equals in class Object

    • compareTo

      public int compareTo(BigList<? extends Character> 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 Comparable<BigList<? extends Character>>
      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:
      ClassCastException - if the argument is not a big list.

    • push

      public void push(char o)
      Description copied from interface: CharStack
      Pushes the given object on the stack.
      Specified by:
      push in interface CharStack
      Parameters:
      o - the object to push on the stack.
      See Also:

    • popChar

      public char popChar()
      Description copied from interface: CharStack
      Pops the top off the stack.
      Specified by:
      popChar in interface CharStack
      Returns:
      the top of the stack.
      See Also:

    • topChar

      public char topChar()
      Description copied from interface: CharStack
      Peeks at the top of the stack (optional operation).
      Specified by:
      topChar in interface CharStack
      Returns:
      the top of the stack.
      See Also:

    • peekChar

      public char peekChar(int i)
      Description copied from interface: CharStack
      Peeks at an element on the stack (optional operation).
      Specified by:
      peekChar in interface CharStack
      Parameters:
      i - an index from the stop of the stack (0 represents the top).
      Returns:
      the i-th element on the stack.
      See Also:

    • rem

      public boolean rem(char k)
      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 AbstractCharCollection
      See Also:
      Implementation Specification:
      This implementation delegates to indexOf().

    • addAll

      public 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).
      Specified by:
      addAll in interface CharBigList
      See Also:
      Implementation Specification:
      This implementation delegates to the type-specific version of addAll(long, Collection).

    • addAll

      public boolean addAll(CharCollection c)
      Adds all elements of the given type-specific collection to this collection.
      Specified by:
      addAll in interface CharCollection
      Overrides:
      addAll in class AbstractCharCollection
      Parameters:
      c - a type-specific collection.
      Returns:
      true if this collection changed as a result of the call.
      See Also:
      Implementation Specification:
      This implementation delegates to the type-specific version of addAll(long, Collection).

    • add

      @Deprecated public void add(long index, Character ok)
      Deprecated.
      Please use the corresponding type-specific method instead.
      Inserts the specified element at the specified position in this big list (optional operation).
      Specified by:
      add in interface BigList<Character>
      Specified by:
      add in interface CharBigList
      Parameters:
      index - a position in the big list.
      ok - an element to be inserted.
      See Also:
      Implementation Specification:
      This implementation delegates to the corresponding type-specific method.

    • set

      @Deprecated public Character set(long index, Character ok)
      Deprecated.
      Please use the corresponding type-specific method instead.
      Replaces the element at the specified position in this big list with the specified element (optional operation).
      Specified by:
      set in interface BigList<Character>
      Specified by:
      set in interface CharBigList
      Parameters:
      index - a position in the big list.
      ok - the element to be stored at the specified position.
      Returns:
      the element previously at the specified positions.
      See Also:
      Implementation Specification:
      This implementation delegates to the corresponding type-specific method.

    • get

      @Deprecated public Character get(long index)
      Deprecated.
      Please use the corresponding type-specific method instead.
      Returns the element at the specified position.
      Specified by:
      get in interface BigList<Character>
      Specified by:
      get in interface CharBigList
      Parameters:
      index - a position in the big list.
      Returns:
      the element at the specified position.
      See Also:
      Implementation Specification:
      This implementation delegates to the corresponding type-specific method.

    • indexOf

      @Deprecated public long indexOf(Object ok)
      Deprecated.
      Please use the corresponding type-specific method instead.
      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<Character>
      Specified by:
      indexOf in interface CharBigList
      Parameters:
      ok - 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:
      Implementation Specification:
      This implementation delegates to the corresponding type-specific method.

    • lastIndexOf

      @Deprecated public long lastIndexOf(Object ok)
      Deprecated.
      Please use the corresponding type-specific method instead.
      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<Character>
      Specified by:
      lastIndexOf in interface CharBigList
      Parameters:
      ok - 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:
      Implementation Specification:
      This implementation delegates to the corresponding type-specific method.

    • remove

      @Deprecated public Character remove(long index)
      Deprecated.
      Please use the corresponding type-specific method instead.
      Removes the element at the specified position.
      Specified by:
      remove in interface BigList<Character>
      Specified by:
      remove in interface CharBigList
      Parameters:
      index - a position in the big list.
      Returns:
      the element previously at the specified position.
      See Also:
      Implementation Specification:
      This implementation delegates to the corresponding type-specific method.

    • push

      @Deprecated public void push(Character o)
      Deprecated.
      Please use the corresponding type-specific method instead.
      Pushes the given object on the stack.

      This default implementation delegates to the corresponding type-specific method.

      Specified by:
      push in interface CharStack
      Specified by:
      push in interface Stack<Character>
      Parameters:
      o - the object that will become the new top of the stack.
      Implementation Specification:
      This implementation delegates to the corresponding type-specific method.

    • pop

      @Deprecated public Character pop()
      Deprecated.
      Please use the corresponding type-specific method instead.
      Pops the top off the stack.

      This default implementation delegates to the corresponding type-specific method.

      Specified by:
      pop in interface CharStack
      Specified by:
      pop in interface Stack<Character>
      Returns:
      the top of the stack.
      Implementation Specification:
      This implementation delegates to the corresponding type-specific method.

    • top

      @Deprecated public Character top()
      Deprecated.
      Please use the corresponding type-specific method instead.
      Peeks at the top of the stack (optional operation).

      This default implementation returns peek(0).

      This default implementation delegates to the corresponding type-specific method.

      Specified by:
      top in interface CharStack
      Specified by:
      top in interface Stack<Character>
      Returns:
      the top of the stack.
      Implementation Specification:
      This implementation delegates to the corresponding type-specific method.

    • peek

      @Deprecated public Character peek(int i)
      Deprecated.
      Please use the corresponding type-specific method instead.
      Peeks at an element on the stack (optional operation).

      This default implementation just throws an UnsupportedOperationException.

      This default implementation delegates to the corresponding type-specific method.

      Specified by:
      peek in interface CharStack
      Specified by:
      peek in interface Stack<Character>
      Parameters:
      i - an index from the stop of the stack (0 represents the top).
      Returns:
      the i-th element on the stack.
      Implementation Specification:
      This implementation delegates to the corresponding type-specific method.

    • toString

      public String toString()
      Overrides:
      toString in class AbstractCharCollection