Set (vavr-champ 0.10.5 API)

Type Parameters:

T - Component type

All Superinterfaces:

Foldable<T>, java.lang.Iterable<T>, java.io.Serializable, Traversable<T>, Value<T>

All Known Subinterfaces:

SortedSet<T>

All Known Implementing Classes:

BitSet, HashSet, LinkedHashSet, TreeSet
```
public interface Set<T>
extends Traversable<T>, java.io.Serializable
```
An immutable Set interface.
CAUTION: The Vavr Set implementations generally support null elements. However SortedSet implementations require an element Comparator, which may not support null 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:
- toJavaSet()

Field Summary

Fields
Modifier and Type Field and Description

static long serialVersionUID

Fields
Modifier and Type	Field and Description
`static long`	`serialVersionUID`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and 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.
`<R> Set<R>`	`collect(PartialFunction<? super T,? extends R> partialFunction)` Collects all elements that are in the domain of the given `partialFunction` by mapping the elements to type `R`.
`boolean`	`contains(T element)` Shortcut for `exists(e -> Objects.equals(e, element))`, tests if the given `element` 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.
`Set<T>`	`filterNot(java.util.function.Predicate<? super T> predicate)` Returns a new traversable consisting of all elements which do not 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 this `Traversable` 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 as `Option`.
`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 this `Traversable` to elements of a new type preserving their order, if any.
`static <T> Set<T>`	`narrow(Set<? extends T> set)` Narrows a widened `Set<? extends T>` to `Set<T>` by performing a type-safe cast.
`Set<T>`	`orElse(java.lang.Iterable<? extends T> other)` Returns this `Traversable` if it is nonempty, otherwise return the alternative.
`Set<T>`	`orElse(java.util.function.Supplier<? extends java.lang.Iterable<? extends T>> supplier)` Returns this `Traversable` 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 this `Traversable` 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 given `action` on the first element if this is an eager implementation.
`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 this `Traversable`.
`Iterator<? extends Set<T>>`	`sliding(int size)` Slides a window of a specific `size` and step size 1 over this `Traversable` by calling `Traversable.sliding(int, int)`.
`Iterator<? extends Set<T>>`	`sliding(int size, int step)` Slides a window of a specific `size` and `step` size over this `Traversable`.
`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 given `predicate` 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 an `Option`.
`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 Vavr `Set` to a `java.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 of `that` set to this set, if not already present.
`<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)` Zips this traversable with its indices by applying mapper provided.

Methods inherited from interface io.vavr.collection.Traversable
arrangeBy, average, containsAll, count, equals, existsUnique, find, findLast, fold, 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, narrow, nonEmpty, product, reduce, reduceLeft, reduceLeftOption, reduceOption, reduceRight, reduceRightOption, single, singleOption, size, spliterator, sum, toLinkedMap, toMap, toSortedMap, toSortedMap, unzip, unzip3

Methods inherited from interface io.vavr.Value
collect, collect, corresponds, eq, exists, forAll, forEach, getOrElse, getOrElse, getOrElseThrow, getOrElseTry, getOrNull, isAsync, isLazy, narrow, 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 widened Set<? extends T> to Set<T> by performing a type-safe cast. This is eligible because immutable/read-only collections are covariant.
 
 Type Parameters:
 
 T - Component type of the Set.
 
 Parameters:
 
 set - A Set.
 
 Returns:
 
 the given set instance as narrowed type Set<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.
 - 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 Vavr Set to a java.util.Set while preserving characteristics like insertion order (LinkedHashSet) and sort order (SortedSet).
 
 Specified by:
 
 toJavaSet in interface Value<T>
 
 Returns:
 
 a new java.util.Set instance
 - union
```
Set<T> union(Set<? extends T> that)
```
 Adds all of the elements of that 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 given partialFunction by mapping the elements to type R.
 More specifically, for each of this elements in iteration order first it is checked
```
 partialFunction.isDefinedAt(element)
 
```
 If the elements makes it through that filter, the mapped instance is added to the result collection
```
 R newElement = partialFunction.apply(element)
 
```
 Note:If this Traversable is ordered (i.e. extends Ordered, the caller of collect has to ensure that the elements are comparable (i.e. extend Comparable).
 Specified by:
 
 collect in interface Traversable<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 type R
 - contains
```
boolean contains(T element)
```
 Description copied from interface: Value
 
 Shortcut for exists(e -> Objects.equals(e, element)), tests if the given element is contained.
 
 Specified by:
 
 contains in interface Value<T>
 
 Parameters:
 
 element - An Object of type A, may be null.
 
 Returns:
 
 true, if element is contained, false otherwise.
 - distinct
```
Set<T> distinct()
```
 Description copied from interface: Traversable
 
 Returns a new version of this which contains no duplicates. Elements are compared using equals.
 
 Specified by:
 
 distinct in interface Traversable<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 given comparator.
 
 Specified by:
 
 distinctBy in interface Traversable<T>
 
 Parameters:
 
 comparator - A comparator
 
 Returns:
 
 a new Traversable containing this elements without duplicates
 - distinctBy
```
 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 using equals.
 The elements of the result are determined in the order of their occurrence - first match wins.
 
 Specified by:
 
 distinctBy in interface Traversable<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 interface Traversable<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 interface Traversable<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 interface Traversable<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 interface Traversable<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 interface Traversable<T>
 
 Parameters:
 
 predicate - A predicate
 
 Returns:
 
 a new traversable
 - filterNot
```
Set<T> filterNot(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:
 
 filterNot in interface Traversable<T>
 
 Parameters:
 
 predicate - A predicate
 
 Returns:
 
 a new traversable
 - flatMap
```
 Set 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 interface Traversable<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 interface Traversable<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 this Traversable into fixed size blocks.
 Let length be the length of this Iterable. Then grouped is defined as follows:
 - If this.isEmpty(), the resulting Iterator is empty.
 - If size <= length, the resulting Iterator will contain length / size blocks of size size and maybe a non-empty block of size length % size, if there are remaining elements.
 - If size > length, the resulting Iterator will contain one block of size length.
 Examples:
```
 
 [].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]]
 
 
```
 Please note that grouped(int) is a special case of Traversable.sliding(int, int), i.e. grouped(size) is the same as sliding(size, size).
 Specified by:
 
 grouped in interface Traversable<T>
 
 Parameters:
 
 size - a positive block size
 
 Returns:
 
 A new Iterator of grouped blocks of the given size
 - init
```
Set<T> init()
```
 Description copied from interface: Traversable
 
 Dual of Traversable.tail(), returning all elements except the last.
 
 Specified by:
 
 init in interface Traversable<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 as Option.
 
 Specified by:
 
 initOption in interface Traversable<T>
 
 Returns:
 
 Some(traversable) or None 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 interface Traversable<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.
 
 Specified by:
 
 iterator in interface java.lang.Iterable<T>
 
 Specified by:
 
 iterator in interface Traversable<T>
 
 Specified by:
 
 iterator in interface Value<T>
 
 Returns:
 
 A new Iterator of this Traversable elements.
 - length
```
int length()
```
 Description copied from interface: Traversable
 
 Computes the number of elements of this Traversable.
 Same as Traversable.size().
 
 Specified by:
 
 length in interface Traversable<T>
 
 Returns:
 
 the number of elements
 - map
```
 Set map(java.util.function.Function<? super T,? extends U> mapper)
```
 Description copied from interface: Traversable
 
 Maps the elements of this Traversable to elements of a new type preserving their order, if any.
 
 Specified by:
 
 map in interface Traversable<T>
 
 Specified by:
 
 map in interface Value<T>
 
 Type Parameters:
 
 U - Component type of the target Traversable
 
 Parameters:
 
 mapper - A mapper.
 
 Returns:
 
 a mapped Traversable
 - orElse
```
Set<T> orElse(java.lang.Iterable<? extends T> other)
```
 Description copied from interface: Traversable
 
 Returns this Traversable if it is nonempty, otherwise return the alternative.
 
 Specified by:
 
 orElse in interface Traversable<T>
 
 Parameters:
 
 other - An alternative Traversable
 
 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 this Traversable if it is nonempty, otherwise return the result of evaluating supplier.
 
 Specified by:
 
 orElse in interface Traversable<T>
 
 Parameters:
 
 supplier - An alternative Traversable 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 this Traversable by splitting this elements in two in distinct traversables according to a predicate.
 
 Specified by:
 
 partition in interface Traversable<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 given predicate, the second Traversable 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 given action on the first element if this is an eager implementation. Performs the given action on all elements (the first immediately, successive deferred), if this is a lazy implementation.
 
 Specified by:
 
 peek in interface Traversable<T>
 
 Specified by:
 
 peek in interface Value<T>
 
 Parameters:
 
 action - The action that will be performed on the element(s).
 
 Returns:
 
 this instance
 - 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 interface Traversable<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 interface Traversable<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 interface Traversable<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 interface Traversable<T>
 
 Parameters:
 
 zero - neutral element for the operator op
 
 operation - the associative operator for the scan
 
 Returns:
 
 a new traversable collection containing the prefix scan of the elements in this traversable collection
 - scanLeft
```
 Set 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 interface Traversable<T>
 
 Type Parameters:
 
 U - the type of the elements in the resulting collection
 
 Parameters:
 
 zero - the initial value
 
 operation - the binary operator applied to the intermediate result and the element
 
 Returns:
 
 collection with intermediate results
 - scanRight
```
 Set 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 interface Traversable<T>
 
 Type Parameters:
 
 U - the type of the elements in the resulting collection
 
 Parameters:
 
 zero - the initial value
 
 operation - 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 this Traversable.
 Each window contains elements with the same class, as determined by classifier. Two consecutive values in this Traversable will be in the same window only if classifier 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 interface Traversable<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 specific size and step size 1 over this Traversable by calling Traversable.sliding(int, int).
 
 Specified by:
 
 sliding in interface Traversable<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 specific size and step size over this Traversable.
 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]]
 
 
```
 Specified by:
 
 sliding in interface Traversable<T>
 
 Parameters:
 
 size - a positive window size
 
 step - 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 given predicate and the second element is the remainder.
 
 Specified by:
 
 span in interface Traversable<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 interface Traversable<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 an Option.
 
 Specified by:
 
 tailOption in interface Traversable<T>
 
 Returns:
 
 Some(traversable) or None 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 if n < 0 or n > length().
 In the case of n < 0 the empty instance is returned, in the case of n > length() this is returned.
 
 Specified by:
 
 take in interface Traversable<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 if n < 0 or n > length().
 In the case of n < 0 the empty instance is returned, in the case of n > length() this is returned.
 
 Specified by:
 
 takeRight in interface Traversable<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 interface Traversable<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 interface Traversable<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.
 - zip
```
 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 interface Traversable<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 interface Traversable<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
```
 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 interface Traversable<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 interface Traversable<T>
 
 Returns:
 
 A new traversable containing all elements of this traversable paired with their index, starting with 0.
 - zipWithIndex
```
 Set zipWithIndex(java.util.function.BiFunction<? super T,? super java.lang.Integer,? extends U> mapper)
```
 Description copied from interface: Traversable
 
 Zips this traversable with its indices by applying mapper provided.
 
 Specified by:
 
 zipWithIndex in interface Traversable<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.

Interface Set<T>

Field Summary

Method Summary

Methods inherited from interface io.vavr.collection.Traversable

Methods inherited from interface io.vavr.Value

Field Detail

serialVersionUID

Method Detail

narrow

add

addAll

diff

intersect

remove

removeAll

toJavaSet

union

collect

contains

distinct

distinctBy

distinctBy

drop

dropRight

dropUntil

dropWhile

filter

filterNot

flatMap

groupBy

grouped

init

initOption

isDistinct

iterator

length

map

orElse

orElse

partition

peek

replace

replaceAll

retainAll

scan

scanLeft

scanRight

slideBy

sliding

sliding

span

tail

tailOption

take

takeRight

takeUntil

takeWhile

zip

zipWith

zipAll

zipWithIndex

zipWithIndex