Class ObjectAVLTreeSet<K>

java.lang.Object
All Implemented Interfaces:
ObjectBidirectionalIterable<K>, ObjectCollection<K>, ObjectIterable<K>, ObjectSet<K>, ObjectSortedSet<K>, java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<K>, java.util.Collection<K>, java.util.Set<K>, java.util.SortedSet<K>

public class ObjectAVLTreeSet<K>
extends AbstractObjectSortedSet<K>
implements java.io.Serializable, java.lang.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:
Serialized Form
  • Constructor Summary

    Constructors
    Constructor Description
    ObjectAVLTreeSet()
    Creates a new empty tree set.
    ObjectAVLTreeSet​(ObjectCollection<? extends K> c)
    Creates a new tree set copying a given type-specific collection.
    ObjectAVLTreeSet​(ObjectSortedSet<K> s)
    Creates a new tree set copying a given type-specific sorted set (and its Comparator).
    ObjectAVLTreeSet​(java.util.Collection<? extends K> c)
    Creates a new tree set copying a given set.
    ObjectAVLTreeSet​(java.util.Comparator<? super K> c)
    Creates a new empty tree set with the given comparator.
    ObjectAVLTreeSet​(java.util.Iterator<? extends K> i)
    Creates a new tree set using elements provided by a type-specific iterator.
    ObjectAVLTreeSet​(java.util.SortedSet<K> s)
    Creates a new tree set copying a given sorted set (and its Comparator).
    ObjectAVLTreeSet​(K[] a)
    Creates a new tree set copying the elements of an array.
    ObjectAVLTreeSet​(K[] a, int offset, int length)
    Creates a new tree set and fills it with the elements of a given array.
    ObjectAVLTreeSet​(K[] a, int offset, int length, java.util.Comparator<? super K> c)
    Creates a new tree set and fills it with the elements of a given array using a given Comparator.
    ObjectAVLTreeSet​(K[] a, java.util.Comparator<? super K> c)
    Creates a new tree set copying the elements of an array using a given Comparator.
  • Method Summary

    Modifier and Type Method Description
    boolean add​(K k)  
    void clear()  
    java.lang.Object clone()
    Returns a deep copy of this tree set.
    java.util.Comparator<? super K> comparator()  
    boolean contains​(java.lang.Object k)  
    K first()  
    K get​(java.lang.Object k)  
    ObjectSortedSet<K> headSet​(K to)
    Returns a view of the portion of this sorted set whose elements are strictly less than toElement.
    boolean isEmpty()  
    ObjectBidirectionalIterator<K> iterator()
    Returns a type-specific iterator on the elements of this collection.
    ObjectBidirectionalIterator<K> iterator​(K from)
    Returns a type-specific BidirectionalIterator on the elements in this set, starting from a given element of the domain (optional operation).
    K last()  
    boolean remove​(java.lang.Object k)  
    int size()  
    ObjectSortedSet<K> subSet​(K from, K to)
    Returns a view of the portion of this sorted set whose elements range from fromElement, inclusive, to toElement, exclusive.
    ObjectSortedSet<K> tailSet​(K 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.objects.AbstractObjectSet

    equals, hashCode

    Methods inherited from class it.unimi.dsi.fastutil.objects.AbstractObjectCollection

    toString

    Methods inherited from class java.util.AbstractCollection

    addAll, containsAll, removeAll, retainAll, toArray, toArray

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface java.util.Collection

    parallelStream, removeIf, stream, toArray

    Methods inherited from interface java.lang.Iterable

    forEach

    Methods inherited from interface it.unimi.dsi.fastutil.objects.ObjectSortedSet

    spliterator

    Methods inherited from interface java.util.Set

    addAll, containsAll, equals, hashCode, removeAll, retainAll, toArray, toArray
  • Constructor Details

    • ObjectAVLTreeSet

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

      public ObjectAVLTreeSet​(java.util.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​(java.util.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​(java.util.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​(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​(java.util.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, java.util.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, java.util.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 java.util.Collection<K>
      Specified by:
      add in interface java.util.Set<K>
      Overrides:
      add in class java.util.AbstractCollection<K>
    • remove

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

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

      public K get​(java.lang.Object k)
    • clear

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

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

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

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

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

      public ObjectBidirectionalIterator<K> iterator()
      Description copied from interface: ObjectCollection
      Returns a type-specific iterator on the elements of this collection.
      Specified by:
      iterator in interface java.util.Collection<K>
      Specified by:
      iterator in interface java.lang.Iterable<K>
      Specified by:
      iterator in interface ObjectBidirectionalIterable<K>
      Specified by:
      iterator in interface ObjectCollection<K>
      Specified by:
      iterator in interface ObjectIterable<K>
      Specified by:
      iterator in interface ObjectSet<K>
      Specified by:
      iterator in interface ObjectSortedSet<K>
      Specified by:
      iterator in interface java.util.Set<K>
      Specified by:
      iterator in class AbstractObjectSortedSet<K>
      Returns:
      a type-specific iterator on the elements of this collection.
      See Also:
      Iterable.iterator()
    • iterator

      public 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 java.util.Comparator<? super K> comparator()
      Specified by:
      comparator in interface java.util.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 java.util.SortedSet<K>
      See Also:
      SortedSet.headSet(Object)
    • 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 java.util.SortedSet<K>
      See Also:
      SortedSet.tailSet(Object)
    • 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 java.util.SortedSet<K>
      See Also:
      SortedSet.subSet(Object,Object)
    • clone

      public java.lang.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.

      Returns:
      a deep copy of this tree set.