it.unimi.dsi.fastutil.doubles

Class DoubleAVLTreeSet

java.lang.Object

java.util.AbstractCollection<Double>

it.unimi.dsi.fastutil.doubles.AbstractDoubleCollection

it.unimi.dsi.fastutil.doubles.AbstractDoubleSet

it.unimi.dsi.fastutil.doubles.AbstractDoubleSortedSet

it.unimi.dsi.fastutil.doubles.DoubleAVLTreeSet

All Implemented Interfaces:

DoubleBidirectionalIterable, DoubleCollection, DoubleIterable, DoubleSet, DoubleSortedSet, Serializable, Cloneable, Iterable<Double>, Collection<Double>, Set<Double>, SortedSet<Double>

public class DoubleAVLTreeSet
extends AbstractDoubleSortedSet
implements Serializable, Cloneable, DoubleSortedSet

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

Fields

Modifier and Type	Field and Description
protected DoubleComparator	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.
protected int	count Number of elements in this set.
protected it.unimi.dsi.fastutil.doubles.DoubleAVLTreeSet.Entry	firstEntry The entry of the first element of this set.
protected it.unimi.dsi.fastutil.doubles.DoubleAVLTreeSet.Entry	lastEntry The entry of the last element of this set.
protected Comparator<? super Double>	storedComparator This set's comparator, as provided in the constructor.
protected it.unimi.dsi.fastutil.doubles.DoubleAVLTreeSet.Entry	tree A reference to the root entry.

Constructor Summary

Constructors

Constructor and Description
DoubleAVLTreeSet() Creates a new empty tree set.
DoubleAVLTreeSet(Collection<? extends Double> c) Creates a new tree set copying a given set.
DoubleAVLTreeSet(Comparator<? super Double> c) Creates a new empty tree set with the given comparator.
DoubleAVLTreeSet(double[] a) Creates a new tree set copying the elements of an array.
DoubleAVLTreeSet(double[] a, Comparator<? super Double> c) Creates a new tree set copying the elements of an array using a given Comparator.
DoubleAVLTreeSet(double[] a, int offset, int length) Creates a new tree set and fills it with the elements of a given array.
DoubleAVLTreeSet(double[] a, int offset, int length, Comparator<? super Double> c) Creates a new tree set and fills it with the elements of a given array using a given Comparator.
DoubleAVLTreeSet(DoubleCollection c) Creates a new tree set copying a given type-specific collection.
DoubleAVLTreeSet(DoubleIterator i) Creates a new tree set using elements provided by a type-specific iterator.
DoubleAVLTreeSet(DoubleSortedSet s) Creates a new tree set copying a given type-specific sorted set (and its Comparator).
DoubleAVLTreeSet(Iterator<?> i) Creates a new tree set using elements provided by an iterator.
DoubleAVLTreeSet(SortedSet<Double> s) Creates a new tree set copying a given sorted set (and its Comparator).

Method Summary

Modifier and Type	Method and Description
boolean	add(double k) Ensures that this collection contains the specified element (optional operation).
void	clear()
Object	clone() Returns a deep copy of this tree set.
DoubleComparator	comparator()
boolean	contains(double k) Returns true if this collection contains the specified element.
double	firstDouble() Returns the first (lowest) element currently in this set.
DoubleSortedSet	headSet(double to) Returns a view of the portion of this sorted set whose elements are strictly less than toElement.
boolean	isEmpty()
DoubleBidirectionalIterator	iterator() Returns a type-specific iterator on the elements of this collection.
DoubleBidirectionalIterator	iterator(double from) Returns a type-specific BidirectionalIterator on the elements in this set, starting from a given element of the domain (optional operation).
double	lastDouble() Returns the last (highest) element currently in this set.
boolean	remove(double k) Removes an element from this set.
int	size()
DoubleSortedSet	subSet(double from, double to) Returns a view of the portion of this sorted set whose elements range from fromElement, inclusive, to toElement, exclusive.
DoubleSortedSet	tailSet(double 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.doubles.AbstractDoubleSet

equals, hashCode, rem

Methods inherited from class it.unimi.dsi.fastutil.doubles.AbstractDoubleCollection

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

Methods inherited from class java.util.AbstractCollection

addAll, containsAll, removeAll, retainAll, toArray, toArray

Methods inherited from class java.lang.Object

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

Methods inherited from interface it.unimi.dsi.fastutil.doubles.DoubleSortedSet

first, headSet, last, subSet, tailSet

Methods inherited from interface it.unimi.dsi.fastutil.doubles.DoubleSet

add, contains, rem, remove

Methods inherited from interface it.unimi.dsi.fastutil.doubles.DoubleCollection

addAll, containsAll, removeAll, removeIf, removeIf, retainAll, toArray, toDoubleArray, toDoubleArray

Methods inherited from interface it.unimi.dsi.fastutil.doubles.DoubleIterable

forEach, forEach

Methods inherited from interface java.util.SortedSet

spliterator

Methods inherited from interface java.util.Set

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

Methods inherited from interface java.util.Collection

parallelStream, stream

Field Detail

tree

protected transient it.unimi.dsi.fastutil.doubles.DoubleAVLTreeSet.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.doubles.DoubleAVLTreeSet.Entry firstEntry

The entry of the first element of this set.

lastEntry

protected transient it.unimi.dsi.fastutil.doubles.DoubleAVLTreeSet.Entry lastEntry

The entry of the last element of this set.

storedComparator

protected Comparator<? super Double> storedComparator

This set's comparator, as provided in the constructor.

actualComparator

protected transient DoubleComparator 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 Detail

DoubleAVLTreeSet

public DoubleAVLTreeSet()

Creates a new empty tree set.

DoubleAVLTreeSet

public DoubleAVLTreeSet(Comparator<? super Double> c)

Creates a new empty tree set with the given comparator.

Parameters:

c - a Comparator (even better, a type-specific comparator).

DoubleAVLTreeSet

public DoubleAVLTreeSet(Collection<? extends Double> c)

Creates a new tree set copying a given set.

Parameters:

c - a collection to be copied into the new tree set.

DoubleAVLTreeSet

public DoubleAVLTreeSet(SortedSet<Double> 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.

DoubleAVLTreeSet

public DoubleAVLTreeSet(DoubleCollection 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.

DoubleAVLTreeSet

public DoubleAVLTreeSet(DoubleSortedSet 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.

DoubleAVLTreeSet

public DoubleAVLTreeSet(DoubleIterator 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.

DoubleAVLTreeSet

public DoubleAVLTreeSet(Iterator<?> i)

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

Parameters:

i - an iterator whose elements will fill the set.

DoubleAVLTreeSet

public DoubleAVLTreeSet(double[] a,
                        int offset,
                        int length,
                        Comparator<? super Double> 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).

DoubleAVLTreeSet

public DoubleAVLTreeSet(double[] 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.

DoubleAVLTreeSet

public DoubleAVLTreeSet(double[] a)

Creates a new tree set copying the elements of an array.

Parameters:

a - an array to be copied into the new tree set.

DoubleAVLTreeSet

public DoubleAVLTreeSet(double[] a,
                        Comparator<? super Double> 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 boolean add(double k)

Description copied from class: AbstractDoubleCollection

Ensures that this collection contains the specified element (optional operation).

This implementation always throws an UnsupportedOperationException.

Specified by:

add in interface DoubleCollection

Overrides:

add in class AbstractDoubleCollection

See Also:

Collection.add(Object)

remove

public boolean remove(double k)

Description copied from class: AbstractDoubleSet

Removes an element from this set.

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

Specified by:

remove in interface DoubleSet

Overrides:

remove in class AbstractDoubleSet

See Also:

Collection.remove(Object)

contains

public boolean contains(double k)

Description copied from class: AbstractDoubleCollection

Returns true if this collection contains the specified element.

This implementation iterates over the elements in the collection, looking for the specified element.

Specified by:

contains in interface DoubleCollection

Overrides:

contains in class AbstractDoubleCollection

See Also:

Collection.contains(Object)

clear

public void clear()

Specified by:

clear in interface Collection<Double>

Specified by:

clear in interface Set<Double>

Overrides:

clear in class AbstractCollection<Double>

size

public int size()

Specified by:

size in interface Collection<Double>

Specified by:

size in interface Set<Double>

Specified by:

size in class AbstractCollection<Double>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<Double>

Specified by:

isEmpty in interface Set<Double>

Overrides:

isEmpty in class AbstractCollection<Double>

firstDouble

public double firstDouble()

Description copied from interface: DoubleSortedSet

Returns the first (lowest) element currently in this set.

Specified by:

firstDouble in interface DoubleSortedSet

See Also:

SortedSet.first()

lastDouble

public double lastDouble()

Description copied from interface: DoubleSortedSet

Returns the last (highest) element currently in this set.

Specified by:

lastDouble in interface DoubleSortedSet

See Also:

SortedSet.last()

iterator

public DoubleBidirectionalIterator iterator()

Description copied from interface: DoubleCollection

Returns a type-specific iterator on the elements of this collection.

Note that this specification strengthens the one given in Iterable.iterator(), which was already strengthened in the corresponding type-specific class, but was weakened by the fact that this interface extends Collection.

Specified by:

iterator in interface DoubleBidirectionalIterable

Specified by:

iterator in interface DoubleCollection

Specified by:

iterator in interface DoubleIterable

Specified by:

iterator in interface DoubleSet

Specified by:

iterator in interface DoubleSortedSet

Specified by:

iterator in interface Iterable<Double>

Specified by:

iterator in interface Collection<Double>

Specified by:

iterator in interface Set<Double>

Specified by:

iterator in class AbstractDoubleSortedSet

Returns:

a type-specific iterator on the elements of this collection.

See Also:

Iterable.iterator()

iterator

public DoubleBidirectionalIterator iterator(double from)

Description copied from interface: DoubleSortedSet

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 DoubleSortedSet

Parameters:

from - an element to start from.

Returns:

a bidirectional iterator on the element in this set, starting at the given element.

comparator

public DoubleComparator comparator()

Description copied from interface: DoubleSortedSet

Note that this specification strengthens the one given in SortedSet.comparator().

Specified by:

comparator in interface DoubleSortedSet

Specified by:

comparator in interface SortedSet<Double>

headSet

public DoubleSortedSet headSet(double to)

Description copied from interface: DoubleSortedSet

Returns a view of the portion of this sorted set whose elements are strictly less than toElement.

Note that this specification strengthens the one given in SortedSet.headSet(Object).

Specified by:

headSet in interface DoubleSortedSet

See Also:

SortedSet.headSet(Object)

tailSet

public DoubleSortedSet tailSet(double from)

Description copied from interface: DoubleSortedSet

Returns a view of the portion of this sorted set whose elements are greater than or equal to fromElement.

Note that this specification strengthens the one given in SortedSet.headSet(Object).

Specified by:

tailSet in interface DoubleSortedSet

See Also:

SortedSet.tailSet(Object)

subSet

public DoubleSortedSet subSet(double from,
                              double to)

Description copied from interface: DoubleSortedSet

Returns a view of the portion of this sorted set whose elements range from fromElement, inclusive, to toElement, exclusive.

Note that this specification strengthens the one given in SortedSet.subSet(Object,Object).

Specified by:

subSet in interface DoubleSortedSet

See Also:

SortedSet.subSet(Object,Object)

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.