Interface SortedSet<T>
- Type Parameters:
T
- Component type
- All Superinterfaces:
Foldable<T>
,Function<T,
,Boolean> Function1<T,
,Boolean> Iterable<T>
,Ordered<T>
,Serializable
,Set<T>
,Traversable<T>
,Value<T>
- All Known Subinterfaces:
BitSet<T>
- All Known Implementing Classes:
BitSetModule.AbstractBitSet
,BitSetModule.BitSet1
,BitSetModule.BitSet2
,BitSetModule.BitSetN
,TreeSet
SortedSet
interface.
Specific SortedSet operations:
-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionAdd the given element to this set, if it is not already contained.Adds all of the given elements to this set, if not already contained.<R> SortedSet
<R> collect
(PartialFunction<? super T, ? extends R> partialFunction) Collects all elements that are in the domain of the givenpartialFunction
by mapping the elements to typeR
.Calculates the difference between this set and another set.distinct()
Returns a new version of this which contains no duplicates.distinctBy
(Comparator<? super T> comparator) Returns a new version of this which contains no duplicates.distinctBy
(Function<? super T, ? extends U> keyExtractor) Returns a new version of this which contains no duplicates.drop
(int n) Drops the first n elements of this or all elements, if this length < n.dropRight
(int n) Drops the last n elements of this or all elements, if this length < n.Drops elements until the predicate holds for the current element.Drops elements while the predicate holds for the current element.Returns a new traversable consisting of all elements which satisfy the given predicate.<U> SortedSet
<U> flatMap
(Comparator<? super U> comparator, Function<? super T, ? extends Iterable<? extends U>> mapper) Same asflatMap(Function)
but using a specific comparator for values of the codomain of the givenmapper
.<U> SortedSet
<U> FlatMaps this Traversable.Groups this elements by classifying the elements.grouped
(int size) Groups thisTraversable
into fixed size blocks.init()
Dual of Traversable.tail(), returning all elements except the last.Dual of Traversable.tailOption(), returning all elements except the last asOption
.Computes the intersection between this set and another set.default boolean
Checks if this Traversable is ordered<U> SortedSet
<U> map
(Comparator<? super U> comparator, Function<? super T, ? extends U> mapper) Same asmap(Function)
but using a specific comparator for values of the codomain of the givenmapper
.<U> SortedSet
<U> Maps the elements of thisTraversable
to elements of a new type preserving their order, if any.static <T> SortedSet
<T> Narrows a widenedSortedSet<? extends T>
toSortedSet<T>
by performing a type-safe cast.Returns thisTraversable
if it is nonempty, otherwise return the alternative.Returns thisTraversable
if it is nonempty, otherwise return the result of evaluating supplier.Creates a partition of thisTraversable
by splitting this elements in two in distinct traversables according to a predicate.Performs the givenaction
on the first element if this is an eager implementation.Returns a new traversable consisting of all elements which do not satisfy the given predicate.Removes a specific element from this set, if present.Removes all of the given elements from this set, if present.Replaces the first occurrence (if exists) of the given currentElement with newElement.replaceAll
(T currentElement, T newElement) Replaces all occurrences of the given currentElement with newElement.Keeps all occurrences of the given elements from this.Computes a prefix scan of the elements of the collection.<U> Set
<U> scanLeft
(U zero, BiFunction<? super U, ? super T, ? extends U> operation) Produces a collection containing cumulative results of applying the operator going left to right.<U> Set
<U> scanRight
(U zero, BiFunction<? super T, ? super U, ? extends U> operation) Produces a collection containing cumulative results of applying the operator going right to left.Slides a non-overlapping window of a variable size over thisTraversable
.sliding
(int size) Slides a window of a specificsize
and step size 1 over thisTraversable
by callingTraversable.sliding(int, int)
.sliding
(int size, int step) Slides a window of a specificsize
andstep
size over thisTraversable
.Returns a tuple where the first element is the longest prefix of elements that satisfy the givenpredicate
and the second element is the remainder.tail()
Drops the first element of a non-empty Traversable.Drops the first element of a non-empty Traversable and returns anOption
.take
(int n) Takes the first n elements of this or all elements, if this length < n.takeRight
(int n) Takes the last n elements of this or all elements, if this length < n.Takes elements until the predicate holds for the current element.Takes elements while the predicate holds for the current element.Converts this VavrSet
to ajava.util.Set
while preserving characteristics like insertion order (LinkedHashSet
) and sort order (SortedSet
).Adds all of the elements ofthat
set to this set, if not already present.Unzips this elements by mapping this elements to pairs which are subsequently split into two distinct sets.Unzips this elements by mapping this elements to triples which are subsequently split into three distinct sets.Returns a traversable formed from this traversable and another Iterable collection by combining corresponding elements in pairs.Returns a traversable formed from this traversable and another Iterable by combining corresponding elements in pairs.<U,
R> SortedSet <R> zipWith
(Iterable<? extends U> that, BiFunction<? super T, ? super U, ? extends R> mapper) Returns a traversable formed from this traversable and another Iterable collection by mapping elements.Zips this traversable with its indices.<U> SortedSet
<U> zipWithIndex
(BiFunction<? super T, ? super Integer, ? extends U> mapper) Returns a traversable formed from this traversable and another Iterable collection by mapping elements.Methods inherited from interface io.vavr.collection.Foldable
fold, reduce, reduceOption
Methods inherited from interface io.vavr.Function1
andThen, arity, compose, curried, isMemoized, memoized, partial, reversed, tupled
Methods inherited from interface io.vavr.collection.Ordered
comparator
Methods inherited from interface io.vavr.collection.Set
apply, contains, isDistinct, iterator, length
Methods inherited from interface io.vavr.collection.Traversable
arrangeBy, average, containsAll, count, equals, existsUnique, find, findLast, foldLeft, foldRight, forEachWithIndex, get, hasDefiniteSize, hashCode, head, headOption, isEmpty, isSequential, isSingleValued, isTraversableAgain, last, lastOption, max, maxBy, maxBy, min, minBy, minBy, mkCharSeq, mkCharSeq, mkCharSeq, mkString, mkString, mkString, nonEmpty, product, reduceLeft, reduceLeftOption, reduceRight, reduceRightOption, single, singleOption, size, spliterator, sum
Methods inherited from interface io.vavr.Value
collect, collect, corresponds, eq, exists, forAll, forEach, getOrElse, getOrElse, getOrElseThrow, getOrElseTry, getOrNull, isAsync, isLazy, out, out, stderr, stdout, stringPrefix, toArray, toCharSeq, toCompletableFuture, toEither, toEither, toInvalid, toInvalid, toJavaArray, toJavaArray, toJavaArray, toJavaCollection, toJavaList, toJavaList, toJavaMap, toJavaMap, toJavaMap, toJavaOptional, toJavaParallelStream, toJavaSet, toJavaStream, toLeft, toLeft, toLinkedMap, toLinkedMap, toLinkedSet, toList, toMap, toMap, toOption, toPriorityQueue, toPriorityQueue, toQueue, toRight, toRight, toSet, toSortedMap, toSortedMap, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toStream, toString, toTree, toTree, toTry, toTry, toValid, toValid, toValidation, toValidation, toVector
-
Field Details
-
serialVersionUID
static final long serialVersionUID- See Also:
-
-
Method Details
-
narrow
Narrows a widenedSortedSet<? extends T>
toSortedSet<T>
by performing a type-safe cast. This is eligible because immutable/read-only collections are covariant.CAUTION: The underlying
Comparator
might fail!- Type Parameters:
T
- Component type of theSortedSet
.- Parameters:
sortedSet
- ASortedSet
.- Returns:
- the given
sortedSet
instance as narrowed typeSortedSet<T>
.
-
flatMap
<U> SortedSet<U> flatMap(Comparator<? super U> comparator, Function<? super T, ? extends Iterable<? extends U>> mapper) Same asflatMap(Function)
but using a specific comparator for values of the codomain of the givenmapper
.- Type Parameters:
U
- Type of flat-mapped values- Parameters:
comparator
- A comparator for values of type Umapper
- A function which maps values of type T to Iterables of values of type U- Returns:
- A new Set instance containing mapped values
-
map
Same asmap(Function)
but using a specific comparator for values of the codomain of the givenmapper
.- Type Parameters:
U
- Type of mapped values- Parameters:
comparator
- A comparator for values of type Umapper
- A function which maps values of type T to values of type U- Returns:
- A new Set instance containing mapped values
-
add
Description copied from interface:Set
Add the given element to this set, if it is not already contained. -
addAll
Description copied from interface:Set
Adds all of the given elements to this set, if not already contained. -
collect
Description copied from interface:Traversable
Collects all elements that are in the domain of the givenpartialFunction
by mapping the elements to typeR
.More specifically, for each of this elements in iteration order first it is checked
If the elements makes it through that filter, the mapped instance is added to the result collectionpartialFunction.isDefinedAt(element)
Note:If thisR newElement = partialFunction.apply(element)
Traversable
is ordered (i.e. extendsOrdered
, the caller ofcollect
has to ensure that the elements are comparable (i.e. extendComparable
).- Specified by:
collect
in interfaceSet<T>
- Specified by:
collect
in interfaceTraversable<T>
- Type Parameters:
R
- The new element type- Parameters:
partialFunction
- A function that is not necessarily defined of all elements of this traversable.- Returns:
- A new
Traversable
instance containing elements of typeR
-
diff
Description copied from interface:Set
Calculates the difference between this set and another set.See also
Set.removeAll(Iterable)
. -
distinct
Description copied from interface:Traversable
Returns a new version of this which contains no duplicates. Elements are compared usingequals
. -
distinctBy
Description copied from interface:Traversable
Returns a new version of this which contains no duplicates. Elements are compared using the givencomparator
.- Specified by:
distinctBy
in interfaceSet<T>
- Specified by:
distinctBy
in interfaceTraversable<T>
- Parameters:
comparator
- A comparator- Returns:
- a new
Traversable
containing this elements without duplicates
-
distinctBy
Description copied from interface:Traversable
Returns a new version of this which contains no duplicates. Elements mapped to keys which are compared usingequals
.The elements of the result are determined in the order of their occurrence - first match wins.
- Specified by:
distinctBy
in interfaceSet<T>
- Specified by:
distinctBy
in interfaceTraversable<T>
- Type Parameters:
U
- key type- Parameters:
keyExtractor
- A key extractor- Returns:
- a new
Traversable
containing this elements without duplicates
-
drop
Description copied from interface:Traversable
Drops the first n elements of this or all elements, if this length < n. -
dropRight
Description copied from interface:Traversable
Drops the last n elements of this or all elements, if this length < n. -
dropUntil
Description copied from interface:Traversable
Drops elements until the predicate holds for the current element. -
dropWhile
Description copied from interface:Traversable
Drops elements while the predicate holds for the current element.Note: This is essentially the same as
dropUntil(predicate.negate())
. It is intended to be used with method references, which cannot be negated directly. -
filter
Description copied from interface:Traversable
Returns a new traversable consisting of all elements which satisfy the given predicate. -
reject
Description copied from interface:Traversable
Returns a new traversable consisting of all elements which do not satisfy the given predicate.The default implementation is equivalent to
filter(predicate.negate()
-
flatMap
Description copied from interface:Traversable
FlatMaps this Traversable. -
groupBy
Description copied from interface:Traversable
Groups this elements by classifying the elements. -
grouped
Description copied from interface:Traversable
Groups thisTraversable
into fixed size blocks.Let length be the length of this Iterable. Then grouped is defined as follows:
- If
this.isEmpty()
, the resultingIterator
is empty. - If
size <= length
, the resultingIterator
will containlength / size
blocks of sizesize
and maybe a non-empty block of sizelength % size
, if there are remaining elements. - If
size > length
, the resultingIterator
will contain one block of sizelength
.
[].grouped(1) = [] [].grouped(0) throws [].grouped(-1) throws [1,2,3,4].grouped(2) = [[1,2],[3,4]] [1,2,3,4,5].grouped(2) = [[1,2],[3,4],[5]] [1,2,3,4].grouped(5) = [[1,2,3,4]]
grouped(int)
is a special case of Traversable.sliding(int, int), i.e.grouped(size)
is the same assliding(size, size)
. - If
-
init
Description copied from interface:Traversable
Dual of Traversable.tail(), returning all elements except the last. -
initOption
Description copied from interface:Traversable
Dual of Traversable.tailOption(), returning all elements except the last asOption
.- Specified by:
initOption
in interfaceSet<T>
- Specified by:
initOption
in interfaceTraversable<T>
- Returns:
Some(traversable)
orNone
if this is empty.
-
intersect
Description copied from interface:Set
Computes the intersection between this set and another set.See also
Set.retainAll(Iterable)
. -
isOrdered
default boolean isOrdered()Description copied from interface:Traversable
Checks if this Traversable is ordered- Specified by:
isOrdered
in interfaceTraversable<T>
- Returns:
- true, if this Traversable is ordered, false otherwise.
-
map
Description copied from interface:Traversable
Maps the elements of thisTraversable
to elements of a new type preserving their order, if any. -
orElse
Description copied from interface:Traversable
Returns thisTraversable
if it is nonempty, otherwise return the alternative. -
orElse
Description copied from interface:Traversable
Returns thisTraversable
if it is nonempty, otherwise return the result of evaluating supplier. -
partition
Description copied from interface:Traversable
Creates a partition of thisTraversable
by splitting this elements in two in distinct traversables according to a predicate.- Specified by:
partition
in interfaceSet<T>
- Specified by:
partition
in interfaceTraversable<T>
- Parameters:
predicate
- A predicate which classifies an element if it is in the first or the second traversable.- Returns:
- A disjoint union of two traversables. The first
Traversable
contains all elements that satisfy the givenpredicate
, the secondTraversable
contains all elements that don't. The original order of elements is preserved.
-
peek
Description copied from interface:Value
Performs the givenaction
on the first element if this is an eager implementation. Performs the givenaction
on all elements (the first immediately, successive deferred), if this is a lazy implementation. -
remove
Description copied from interface:Set
Removes a specific element from this set, if present. -
removeAll
Description copied from interface:Set
Removes all of the given elements from this set, if present. -
replace
Description copied from interface:Traversable
Replaces the first occurrence (if exists) of the given currentElement with newElement.- Specified by:
replace
in interfaceSet<T>
- Specified by:
replace
in interfaceTraversable<T>
- Parameters:
currentElement
- An element to be substituted.newElement
- A replacement for currentElement.- Returns:
- a Traversable containing all elements of this where the first occurrence of currentElement is replaced with newElement.
-
replaceAll
Description copied from interface:Traversable
Replaces all occurrences of the given currentElement with newElement.- Specified by:
replaceAll
in interfaceSet<T>
- Specified by:
replaceAll
in interfaceTraversable<T>
- Parameters:
currentElement
- An element to be substituted.newElement
- A replacement for currentElement.- Returns:
- a Traversable containing all elements of this where all occurrences of currentElement are replaced with newElement.
-
retainAll
Description copied from interface:Traversable
Keeps all occurrences of the given elements from this. -
scan
Description copied from interface:Traversable
Computes a prefix scan of the elements of the collection. Note: The neutral element z may be applied more than once.- Specified by:
scan
in interfaceSet<T>
- Specified by:
scan
in interfaceTraversable<T>
- Parameters:
zero
- neutral element for the operator opoperation
- the associative operator for the scan- Returns:
- a new traversable collection containing the prefix scan of the elements in this traversable collection
-
scanLeft
Description copied from interface:Traversable
Produces a collection containing cumulative results of applying the operator going left to right. Note: will not terminate for infinite-sized collections. Note: might return different results for different runs, unless the underlying collection type is ordered.- Specified by:
scanLeft
in interfaceSet<T>
- Specified by:
scanLeft
in interfaceTraversable<T>
- Type Parameters:
U
- the type of the elements in the resulting collection- Parameters:
zero
- the initial valueoperation
- the binary operator applied to the intermediate result and the element- Returns:
- collection with intermediate results
-
scanRight
Description copied from interface:Traversable
Produces a collection containing cumulative results of applying the operator going right to left. The head of the collection is the last cumulative result. Note: will not terminate for infinite-sized collections. Note: might return different results for different runs, unless the underlying collection type is ordered.- Specified by:
scanRight
in interfaceSet<T>
- Specified by:
scanRight
in interfaceTraversable<T>
- Type Parameters:
U
- the type of the elements in the resulting collection- Parameters:
zero
- the initial valueoperation
- the binary operator applied to the intermediate result and the element- Returns:
- collection with intermediate results
-
slideBy
Description copied from interface:Traversable
Slides a non-overlapping window of a variable size over thisTraversable
.Each window contains elements with the same class, as determined by
classifier
. Two consecutive values in thisTraversable
will be in the same window only ifclassifier
returns equal values for them. Otherwise, the values will constitute the last element of the previous window and the first element of the next window.Examples:
[].slideBy(Function.identity()) = [] [1,2,3,4,4,5].slideBy(Function.identity()) = [[1],[2],[3],[4,4],[5]] [1,2,3,10,12,5,7,20,29].slideBy(x -> x/10) = [[1,2,3],[10,12],[5,7],[20,29]]
-
sliding
Description copied from interface:Traversable
Slides a window of a specificsize
and step size 1 over thisTraversable
by callingTraversable.sliding(int, int)
. -
sliding
Description copied from interface:Traversable
Slides a window of a specificsize
andstep
size over thisTraversable
.Examples:
[].sliding(1,1) = [] [1,2,3,4,5].sliding(2,3) = [[1,2],[4,5]] [1,2,3,4,5].sliding(2,4) = [[1,2],[5]] [1,2,3,4,5].sliding(2,5) = [[1,2]] [1,2,3,4].sliding(5,3) = [[1,2,3,4],[4]]
-
span
Description copied from interface:Traversable
Returns a tuple where the first element is the longest prefix of elements that satisfy the givenpredicate
and the second element is the remainder. -
tail
Description copied from interface:Traversable
Drops the first element of a non-empty Traversable. -
tailOption
Description copied from interface:Traversable
Drops the first element of a non-empty Traversable and returns anOption
.- Specified by:
tailOption
in interfaceSet<T>
- Specified by:
tailOption
in interfaceTraversable<T>
- Returns:
Some(traversable)
orNone
if this is empty.
-
take
Description copied from interface:Traversable
Takes the first n elements of this or all elements, if this length < n.The result is equivalent to
sublist(0, max(0, min(length(), n)))
but does not throw ifn < 0
orn > length()
.In the case of
n < 0
the empty instance is returned, in the case ofn > length()
this is returned. -
takeRight
Description copied from interface:Traversable
Takes the last n elements of this or all elements, if this length < n.The result is equivalent to
sublist(max(0, min(length(), length() - n)), n)
, i.e. takeRight will not throw ifn < 0
orn > length()
.In the case of
n < 0
the empty instance is returned, in the case ofn > length()
this is returned. -
takeUntil
Description copied from interface:Traversable
Takes elements until the predicate holds for the current element.Note: This is essentially the same as
takeWhile(predicate.negate())
. It is intended to be used with method references, which cannot be negated directly. -
takeWhile
Description copied from interface:Traversable
Takes elements while the predicate holds for the current element. -
toJavaSet
Description copied from interface:Set
Converts this VavrSet
to ajava.util.Set
while preserving characteristics like insertion order (LinkedHashSet
) and sort order (SortedSet
). -
union
Description copied from interface:Set
Adds all of the elements ofthat
set to this set, if not already present.See also
Set.addAll(Iterable)
. -
unzip
<T1,T2> Tuple2<? extends SortedSet<T1>,? extends SortedSet<T2>> unzip(Function<? super T, Tuple2<? extends T1, ? extends T2>> unzipper) Description copied from interface:Traversable
Unzips this elements by mapping this elements to pairs which are subsequently split into two distinct sets.- Specified by:
unzip
in interfaceSet<T>
- Specified by:
unzip
in interfaceTraversable<T>
- Type Parameters:
T1
- 1st element type of a pair returned by unzipperT2
- 2nd element type of a pair returned by unzipper- Parameters:
unzipper
- a function which converts elements of this to pairs- Returns:
- A pair of set containing elements split by unzipper
-
unzip3
<T1,T2, Tuple3<? extends SortedSet<T1>,T3> ? extends SortedSet<T2>, unzip3? extends SortedSet<T3>> (Function<? super T, Tuple3<? extends T1, ? extends T2, ? extends T3>> unzipper) Description copied from interface:Traversable
Unzips this elements by mapping this elements to triples which are subsequently split into three distinct sets.- Specified by:
unzip3
in interfaceSet<T>
- Specified by:
unzip3
in interfaceTraversable<T>
- Type Parameters:
T1
- 1st element type of a triplet returned by unzipperT2
- 2nd element type of a triplet returned by unzipperT3
- 3rd element type of a triplet returned by unzipper- Parameters:
unzipper
- a function which converts elements of this to pairs- Returns:
- A triplet of set containing elements split by unzipper
-
zip
Description copied from interface:Traversable
Returns a traversable formed from this traversable and another Iterable collection by combining corresponding elements in pairs. If one of the two iterables is longer than the other, its remaining elements are ignored.The length of the returned traversable is the minimum of the lengths of this traversable and
that
iterable.- Specified by:
zip
in interfaceSet<T>
- Specified by:
zip
in interfaceTraversable<T>
- Type Parameters:
U
- The type of the second half of the returned pairs.- Parameters:
that
- The Iterable providing the second half of each result pair.- Returns:
- a new traversable containing pairs consisting of corresponding elements of this traversable and
that
iterable.
-
zipWith
<U,R> SortedSet<R> zipWith(Iterable<? extends U> that, BiFunction<? super T, ? super U, ? extends R> mapper) Description copied from interface:Traversable
Returns a traversable formed from this traversable and another Iterable collection by mapping elements. If one of the two iterables is longer than the other, its remaining elements are ignored.The length of the returned traversable is the minimum of the lengths of this traversable and
that
iterable.- Specified by:
zipWith
in interfaceSet<T>
- Specified by:
zipWith
in interfaceTraversable<T>
- Type Parameters:
U
- The type of the second parameter of the mapper.R
- The type of the mapped elements.- Parameters:
that
- The Iterable providing the second parameter of the mapper.mapper
- a mapper.- Returns:
- a new traversable containing mapped elements of this traversable and
that
iterable.
-
zipAll
Description copied from interface:Traversable
Returns a traversable formed from this traversable and another Iterable by combining corresponding elements in pairs. If one of the two collections is shorter than the other, placeholder elements are used to extend the shorter collection to the length of the longer.The length of the returned traversable is the maximum of the lengths of this traversable and
that
iterable.Special case: if this traversable is shorter than that elements, and that elements contains duplicates, the resulting traversable may be shorter than the maximum of the lengths of this and that because a traversable contains an element at most once.
If this Traversable is shorter than that, thisElem values are used to fill the result. If that is shorter than this Traversable, thatElem values are used to fill the result.
- Specified by:
zipAll
in interfaceSet<T>
- Specified by:
zipAll
in interfaceTraversable<T>
- Type Parameters:
U
- The type of the second half of the returned pairs.- Parameters:
that
- The Iterable providing the second half of each result pair.thisElem
- The element to be used to fill up the result if this traversable is shorter than that.thatElem
- The element to be used to fill up the result if that is shorter than this traversable.- Returns:
- A new traversable containing pairs consisting of corresponding elements of this traversable and that.
-
zipWithIndex
Description copied from interface:Traversable
Zips this traversable with its indices.- Specified by:
zipWithIndex
in interfaceSet<T>
- Specified by:
zipWithIndex
in interfaceTraversable<T>
- Returns:
- A new traversable containing all elements of this traversable paired with their index, starting with 0.
-
zipWithIndex
Description copied from interface:Traversable
Returns a traversable formed from this traversable and another Iterable collection by mapping elements. If one of the two iterables is longer than the other, its remaining elements are ignored.The length of the returned traversable is the minimum of the lengths of this traversable and
that
iterable.- Specified by:
zipWithIndex
in interfaceSet<T>
- Specified by:
zipWithIndex
in interfaceTraversable<T>
- Type Parameters:
U
- The type of the mapped elements.- Parameters:
mapper
- a mapper.- Returns:
- a new traversable containing mapped elements of this traversable and
that
iterable.
-