Class ObjectAVLTreeSet<K>

java.lang.Object
java.util.AbstractCollection<K>
it.unimi.dsi.fastutil.objects.AbstractObjectCollection<K>
All Implemented Interfaces:
it.unimi.dsi.fastutil.objects.ObjectBidirectionalIterable<K>, it.unimi.dsi.fastutil.objects.ObjectCollection<K>, it.unimi.dsi.fastutil.objects.ObjectIterable<K>, ObjectSet<K>, ObjectSortedSet<K>, Serializable, Cloneable, Iterable<K>, Collection<K>, SequencedCollection<K>, SequencedSet<K>, Set<K>, SortedSet<K>

public class ObjectAVLTreeSet<K> extends AbstractObjectSortedSet<K> implements Serializable, Cloneable, ObjectSortedSet<K>
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 Details

    • tree

      protected transient it.unimi.dsi.fastutil.objects.ObjectAVLTreeSet.Entry<K> tree
      A reference to the root entry.
    • count

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

      protected transient it.unimi.dsi.fastutil.objects.ObjectAVLTreeSet.Entry<K> firstEntry
      The entry of the first element of this set.
    • lastEntry

      protected transient it.unimi.dsi.fastutil.objects.ObjectAVLTreeSet.Entry<K> lastEntry
      The entry of the last element of this set.
    • storedComparator

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

      protected transient Comparator<? super K> 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

    • ObjectAVLTreeSet

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

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

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

      public ObjectAVLTreeSet(SortedSet<K> 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.
    • ObjectAVLTreeSet

      public ObjectAVLTreeSet(it.unimi.dsi.fastutil.objects.ObjectCollection<? extends K> 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.
    • ObjectAVLTreeSet

      public ObjectAVLTreeSet(ObjectSortedSet<K> 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.
    • ObjectAVLTreeSet

      public ObjectAVLTreeSet(Iterator<? extends K> 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.
    • ObjectAVLTreeSet

      public ObjectAVLTreeSet(K[] a, int offset, int length, Comparator<? super K> 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).
    • ObjectAVLTreeSet

      public ObjectAVLTreeSet(K[] 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.
    • ObjectAVLTreeSet

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

      public ObjectAVLTreeSet(K[] a, Comparator<? super K> 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(K k)
      Specified by:
      add in interface Collection<K>
      Specified by:
      add in interface Set<K>
      Overrides:
      add in class AbstractCollection<K>
    • remove

      public boolean remove(Object k)
      Specified by:
      remove in interface Collection<K>
      Specified by:
      remove in interface Set<K>
      Overrides:
      remove in class AbstractCollection<K>
    • contains

      public boolean contains(Object k)
      Specified by:
      contains in interface Collection<K>
      Specified by:
      contains in interface Set<K>
      Overrides:
      contains in class AbstractCollection<K>
    • get

      public K get(Object k)
    • clear

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

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

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

      public K first()
      Specified by:
      first in interface SortedSet<K>
    • last

      public K last()
      Specified by:
      last in interface SortedSet<K>
    • iterator

      public it.unimi.dsi.fastutil.objects.ObjectBidirectionalIterator<K> iterator()
      Description copied from interface: ObjectSet
      Returns a type-specific iterator on the elements of this set.
      Specified by:
      iterator in interface Collection<K>
      Specified by:
      iterator in interface Iterable<K>
      Specified by:
      iterator in interface it.unimi.dsi.fastutil.objects.ObjectBidirectionalIterable<K>
      Specified by:
      iterator in interface it.unimi.dsi.fastutil.objects.ObjectCollection<K>
      Specified by:
      iterator in interface it.unimi.dsi.fastutil.objects.ObjectIterable<K>
      Specified by:
      iterator in interface ObjectSet<K>
      Specified by:
      iterator in interface ObjectSortedSet<K>
      Specified by:
      iterator in interface Set<K>
      Specified by:
      iterator in class AbstractObjectSortedSet<K>
      Returns:
      a type-specific iterator on the elements of this set.
    • iterator

      public it.unimi.dsi.fastutil.objects.ObjectBidirectionalIterator<K> iterator(K from)
      Description copied from interface: ObjectSortedSet
      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 ObjectSortedSet<K>
      Parameters:
      from - an element to start from.
      Returns:
      a bidirectional iterator on the element in this set, starting at the given element.
    • comparator

      public Comparator<? super K> comparator()
      Specified by:
      comparator in interface SortedSet<K>
    • headSet

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

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

      public ObjectSortedSet<K> subSet(K from, K to)
      Description copied from interface: ObjectSortedSet
      Returns a view of the portion of this sorted set whose elements range from fromElement, inclusive, to toElement, exclusive.
      Specified by:
      subSet in interface ObjectSortedSet<K>
      Specified by:
      subSet in interface SortedSet<K>
      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.