Interface Set<T>
-
- Type Parameters:
T
- Component type
- All Superinterfaces:
Foldable<T>
,java.util.function.Function<T,java.lang.Boolean>
,Function1<T,java.lang.Boolean>
,java.lang.Iterable<T>
,java.io.Serializable
,Traversable<T>
,Value<T>
- All Known Implementing Classes:
BitSetModule.AbstractBitSet
,BitSetModule.BitSet1
,BitSetModule.BitSet2
,BitSetModule.BitSetN
,HashSet
,LinkedHashSet
,TreeSet
public interface Set<T> extends Traversable<T>, Function1<T,java.lang.Boolean>, java.io.Serializable
An immutableSet
interface.CAUTION: The Vavr
Set
implementations generally supportnull
elements. HoweverSortedSet
implementations require an elementComparator
, which may not supportnull
elements.Examples:
Set<?> addNull(Set<?> set) { // CAUTION: Do not expect a Set to accept null values in general! return set.add(null); } void test() { // ok addNull(HashSet.of(1)); // ok addNull(TreeSet.of(nullsFirst(naturalOrder()), 1)); // ok addNull(TreeSet.empty()); // throws NPE! addNull(TreeSet.of(1)); }
Basic operations:
Conversion:
-
-
Field Summary
Fields Modifier and Type Field Description static long
serialVersionUID
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Default Methods Deprecated Methods Modifier and Type Method Description Set<T>
add(T element)
Add the given element to this set, if it is not already contained.Set<T>
addAll(java.lang.Iterable<? extends T> elements)
Adds all of the given elements to this set, if not already contained.default java.lang.Boolean
apply(T element)
Deprecated.Will be removed<R> Set<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
.boolean
contains(T element)
Shortcut forexists(e -> Objects.equals(e, element))
, tests if the givenelement
is contained.Set<T>
diff(Set<? extends T> that)
Calculates the difference between this set and another set.Set<T>
distinct()
Returns a new version of this which contains no duplicates.Set<T>
distinctBy(java.util.Comparator<? super T> comparator)
Returns a new version of this which contains no duplicates.<U> Set<T>
distinctBy(java.util.function.Function<? super T,? extends U> keyExtractor)
Returns a new version of this which contains no duplicates.Set<T>
drop(int n)
Drops the first n elements of this or all elements, if this length < n.Set<T>
dropRight(int n)
Drops the last n elements of this or all elements, if this length < n.Set<T>
dropUntil(java.util.function.Predicate<? super T> predicate)
Drops elements until the predicate holds for the current element.Set<T>
dropWhile(java.util.function.Predicate<? super T> predicate)
Drops elements while the predicate holds for the current element.Set<T>
filter(java.util.function.Predicate<? super T> predicate)
Returns a new traversable consisting of all elements which satisfy the given predicate.<U> Set<U>
flatMap(java.util.function.Function<? super T,? extends java.lang.Iterable<? extends U>> mapper)
FlatMaps this Traversable.<C> Map<C,? extends Set<T>>
groupBy(java.util.function.Function<? super T,? extends C> classifier)
Groups this elements by classifying the elements.Iterator<? extends Set<T>>
grouped(int size)
Groups thisTraversable
into fixed size blocks.Set<T>
init()
Dual of Traversable.tail(), returning all elements except the last.Option<? extends Set<T>>
initOption()
Dual of Traversable.tailOption(), returning all elements except the last asOption
.Set<T>
intersect(Set<? extends T> that)
Computes the intersection between this set and another set.default boolean
isDistinct()
Checks if this Traversable may consist of distinct elements only.Iterator<T>
iterator()
An iterator by means of head() and tail().int
length()
Computes the number of elements of this Traversable.<U> Set<U>
map(java.util.function.Function<? super T,? extends U> mapper)
Maps the elements of thisTraversable
to elements of a new type preserving their order, if any.static <T> Set<T>
narrow(Set<? extends T> set)
Narrows a widenedSet<? extends T>
toSet<T>
by performing a type-safe cast.Set<T>
orElse(java.lang.Iterable<? extends T> other)
Returns thisTraversable
if it is nonempty, otherwise return the alternative.Set<T>
orElse(java.util.function.Supplier<? extends java.lang.Iterable<? extends T>> supplier)
Returns thisTraversable
if it is nonempty, otherwise return the result of evaluating supplier.Tuple2<? extends Set<T>,? extends Set<T>>
partition(java.util.function.Predicate<? super T> predicate)
Creates a partition of thisTraversable
by splitting this elements in two in distinct traversables according to a predicate.Set<T>
peek(java.util.function.Consumer<? super T> action)
Performs the givenaction
on the first element if this is an eager implementation.Set<T>
reject(java.util.function.Predicate<? super T> predicate)
Returns a new traversable consisting of all elements which do not satisfy the given predicate.Set<T>
remove(T element)
Removes a specific element from this set, if present.Set<T>
removeAll(java.lang.Iterable<? extends T> elements)
Removes all of the given elements from this set, if present.Set<T>
replace(T currentElement, T newElement)
Replaces the first occurrence (if exists) of the given currentElement with newElement.Set<T>
replaceAll(T currentElement, T newElement)
Replaces all occurrences of the given currentElement with newElement.Set<T>
retainAll(java.lang.Iterable<? extends T> elements)
Keeps all occurrences of the given elements from this.Set<T>
scan(T zero, java.util.function.BiFunction<? super T,? super T,? extends T> operation)
Computes a prefix scan of the elements of the collection.<U> Set<U>
scanLeft(U zero, java.util.function.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, java.util.function.BiFunction<? super T,? super U,? extends U> operation)
Produces a collection containing cumulative results of applying the operator going right to left.Iterator<? extends Set<T>>
slideBy(java.util.function.Function<? super T,?> classifier)
Slides a non-overlapping window of a variable size over thisTraversable
.Iterator<? extends Set<T>>
sliding(int size)
Slides a window of a specificsize
and step size 1 over thisTraversable
by callingTraversable.sliding(int, int)
.Iterator<? extends Set<T>>
sliding(int size, int step)
Slides a window of a specificsize
andstep
size over thisTraversable
.Tuple2<? extends Set<T>,? extends Set<T>>
span(java.util.function.Predicate<? super T> predicate)
Returns a tuple where the first element is the longest prefix of elements that satisfy the givenpredicate
and the second element is the remainder.Set<T>
tail()
Drops the first element of a non-empty Traversable.Option<? extends Set<T>>
tailOption()
Drops the first element of a non-empty Traversable and returns anOption
.Set<T>
take(int n)
Takes the first n elements of this or all elements, if this length < n.Set<T>
takeRight(int n)
Takes the last n elements of this or all elements, if this length < n.Set<T>
takeUntil(java.util.function.Predicate<? super T> predicate)
Takes elements until the predicate holds for the current element.Set<T>
takeWhile(java.util.function.Predicate<? super T> predicate)
Takes elements while the predicate holds for the current element.java.util.Set<T>
toJavaSet()
Converts this VavrSet
to ajava.util.Set
while preserving characteristics like insertion order (LinkedHashSet
) and sort order (SortedSet
).Set<T>
union(Set<? extends T> that)
Adds all of the elements ofthat
set to this set, if not already present.<T1,T2>
Tuple2<? extends Set<T1>,? extends Set<T2>>unzip(java.util.function.Function<? super T,Tuple2<? extends T1,? extends T2>> unzipper)
Unzips this elements by mapping this elements to pairs which are subsequently split into two distinct sets.<T1,T2,T3>
Tuple3<? extends Set<T1>,? extends Set<T2>,? extends Set<T3>>unzip3(java.util.function.Function<? super T,Tuple3<? extends T1,? extends T2,? extends T3>> unzipper)
Unzips this elements by mapping this elements to triples which are subsequently split into three distinct sets.<U> Set<Tuple2<T,U>>
zip(java.lang.Iterable<? extends U> that)
Returns a traversable formed from this traversable and another Iterable collection by combining corresponding elements in pairs.<U> Set<Tuple2<T,U>>
zipAll(java.lang.Iterable<? extends U> that, T thisElem, U thatElem)
Returns a traversable formed from this traversable and another Iterable by combining corresponding elements in pairs.<U,R>
Set<R>zipWith(java.lang.Iterable<? extends U> that, java.util.function.BiFunction<? super T,? super U,? extends R> mapper)
Returns a traversable formed from this traversable and another Iterable collection by mapping elements.Set<Tuple2<T,java.lang.Integer>>
zipWithIndex()
Zips this traversable with its indices.<U> Set<U>
zipWithIndex(java.util.function.BiFunction<? super T,? super java.lang.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.Traversable
arrangeBy, average, containsAll, count, equals, existsUnique, find, findLast, foldLeft, foldRight, forEachWithIndex, get, hasDefiniteSize, hashCode, head, headOption, isEmpty, isOrdered, 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 Detail
-
serialVersionUID
static final long serialVersionUID
- See Also:
- Constant Field Values
-
-
Method Detail
-
narrow
static <T> Set<T> narrow(Set<? extends T> set)
Narrows a widenedSet<? extends T>
toSet<T>
by performing a type-safe cast. This is eligible because immutable/read-only collections are covariant.- Type Parameters:
T
- Component type of theSet
.- Parameters:
set
- ASet
.- Returns:
- the given
set
instance as narrowed typeSet<T>
.
-
add
Set<T> add(T element)
Add the given element to this set, if it is not already contained.- Parameters:
element
- The element to be added.- Returns:
- A new set containing all elements of this set and also
element
.
-
addAll
Set<T> addAll(java.lang.Iterable<? extends T> elements)
Adds all of the given elements to this set, if not already contained.- Parameters:
elements
- The elements to be added.- Returns:
- A new set containing all elements of this set and the given
elements
, if not already contained.
-
apply
@Deprecated default java.lang.Boolean apply(T element)
Deprecated.Will be removed
-
diff
Set<T> diff(Set<? extends T> that)
Calculates the difference between this set and another set.See also
removeAll(Iterable)
.- Parameters:
that
- Elements to be removed from this set.- Returns:
- A new Set containing all elements of this set which are not located in
that
set.
-
intersect
Set<T> intersect(Set<? extends T> that)
Computes the intersection between this set and another set.See also
retainAll(Iterable)
.- Parameters:
that
- the set to intersect with.- Returns:
- A new Set consisting of all elements that are both in this set and in the given set
that
.
-
remove
Set<T> remove(T element)
Removes a specific element from this set, if present.- Parameters:
element
- The element to be removed from this set.- Returns:
- A new set consisting of the elements of this set, without the given
element
.
-
removeAll
Set<T> removeAll(java.lang.Iterable<? extends T> elements)
Removes all of the given elements from this set, if present.- Parameters:
elements
- The elements to be removed from this set.- Returns:
- A new set consisting of the elements of this set, without the given
elements
.
-
toJavaSet
java.util.Set<T> toJavaSet()
Converts this VavrSet
to ajava.util.Set
while preserving characteristics like insertion order (LinkedHashSet
) and sort order (SortedSet
).
-
union
Set<T> union(Set<? extends T> that)
Adds all of the elements ofthat
set to this set, if not already present.See also
addAll(Iterable)
.- Parameters:
that
- The set to form the union with.- Returns:
- A new set that contains all distinct elements of this and
that
set.
-
collect
<R> Set<R> collect(PartialFunction<? super T,? extends R> partialFunction)
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 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
-
contains
boolean contains(T element)
Description copied from interface:Value
Shortcut forexists(e -> Objects.equals(e, element))
, tests if the givenelement
is contained.
-
distinct
Set<T> distinct()
Description copied from interface:Traversable
Returns a new version of this which contains no duplicates. Elements are compared usingequals
.- Specified by:
distinct
in interfaceTraversable<T>
- Returns:
- a new
Traversable
containing this elements without duplicates
-
distinctBy
Set<T> distinctBy(java.util.Comparator<? super T> comparator)
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 interfaceTraversable<T>
- Parameters:
comparator
- A comparator- Returns:
- a new
Traversable
containing this elements without duplicates
-
distinctBy
<U> Set<T> distinctBy(java.util.function.Function<? super T,? extends U> keyExtractor)
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 interfaceTraversable<T>
- Type Parameters:
U
- key type- Parameters:
keyExtractor
- A key extractor- Returns:
- a new
Traversable
containing this elements without duplicates
-
drop
Set<T> drop(int n)
Description copied from interface:Traversable
Drops the first n elements of this or all elements, if this length < n.- Specified by:
drop
in interfaceTraversable<T>
- Parameters:
n
- The number of elements to drop.- Returns:
- a new instance consisting of all elements of this except the first n ones, or else the empty instance, if this has less than n elements.
-
dropRight
Set<T> dropRight(int n)
Description copied from interface:Traversable
Drops the last n elements of this or all elements, if this length < n.- Specified by:
dropRight
in interfaceTraversable<T>
- Parameters:
n
- The number of elements to drop.- Returns:
- a new instance consisting of all elements of this except the last n ones, or else the empty instance, if this has less than n elements.
-
dropUntil
Set<T> dropUntil(java.util.function.Predicate<? super T> predicate)
Description copied from interface:Traversable
Drops elements until the predicate holds for the current element.- Specified by:
dropUntil
in interfaceTraversable<T>
- Parameters:
predicate
- A condition tested subsequently for this elements.- Returns:
- a new instance consisting of all elements starting from the first one which does satisfy the given predicate.
-
dropWhile
Set<T> dropWhile(java.util.function.Predicate<? super T> predicate)
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.- Specified by:
dropWhile
in interfaceTraversable<T>
- Parameters:
predicate
- A condition tested subsequently for this elements.- Returns:
- a new instance consisting of all elements starting from the first one which does not satisfy the given predicate.
-
filter
Set<T> filter(java.util.function.Predicate<? super T> predicate)
Description copied from interface:Traversable
Returns a new traversable consisting of all elements which satisfy the given predicate.- Specified by:
filter
in interfaceTraversable<T>
- Parameters:
predicate
- A predicate- Returns:
- a new traversable
-
reject
Set<T> reject(java.util.function.Predicate<? super T> predicate)
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()
- Specified by:
reject
in interfaceTraversable<T>
- Parameters:
predicate
- A predicate- Returns:
- a new traversable
-
flatMap
<U> Set<U> flatMap(java.util.function.Function<? super T,? extends java.lang.Iterable<? extends U>> mapper)
Description copied from interface:Traversable
FlatMaps this Traversable.- Specified by:
flatMap
in interfaceTraversable<T>
- Type Parameters:
U
- The resulting component type.- Parameters:
mapper
- A mapper- Returns:
- A new Traversable instance.
-
groupBy
<C> Map<C,? extends Set<T>> groupBy(java.util.function.Function<? super T,? extends C> classifier)
Description copied from interface:Traversable
Groups this elements by classifying the elements.- Specified by:
groupBy
in interfaceTraversable<T>
- Type Parameters:
C
- classified class type- Parameters:
classifier
- A function which classifies elements into classes- Returns:
- A Map containing the grouped elements
- See Also:
Traversable.arrangeBy(Function)
-
grouped
Iterator<? extends Set<T>> grouped(int size)
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)
.- Specified by:
grouped
in interfaceTraversable<T>
- Parameters:
size
- a positive block size- Returns:
- A new Iterator of grouped blocks of the given size
- If
-
init
Set<T> init()
Description copied from interface:Traversable
Dual of Traversable.tail(), returning all elements except the last.- Specified by:
init
in interfaceTraversable<T>
- Returns:
- a new instance containing all elements except the last.
-
initOption
Option<? extends Set<T>> initOption()
Description copied from interface:Traversable
Dual of Traversable.tailOption(), returning all elements except the last asOption
.- Specified by:
initOption
in interfaceTraversable<T>
- Returns:
Some(traversable)
orNone
if this is empty.
-
isDistinct
default boolean isDistinct()
Description copied from interface:Traversable
Checks if this Traversable may consist of distinct elements only.- Specified by:
isDistinct
in interfaceTraversable<T>
- Returns:
- true if this Traversable may consist of distinct elements only, false otherwise.
-
iterator
Iterator<T> iterator()
Description copied from interface:Traversable
An iterator by means of head() and tail(). Subclasses may want to override this method.
-
length
int length()
Description copied from interface:Traversable
Computes the number of elements of this Traversable.Same as
Traversable.size()
.- Specified by:
length
in interfaceTraversable<T>
- Returns:
- the number of elements
-
map
<U> Set<U> map(java.util.function.Function<? super T,? extends U> mapper)
Description copied from interface:Traversable
Maps the elements of thisTraversable
to elements of a new type preserving their order, if any.
-
orElse
Set<T> orElse(java.lang.Iterable<? extends T> other)
Description copied from interface:Traversable
Returns thisTraversable
if it is nonempty, otherwise return the alternative.- Specified by:
orElse
in interfaceTraversable<T>
- Parameters:
other
- An alternativeTraversable
- Returns:
- this
Traversable
if it is nonempty, otherwise return the alternative.
-
orElse
Set<T> orElse(java.util.function.Supplier<? extends java.lang.Iterable<? extends T>> supplier)
Description copied from interface:Traversable
Returns thisTraversable
if it is nonempty, otherwise return the result of evaluating supplier.- Specified by:
orElse
in interfaceTraversable<T>
- Parameters:
supplier
- An alternativeTraversable
supplier- Returns:
- this
Traversable
if it is nonempty, otherwise return the result of evaluating supplier.
-
partition
Tuple2<? extends Set<T>,? extends Set<T>> partition(java.util.function.Predicate<? super T> predicate)
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 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
Set<T> peek(java.util.function.Consumer<? super T> action)
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.
-
replace
Set<T> replace(T currentElement, T newElement)
Description copied from interface:Traversable
Replaces the first occurrence (if exists) of the given currentElement with newElement.- 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
Set<T> replaceAll(T currentElement, T newElement)
Description copied from interface:Traversable
Replaces all occurrences of the given currentElement with newElement.- 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
Set<T> retainAll(java.lang.Iterable<? extends T> elements)
Description copied from interface:Traversable
Keeps all occurrences of the given elements from this.- Specified by:
retainAll
in interfaceTraversable<T>
- Parameters:
elements
- Elements to be kept.- Returns:
- a Traversable containing all occurrences of the given elements.
-
scan
Set<T> scan(T zero, java.util.function.BiFunction<? super T,? super T,? extends T> operation)
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 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
<U> Set<U> scanLeft(U zero, java.util.function.BiFunction<? super U,? super T,? extends U> operation)
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 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
<U> Set<U> scanRight(U zero, java.util.function.BiFunction<? super T,? super U,? extends U> operation)
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 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
Iterator<? extends Set<T>> slideBy(java.util.function.Function<? super T,?> classifier)
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]]
- Specified by:
slideBy
in interfaceTraversable<T>
- Parameters:
classifier
- A function which classifies elements into classes- Returns:
- A new Iterator of windows of the grouped elements
-
sliding
Iterator<? extends Set<T>> sliding(int size)
Description copied from interface:Traversable
Slides a window of a specificsize
and step size 1 over thisTraversable
by callingTraversable.sliding(int, int)
.- Specified by:
sliding
in interfaceTraversable<T>
- Parameters:
size
- a positive window size- Returns:
- a new Iterator of windows of a specific size using step size 1
-
sliding
Iterator<? extends Set<T>> sliding(int size, int step)
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]]
- Specified by:
sliding
in interfaceTraversable<T>
- Parameters:
size
- a positive window sizestep
- a positive step size- Returns:
- a new Iterator of windows of a specific size using a specific step size
-
span
Tuple2<? extends Set<T>,? extends Set<T>> span(java.util.function.Predicate<? super T> predicate)
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.- Specified by:
span
in interfaceTraversable<T>
- Parameters:
predicate
- A predicate.- Returns:
- a
Tuple
containing the longest prefix of elements that satisfy p and the remainder.
-
tail
Set<T> tail()
Description copied from interface:Traversable
Drops the first element of a non-empty Traversable.- Specified by:
tail
in interfaceTraversable<T>
- Returns:
- A new instance of Traversable containing all elements except the first.
-
tailOption
Option<? extends Set<T>> tailOption()
Description copied from interface:Traversable
Drops the first element of a non-empty Traversable and returns anOption
.- Specified by:
tailOption
in interfaceTraversable<T>
- Returns:
Some(traversable)
orNone
if this is empty.
-
take
Set<T> take(int n)
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.- Specified by:
take
in interfaceTraversable<T>
- Parameters:
n
- The number of elements to take.- Returns:
- A new instance consisting of the first n elements of this or all elements, if this has less than n elements.
-
takeRight
Set<T> takeRight(int n)
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.- Specified by:
takeRight
in interfaceTraversable<T>
- Parameters:
n
- The number of elements to take.- Returns:
- A new instance consisting of the last n elements of this or all elements, if this has less than n elements.
-
takeUntil
Set<T> takeUntil(java.util.function.Predicate<? super T> predicate)
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.- Specified by:
takeUntil
in interfaceTraversable<T>
- Parameters:
predicate
- A condition tested subsequently for this elements.- Returns:
- a new instance consisting of all elements before the first one which does satisfy the given predicate.
-
takeWhile
Set<T> takeWhile(java.util.function.Predicate<? super T> predicate)
Description copied from interface:Traversable
Takes elements while the predicate holds for the current element.- Specified by:
takeWhile
in interfaceTraversable<T>
- Parameters:
predicate
- A condition tested subsequently for the contained elements.- Returns:
- a new instance consisting of all elements before the first one which does not satisfy the given predicate.
-
unzip
<T1,T2> Tuple2<? extends Set<T1>,? extends Set<T2>> unzip(java.util.function.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 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,T3> Tuple3<? extends Set<T1>,? extends Set<T2>,? extends Set<T3>> unzip3(java.util.function.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 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
<U> Set<Tuple2<T,U>> zip(java.lang.Iterable<? extends U> that)
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 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> Set<R> zipWith(java.lang.Iterable<? extends U> that, java.util.function.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 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
<U> Set<Tuple2<T,U>> zipAll(java.lang.Iterable<? extends U> that, T thisElem, U thatElem)
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 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
Set<Tuple2<T,java.lang.Integer>> zipWithIndex()
Description copied from interface:Traversable
Zips this traversable with its indices.- Specified by:
zipWithIndex
in interfaceTraversable<T>
- Returns:
- A new traversable containing all elements of this traversable paired with their index, starting with 0.
-
zipWithIndex
<U> Set<U> zipWithIndex(java.util.function.BiFunction<? super T,? super java.lang.Integer,? extends U> 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:
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.
-
-