it.unimi.dsi.fastutil.chars

Class CharRBTreeSet

java.lang.Object

java.util.AbstractCollection<java.lang.Character>

it.unimi.dsi.fastutil.chars.AbstractCharCollection

it.unimi.dsi.fastutil.chars.AbstractCharSet

it.unimi.dsi.fastutil.chars.AbstractCharSortedSet

it.unimi.dsi.fastutil.chars.CharRBTreeSet

All Implemented Interfaces:

it.unimi.dsi.fastutil.chars.CharBidirectionalIterable, it.unimi.dsi.fastutil.chars.CharCollection, it.unimi.dsi.fastutil.chars.CharIterable, CharSet, CharSortedSet, java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<java.lang.Character>, java.util.Collection<java.lang.Character>, java.util.Set<java.lang.Character>, java.util.SortedSet<java.lang.Character>

public class CharRBTreeSet
extends AbstractCharSortedSet
implements java.io.Serializable, java.lang.Cloneable, CharSortedSet

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 it.unimi.dsi.fastutil.chars.CharComparator	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.chars.CharRBTreeSet.Entry	firstEntry The entry of the first element of this set.
protected it.unimi.dsi.fastutil.chars.CharRBTreeSet.Entry	lastEntry The entry of the last element of this set.
protected java.util.Comparator<? super java.lang.Character>	storedComparator This set's comparator, as provided in the constructor.
protected it.unimi.dsi.fastutil.chars.CharRBTreeSet.Entry	tree A reference to the root entry.

Constructor Summary

Constructors

Constructor and Description
CharRBTreeSet() Creates a new empty tree set.
CharRBTreeSet(char[] a) Creates a new tree set copying the elements of an array.
CharRBTreeSet(char[] a, java.util.Comparator<? super java.lang.Character> c) Creates a new tree set copying the elements of an array using a given Comparator.
CharRBTreeSet(char[] a, int offset, int length) Creates a new tree set and fills it with the elements of a given array.
CharRBTreeSet(char[] a, int offset, int length, java.util.Comparator<? super java.lang.Character> c) Creates a new tree set and fills it with the elements of a given array using a given Comparator.
CharRBTreeSet(it.unimi.dsi.fastutil.chars.CharCollection c) Creates a new tree set copying a given type-specific collection.
CharRBTreeSet(it.unimi.dsi.fastutil.chars.CharIterator i) Creates a new tree set using elements provided by a type-specific iterator.
CharRBTreeSet(CharSortedSet s) Creates a new tree set copying a given type-specific sorted set (and its Comparator).
CharRBTreeSet(java.util.Collection<? extends java.lang.Character> c) Creates a new tree set copying a given collection.
CharRBTreeSet(java.util.Comparator<? super java.lang.Character> c) Creates a new empty tree set with the given comparator.
CharRBTreeSet(java.util.Iterator<?> i) Creates a new tree set using elements provided by an iterator.
CharRBTreeSet(java.util.SortedSet<java.lang.Character> s) Creates a new tree set copying a given sorted set (and its Comparator).

Method Summary

Modifier and Type	Method and Description
boolean	add(char k)
void	clear()
java.lang.Object	clone() Returns a deep copy of this tree set.
it.unimi.dsi.fastutil.chars.CharComparator	comparator()
boolean	contains(char k)
char	firstChar() Returns the first (lowest) element currently in this set.
CharSortedSet	headSet(char to) Returns a view of the portion of this sorted set whose elements are strictly less than toElement.
boolean	isEmpty()
it.unimi.dsi.fastutil.chars.CharBidirectionalIterator	iterator() Returns a type-specific iterator on the elements of this set.
it.unimi.dsi.fastutil.chars.CharBidirectionalIterator	iterator(char from) Returns a type-specific BidirectionalIterator on the elements in this set, starting from a given element of the domain (optional operation).
char	lastChar() Returns the last (highest) element currently in this set.
boolean	remove(char k) Removes an element from this set.
int	size()
CharSortedSet	subSet(char from, char to) Returns a view of the portion of this sorted set whose elements range from fromElement, inclusive, to toElement, exclusive.
CharSortedSet	tailSet(char 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.chars.AbstractCharSet

equals, hashCode, rem

Methods inherited from class it.unimi.dsi.fastutil.chars.AbstractCharCollection

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

Methods inherited from class java.util.AbstractCollection

toArray, toArray

Methods inherited from class java.lang.Object

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

Methods inherited from interface it.unimi.dsi.fastutil.chars.CharSortedSet

first, headSet, last, spliterator, subSet, tailSet

Methods inherited from interface it.unimi.dsi.fastutil.chars.CharSet

add, contains, of, of, of, of, of, rem, remove

Methods inherited from interface it.unimi.dsi.fastutil.chars.CharCollection

addAll, containsAll, intIterator, intParallelStream, intSpliterator, intStream, parallelStream, removeAll, removeIf, removeIf, removeIf, retainAll, stream, toArray, toCharArray, toCharArray

Methods inherited from interface it.unimi.dsi.fastutil.chars.CharIterable

forEach, forEach, forEach

Methods inherited from interface java.util.Set

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

Field Detail

tree

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

The entry of the first element of this set.

lastEntry

protected transient it.unimi.dsi.fastutil.chars.CharRBTreeSet.Entry lastEntry

The entry of the last element of this set.

storedComparator

protected java.util.Comparator<? super java.lang.Character> storedComparator

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

actualComparator

protected transient it.unimi.dsi.fastutil.chars.CharComparator 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

CharRBTreeSet

public CharRBTreeSet()

Creates a new empty tree set.

CharRBTreeSet

public CharRBTreeSet(java.util.Comparator<? super java.lang.Character> c)

Creates a new empty tree set with the given comparator.

Parameters:

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

CharRBTreeSet

public CharRBTreeSet(java.util.Collection<? extends java.lang.Character> c)

Creates a new tree set copying a given collection.

Parameters:

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

CharRBTreeSet

public CharRBTreeSet(java.util.SortedSet<java.lang.Character> 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.

CharRBTreeSet

public CharRBTreeSet(it.unimi.dsi.fastutil.chars.CharCollection 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.

CharRBTreeSet

public CharRBTreeSet(CharSortedSet 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.

CharRBTreeSet

public CharRBTreeSet(it.unimi.dsi.fastutil.chars.CharIterator 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.

CharRBTreeSet

public CharRBTreeSet(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.

CharRBTreeSet

public CharRBTreeSet(char[] a,
                     int offset,
                     int length,
                     java.util.Comparator<? super java.lang.Character> 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).

CharRBTreeSet

public CharRBTreeSet(char[] 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.

CharRBTreeSet

public CharRBTreeSet(char[] a)

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

Parameters:

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

CharRBTreeSet

public CharRBTreeSet(char[] a,
                     java.util.Comparator<? super java.lang.Character> 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(char k)

Specified by:

add in interface it.unimi.dsi.fastutil.chars.CharCollection

Overrides:

add in class it.unimi.dsi.fastutil.chars.AbstractCharCollection

remove

public boolean remove(char k)

Description copied from class: AbstractCharSet

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 CharSet

Overrides:

remove in class AbstractCharSet

See Also:

Collection.remove(Object)

contains

public boolean contains(char k)

Specified by:

contains in interface it.unimi.dsi.fastutil.chars.CharCollection

Overrides:

contains in class it.unimi.dsi.fastutil.chars.AbstractCharCollection

clear

public void clear()

Specified by:

clear in interface java.util.Collection<java.lang.Character>

Specified by:

clear in interface java.util.Set<java.lang.Character>

Overrides:

clear in class java.util.AbstractCollection<java.lang.Character>

size

public int size()

Specified by:

size in interface java.util.Collection<java.lang.Character>

Specified by:

size in interface java.util.Set<java.lang.Character>

Specified by:

size in class java.util.AbstractCollection<java.lang.Character>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Collection<java.lang.Character>

Specified by:

isEmpty in interface java.util.Set<java.lang.Character>

Overrides:

isEmpty in class java.util.AbstractCollection<java.lang.Character>

firstChar

public char firstChar()

Description copied from interface: CharSortedSet

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

Specified by:

firstChar in interface CharSortedSet

See Also:

SortedSet.first()

lastChar

public char lastChar()

Description copied from interface: CharSortedSet

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

Specified by:

lastChar in interface CharSortedSet

See Also:

SortedSet.last()

iterator

public it.unimi.dsi.fastutil.chars.CharBidirectionalIterator iterator()

Description copied from interface: CharSet

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

Specified by:

iterator in interface it.unimi.dsi.fastutil.chars.CharBidirectionalIterable

Specified by:

iterator in interface it.unimi.dsi.fastutil.chars.CharCollection

Specified by:

iterator in interface it.unimi.dsi.fastutil.chars.CharIterable

Specified by:

iterator in interface CharSet

Specified by:

iterator in interface CharSortedSet

Specified by:

iterator in interface java.lang.Iterable<java.lang.Character>

Specified by:

iterator in interface java.util.Collection<java.lang.Character>

Specified by:

iterator in interface java.util.Set<java.lang.Character>

Specified by:

iterator in class AbstractCharSortedSet

Returns:

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

iterator

public it.unimi.dsi.fastutil.chars.CharBidirectionalIterator iterator(char from)

Description copied from interface: CharSortedSet

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 CharSortedSet

Parameters:

from - an element to start from.

Returns:

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

comparator

public it.unimi.dsi.fastutil.chars.CharComparator comparator()

Description copied from interface: CharSortedSet

Specified by:

comparator in interface CharSortedSet

Specified by:

comparator in interface java.util.SortedSet<java.lang.Character>

headSet

public CharSortedSet headSet(char to)

Description copied from interface: CharSortedSet

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

Specified by:

headSet in interface CharSortedSet

See Also:

SortedSet.headSet(Object)

tailSet

public CharSortedSet tailSet(char from)

Description copied from interface: CharSortedSet

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

Specified by:

tailSet in interface CharSortedSet

See Also:

SortedSet.tailSet(Object)

subSet

public CharSortedSet subSet(char from,
                            char to)

Description copied from interface: CharSortedSet

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

Specified by:

subSet in interface CharSortedSet

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.

Overrides:

clone in class java.lang.Object

Returns:

a deep copy of this tree set.