Package io.vavr.collection

Interface BitSet<T>

All Superinterfaces:

Foldable<T>, Function<T,Boolean>, Function1<T,Boolean>, Iterable<T>, Ordered<T>, Serializable, Set<T>, SortedSet<T>, Traversable<T>, Value<T>

public interface BitSet<T>
extends SortedSet<T>

An immutable BitSet implementation.

Author:

Ruslan Sennov

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	BitSet.Builder<T>

Field Summary

Fields

Modifier and Type	Field	Description
static final long	serialVersionUID

Method Summary

Modifier and Type	Method	Description
BitSet<T>	add(T element)	Add the given element to this set, if it is not already contained.
BitSet<T>	addAll(Iterable<? extends T> elements)	Adds all of the given elements to this set, if not already contained.
default <R> SortedSet<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.
static Collector<Integer,ArrayList<Integer>,BitSet<Integer>>	collector()	Returns a Collector which may be used in conjunction with Stream.collect(java.util.stream.Collector) to obtain a BitSet.
default BitSet<T>	diff(Set<? extends T> elements)	Calculates the difference between this set and another set.
default BitSet<T>	distinct()	Returns a new version of this which contains no duplicates.
BitSet<T>	distinctBy(Comparator<? super T> comparator)	Returns a new version of this which contains no duplicates.
<U> BitSet<T>	distinctBy(Function<? super T,? extends U> keyExtractor)	Returns a new version of this which contains no duplicates.
BitSet<T>	drop(int n)	Drops the first n elements of this or all elements, if this length < n.
BitSet<T>	dropRight(int n)	Drops the last n elements of this or all elements, if this length < n.
default BitSet<T>	dropUntil(Predicate<? super T> predicate)	Drops elements until the predicate holds for the current element.
BitSet<T>	dropWhile(Predicate<? super T> predicate)	Drops elements while the predicate holds for the current element.
static BitSet<Integer>	empty()	Returns a BitSet containing no elements.
static BitSet<Integer>	fill(int n, Supplier<Integer> s)	Returns a BitSet containing n values supplied by a given Supplier s.
BitSet<T>	filter(Predicate<? super T> predicate)	Returns a new traversable consisting of all elements which satisfy the given predicate.
default <U> SortedSet<U>	flatMap(Comparator<? super U> comparator, Function<? super T,? extends Iterable<? extends U>> mapper)	Same as SortedSet.flatMap(Function) but using a specific comparator for values of the codomain of the given mapper.
default <U> SortedSet<U>	flatMap(Function<? super T,? extends Iterable<? extends U>> mapper)	FlatMaps this Traversable.
default <U> U	foldRight(U zero, BiFunction<? super T,? super U,? extends U> f)	Folds this elements from the right, starting with zero and successively calling combine.
<C> Map<C,BitSet<T>>	groupBy(Function<? super T,? extends C> classifier)	Groups this elements by classifying the elements.
default Iterator<BitSet<T>>	grouped(int size)	Groups this Traversable into fixed size blocks.
default boolean	hasDefiniteSize()	Checks if this Traversable is known to have a finite size.
BitSet<T>	init()	Dual of Traversable.tail(), returning all elements except the last.
default Option<BitSet<T>>	initOption()	Dual of Traversable.tailOption(), returning all elements except the last as Option.
BitSet<T>	intersect(Set<? extends T> elements)	Computes the intersection between this set and another set.
default boolean	isAsync()	An BitSet's value is computed synchronously.
default boolean	isLazy()	An BitSet's value is computed eagerly.
default boolean	isTraversableAgain()	Checks if this Traversable can be repeatedly traversed.
default T	last()	Dual of Traversable.head(), returning the last element.
default <U> SortedSet<U>	map(Comparator<? super U> comparator, Function<? super T,? extends U> mapper)	Same as SortedSet.map(Function) but using a specific comparator for values of the codomain of the given mapper.
default <U> SortedSet<U>	map(Function<? super T,? extends U> mapper)	Maps the elements of this Traversable to elements of a new type preserving their order, if any.
static BitSet<Integer>	of(Integer value)	Returns a BitSet containing a single value.
static BitSet<Integer>	of(Integer... values)	Creates a BitSet of int numbers starting from from, extending to toExclusive - 1.
static BitSet<Boolean>	ofAll(boolean... elements)	Creates a BitSet from boolean values.
static BitSet<Byte>	ofAll(byte... elements)	Creates a BitSet from byte values.
static BitSet<Character>	ofAll(char... elements)	Creates a BitSet from char values.
static BitSet<Integer>	ofAll(int... elements)	Creates a BitSet from int values.
static BitSet<Long>	ofAll(long... elements)	Creates a BitSet from long values.
static BitSet<Short>	ofAll(short... elements)	Creates a BitSet from short values.
static BitSet<Integer>	ofAll(Iterable<Integer> values)	Creates a BitSet of int numbers starting from from, extending to toExclusive - 1.
static BitSet<Integer>	ofAll(Stream<Integer> javaStream)	Creates a BitSet of int numbers starting from from, extending to toExclusive - 1.
Tuple2<BitSet<T>,BitSet<T>>	partition(Predicate<? super T> predicate)	Creates a partition of this Traversable by splitting this elements in two in distinct traversables according to a predicate.
default BitSet<T>	peek(Consumer<? super T> action)	Performs the given action on the first element if this is an eager implementation.
static BitSet<Character>	range(char from, char toExclusive)	Creates a BitSet of char numbers starting from from, extending to toExclusive - 1.
static BitSet<Integer>	range(int from, int toExclusive)	Creates a BitSet of int numbers starting from from, extending to toExclusive - 1.
static BitSet<Long>	range(long from, long toExclusive)	Creates a BitSet of long numbers starting from from, extending to toExclusive - 1.
static BitSet<Character>	rangeBy(char from, char toExclusive, int step)	Creates a BitSet of char numbers starting from from, extending to toExclusive - 1, with step.
static BitSet<Integer>	rangeBy(int from, int toExclusive, int step)	Creates a BitSet of int numbers starting from from, extending to toExclusive - 1, with step.
static BitSet<Long>	rangeBy(long from, long toExclusive, long step)	Creates a BitSet of long numbers starting from from, extending to toExclusive - 1, with step.
static BitSet<Character>	rangeClosed(char from, char toInclusive)	Creates a BitSet of char numbers starting from from, extending to toInclusive.
static BitSet<Integer>	rangeClosed(int from, int toInclusive)	Creates a BitSet of int numbers starting from from, extending to toInclusive.
static BitSet<Long>	rangeClosed(long from, long toInclusive)	Creates a BitSet of long numbers starting from from, extending to toInclusive.
static BitSet<Character>	rangeClosedBy(char from, char toInclusive, int step)	Creates a BitSet of char numbers starting from from, extending to toInclusive, with step.
static BitSet<Integer>	rangeClosedBy(int from, int toInclusive, int step)	Creates a BitSet of int numbers starting from from, extending to toInclusive, with step.
static BitSet<Long>	rangeClosedBy(long from, long toInclusive, long step)	Creates a BitSet of long numbers starting from from, extending to toInclusive, with step.
BitSet<T>	reject(Predicate<? super T> predicate)	Returns a new traversable consisting of all elements which do not satisfy the given predicate.
BitSet<T>	remove(T element)	Removes a specific element from this set, if present.
BitSet<T>	removeAll(Iterable<? extends T> elements)	Removes all of the given elements from this set, if present.
default BitSet<T>	replace(T currentElement, T newElement)	Replaces the first occurrence (if exists) of the given currentElement with newElement.
default BitSet<T>	replaceAll(T currentElement, T newElement)	Replaces all occurrences of the given currentElement with newElement.
default BitSet<T>	retainAll(Iterable<? extends T> elements)	Keeps all occurrences of the given elements from this.
BitSet<T>	scan(T zero, BiFunction<? super T,? super T,? extends T> operation)	Computes a prefix scan of the elements of the collection.
default <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.
default <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.
Iterator<BitSet<T>>	slideBy(Function<? super T,?> classifier)	Slides a non-overlapping window of a variable size over this Traversable.
default Iterator<BitSet<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<BitSet<T>>	sliding(int size, int step)	Slides a window of a specific size and step size over this Traversable.
Tuple2<BitSet<T>,BitSet<T>>	span(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.
default String	stringPrefix()	Returns the name of this Value type, which is used by toString().
static BitSet<Integer>	tabulate(int n, Function<Integer,Integer> f)	Returns a BitSet containing n values of a given Function f over a range of integer values from 0 to n - 1.
default BitSet<T>	tail()	Drops the first element of a non-empty Traversable.
default Option<BitSet<T>>	tailOption()	Drops the first element of a non-empty Traversable and returns an Option.
BitSet<T>	take(int n)	Takes the first n elements of this or all elements, if this length < n.
BitSet<T>	takeRight(int n)	Takes the last n elements of this or all elements, if this length < n.
default BitSet<T>	takeUntil(Predicate<? super T> predicate)	Takes elements until the predicate holds for the current element.
BitSet<T>	takeWhile(Predicate<? super T> predicate)	Takes elements while the predicate holds for the current element.
default SortedSet<T>	toJavaSet()	Converts this Vavr Set to a java.util.Set while preserving characteristics like insertion order (LinkedHashSet) and sort order (SortedSet).
default BitSet<T>	union(Set<? extends T> elements)	Adds all of the elements of that set to this set, if not already present.
default <T1, T2> Tuple2<TreeSet<T1>,TreeSet<T2>>	unzip(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.
default <T1, T2, T3> Tuple3<TreeSet<T1>,TreeSet<T2>,TreeSet<T3>>	unzip3(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.
static BitSet.Builder<Byte>	withBytes()
static BitSet.Builder<Character>	withCharacters()
static <T extends Enum<T>> BitSet.Builder<T>	withEnum(Class<T> enumClass)
static BitSet.Builder<Long>	withLongs()
static <T> BitSet.Builder<T>	withRelations(Function1<Integer,T> fromInt, Function1<T,Integer> toInt)
static BitSet.Builder<Short>	withShorts()
default <U> TreeSet<Tuple2<T,U>>	zip(Iterable<? extends U> that)	Returns a traversable formed from this traversable and another Iterable collection by combining corresponding elements in pairs.
default <U> TreeSet<Tuple2<T,U>>	zipAll(Iterable<? extends U> that, T thisElem, U thatElem)	Returns a traversable formed from this traversable and another Iterable by combining corresponding elements in pairs.
default <U, R> TreeSet<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.
default TreeSet<Tuple2<T,Integer>>	zipWithIndex()	Zips this traversable with its indices.
default <U> TreeSet<U>	zipWithIndex(BiFunction<? super T,? super Integer,? extends U> mapper)	Zips this traversable with its indices by applying mapper provided.

Methods inherited from interface io.vavr.collection.Foldable

fold, reduce, reduceOption

Methods inherited from interface io.vavr.Function1

andThen, arity, compose, curried, isMemoized, memoized, partial, reversed, tupled

Methods inherited from interface io.vavr.collection.Ordered

comparator

Methods inherited from interface io.vavr.collection.Set

apply, contains, isDistinct, iterator, length

Methods inherited from interface io.vavr.collection.SortedSet

isOrdered, orElse, orElse

Methods inherited from interface io.vavr.collection.Traversable

arrangeBy, average, containsAll, count, equals, existsUnique, find, findLast, foldLeft, forEachWithIndex, get, hashCode, head, headOption, isEmpty, isSequential, isSingleValued, 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, out, out, stderr, stdout, 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:

• Constant Field Values

Method Details

withRelations

static <T> BitSet.Builder<T> withRelations(Function1<Integer,T> fromInt,
 Function1<T,Integer> toInt)

withEnum

static <T extends Enum<T>> BitSet.Builder<T> withEnum(Class<T> enumClass)

withCharacters

static BitSet.Builder<Character> withCharacters()

withBytes

static BitSet.Builder<Byte> withBytes()

withLongs

static BitSet.Builder<Long> withLongs()

withShorts

static BitSet.Builder<Short> withShorts()

collector

static Collector<Integer,ArrayList<Integer>,BitSet<Integer>> collector()

Returns a Collector which may be used in conjunction with Stream.collect(java.util.stream.Collector) to obtain a BitSet.

Returns:

A BitSet Collector.

empty

static BitSet<Integer> empty()

Returns a BitSet containing no elements.

Returns:

an empty BitSet

of

static BitSet<Integer> of(Integer value)

Returns a BitSet containing a single value.

Parameters:

value - A single value

Returns:

A BitSet containing the given value

of

static BitSet<Integer> of(Integer... values)

Creates a BitSet of int numbers starting from from, extending to toExclusive - 1.

Parameters:

values - int values

Returns:

A new BitSet of int values

tabulate

static BitSet<Integer> tabulate(int n,
 Function<Integer,Integer> f)

Returns a BitSet containing n values of a given Function f over a range of integer values from 0 to n - 1.

Parameters:

n - The number of elements in the BitSet

f - The Function computing element values

Returns:

A BitSet consisting of elements f(0),f(1), ..., f(n - 1)

Throws:

NullPointerException - if f is null

fill

static BitSet<Integer> fill(int n,
 Supplier<Integer> s)

Returns a BitSet containing n values supplied by a given Supplier s.

Parameters:

n - The number of elements in the BitSet

s - The Supplier computing element values

Returns:

A BitSet of size n, where each element contains the result supplied by s.

Throws:

NullPointerException - if s is null

ofAll

static BitSet<Integer> ofAll(Iterable<Integer> values)

Creates a BitSet of int numbers starting from from, extending to toExclusive - 1.

Parameters:

values - int values

Returns:

A new BitSet of int values

ofAll

static BitSet<Integer> ofAll(Stream<Integer> javaStream)

Creates a BitSet of int numbers starting from from, extending to toExclusive - 1.

Parameters:

javaStream - A java.util.stream.Stream of int values

Returns:

A new BitSet of int values

ofAll

static BitSet<Boolean> ofAll(boolean... elements)

Creates a BitSet from boolean values.

Parameters:

elements - boolean values

Returns:

A new BitSet of boolean values

Throws:

NullPointerException - if elements is null

ofAll

static BitSet<Byte> ofAll(byte... elements)

Creates a BitSet from byte values.

Parameters:

elements - byte values

Returns:

A new BitSet of byte values

Throws:

NullPointerException - if elements is null

ofAll

static BitSet<Character> ofAll(char... elements)

Creates a BitSet from char values.

Parameters:

elements - char values

Returns:

A new BitSet of char values

Throws:

NullPointerException - if elements is null

ofAll

static BitSet<Integer> ofAll(int... elements)

Creates a BitSet from int values.

Parameters:

elements - int values

Returns:

A new BitSet of int values

Throws:

NullPointerException - if elements is null

ofAll

static BitSet<Long> ofAll(long... elements)

Creates a BitSet from long values.

Parameters:

elements - long values

Returns:

A new BitSet of long values

Throws:

NullPointerException - if elements is null

ofAll

static BitSet<Short> ofAll(short... elements)

Creates a BitSet from short values.

Parameters:

elements - short values

Returns:

A new BitSet of short values

Throws:

NullPointerException - if elements is null

range

static BitSet<Integer> range(int from,
 int toExclusive)

Creates a BitSet of int numbers starting from from, extending to toExclusive - 1.

Parameters:

from - the first number

toExclusive - the last number + 1

Returns:

a range of int values as specified or the empty range if from >= toExclusive

range

static BitSet<Character> range(char from,
 char toExclusive)

Creates a BitSet of char numbers starting from from, extending to toExclusive - 1.

Parameters:

from - the first number

toExclusive - the last number + 1

Returns:

a range of char values as specified or the empty range if from >= toExclusive

range

static BitSet<Long> range(long from,
 long toExclusive)

Creates a BitSet of long numbers starting from from, extending to toExclusive - 1.

Parameters:

from - the first number

toExclusive - the last number + 1

Returns:

a range of long values as specified or the empty range if from >= toExclusive

rangeBy

static BitSet<Integer> rangeBy(int from,
 int toExclusive,
 int step)

Creates a BitSet of int numbers starting from from, extending to toExclusive - 1, with step.

Parameters:

from - the first number

toExclusive - the last number + 1

step - the step

Returns:

a range of long values as specified or the empty range if
from >= toInclusive and step > 0 or
from <= toInclusive and step < 0

Throws:

IllegalArgumentException - if step is zero

rangeBy

static BitSet<Character> rangeBy(char from,
 char toExclusive,
 int step)

Creates a BitSet of char numbers starting from from, extending to toExclusive - 1, with step.

Parameters:

from - the first number

toExclusive - the last number + 1

step - the step

Returns:

a range of char values as specified or the empty range if
from >= toInclusive and step > 0 or
from <= toInclusive and step < 0

Throws:

IllegalArgumentException - if step is zero

rangeBy

static BitSet<Long> rangeBy(long from,
 long toExclusive,
 long step)

Creates a BitSet of long numbers starting from from, extending to toExclusive - 1, with step.

Parameters:

from - the first number

toExclusive - the last number + 1

step - the step

Returns:

a range of long values as specified or the empty range if
from >= toInclusive and step > 0 or
from <= toInclusive and step < 0

Throws:

IllegalArgumentException - if step is zero

rangeClosed

static BitSet<Integer> rangeClosed(int from,
 int toInclusive)

Creates a BitSet of int numbers starting from from, extending to toInclusive.

Parameters:

from - the first number

toInclusive - the last number

Returns:

a range of int values as specified or the empty range if from > toInclusive

rangeClosed

static BitSet<Character> rangeClosed(char from,
 char toInclusive)

Creates a BitSet of char numbers starting from from, extending to toInclusive.

Parameters:

from - the first number

toInclusive - the last number

Returns:

a range of char values as specified or the empty range if from > toInclusive

rangeClosed

static BitSet<Long> rangeClosed(long from,
 long toInclusive)

Creates a BitSet of long numbers starting from from, extending to toInclusive.

Parameters:

from - the first number

toInclusive - the last number

Returns:

a range of long values as specified or the empty range if from > toInclusive

rangeClosedBy

static BitSet<Integer> rangeClosedBy(int from,
 int toInclusive,
 int step)

Creates a BitSet of int numbers starting from from, extending to toInclusive, with step.

Parameters:

from - the first number

toInclusive - the last number

step - the step

Returns:

a range of int values as specified or the empty range if
from > toInclusive and step > 0 or
from < toInclusive and step < 0

Throws:

IllegalArgumentException - if step is zero

rangeClosedBy

static BitSet<Character> rangeClosedBy(char from,
 char toInclusive,
 int step)

Creates a BitSet of char numbers starting from from, extending to toInclusive, with step.

Parameters:

from - the first number

toInclusive - the last number

step - the step

Returns:

a range of char values as specified or the empty range if
from > toInclusive and step > 0 or
from < toInclusive and step < 0

Throws:

IllegalArgumentException - if step is zero

rangeClosedBy

static BitSet<Long> rangeClosedBy(long from,
 long toInclusive,
 long step)

Creates a BitSet of long numbers starting from from, extending to toInclusive, with step.

Parameters:

from - the first number

toInclusive - the last number

step - the step

Returns:

a range of long values as specified or the empty range if
from > toInclusive and step > 0 or
from < toInclusive and step < 0

Throws:

IllegalArgumentException - if step is zero

add

BitSet<T> add(T element)

Description copied from interface: Set

Add the given element to this set, if it is not already contained.

Specified by:

add in interface Set<T>

Specified by:

add in interface SortedSet<T>

Parameters:

element - The element to be added.

Returns:

A new set containing all elements of this set and also element.

addAll

BitSet<T> addAll(Iterable<? extends T> elements)

Description copied from interface: Set

Adds all of the given elements to this set, if not already contained.

Specified by:

addAll in interface Set<T>

Specified by:

addAll in interface SortedSet<T>

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.

collect

default <R> SortedSet<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 Set<T>

Specified by:

collect in interface SortedSet<T>

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

diff

default BitSet<T> diff(Set<? extends T> elements)

Description copied from interface: Set

Calculates the difference between this set and another set.

See also Set.removeAll(Iterable).

Specified by:

diff in interface Set<T>

Specified by:

diff in interface SortedSet<T>

Parameters:

elements - Elements to be removed from this set.

Returns:

A new Set containing all elements of this set which are not located in that set.

distinct

default BitSet<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 Set<T>

Specified by:

distinct in interface SortedSet<T>

Specified by:

distinct in interface Traversable<T>

Returns:

a new Traversable containing this elements without duplicates

distinctBy

BitSet<T> distinctBy(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 Set<T>

Specified by:

distinctBy in interface SortedSet<T>

Specified by:

distinctBy in interface Traversable<T>

Parameters:

comparator - A comparator

Returns:

a new Traversable containing this elements without duplicates

distinctBy

<U> BitSet<T> distinctBy(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 Set<T>

Specified by:

distinctBy in interface SortedSet<T>

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

BitSet<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 Set<T>

Specified by:

drop in interface SortedSet<T>

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

BitSet<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 Set<T>

Specified by:

dropRight in interface SortedSet<T>

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

default BitSet<T> dropUntil(Predicate<? super T> predicate)

Description copied from interface: Traversable

Drops elements until the predicate holds for the current element.

Specified by:

dropUntil in interface Set<T>

Specified by:

dropUntil in interface SortedSet<T>

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

BitSet<T> dropWhile(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 Set<T>

Specified by:

dropWhile in interface SortedSet<T>

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

BitSet<T> filter(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 Set<T>

Specified by:

filter in interface SortedSet<T>

Specified by:

filter in interface Traversable<T>

Parameters:

predicate - A predicate

Returns:

a new traversable

reject

BitSet<T> reject(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 interface Set<T>

Specified by:

reject in interface SortedSet<T>

Specified by:

reject in interface Traversable<T>

Parameters:

predicate - A predicate

Returns:

a new traversable

flatMap

default <U> SortedSet<U> flatMap(Comparator<? super U> comparator,
 Function<? super T,? extends Iterable<? extends U>> mapper)

Description copied from interface: SortedSet

Same as SortedSet.flatMap(Function) but using a specific comparator for values of the codomain of the given mapper.

Specified by:

flatMap in interface SortedSet<T>

Type Parameters:

U - Type of flat-mapped values

Parameters:

comparator - A comparator for values of type U

mapper - A function which maps values of type T to Iterables of values of type U

Returns:

A new Set instance containing mapped values

flatMap

default <U> SortedSet<U> flatMap(Function<? super T,? extends Iterable<? extends U>> mapper)

Description copied from interface: Traversable

FlatMaps this Traversable.

Specified by:

flatMap in interface Set<T>

Specified by:

flatMap in interface SortedSet<T>

Specified by:

flatMap in interface Traversable<T>

Type Parameters:

U - The resulting component type.

Parameters:

mapper - A mapper

Returns:

A new Traversable instance.

foldRight

default <U> U foldRight(U zero,
 BiFunction<? super T,? super U,? extends U> f)

Description copied from interface: Foldable

Folds this elements from the right, starting with zero and successively calling combine.

Example:

 
 // = "!cba"
 List("a", "b", "c").foldRight("!", (x, xs) -> xs + x)
  

Specified by:

foldRight in interface Foldable<T>

Specified by:

foldRight in interface Traversable<T>

Type Parameters:

U - the type of the folded value

Parameters:

zero - A zero element to start with.

f - A function which combines elements.

Returns:

a folded value

groupBy

<C> Map<C,BitSet<T>> groupBy(Function<? super T,? extends C> classifier)

Description copied from interface: Traversable

Groups this elements by classifying the elements.

Specified by:

groupBy in interface Set<T>

Specified by:

groupBy in interface SortedSet<T>

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

default Iterator<BitSet<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 Set<T>

Specified by:

grouped in interface SortedSet<T>

Specified by:

grouped in interface Traversable<T>

Parameters:

size - a positive block size

Returns:

A new Iterator of grouped blocks of the given size

hasDefiniteSize

default boolean hasDefiniteSize()

Description copied from interface: Traversable

Checks if this Traversable is known to have a finite size.

This method should be implemented by classes only, i.e. not by interfaces.

Specified by:

hasDefiniteSize in interface Traversable<T>

Returns:

true, if this Traversable is known to have a finite size, false otherwise.

init

BitSet<T> init()

Description copied from interface: Traversable

Dual of Traversable.tail(), returning all elements except the last.

Specified by:

init in interface Set<T>

Specified by:

init in interface SortedSet<T>

Specified by:

init in interface Traversable<T>

Returns:

a new instance containing all elements except the last.

initOption

default Option<BitSet<T>> initOption()

Description copied from interface: Traversable

Dual of Traversable.tailOption(), returning all elements except the last as Option.

Specified by:

initOption in interface Set<T>

Specified by:

initOption in interface SortedSet<T>

Specified by:

initOption in interface Traversable<T>

Returns:

Some(traversable) or None if this is empty.

isAsync

default boolean isAsync()

An BitSet's value is computed synchronously.

Specified by:

isAsync in interface Value<T>

Returns:

false

isTraversableAgain

default boolean isTraversableAgain()

Description copied from interface: Traversable

Checks if this Traversable can be repeatedly traversed.

This method should be implemented by classes only, i.e. not by interfaces.

Specified by:

isTraversableAgain in interface Traversable<T>

Returns:

true, if this Traversable is known to be traversable repeatedly, false otherwise.

isLazy

default boolean isLazy()

An BitSet's value is computed eagerly.

Specified by:

isLazy in interface Value<T>

Returns:

false

intersect

BitSet<T> intersect(Set<? extends T> elements)

Description copied from interface: Set

Computes the intersection between this set and another set.

See also Set.retainAll(Iterable).

Specified by:

intersect in interface Set<T>

Specified by:

intersect in interface SortedSet<T>

Parameters:

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

last

default T last()

Description copied from interface: Traversable

Dual of Traversable.head(), returning the last element.

Specified by:

last in interface Traversable<T>

Returns:

the last element.

partition

Tuple2<BitSet<T>,BitSet<T>> partition(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 Set<T>

Specified by:

partition in interface SortedSet<T>

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

default BitSet<T> peek(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 Set<T>

Specified by:

peek in interface SortedSet<T>

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

stringPrefix

default String stringPrefix()

Description copied from interface: Value

Returns the name of this Value type, which is used by toString().

Specified by:

stringPrefix in interface Value<T>

Returns:

This type name.

map

default <U> SortedSet<U> map(Comparator<? super U> comparator,
 Function<? super T,? extends U> mapper)

Description copied from interface: SortedSet

Same as SortedSet.map(Function) but using a specific comparator for values of the codomain of the given mapper.

Specified by:

map in interface SortedSet<T>

Type Parameters:

U - Type of mapped values

Parameters:

comparator - A comparator for values of type U

mapper - A function which maps values of type T to values of type U

Returns:

A new Set instance containing mapped values

map

default <U> SortedSet<U> map(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 Set<T>

Specified by:

map in interface SortedSet<T>

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

remove

BitSet<T> remove(T element)

Description copied from interface: Set

Removes a specific element from this set, if present.

Specified by:

remove in interface Set<T>

Specified by:

remove in interface SortedSet<T>

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

BitSet<T> removeAll(Iterable<? extends T> elements)

Description copied from interface: Set

Removes all of the given elements from this set, if present.

Specified by:

removeAll in interface Set<T>

Specified by:

removeAll in interface SortedSet<T>

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.

replace

default BitSet<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 Set<T>

Specified by:

replace in interface SortedSet<T>

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

default BitSet<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 Set<T>

Specified by:

replaceAll in interface SortedSet<T>

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

default BitSet<T> retainAll(Iterable<? extends T> elements)

Description copied from interface: Traversable

Keeps all occurrences of the given elements from this.

Specified by:

retainAll in interface Set<T>

Specified by:

retainAll in interface SortedSet<T>

Specified by:

retainAll in interface Traversable<T>

Parameters:

elements - Elements to be kept.

Returns:

a Traversable containing all occurrences of the given elements.

scan

BitSet<T> scan(T zero,
 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 Set<T>

Specified by:

scan in interface SortedSet<T>

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

default <U> Set<U> scanLeft(U zero,
 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 Set<T>

Specified by:

scanLeft in interface SortedSet<T>

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

default <U> Set<U> scanRight(U zero,
 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 Set<T>

Specified by:

scanRight in interface SortedSet<T>

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<BitSet<T>> slideBy(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 Set<T>

Specified by:

slideBy in interface SortedSet<T>

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

default Iterator<BitSet<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 Set<T>

Specified by:

sliding in interface SortedSet<T>

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<BitSet<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],[4]]
 
 

Specified by:

sliding in interface Set<T>

Specified by:

sliding in interface SortedSet<T>

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<BitSet<T>,BitSet<T>> span(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 Set<T>

Specified by:

span in interface SortedSet<T>

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

default BitSet<T> tail()

Description copied from interface: Traversable

Drops the first element of a non-empty Traversable.

Specified by:

tail in interface Set<T>

Specified by:

tail in interface SortedSet<T>

Specified by:

tail in interface Traversable<T>

Returns:

A new instance of Traversable containing all elements except the first.

tailOption

default Option<BitSet<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 Set<T>

Specified by:

tailOption in interface SortedSet<T>

Specified by:

tailOption in interface Traversable<T>

Returns:

Some(traversable) or None if this is empty.

take

BitSet<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 Set<T>

Specified by:

take in interface SortedSet<T>

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

BitSet<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 Set<T>

Specified by:

takeRight in interface SortedSet<T>

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

default BitSet<T> takeUntil(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 Set<T>

Specified by:

takeUntil in interface SortedSet<T>

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

BitSet<T> takeWhile(Predicate<? super T> predicate)

Description copied from interface: Traversable

Takes elements while the predicate holds for the current element.

Specified by:

takeWhile in interface Set<T>

Specified by:

takeWhile in interface SortedSet<T>

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.

toJavaSet

default SortedSet<T> toJavaSet()

Description copied from interface: Set

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 Set<T>

Specified by:

toJavaSet in interface SortedSet<T>

Specified by:

toJavaSet in interface Value<T>

Returns:

a new java.util.Set instance

union

default BitSet<T> union(Set<? extends T> elements)

Description copied from interface: Set

Adds all of the elements of that set to this set, if not already present.

See also Set.addAll(Iterable).

Specified by:

union in interface Set<T>

Specified by:

union in interface SortedSet<T>

Parameters:

elements - The set to form the union with.

Returns:

A new set that contains all distinct elements of this and that set.

unzip

default <T1,
T2> Tuple2<TreeSet<T1>,TreeSet<T2>> unzip(Function<? super T,Tuple2<? extends T1,? extends T2>> unzipper)

Description copied from interface: Traversable

Unzips this elements by mapping this elements to pairs which are subsequently split into two distinct sets.

Specified by:

unzip in interface Set<T>

Specified by:

unzip in interface SortedSet<T>

Specified by:

unzip in interface Traversable<T>

Type Parameters:

T1 - 1st element type of a pair returned by unzipper

T2 - 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

default <T1,
T2,
T3>
Tuple3<TreeSet<T1>,TreeSet<T2>,TreeSet<T3>> unzip3(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 interface Set<T>

Specified by:

unzip3 in interface SortedSet<T>

Specified by:

unzip3 in interface Traversable<T>

Type Parameters:

T1 - 1st element type of a triplet returned by unzipper

T2 - 2nd element type of a triplet returned by unzipper

T3 - 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

default <U> TreeSet<Tuple2<T,U>> zip(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 Set<T>

Specified by:

zip in interface SortedSet<T>

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

default <U,
R> TreeSet<R> zipWith(Iterable<? extends U> that,
 BiFunction<? super T,? super U,? extends R> mapper)

Description copied from interface: Traversable

Returns a traversable formed from this traversable and another Iterable collection by mapping elements. If one of the two iterables is longer than the other, its remaining elements are ignored.

The length of the returned traversable is the minimum of the lengths of this traversable and that iterable.

Specified by:

zipWith in interface Set<T>

Specified by:

zipWith in interface SortedSet<T>

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

default <U> TreeSet<Tuple2<T,U>> zipAll(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 Set<T>

Specified by:

zipAll in interface SortedSet<T>

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

default TreeSet<Tuple2<T,Integer>> zipWithIndex()

Description copied from interface: Traversable

Zips this traversable with its indices.

Specified by:

zipWithIndex in interface Set<T>

Specified by:

zipWithIndex in interface SortedSet<T>

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

default <U> TreeSet<U> zipWithIndex(BiFunction<? super T,? super Integer,? extends U> mapper)

Description copied from interface: Traversable

Zips this traversable with its indices by applying mapper provided.

Specified by:

zipWithIndex in interface Set<T>

Specified by:

zipWithIndex in interface SortedSet<T>

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.