it.unimi.dsi.fastutil.floats

Class FloatRBTreeSet

java.lang.Object

java.util.AbstractCollection<Float>

it.unimi.dsi.fastutil.floats.AbstractFloatCollection

it.unimi.dsi.fastutil.floats.AbstractFloatSet

it.unimi.dsi.fastutil.floats.AbstractFloatSortedSet

it.unimi.dsi.fastutil.floats.FloatRBTreeSet

All Implemented Interfaces:

FloatBidirectionalIterable, FloatCollection, FloatIterable, FloatSet, FloatSortedSet, Serializable, Cloneable, Iterable<Float>, Collection<Float>, Set<Float>, SortedSet<Float>

public class FloatRBTreeSet
extends AbstractFloatSortedSet
implements Serializable, Cloneable, FloatSortedSet

A type-specific red-black 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 FloatComparator	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.floats.FloatRBTreeSet.Entry	firstEntry The entry of the first element of this set.
protected it.unimi.dsi.fastutil.floats.FloatRBTreeSet.Entry	lastEntry The entry of the last element of this set.
protected Comparator<? super Float>	storedComparator This set's comparator, as provided in the constructor.
protected it.unimi.dsi.fastutil.floats.FloatRBTreeSet.Entry	tree A reference to the root entry.

Constructor Summary

Constructors

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

Method Summary

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

equals, hashCode, rem

Methods inherited from class it.unimi.dsi.fastutil.floats.AbstractFloatCollection

add, addAll, contains, containsAll, remove, removeAll, retainAll, toArray, toFloatArray, toFloatArray, 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.floats.FloatSortedSet

first, headSet, last, subSet, tailSet

Methods inherited from interface it.unimi.dsi.fastutil.floats.FloatSet

add, contains, rem, remove

Methods inherited from interface it.unimi.dsi.fastutil.floats.FloatCollection

addAll, containsAll, removeAll, removeIf, removeIf, retainAll, toArray, toFloatArray, toFloatArray

Methods inherited from interface it.unimi.dsi.fastutil.floats.FloatIterable

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.floats.FloatRBTreeSet.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.floats.FloatRBTreeSet.Entry firstEntry

The entry of the first element of this set.

lastEntry

protected transient it.unimi.dsi.fastutil.floats.FloatRBTreeSet.Entry lastEntry

The entry of the last element of this set.

storedComparator

protected Comparator<? super Float> storedComparator

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

actualComparator

protected transient FloatComparator 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

FloatRBTreeSet

public FloatRBTreeSet()

Creates a new empty tree set.

FloatRBTreeSet

public FloatRBTreeSet(Comparator<? super Float> c)

Creates a new empty tree set with the given comparator.

Parameters:

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

FloatRBTreeSet

public FloatRBTreeSet(Collection<? extends Float> c)

Creates a new tree set copying a given collection.

Parameters:

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

FloatRBTreeSet

public FloatRBTreeSet(SortedSet<Float> 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.

FloatRBTreeSet

public FloatRBTreeSet(FloatCollection 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.

FloatRBTreeSet

public FloatRBTreeSet(FloatSortedSet 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.

FloatRBTreeSet

public FloatRBTreeSet(FloatIterator 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.

FloatRBTreeSet

public FloatRBTreeSet(Iterator<?> i)

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

Parameters:

i - an iterator whose elements will fill the set.

FloatRBTreeSet

public FloatRBTreeSet(float[] a,
                      int offset,
                      int length,
                      Comparator<? super Float> 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).

FloatRBTreeSet

public FloatRBTreeSet(float[] 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.

FloatRBTreeSet

public FloatRBTreeSet(float[] a)

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

Parameters:

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

FloatRBTreeSet

public FloatRBTreeSet(float[] a,
                      Comparator<? super Float> 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(float k)

Description copied from class: AbstractFloatCollection

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

This implementation always throws an UnsupportedOperationException.

Specified by:

add in interface FloatCollection

Overrides:

add in class AbstractFloatCollection

See Also:

Collection.add(Object)

remove

public boolean remove(float k)

Description copied from class: AbstractFloatSet

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 FloatSet

Overrides:

remove in class AbstractFloatSet

See Also:

Collection.remove(Object)

contains

public boolean contains(float k)

Description copied from class: AbstractFloatCollection

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 FloatCollection

Overrides:

contains in class AbstractFloatCollection

See Also:

Collection.contains(Object)

clear

public void clear()

Specified by:

clear in interface Collection<Float>

Specified by:

clear in interface Set<Float>

Overrides:

clear in class AbstractCollection<Float>

size

public int size()

Specified by:

size in interface Collection<Float>

Specified by:

size in interface Set<Float>

Specified by:

size in class AbstractCollection<Float>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<Float>

Specified by:

isEmpty in interface Set<Float>

Overrides:

isEmpty in class AbstractCollection<Float>

firstFloat

public float firstFloat()

Description copied from interface: FloatSortedSet

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

Specified by:

firstFloat in interface FloatSortedSet

See Also:

SortedSet.first()

lastFloat

public float lastFloat()

Description copied from interface: FloatSortedSet

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

Specified by:

lastFloat in interface FloatSortedSet

See Also:

SortedSet.last()

iterator

public FloatBidirectionalIterator iterator()

Description copied from interface: FloatCollection

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 FloatBidirectionalIterable

Specified by:

iterator in interface FloatCollection

Specified by:

iterator in interface FloatIterable

Specified by:

iterator in interface FloatSet

Specified by:

iterator in interface FloatSortedSet

Specified by:

iterator in interface Iterable<Float>

Specified by:

iterator in interface Collection<Float>

Specified by:

iterator in interface Set<Float>

Specified by:

iterator in class AbstractFloatSortedSet

Returns:

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

See Also:

Iterable.iterator()

iterator

public FloatBidirectionalIterator iterator(float from)

Description copied from interface: FloatSortedSet

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 FloatSortedSet

Parameters:

from - an element to start from.

Returns:

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

comparator

public FloatComparator comparator()

Description copied from interface: FloatSortedSet

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

Specified by:

comparator in interface FloatSortedSet

Specified by:

comparator in interface SortedSet<Float>

headSet

public FloatSortedSet headSet(float to)

Description copied from interface: FloatSortedSet

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 FloatSortedSet

See Also:

SortedSet.headSet(Object)

tailSet

public FloatSortedSet tailSet(float from)

Description copied from interface: FloatSortedSet

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 FloatSortedSet

See Also:

SortedSet.tailSet(Object)

subSet

public FloatSortedSet subSet(float from,
                             float to)

Description copied from interface: FloatSortedSet

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 FloatSortedSet

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.