it.unimi.dsi.fastutil.chars

Interface CharSortedSet

All Superinterfaces:

CharBidirectionalIterable, CharCollection, CharIterable, CharSet, Collection<Character>, Iterable<Character>, Set<Character>, SortedSet<Character>

All Known Implementing Classes:

AbstractCharSortedSet, CharAVLTreeSet, CharLinkedOpenCustomHashSet, CharLinkedOpenHashSet, CharRBTreeSet, CharSortedSets.EmptySet, CharSortedSets.Singleton, CharSortedSets.SynchronizedSortedSet, CharSortedSets.UnmodifiableSortedSet

public interface CharSortedSet
extends CharSet, SortedSet<Character>, CharBidirectionalIterable

A type-specific SortedSet; provides some additional methods that use polymorphism to avoid (un)boxing.

Additionally, this interface strengthens iterator(), comparator() (for primitive types), SortedSet.subSet(Object,Object), SortedSet.headSet(Object) and SortedSet.tailSet(Object).

See Also:

SortedSet

Method Summary

Modifier and Type	Method and Description
CharComparator	comparator() Returns the comparator used to order the elements in this set, or null if this set uses the natural ordering of its elements.
default Character	first() Deprecated. Please use the corresponding type-specific method instead.
char	firstChar() Returns the first (lowest) element currently in this set.
CharSortedSet	headSet(char toElement) Returns a view of the portion of this sorted set whose elements are strictly less than toElement.
default CharSortedSet	headSet(Character to) Deprecated. Please use the corresponding type-specific method instead.
CharBidirectionalIterator	iterator() Returns a type-specific BidirectionalIterator on the elements in this set.
CharBidirectionalIterator	iterator(char fromElement) Returns a type-specific BidirectionalIterator on the elements in this set, starting from a given element of the domain (optional operation).
default Character	last() Deprecated. Please use the corresponding type-specific method instead.
char	lastChar() Returns the last (highest) element currently in this set.
default CharSortedSet	subSet(Character from, Character to) Deprecated. Please use the corresponding type-specific method instead.
CharSortedSet	subSet(char fromElement, char toElement) Returns a view of the portion of this sorted set whose elements range from fromElement, inclusive, to toElement, exclusive.
CharSortedSet	tailSet(char fromElement) Returns a view of the portion of this sorted set whose elements are greater than or equal to fromElement.
default CharSortedSet	tailSet(Character from) Deprecated. Please use the corresponding type-specific method instead.

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

add, contains, rem, remove, remove

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

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

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

forEach, forEach

Methods inherited from interface java.util.SortedSet

spliterator

Methods inherited from interface java.util.Set

addAll, clear, containsAll, equals, hashCode, isEmpty, removeAll, retainAll, size, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Method Detail

iterator

CharBidirectionalIterator iterator(char fromElement)

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.

Parameters:

fromElement - an element to start from.

Returns:

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

Throws:

UnsupportedOperationException - if this set does not support iterators with a starting point.

iterator

CharBidirectionalIterator iterator()

Returns a type-specific BidirectionalIterator on the elements in this set.

Note that this specification strengthens the one given in the corresponding type-specific Collection.

This method returns a parameterised bidirectional iterator. The iterator can be moreover safely cast to a type-specific iterator.

Specified by:

iterator in interface CharBidirectionalIterable

Specified by:

iterator in interface CharCollection

Specified by:

iterator in interface CharIterable

Specified by:

iterator in interface CharSet

Specified by:

iterator in interface Collection<Character>

Specified by:

iterator in interface Iterable<Character>

Specified by:

iterator in interface Set<Character>

Returns:

a bidirectional iterator on the element in this set.

See Also:

Iterable.iterator()

subSet

CharSortedSet subSet(char fromElement,
                     char toElement)

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).

See Also:

SortedSet.subSet(Object,Object)

headSet

CharSortedSet headSet(char toElement)

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).

See Also:

SortedSet.headSet(Object)

tailSet

CharSortedSet tailSet(char fromElement)

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).

See Also:

SortedSet.tailSet(Object)

comparator

CharComparator comparator()

Returns the comparator used to order the elements in this set, or null if this set uses the natural ordering of its elements.

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

Specified by:

comparator in interface SortedSet<Character>

Returns:

the comparator used to order the elements in this set, or null if this set uses the natural ordering of its elements

firstChar

char firstChar()

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

See Also:

SortedSet.first()

lastChar

char lastChar()

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

See Also:

SortedSet.last()

subSet

@Deprecated
default CharSortedSet subSet(Character from,
                                         Character to)

Deprecated. Please use the corresponding type-specific method instead.

Returns a view of the portion of this set whose elements range from fromElement, inclusive, to toElement, exclusive. (If fromElement and toElement are equal, the returned set is empty.) The returned set is backed by this set, so changes in the returned set are reflected in this set, and vice-versa. The returned set supports all optional set operations that this set supports.

The returned set will throw an IllegalArgumentException on an attempt to insert an element outside its range.

Specified by:

subSet in interface SortedSet<Character>

Parameters:

from - low endpoint (inclusive) of the returned set

to - high endpoint (exclusive) of the returned set

Returns:

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

headSet

@Deprecated
default CharSortedSet headSet(Character to)

Deprecated. Please use the corresponding type-specific method instead.

Returns a view of the portion of this set whose elements are strictly less than toElement. The returned set is backed by this set, so changes in the returned set are reflected in this set, and vice-versa. The returned set supports all optional set operations that this set supports.

The returned set will throw an IllegalArgumentException on an attempt to insert an element outside its range.

Specified by:

headSet in interface SortedSet<Character>

Parameters:

to - high endpoint (exclusive) of the returned set

Returns:

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

tailSet

@Deprecated
default CharSortedSet tailSet(Character from)

Deprecated. Please use the corresponding type-specific method instead.

Returns a view of the portion of this set whose elements are greater than or equal to fromElement. The returned set is backed by this set, so changes in the returned set are reflected in this set, and vice-versa. The returned set supports all optional set operations that this set supports.

The returned set will throw an IllegalArgumentException on an attempt to insert an element outside its range.

Specified by:

tailSet in interface SortedSet<Character>

Parameters:

from - low endpoint (inclusive) of the returned set

Returns:

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

first

@Deprecated
default Character first()

Deprecated. Please use the corresponding type-specific method instead.

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

Specified by:

first in interface SortedSet<Character>

Returns:

the first (lowest) element currently in this set

last

@Deprecated
default Character last()

Deprecated. Please use the corresponding type-specific method instead.

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

Specified by:

last in interface SortedSet<Character>

Returns:

the last (highest) element currently in this set