it.unimi.dsi.fastutil.objects
Class ObjectAVLTreeSet

java.lang.Object
  it.unimi.dsi.fastutil.objects.AbstractObjectCollection
      it.unimi.dsi.fastutil.objects.AbstractObjectSet
          it.unimi.dsi.fastutil.objects.AbstractObjectSortedSet
              it.unimi.dsi.fastutil.objects.ObjectAVLTreeSet

All Implemented Interfaces:

Cloneable, Collection, ObjectCollection, ObjectSet, ObjectSortedSet, Serializable, Set, SortedSet

public class ObjectAVLTreeSet

extends AbstractObjectSortedSet

implements Serializable, Cloneable, ObjectSortedSet

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

Field Summary

static long

serialVersionUID

Constructor Summary

ObjectAVLTreeSet()
Creates a new empty tree set.

ObjectAVLTreeSet(Collection c)
Creates a new tree set copying a given set.

ObjectAVLTreeSet(Comparator c)
Creates a new empty tree set with the given comparator.

ObjectAVLTreeSet(Iterator i)
Creates a new tree set using elements provided by an iterator.

ObjectAVLTreeSet(Object[] a)
Creates a new tree set copying the elements of an array.

ObjectAVLTreeSet(Object[] a, Comparator c)
Creates a new tree set copying the elements of an array using a given Comparator.

ObjectAVLTreeSet(Object[] a, int offset, int length)
Creates a new tree set and fills it with the elements of a given array.

ObjectAVLTreeSet(Object[] a, int offset, int length, Comparator c)
Creates a new tree set and fills it with the elements of a given array using a given Comparator.

ObjectAVLTreeSet(ObjectCollection c)
Creates a new tree set copying a given type-specific collection.

ObjectAVLTreeSet(ObjectIterator i)
Creates a new tree set using elements provided by a type-specific iterator.

ObjectAVLTreeSet(ObjectSortedSet s)
Creates a new tree set copying a given type-specific sorted set (and its Comparator).

ObjectAVLTreeSet(SortedSet s)
Creates a new tree set copying a given sorted set (and its Comparator).

Method Summary

boolean	add(Object k)
void	clear()
Object	clone() Returns a deep copy of this tree set.
Comparator	comparator()
boolean	contains(Object k)
Object	first() Delegates to the corresponding type-specific method.
SortedSet	headSet(Object to) Delegates to the corresponding type-specific method.
boolean	isEmpty()
ObjectBidirectionalIterator	iterator(Object from) Returns a type-specific BidirectionalIterator on the elements in this set, starting from a given element of the domain (optional operation).
Object	last() Delegates to the corresponding type-specific method.
ObjectIterator	objectIterator() Returns a type-specific iterator on the collection.
boolean	remove(Object k) Note that the corresponding method of the type-specific collection is rem().
int	size()
SortedSet	subSet(Object from, Object to) Delegates to the corresponding type-specific method.
SortedSet	tailSet(Object from) Delegates to the corresponding type-specific method.

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

equals, hashCode, rem

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

addAll, containsAll, iterator, removeAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Set

addAll, containsAll, equals, hashCode, iterator, removeAll, retainAll, toArray, toArray

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

ObjectAVLTreeSet

public ObjectAVLTreeSet()

Creates a new empty tree set.

ObjectAVLTreeSet

public ObjectAVLTreeSet(Comparator 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 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 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 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 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(ObjectIterator 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(Iterator i)

Creates a new tree set using elements provided by an iterator.

Parameters:

i - an iterator whose elements will fill the set.

ObjectAVLTreeSet

public ObjectAVLTreeSet(Object[] a,
                        int offset,
                        int length,
                        Comparator 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(Object[] 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(Object[] 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(Object[] a,
                        Comparator 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 Detail

add

public final boolean add(Object k)

Specified by:

add in interface Set

Overrides:

add in class AbstractObjectCollection

remove

public final boolean remove(Object k)

Description copied from interface: ObjectSet

Note that the corresponding method of the type-specific collection is rem(). This unfortunate situation is caused by the clash with the similarly named index-based method in the List interface.

Specified by:

remove in interface ObjectSet

Overrides:

remove in class AbstractObjectSet

contains

public boolean contains(Object k)

Specified by:

contains in interface Set

clear

public void clear()

Specified by:

clear in interface Set

Overrides:

clear in class AbstractObjectCollection

size

public int size()

Specified by:

size in interface Set

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Set

Overrides:

isEmpty in class AbstractObjectCollection

first

public Object first()

Description copied from class: AbstractObjectSortedSet

Delegates to the corresponding type-specific method.

Specified by:

first in interface SortedSet

Overrides:

first in class AbstractObjectSortedSet

last

public Object last()

Description copied from class: AbstractObjectSortedSet

Delegates to the corresponding type-specific method.

Specified by:

last in interface SortedSet

Overrides:

last in class AbstractObjectSortedSet

objectIterator

public ObjectIterator objectIterator()

Description copied from interface: ObjectCollection

Returns a type-specific iterator on the collection.

The iterator returned by the Collection.iterator() method and by this method are identical; however, using this method you can save a type casting.

Specified by:

objectIterator in interface ObjectCollection

See Also:

Collection.iterator()

iterator

public ObjectBidirectionalIterator iterator(Object 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

Overrides:

iterator in class AbstractObjectSet

comparator

public Comparator comparator()

Specified by:

comparator in interface SortedSet

headSet

public SortedSet headSet(Object to)

Description copied from class: AbstractObjectSortedSet

Delegates to the corresponding type-specific method.

Specified by:

headSet in interface SortedSet

Overrides:

headSet in class AbstractObjectSortedSet

tailSet

public SortedSet tailSet(Object from)

Description copied from class: AbstractObjectSortedSet

Delegates to the corresponding type-specific method.

Specified by:

tailSet in interface SortedSet

Overrides:

tailSet in class AbstractObjectSortedSet

subSet

public SortedSet subSet(Object from,
                        Object to)

Description copied from class: AbstractObjectSortedSet

Delegates to the corresponding type-specific method.

Specified by:

subSet in interface SortedSet

Overrides:

subSet in class AbstractObjectSortedSet

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.

Returns:

a deep copy of this tree set.