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 givenpartialFunctionby 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 thisTraversableinto 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 booleanChecks 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 thisTraversableto 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 thisTraversableif it is nonempty, otherwise return the alternative.Returns thisTraversableif it is nonempty, otherwise return the result of evaluating supplier.Creates a partition of thisTraversableby splitting this elements in two in distinct traversables according to a predicate.Performs the givenactionon 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 specificsizeand step size 1 over thisTraversableby callingTraversable.sliding(int, int).sliding(int size, int step) Slides a window of a specificsizeandstepsize over thisTraversable.Returns a tuple where the first element is the longest prefix of elements that satisfy the givenpredicateand 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 VavrSetto ajava.util.Setwhile preserving characteristics like insertion order (LinkedHashSet) and sort order (SortedSet).Adds all of the elements ofthatset 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) Zips this traversable with its indices by applying mapper provided.Methods inherited from interface Foldable
fold, reduce, reduceOptionMethods inherited from interface Function1
andThen, arity, compose, curried, isMemoized, memoized, partial, reversed, tupledMethods inherited from interface Ordered
comparatorMethods inherited from interface 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, sumMethods inherited from interface 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
Comparatormight fail!- Type Parameters:
T- Component type of theSortedSet.- Parameters:
sortedSet- ASortedSet.- Returns:
- the given
sortedSetinstance 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
-
addAll
Description copied from interface:SetAdds all of the given elements to this set, if not already contained. -
collect
Description copied from interface:TraversableCollects all elements that are in the domain of the givenpartialFunctionby 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)Traversableis ordered (i.e. extendsOrdered, the caller ofcollecthas to ensure that the elements are comparable (i.e. extendComparable).- Specified by:
collectin interfaceSet<T>- Specified by:
collectin 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
Traversableinstance containing elements of typeR
-
diff
Description copied from interface:SetCalculates the difference between this set and another set.See also
Set.removeAll(Iterable). -
distinct
Description copied from interface:TraversableReturns a new version of this which contains no duplicates. Elements are compared usingequals. -
distinctBy
Description copied from interface:TraversableReturns a new version of this which contains no duplicates. Elements are compared using the givencomparator.- Specified by:
distinctByin interfaceSet<T>- Specified by:
distinctByin interfaceTraversable<T>- Parameters:
comparator- A comparator- Returns:
- a new
Traversablecontaining this elements without duplicates
-
distinctBy
Description copied from interface:TraversableReturns 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:
distinctByin interfaceSet<T>- Specified by:
distinctByin interfaceTraversable<T>- Type Parameters:
U- key type- Parameters:
keyExtractor- A key extractor- Returns:
- a new
Traversablecontaining this elements without duplicates
-
drop
Description copied from interface:TraversableDrops the first n elements of this or all elements, if this length < n. -
dropRight
Description copied from interface:TraversableDrops the last n elements of this or all elements, if this length < n. -
dropUntil
Description copied from interface:TraversableDrops elements until the predicate holds for the current element. -
dropWhile
Description copied from interface:TraversableDrops 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:TraversableReturns a new traversable consisting of all elements which satisfy the given predicate. -
reject
Description copied from interface:TraversableReturns 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:TraversableFlatMaps this Traversable. -
groupBy
Description copied from interface:TraversableGroups this elements by classifying the elements. -
grouped
Description copied from interface:TraversableGroups thisTraversableinto fixed size blocks.Let length be the length of this Iterable. Then grouped is defined as follows:
- If
this.isEmpty(), the resultingIteratoris empty. - If
size <= length, the resultingIteratorwill containlength / sizeblocks of sizesizeand maybe a non-empty block of sizelength % size, if there are remaining elements. - If
size > length, the resultingIteratorwill contain one block of sizelength.
Please note that[].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:TraversableDual of Traversable.tail(), returning all elements except the last. -
initOption
Description copied from interface:TraversableDual of Traversable.tailOption(), returning all elements except the last asOption.- Specified by:
initOptionin interfaceSet<T>- Specified by:
initOptionin interfaceTraversable<T>- Returns:
Some(traversable)orNoneif this is empty.
-
intersect
Description copied from interface:SetComputes the intersection between this set and another set.See also
Set.retainAll(Iterable). -
isOrdered
default boolean isOrdered()Description copied from interface:TraversableChecks if this Traversable is ordered- Specified by:
isOrderedin interfaceTraversable<T>- Returns:
- true, if this Traversable is ordered, false otherwise.
-
map
Description copied from interface:TraversableMaps the elements of thisTraversableto elements of a new type preserving their order, if any. -
orElse
Description copied from interface:TraversableReturns thisTraversableif it is nonempty, otherwise return the alternative. -
orElse
Description copied from interface:TraversableReturns thisTraversableif it is nonempty, otherwise return the result of evaluating supplier. -
partition
Description copied from interface:TraversableCreates a partition of thisTraversableby splitting this elements in two in distinct traversables according to a predicate.- Specified by:
partitionin interfaceSet<T>- Specified by:
partitionin 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
Traversablecontains all elements that satisfy the givenpredicate, the secondTraversablecontains all elements that don't. The original order of elements is preserved.
-
peek
Description copied from interface:ValuePerforms the givenactionon the first element if this is an eager implementation. Performs the givenactionon all elements (the first immediately, successive deferred), if this is a lazy implementation. -
remove
Description copied from interface:SetRemoves a specific element from this set, if present. -
removeAll
Description copied from interface:SetRemoves all of the given elements from this set, if present. -
replace
Description copied from interface:TraversableReplaces the first occurrence (if exists) of the given currentElement with newElement.- Specified by:
replacein interfaceSet<T>- Specified by:
replacein 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:TraversableReplaces all occurrences of the given currentElement with newElement.- Specified by:
replaceAllin interfaceSet<T>- Specified by:
replaceAllin 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:TraversableKeeps all occurrences of the given elements from this. -
scan
Description copied from interface:TraversableComputes a prefix scan of the elements of the collection. Note: The neutral element z may be applied more than once.- Specified by:
scanin interfaceSet<T>- Specified by:
scanin 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:TraversableProduces 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:
scanLeftin interfaceSet<T>- Specified by:
scanLeftin 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:TraversableProduces 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:
scanRightin interfaceSet<T>- Specified by:
scanRightin 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:TraversableSlides 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 thisTraversablewill be in the same window only ifclassifierreturns 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:TraversableSlides a window of a specificsizeand step size 1 over thisTraversableby callingTraversable.sliding(int, int). -
sliding
Description copied from interface:TraversableSlides a window of a specificsizeandstepsize 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:TraversableReturns a tuple where the first element is the longest prefix of elements that satisfy the givenpredicateand the second element is the remainder. -
tail
Description copied from interface:TraversableDrops the first element of a non-empty Traversable. -
tailOption
Description copied from interface:TraversableDrops the first element of a non-empty Traversable and returns anOption.- Specified by:
tailOptionin interfaceSet<T>- Specified by:
tailOptionin interfaceTraversable<T>- Returns:
Some(traversable)orNoneif this is empty.
-
take
Description copied from interface:TraversableTakes 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 < 0orn > length().In the case of
n < 0the empty instance is returned, in the case ofn > length()this is returned. -
takeRight
Description copied from interface:TraversableTakes 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 < 0orn > length().In the case of
n < 0the empty instance is returned, in the case ofn > length()this is returned. -
takeUntil
Description copied from interface:TraversableTakes 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:TraversableTakes elements while the predicate holds for the current element. -
toJavaSet
Description copied from interface:SetConverts this VavrSetto ajava.util.Setwhile preserving characteristics like insertion order (LinkedHashSet) and sort order (SortedSet). -
union
Description copied from interface:SetAdds all of the elements ofthatset 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:TraversableUnzips this elements by mapping this elements to pairs which are subsequently split into two distinct sets.- Specified by:
unzipin interfaceSet<T>- Specified by:
unzipin 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>, ? extends SortedSet<T2>, ? extends SortedSet<T3>> unzip3T3> (Function<? super T, Tuple3<? extends T1, ? extends T2, ? extends T3>> unzipper) Description copied from interface:TraversableUnzips this elements by mapping this elements to triples which are subsequently split into three distinct sets.- Specified by:
unzip3in interfaceSet<T>- Specified by:
unzip3in 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:TraversableReturns 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
thatiterable.- Specified by:
zipin interfaceSet<T>- Specified by:
zipin 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
thatiterable.
-
zipWith
<U,R> SortedSet<R> zipWith(Iterable<? extends U> that, BiFunction<? super T, ? super U, ? extends R> mapper) Description copied from interface:TraversableReturns 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
thatiterable.- Specified by:
zipWithin interfaceSet<T>- Specified by:
zipWithin 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
thatiterable.
-
zipAll
Description copied from interface:TraversableReturns 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
thatiterable.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:
zipAllin interfaceSet<T>- Specified by:
zipAllin 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:TraversableZips this traversable with its indices.- Specified by:
zipWithIndexin interfaceSet<T>- Specified by:
zipWithIndexin interfaceTraversable<T>- Returns:
- A new traversable containing all elements of this traversable paired with their index, starting with 0.
-
zipWithIndex
Description copied from interface:TraversableZips this traversable with its indices by applying mapper provided.- Specified by:
zipWithIndexin interfaceSet<T>- Specified by:
zipWithIndexin interfaceTraversable<T>- Type Parameters:
U- The type of the mapped elements.- Parameters:
mapper- a mapper.- Returns:
- a new traversable containing elements of this traversable, zipped with indices, and mapped with mapper provided.
-