Class CharAVLTreeSet

java.lang.Object
java.util.AbstractCollection<Character>
it.unimi.dsi.fastutil.chars.AbstractCharCollection
All Implemented Interfaces:
it.unimi.dsi.fastutil.chars.CharBidirectionalIterable, it.unimi.dsi.fastutil.chars.CharCollection, it.unimi.dsi.fastutil.chars.CharIterable, CharSet, CharSortedSet, Serializable, Cloneable, Iterable<Character>, Collection<Character>, SequencedCollection<Character>, SequencedSet<Character>, Set<Character>, SortedSet<Character>

public class CharAVLTreeSet extends AbstractCharSortedSet implements Serializable, Cloneable, CharSortedSet
A type-specific AVL tree set with a fast, small-footprint implementation.

The iterators provided by this class are type-specific bidirectional iterators. Moreover, the iterator returned by iterator() can be safely cast to a type-specific list iterator.

See Also:
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected it.unimi.dsi.fastutil.chars.CharComparator
    This set's actual comparator; it may differ from storedComparator because it is always a type-specific comparator, so it could be derived from the former by wrapping.
    protected int
    Number of elements in this set.
    protected it.unimi.dsi.fastutil.chars.CharAVLTreeSet.Entry
    The entry of the first element of this set.
    protected it.unimi.dsi.fastutil.chars.CharAVLTreeSet.Entry
    The entry of the last element of this set.
    protected Comparator<? super Character>
    This set's comparator, as provided in the constructor.
    protected it.unimi.dsi.fastutil.chars.CharAVLTreeSet.Entry
    A reference to the root entry.
  • Constructor Summary

    Constructors
    Constructor
    Description
    Creates a new empty tree set.
    CharAVLTreeSet(char[] a)
    Creates a new tree set copying the elements of an array.
    CharAVLTreeSet(char[] a, int offset, int length)
    Creates a new tree set and fills it with the elements of a given array.
    CharAVLTreeSet(char[] a, int offset, int length, Comparator<? super Character> c)
    Creates a new tree set and fills it with the elements of a given array using a given Comparator.
    CharAVLTreeSet(char[] a, Comparator<? super Character> c)
    Creates a new tree set copying the elements of an array using a given Comparator.
    CharAVLTreeSet(it.unimi.dsi.fastutil.chars.CharCollection c)
    Creates a new tree set copying a given type-specific collection.
    CharAVLTreeSet(it.unimi.dsi.fastutil.chars.CharIterator i)
    Creates a new tree set using elements provided by a type-specific iterator.
    Creates a new tree set copying a given type-specific sorted set (and its Comparator).
    Creates a new tree set copying a given set.
    Creates a new empty tree set with the given comparator.
    Creates a new tree set using elements provided by an iterator.
    Creates a new tree set copying a given sorted set (and its Comparator).
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    add(char k)
     
    void
     
    Returns a deep copy of this tree set.
    it.unimi.dsi.fastutil.chars.CharComparator
    boolean
    contains(char k)
     
    char
    Returns the first (lowest) element currently in this set.
    headSet(char to)
    Returns a view of the portion of this sorted set whose elements are strictly less than toElement.
    boolean
     
    it.unimi.dsi.fastutil.chars.CharBidirectionalIterator
    Returns a type-specific iterator on the elements of this set.
    it.unimi.dsi.fastutil.chars.CharBidirectionalIterator
    iterator(char from)
    Returns a type-specific BidirectionalIterator on the elements in this set, starting from a given element of the domain (optional operation).
    char
    Returns the last (highest) element currently in this set.
    boolean
    remove(char k)
    Removes an element from this set.
    int
     
    subSet(char from, char to)
    Returns a view of the portion of this sorted set whose elements range from fromElement, inclusive, to toElement, exclusive.
    tailSet(char from)
    Returns a view of the portion of this sorted set whose elements are greater than or equal to fromElement.

    Methods inherited from class it.unimi.dsi.fastutil.chars.AbstractCharSet

    equals, hashCode, rem

    Methods inherited from class it.unimi.dsi.fastutil.chars.AbstractCharCollection

    add, addAll, addAll, contains, containsAll, containsAll, remove, removeAll, removeAll, retainAll, retainAll, toArray, toCharArray, toCharArray, toString

    Methods inherited from class java.util.AbstractCollection

    toArray, toArray

    Methods inherited from class java.lang.Object

    finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface it.unimi.dsi.fastutil.chars.CharCollection

    addAll, containsAll, intIterator, intParallelStream, intSpliterator, intStream, parallelStream, removeAll, removeIf, removeIf, removeIf, retainAll, stream, toArray, toCharArray, toCharArray

    Methods inherited from interface it.unimi.dsi.fastutil.chars.CharIterable

    forEach, forEach, forEach

    Methods inherited from interface it.unimi.dsi.fastutil.chars.CharSet

    add, contains, rem, remove

    Methods inherited from interface it.unimi.dsi.fastutil.chars.CharSortedSet

    first, headSet, last, spliterator, subSet, tailSet

    Methods inherited from interface java.util.Collection

    toArray

    Methods inherited from interface java.util.Set

    add, addAll, contains, containsAll, equals, hashCode, remove, removeAll, retainAll, toArray, toArray

    Methods inherited from interface java.util.SortedSet

    addFirst, addLast, getFirst, getLast, removeFirst, removeLast, reversed
  • Field Details

    • tree

      protected transient it.unimi.dsi.fastutil.chars.CharAVLTreeSet.Entry tree
      A reference to the root entry.
    • count

      protected int count
      Number of elements in this set.
    • firstEntry

      protected transient it.unimi.dsi.fastutil.chars.CharAVLTreeSet.Entry firstEntry
      The entry of the first element of this set.
    • lastEntry

      protected transient it.unimi.dsi.fastutil.chars.CharAVLTreeSet.Entry lastEntry
      The entry of the last element of this set.
    • storedComparator

      protected Comparator<? super Character> storedComparator
      This set's comparator, as provided in the constructor.
    • actualComparator

      protected transient it.unimi.dsi.fastutil.chars.CharComparator actualComparator
      This set's actual comparator; it may differ from storedComparator because it is always a type-specific comparator, so it could be derived from the former by wrapping.
  • Constructor Details

    • CharAVLTreeSet

      public CharAVLTreeSet()
      Creates a new empty tree set.
    • CharAVLTreeSet

      public CharAVLTreeSet(Comparator<? super Character> c)
      Creates a new empty tree set with the given comparator.
      Parameters:
      c - a Comparator (even better, a type-specific comparator).
    • CharAVLTreeSet

      public CharAVLTreeSet(Collection<? extends Character> c)
      Creates a new tree set copying a given set.
      Parameters:
      c - a collection to be copied into the new tree set.
    • CharAVLTreeSet

      public CharAVLTreeSet(SortedSet<Character> s)
      Creates a new tree set copying a given sorted set (and its Comparator).
      Parameters:
      s - a SortedSet to be copied into the new tree set.
    • CharAVLTreeSet

      public CharAVLTreeSet(it.unimi.dsi.fastutil.chars.CharCollection c)
      Creates a new tree set copying a given type-specific collection.
      Parameters:
      c - a type-specific collection to be copied into the new tree set.
    • CharAVLTreeSet

      public CharAVLTreeSet(CharSortedSet s)
      Creates a new tree set copying a given type-specific sorted set (and its Comparator).
      Parameters:
      s - a type-specific sorted set to be copied into the new tree set.
    • CharAVLTreeSet

      public CharAVLTreeSet(it.unimi.dsi.fastutil.chars.CharIterator i)
      Creates a new tree set using elements provided by a type-specific iterator.
      Parameters:
      i - a type-specific iterator whose elements will fill the set.
    • CharAVLTreeSet

      public CharAVLTreeSet(Iterator<?> i)
      Creates a new tree set using elements provided by an iterator.
      Parameters:
      i - an iterator whose elements will fill the set.
    • CharAVLTreeSet

      public CharAVLTreeSet(char[] a, int offset, int length, Comparator<? super Character> c)
      Creates a new tree set and fills it with the elements of a given array using a given Comparator.
      Parameters:
      a - an array whose elements will be used to fill the set.
      offset - the first element to use.
      length - the number of elements to use.
      c - a Comparator (even better, a type-specific comparator).
    • CharAVLTreeSet

      public CharAVLTreeSet(char[] a, int offset, int length)
      Creates a new tree set and fills it with the elements of a given array.
      Parameters:
      a - an array whose elements will be used to fill the set.
      offset - the first element to use.
      length - the number of elements to use.
    • CharAVLTreeSet

      public CharAVLTreeSet(char[] a)
      Creates a new tree set copying the elements of an array.
      Parameters:
      a - an array to be copied into the new tree set.
    • CharAVLTreeSet

      public CharAVLTreeSet(char[] a, Comparator<? super Character> c)
      Creates a new tree set copying the elements of an array using a given Comparator.
      Parameters:
      a - an array to be copied into the new tree set.
      c - a Comparator (even better, a type-specific comparator).
  • Method Details

    • add

      public boolean add(char k)
      Specified by:
      add in interface it.unimi.dsi.fastutil.chars.CharCollection
      Overrides:
      add in class it.unimi.dsi.fastutil.chars.AbstractCharCollection
    • remove

      public boolean remove(char k)
      Description copied from class: AbstractCharSet
      Removes an element from this set. Delegates to the type-specific rem() method implemented by type-specific abstract Collection superclass.
      Specified by:
      remove in interface CharSet
      Overrides:
      remove in class AbstractCharSet
      See Also:
    • contains

      public boolean contains(char k)
      Specified by:
      contains in interface it.unimi.dsi.fastutil.chars.CharCollection
      Overrides:
      contains in class it.unimi.dsi.fastutil.chars.AbstractCharCollection
    • clear

      public void clear()
      Specified by:
      clear in interface Collection<Character>
      Specified by:
      clear in interface Set<Character>
      Overrides:
      clear in class AbstractCollection<Character>
    • size

      public int size()
      Specified by:
      size in interface Collection<Character>
      Specified by:
      size in interface Set<Character>
      Specified by:
      size in class AbstractCollection<Character>
    • isEmpty

      public boolean isEmpty()
      Specified by:
      isEmpty in interface Collection<Character>
      Specified by:
      isEmpty in interface Set<Character>
      Overrides:
      isEmpty in class AbstractCollection<Character>
    • firstChar

      public char firstChar()
      Description copied from interface: CharSortedSet
      Returns the first (lowest) element currently in this set.
      Specified by:
      firstChar in interface CharSortedSet
      See Also:
    • lastChar

      public char lastChar()
      Description copied from interface: CharSortedSet
      Returns the last (highest) element currently in this set.
      Specified by:
      lastChar in interface CharSortedSet
      See Also:
    • iterator

      public it.unimi.dsi.fastutil.chars.CharBidirectionalIterator iterator()
      Description copied from interface: CharSet
      Returns a type-specific iterator on the elements of this set.
      Specified by:
      iterator in interface it.unimi.dsi.fastutil.chars.CharBidirectionalIterable
      Specified by:
      iterator in interface it.unimi.dsi.fastutil.chars.CharCollection
      Specified by:
      iterator in interface it.unimi.dsi.fastutil.chars.CharIterable
      Specified by:
      iterator in interface CharSet
      Specified by:
      iterator in interface CharSortedSet
      Specified by:
      iterator in interface Collection<Character>
      Specified by:
      iterator in interface Iterable<Character>
      Specified by:
      iterator in interface Set<Character>
      Specified by:
      iterator in class AbstractCharSortedSet
      Returns:
      a type-specific iterator on the elements of this set.
    • iterator

      public it.unimi.dsi.fastutil.chars.CharBidirectionalIterator iterator(char from)
      Description copied from interface: CharSortedSet
      Returns a type-specific BidirectionalIterator on the elements in this set, starting from a given element of the domain (optional operation).

      This method returns a type-specific bidirectional iterator with given starting point. The starting point is any element comparable to the elements of this set (even if it does not actually belong to the set). The next element of the returned iterator is the least element of the set that is greater than the starting point (if there are no elements greater than the starting point, hasNext() will return false). The previous element of the returned iterator is the greatest element of the set that is smaller than or equal to the starting point (if there are no elements smaller than or equal to the starting point, hasPrevious() will return false).

      Note that passing the last element of the set as starting point and calling previous() you can traverse the entire set in reverse order.

      Specified by:
      iterator in interface CharSortedSet
      Parameters:
      from - an element to start from.
      Returns:
      a bidirectional iterator on the element in this set, starting at the given element.
    • comparator

      public it.unimi.dsi.fastutil.chars.CharComparator comparator()
      Description copied from interface: CharSortedSet
      Specified by:
      comparator in interface CharSortedSet
      Specified by:
      comparator in interface SortedSet<Character>
    • headSet

      public CharSortedSet headSet(char to)
      Description copied from interface: CharSortedSet
      Returns a view of the portion of this sorted set whose elements are strictly less than toElement.
      Specified by:
      headSet in interface CharSortedSet
      See Also:
    • tailSet

      public CharSortedSet tailSet(char from)
      Description copied from interface: CharSortedSet
      Returns a view of the portion of this sorted set whose elements are greater than or equal to fromElement.
      Specified by:
      tailSet in interface CharSortedSet
      See Also:
    • subSet

      public CharSortedSet subSet(char from, char to)
      Description copied from interface: CharSortedSet
      Returns a view of the portion of this sorted set whose elements range from fromElement, inclusive, to toElement, exclusive.
      Specified by:
      subSet in interface CharSortedSet
      See Also:
    • clone

      public Object clone()
      Returns a deep copy of this tree set.

      This method performs a deep copy of this tree set; the data stored in the set, however, is not cloned. Note that this makes a difference only for object keys.

      Overrides:
      clone in class Object
      Returns:
      a deep copy of this tree set.