Class ShortAVLTreeSet

java.lang.Object
All Implemented Interfaces:
ShortBidirectionalIterable, ShortCollection, ShortIterable, ShortSet, ShortSortedSet, java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<java.lang.Short>, java.util.Collection<java.lang.Short>, java.util.Set<java.lang.Short>, java.util.SortedSet<java.lang.Short>

public class ShortAVLTreeSet
extends AbstractShortSortedSet
implements java.io.Serializable, java.lang.Cloneable, ShortSortedSet
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 Details

    • ShortAVLTreeSet

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

      public ShortAVLTreeSet​(java.util.Comparator<? super java.lang.Short> c)
      Creates a new empty tree set with the given comparator.
      Parameters:
      c - a Comparator (even better, a type-specific comparator).
    • ShortAVLTreeSet

      public ShortAVLTreeSet​(java.util.Collection<? extends java.lang.Short> c)
      Creates a new tree set copying a given set.
      Parameters:
      c - a collection to be copied into the new tree set.
    • ShortAVLTreeSet

      public ShortAVLTreeSet​(java.util.SortedSet<java.lang.Short> 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.
    • ShortAVLTreeSet

      public ShortAVLTreeSet​(ShortCollection 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.
    • ShortAVLTreeSet

      public ShortAVLTreeSet​(ShortSortedSet 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.
    • ShortAVLTreeSet

      public ShortAVLTreeSet​(ShortIterator 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.
    • ShortAVLTreeSet

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

      public ShortAVLTreeSet​(short[] a, int offset, int length, java.util.Comparator<? super java.lang.Short> 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).
    • ShortAVLTreeSet

      public ShortAVLTreeSet​(short[] 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.
    • ShortAVLTreeSet

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

      public ShortAVLTreeSet​(short[] a, java.util.Comparator<? super java.lang.Short> 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​(short k)
      Description copied from class: AbstractShortCollection
      Ensures that this collection contains the specified element (optional operation).
      Specified by:
      add in interface ShortCollection
      Overrides:
      add in class AbstractShortCollection
      See Also:
      Collection.add(Object)
    • remove

      public boolean remove​(short k)
      Description copied from class: AbstractShortSet
      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 ShortSet
      Overrides:
      remove in class AbstractShortSet
      See Also:
      Collection.remove(Object)
    • contains

      public boolean contains​(short k)
      Description copied from class: AbstractShortCollection
      Returns true if this collection contains the specified element.
      Specified by:
      contains in interface ShortCollection
      Overrides:
      contains in class AbstractShortCollection
      See Also:
      Collection.contains(Object)
    • clear

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

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

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

      public short firstShort()
      Description copied from interface: ShortSortedSet
      Returns the first (lowest) element currently in this set.
      Specified by:
      firstShort in interface ShortSortedSet
      See Also:
      SortedSet.first()
    • lastShort

      public short lastShort()
      Description copied from interface: ShortSortedSet
      Returns the last (highest) element currently in this set.
      Specified by:
      lastShort in interface ShortSortedSet
      See Also:
      SortedSet.last()
    • iterator

      public ShortBidirectionalIterator iterator()
      Description copied from interface: ShortCollection
      Returns a type-specific iterator on the elements of this collection.
      Specified by:
      iterator in interface java.util.Collection<java.lang.Short>
      Specified by:
      iterator in interface java.lang.Iterable<java.lang.Short>
      Specified by:
      iterator in interface java.util.Set<java.lang.Short>
      Specified by:
      iterator in interface ShortBidirectionalIterable
      Specified by:
      iterator in interface ShortCollection
      Specified by:
      iterator in interface ShortIterable
      Specified by:
      iterator in interface ShortSet
      Specified by:
      iterator in interface ShortSortedSet
      Specified by:
      iterator in class AbstractShortSortedSet
      Returns:
      a type-specific iterator on the elements of this collection.
      See Also:
      Iterable.iterator()
    • iterator

      public ShortBidirectionalIterator iterator​(short from)
      Description copied from interface: ShortSortedSet
      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 ShortSortedSet
      Parameters:
      from - an element to start from.
      Returns:
      a bidirectional iterator on the element in this set, starting at the given element.
    • comparator

      public ShortComparator comparator()
      Description copied from interface: ShortSortedSet
      Specified by:
      comparator in interface ShortSortedSet
      Specified by:
      comparator in interface java.util.SortedSet<java.lang.Short>
    • headSet

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

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

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