Interface BitSet<T>

Type Parameters:

T - Component type

All Superinterfaces:

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

All Known Implementing Classes:

BitSetModule.AbstractBitSet, BitSetModule.BitSet1, BitSetModule.BitSet2, BitSetModule.BitSetN

public interface BitSet<T>
extends SortedSet<T>

An immutable BitSet implementation.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final long	serialVersionUID	The serial version UID for serialization.

Method Summary

Modifier and Type	Method	Description
BitSet<T>	add(T element)	Returns a new set containing all elements of this set plus the given element, if it was not already present.
BitSet<T>	addAll(@NonNull Iterable<? extends T> elements)	Returns a new set containing all elements of this set plus the given elements, excluding duplicates.
default <R> SortedSet<R>	collect(@NonNull PartialFunction<? super T, ? extends R> partialFunction)	Applies a PartialFunction to all elements that are defined for it and collects the results.
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(@NonNull Set<? extends T> elements)	Returns a new set containing all elements of this set except those in the given set.
default BitSet<T>	distinct()	Returns a new Traversable containing the elements of this instance with all duplicates removed.
BitSet<T>	distinctBy(@NonNull Comparator<? super T> comparator)	Returns a new Traversable containing the elements of this instance without duplicates, as determined by the given comparator.
<U> BitSet<T>	distinctBy(@NonNull Function<? super T, ? extends U> keyExtractor)	Returns a new Traversable containing the elements of this instance without duplicates, based on keys extracted from elements using keyExtractor.
BitSet<T>	drop(int n)	Returns a new Traversable without the first n elements, or an empty instance if this contains fewer than n elements.
BitSet<T>	dropRight(int n)	Returns a new Traversable without the last n elements, or an empty instance if this contains fewer than n elements.
default BitSet<T>	dropUntil(@NonNull Predicate<? super T> predicate)	Returns a new Traversable starting from the first element that satisfies the given predicate, dropping all preceding elements.
BitSet<T>	dropWhile(@NonNull Predicate<? super T> predicate)	Returns a new Traversable starting from the first element that does not satisfy the given predicate, dropping all preceding elements.
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(@NonNull Predicate<? super T> predicate)	Returns a new traversable containing only the elements that satisfy the given predicate.
default <U> SortedSet<U>	flatMap(@NonNull 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(@NonNull Function<? super T, ? extends Iterable<? extends U>> mapper)	Transforms each element of this Traversable into an Iterable of elements and flattens the resulting iterables into a single Traversable.
default <U> U	foldRight(U zero, @NonNull BiFunction<? super T, ? super U, ? extends U> f)	Folds the elements of this structure from the right, starting with the given zero value and successively applying the combine function to each element.
<C> Map<C, BitSet<T>>	groupBy(@NonNull Function<? super T, ? extends C> classifier)	Groups elements of this Traversable based on a classifier function.
default Iterator<BitSet<T>>	grouped(int size)	Splits this Traversable into consecutive blocks of the given size.
default boolean	hasDefiniteSize()	Indicates whether this Traversable has a known finite size.
BitSet<T>	init()	Returns all elements of this Traversable except the last one.
default Option<BitSet<T>>	initOption()	Returns all elements of this Traversable except the last one, wrapped in an Option.
BitSet<T>	intersect(@NonNull Set<? extends T> elements)	Returns a new set containing only the elements present in both this set and the given 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 traversed multiple times without side effects.
default T	last()	Returns the last element of this Traversable.
default <U> SortedSet<U>	map(@NonNull 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(@NonNull Function<? super T, ? extends U> mapper)	Transforms the elements of this Traversable to a new type, preserving order if defined.
default <U> SortedSet<U>	mapTo(U value)	Maps the underlying value to another fixed value.
default SortedSet<Void>	mapToVoid()	Maps the underlying value to Void
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(@NonNull Predicate<? super T> predicate)	Splits this Traversable into two partitions according to a predicate.
default BitSet<T>	peek(@NonNull 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(@NonNull Predicate<? super T> predicate)	Returns a new traversable containing only the elements that do not satisfy the given predicate.
BitSet<T>	remove(T element)	Returns a new set with the given element removed, if it was present.
BitSet<T>	removeAll(@NonNull Iterable<? extends T> elements)	Returns a new set with all given elements removed, if present.
default BitSet<T>	replace(T currentElement, T newElement)	Replaces the first occurrence of currentElement with newElement, if it exists.
default BitSet<T>	replaceAll(T currentElement, T newElement)	Replaces all occurrences of currentElement with newElement.
default BitSet<T>	retainAll(@NonNull Iterable<? extends T> elements)	Retains only the elements from this Traversable that are contained in the given elements.
BitSet<T>	scan(T zero, @NonNull BiFunction<? super T, ? super T, ? extends T> operation)	Computes a prefix scan of the elements of this Traversable.
default <U> Set<U>	scanLeft(U zero, @NonNull BiFunction<? super U, ? super T, ? extends U> operation)	Produces a collection containing cumulative results of applying the operator from left to right.
default <U> Set<U>	scanRight(U zero, @NonNull BiFunction<? super T, ? super U, ? extends U> operation)	Produces a collection containing cumulative results of applying the operator from right to left.
Iterator<BitSet<T>>	slideBy(@NonNull Function<? super T, ?> classifier)	Partitions this Traversable into consecutive non-overlapping windows according to a classification function.
default Iterator<BitSet<T>>	sliding(int size)	Slides a window of a given size over this Traversable with a step size of 1.
Iterator<BitSet<T>>	sliding(int size, int step)	Slides a window of a specific size with a given step over this Traversable.
Tuple2<BitSet<T>, BitSet<T>>	span(@NonNull Predicate<? super T> predicate)	Splits this Traversable into a prefix and remainder according to the given predicate.
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()	Returns a new Traversable without its first element.
default Option<BitSet<T>>	tailOption()	Returns a new Traversable without its first element as an Option.
BitSet<T>	take(int n)	Returns the first n elements of this Traversable, or all elements if n exceeds the length.
BitSet<T>	takeRight(int n)	Returns the last n elements of this Traversable, or all elements if n exceeds the length.
default BitSet<T>	takeUntil(@NonNull Predicate<? super T> predicate)	Takes elements from this Traversable until the given predicate holds for an element.
BitSet<T>	takeWhile(@NonNull Predicate<? super T> predicate)	Takes elements from this Traversable while the given predicate holds.
default SortedSet<T>	toJavaSet()	Converts this Vavr set to a java.util.Set, preserving insertion or sort order.
default BitSet<T>	union(@NonNull Set<? extends T> elements)	Returns a new set containing all distinct elements from this set and the given set.
default <T1,T2> Tuple2<TreeSet<T1>, TreeSet<T2>>	unzip(@NonNull Function<? super T, Tuple2<? extends T1, ? extends T2>> unzipper)	Unzips the elements of this Traversable by mapping each element to a pair and splitting them into two separate Traversable collections.
default <T1,T2,T3> Tuple3<TreeSet<T1>, TreeSet<T2>, TreeSet<T3>>	unzip3(@NonNull Function<? super T, Tuple3<? extends T1, ? extends T2, ? extends T3>> unzipper)	Unzips the elements of this Traversable by mapping each element to a triple and splitting them into three separate Traversable collections.
static BitSet.Builder<Byte>	withBytes()	Returns new BitSet Builder for type Byte
static BitSet.Builder<Character>	withCharacters()	Returns new BitSet Builder for type Character
static <T extends Enum<T>> BitSet.Builder<T>	withEnum(Class<T> enumClass)	Returns new BitSet Builder for an enum type
static BitSet.Builder<Long>	withLongs()	Returns new BitSet Builder for type Long
static <T> BitSet.Builder<T>	withRelations(Function1<Integer,T> fromInt, Function1<T,Integer> toInt)	Returns new BitSet Builder with custom conversion functions between Integer and type T
static BitSet.Builder<Short>	withShorts()	Returns new BitSet Builder for type Short
default <U> TreeSet<Tuple2<T,U>>	zip(@NonNull Iterable<? extends U> that)	Returns a Traversable formed by pairing elements of this Traversable with elements of another Iterable.
default <U> TreeSet<Tuple2<T,U>>	zipAll(@NonNull Iterable<? extends U> that, T thisElem, U thatElem)	Returns a Traversable formed by pairing elements of this Traversable with elements of another Iterable, filling in placeholder elements when one collection is shorter than the other.
default <U,R> TreeSet<R>	zipWith(@NonNull Iterable<? extends U> that, BiFunction<? super T, ? super U, ? extends R> mapper)	Returns a Traversable by combining elements of this Traversable with elements of another Iterable using a mapping function.
default TreeSet<Tuple2<T,Integer>>	zipWithIndex()	Zips this Traversable with its indices, starting at 0.
default <U> TreeSet<U>	zipWithIndex(@NonNull BiFunction<? super T, ? super Integer, ? extends U> mapper)	Zips this Traversable with its indices and maps the resulting pairs using the provided mapper.

Methods inherited from interface Foldable

fold, reduce, reduceOption

Methods inherited from interface Function1

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

Methods inherited from interface Ordered

comparator

Methods inherited from interface Set

apply, contains, isDistinct, iterator, length

Methods inherited from interface SortedSet

isOrdered, orElse, orElse

Methods inherited from interface 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 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

The serial version UID for serialization.

See Also:

• Constant Field Values

Method Details

withRelations

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

Returns new BitSet Builder with custom conversion functions between Integer and type T

Type Parameters:

T - Component type

Parameters:

fromInt - function to convert from Integer to T

toInt - function to convert from T to Integer

Returns:

new Builder

withEnum

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

Returns new BitSet Builder for an enum type

Type Parameters:

T - Enum type

Parameters:

enumClass - the enum class

Returns:

new Builder

withCharacters

static BitSet.Builder<Character> withCharacters()

Returns new BitSet Builder for type Character

Returns:

new Builder

withBytes

static BitSet.Builder<Byte> withBytes()

Returns new BitSet Builder for type Byte

Returns:

new Builder

withLongs

static BitSet.Builder<Long> withLongs()

Returns new BitSet Builder for type Long

Returns:

new Builder

withShorts

static BitSet.Builder<Short> withShorts()

Returns new BitSet Builder for type Short

Returns:

new Builder

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

Returns a new set containing all elements of this set plus the given element, if it was not already present.

Specified by:

add in interface Set<T>

Specified by:

add in interface SortedSet<T>

Parameters:

element - the element to add

Returns:

a new set including the element

addAll

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

Description copied from interface: Set

Returns a new set containing all elements of this set plus the given elements, excluding duplicates.

Specified by:

addAll in interface Set<T>

Specified by:

addAll in interface SortedSet<T>

Parameters:

elements - the elements to add

Returns:

a new set including the additional elements

collect

default <R> SortedSet<R> collect(@NonNull PartialFunction<? super T, ? extends R> partialFunction)

Description copied from interface: Traversable

Applies a PartialFunction to all elements that are defined for it and collects the results.

For each element in iteration order, the function is first tested:

partialFunction.isDefinedAt(element)

If true, the element is mapped to type R:

R newElement = partialFunction.apply(element)

Note: If this Traversable is ordered (i.e., extends Ordered), the caller must ensure that the resulting elements are comparable (i.e., implement 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 type of elements in the resulting Traversable

Parameters:

partialFunction - a function that may not be defined for all elements of this traversable

Returns:

a new Traversable containing the results of applying the partial function

diff

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

Description copied from interface: Set

Returns a new set containing all elements of this set except those in the given set.

Specified by:

diff in interface Set<T>

Specified by:

diff in interface SortedSet<T>

Parameters:

elements - the set of elements to remove

Returns:

a new set without the specified elements

distinct

default BitSet<T> distinct()

Description copied from interface: Traversable

Returns a new Traversable containing the elements of this instance with all duplicates removed. Element equality is determined 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 without duplicate elements

distinctBy

BitSet<T> distinctBy(@NonNull Comparator<? super T> comparator)

Description copied from interface: Traversable

Returns a new Traversable containing the elements of this instance without duplicates, as determined by 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 used to determine equality of elements

Returns:

a new Traversable with duplicates removed

distinctBy

<U> BitSet<T> distinctBy(@NonNull Function<? super T, ? extends U> keyExtractor)

Description copied from interface: Traversable

Returns a new Traversable containing the elements of this instance without duplicates, based on keys extracted from elements using keyExtractor.

The first occurrence of each key is retained in the resulting sequence.

Specified by:

distinctBy in interface Set<T>

Specified by:

distinctBy in interface SortedSet<T>

Specified by:

distinctBy in interface Traversable<T>

Type Parameters:

U - the type of key

Parameters:

keyExtractor - a function to extract keys for determining uniqueness

Returns:

a new Traversable with duplicates removed based on keys

drop

BitSet<T> drop(int n)

Description copied from interface: Traversable

Returns a new Traversable without the first n elements, or an empty instance if this contains fewer than n elements.

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 excluding the first n elements

dropRight

BitSet<T> dropRight(int n)

Description copied from interface: Traversable

Returns a new Traversable without the last n elements, or an empty instance if this contains fewer than n elements.

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 from the end

Returns:

a new instance excluding the last n elements

dropUntil

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

Description copied from interface: Traversable

Returns a new Traversable starting from the first element that satisfies the given predicate, dropping all preceding elements.

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 on each element

Returns:

a new instance starting from the first element matching the predicate

dropWhile

BitSet<T> dropWhile(@NonNull Predicate<? super T> predicate)

Description copied from interface: Traversable

Returns a new Traversable starting from the first element that does not satisfy the given predicate, dropping all preceding elements.

This is equivalent to dropUntil(predicate.negate()), which is useful for method references that 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 on each element

Returns:

a new instance starting from the first element not matching the predicate

filter

BitSet<T> filter(@NonNull Predicate<? super T> predicate)

Description copied from interface: Traversable

Returns a new traversable containing only the elements that 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 - the condition to test elements

Returns:

a traversable with elements matching the predicate

reject

BitSet<T> reject(@NonNull Predicate<? super T> predicate)

Description copied from interface: Traversable

Returns a new traversable containing only the elements that do not satisfy the given predicate.

This 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 - the condition to test elements

Returns:

a traversable with elements not matching the predicate

flatMap

default <U> SortedSet<U> flatMap(@NonNull 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(@NonNull Function<? super T, ? extends Iterable<? extends U>> mapper)

Description copied from interface: Traversable

Transforms each element of this Traversable into an Iterable of elements and flattens the resulting iterables into a single 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 type of elements in the resulting Traversable

Parameters:

mapper - a function mapping elements to iterables

Returns:

a new Traversable containing all elements produced by applying mapper and flattening

foldRight

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

Description copied from interface: Foldable

Folds the elements of this structure from the right, starting with the given zero value and successively applying the combine function to each element.

Folding from the right means that elements are combined starting from the last element and associating each step with the accumulated result so far.

Example:

// Result: "!cba"
List.of("a", "b", "c").foldRight("!", (x, acc) -> acc + x);

Specified by:

foldRight in interface Foldable<T>

Specified by:

foldRight in interface Traversable<T>

Type Parameters:

U - the type of the accumulated result

Parameters:

zero - the initial value to start folding with

f - a function that combines the next element and the accumulated value

Returns:

the folded result

groupBy

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

Description copied from interface: Traversable

Groups elements of this Traversable based on a classifier function.

Specified by:

groupBy in interface Set<T>

Specified by:

groupBy in interface SortedSet<T>

Specified by:

groupBy in interface Traversable<T>

Type Parameters:

C - The type of the group keys

Parameters:

classifier - A function that assigns each element to a group

Returns:

A map where each key corresponds to a group of elements

See Also:

• Traversable.arrangeBy(Function)

grouped

default Iterator<BitSet<T>> grouped(int size)

Description copied from interface: Traversable

Splits this Traversable into consecutive blocks of the given size.

Let length be the number of elements in this Traversable:

• If empty, the resulting Iterator is empty.
• If size <= length, the resulting Iterator contains length / size blocks of size size and possibly a final smaller block of size length % size.
• If size > length, the resulting Iterator contains a single 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]]

Note: grouped(size) is equivalent to 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 - the block size; must be positive

Returns:

an Iterator over blocks of elements

hasDefiniteSize

default boolean hasDefiniteSize()

Description copied from interface: Traversable

Indicates whether this Traversable has a known finite size.

This should typically be implemented by concrete classes, not interfaces.

Specified by:

hasDefiniteSize in interface Traversable<T>

Returns:

true if the number of elements is finite and known, false otherwise.

init

BitSet<T> init()

Description copied from interface: Traversable

Returns all elements of this Traversable except the last one.

This is the dual of Traversable.tail().

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

Returns all elements of this Traversable except the last one, wrapped in an Option.

This is the dual of Traversable.tailOption().

Specified by:

initOption in interface Set<T>

Specified by:

initOption in interface SortedSet<T>

Specified by:

initOption in interface Traversable<T>

Returns:

Some(traversable) if non-empty, or None if this Traversable 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 traversed multiple times without side effects.

Implementations should provide the correct behavior; this is not meant for interfaces alone.

Specified by:

isTraversableAgain in interface Traversable<T>

Returns:

true if this Traversable is guaranteed to be repeatably traversable, 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(@NonNull Set<? extends T> elements)

Description copied from interface: Set

Returns a new set containing only the elements present in both this set and the given set.

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 with elements common to both sets

last

default T last()

Description copied from interface: Traversable

Returns the last element of this Traversable.

Specified by:

last in interface Traversable<T>

Returns:

the last element

partition

Tuple2<BitSet<T>, BitSet<T>> partition(@NonNull Predicate<? super T> predicate)

Description copied from interface: Traversable

Splits this Traversable into two partitions according to a predicate.

The first partition contains all elements that satisfy the predicate, and the second contains all elements that do not. The original iteration order is preserved.

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 used to classify elements

Returns:

a Tuple2 containing the two resulting Traversable instances

peek

default BitSet<T> peek(@NonNull 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(@NonNull 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(@NonNull Function<? super T, ? extends U> mapper)

Description copied from interface: Traversable

Transforms the elements of this Traversable to a new type, preserving order if defined.

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 - the target element type

Parameters:

mapper - a mapping function

Returns:

a new Traversable containing the mapped elements

mapTo

default <U> SortedSet<U> mapTo(U value)

Description copied from interface: Value

Maps the underlying value to another fixed value.

Specified by:

mapTo in interface Set<T>

Specified by:

mapTo in interface SortedSet<T>

Specified by:

mapTo in interface Traversable<T>

Specified by:

mapTo in interface Value<T>

Type Parameters:

U - The new component type

Parameters:

value - value to replace the contents with

Returns:

A new value

mapToVoid

default SortedSet<Void> mapToVoid()

Description copied from interface: Value

Maps the underlying value to Void

Specified by:

mapToVoid in interface Set<T>

Specified by:

mapToVoid in interface SortedSet<T>

Specified by:

mapToVoid in interface Traversable<T>

Specified by:

mapToVoid in interface Value<T>

Returns:

A new value of type Void

remove

BitSet<T> remove(T element)

Description copied from interface: Set

Returns a new set with the given element removed, if it was present.

Specified by:

remove in interface Set<T>

Specified by:

remove in interface SortedSet<T>

Parameters:

element - the element to remove

Returns:

a new set without the specified element

removeAll

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

Description copied from interface: Set

Returns a new set with all given elements removed, if present.

Specified by:

removeAll in interface Set<T>

Specified by:

removeAll in interface SortedSet<T>

Parameters:

elements - the elements to remove

Returns:

a new set without the specified elements

replace

default BitSet<T> replace(T currentElement,
 T newElement)

Description copied from interface: Traversable

Replaces the first occurrence of currentElement with newElement, if it exists.

Specified by:

replace in interface Set<T>

Specified by:

replace in interface SortedSet<T>

Specified by:

replace in interface Traversable<T>

Parameters:

currentElement - the element to be replaced

newElement - the replacement element

Returns:

a new Traversable with the first occurrence of currentElement replaced by newElement

replaceAll

default BitSet<T> replaceAll(T currentElement,
 T newElement)

Description copied from interface: Traversable

Replaces all occurrences of 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 - the element to be replaced

newElement - the replacement element

Returns:

a new Traversable with all occurrences of currentElement replaced by newElement

retainAll

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

Description copied from interface: Traversable

Retains only the elements from this Traversable that are contained in the given elements.

Specified by:

retainAll in interface Set<T>

Specified by:

retainAll in interface SortedSet<T>

Specified by:

retainAll in interface Traversable<T>

Parameters:

elements - the elements to keep

Returns:

a new Traversable containing only the elements present in elements, in their original order

scan

BitSet<T> scan(T zero,
 @NonNull BiFunction<? super T, ? super T, ? extends T> operation)

Description copied from interface: Traversable

Computes a prefix scan of the elements of this Traversable.

The neutral element zero 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 - the neutral element for the operator

operation - an associative binary operator

Returns:

a new Traversable containing the prefix scan of the elements

scanLeft

default <U> Set<U> scanLeft(U zero,
 @NonNull BiFunction<? super U, ? super T, ? extends U> operation)

Description copied from interface: Traversable

Produces a collection containing cumulative results of applying the operator from left to right.

Will not terminate for infinite collections. The results may vary across runs unless the collection 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 resulting elements

Parameters:

zero - the initial value

operation - a binary operator applied to the intermediate result and each element

Returns:

a new Traversable containing the cumulative results

scanRight

default <U> Set<U> scanRight(U zero,
 @NonNull BiFunction<? super T, ? super U, ? extends U> operation)

Description copied from interface: Traversable

Produces a collection containing cumulative results of applying the operator from right to left.

The head of the resulting collection is the last cumulative result. Will not terminate for infinite collections. Results may vary across runs unless the collection 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 resulting elements

Parameters:

zero - the initial value

operation - a binary operator applied to each element and the intermediate result

Returns:

a new Traversable containing the cumulative results

slideBy

Iterator<BitSet<T>> slideBy(@NonNull Function<? super T, ?> classifier)

Description copied from interface: Traversable

Partitions this Traversable into consecutive non-overlapping windows according to a classification function.

Each window contains elements with the same class, as determined by classifier. Two consecutive elements belong to the same window only if classifier returns equal values for both. Otherwise, the current window ends and a new window begins with the next element.

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 classifying elements into groups

Returns:

An Iterator of windows (grouped elements)

sliding

default Iterator<BitSet<T>> sliding(int size)

Description copied from interface: Traversable

Slides a window of a given size over this Traversable with a step size of 1.

This is equivalent to calling Traversable.sliding(int, int) with a step size of 1.

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:

An Iterator of windows, each containing up to size elements

sliding

Iterator<BitSet<T>> sliding(int size,
 int step)

Description copied from interface: Traversable

Slides a window of a specific size with a given step 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:

an Iterator of windows with the given size and step

span

Tuple2<BitSet<T>, BitSet<T>> span(@NonNull Predicate<? super T> predicate)

Description copied from interface: Traversable

Splits this Traversable into a prefix and remainder according to the given predicate.

The first element of the returned Tuple is the longest prefix of elements satisfying predicate, and the second element is the remaining elements.

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 used to determine the prefix

Returns:

a Tuple containing the prefix and remainder

tail

default BitSet<T> tail()

Description copied from interface: Traversable

Returns a new Traversable without its first element.

Specified by:

tail in interface Set<T>

Specified by:

tail in interface SortedSet<T>

Specified by:

tail in interface Traversable<T>

Returns:

a new Traversable containing all elements except the first

tailOption

default Option<BitSet<T>> tailOption()

Description copied from interface: Traversable

Returns a new Traversable without its first element as 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) if non-empty, otherwise None

take

BitSet<T> take(int n)

Description copied from interface: Traversable

Returns the first n elements of this Traversable, or all elements if n exceeds the length.

Equivalent to sublist(0, max(0, min(length(), n))), but safe for n < 0 or n > length().

If n < 0, an empty instance is returned. If n > length(), the full instance 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 Traversable containing the first n elements

takeRight

BitSet<T> takeRight(int n)

Description copied from interface: Traversable

Returns the last n elements of this Traversable, or all elements if n exceeds the length.

Equivalent to sublist(max(0, length() - n), length()), but safe for n < 0 or n > length().

If n < 0, an empty instance is returned. If n > length(), the full instance 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 from the end

Returns:

a new Traversable containing the last n elements

takeUntil

default BitSet<T> takeUntil(@NonNull Predicate<? super T> predicate)

Description copied from interface: Traversable

Takes elements from this Traversable until the given predicate holds for an element.

Equivalent to takeWhile(predicate.negate()), but useful when using method references that 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 sequentially on the elements

Returns:

a new Traversable containing all elements before the first one that satisfies the predicate

takeWhile

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

Description copied from interface: Traversable

Takes elements from this Traversable while the given predicate holds.

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 sequentially on the elements

Returns:

a new Traversable containing all elements up to (but not including) the first one that does not satisfy the predicate

toJavaSet

default SortedSet<T> toJavaSet()

Description copied from interface: Set

Converts this Vavr set to a java.util.Set, preserving insertion or sort order.

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(@NonNull Set<? extends T> elements)

Description copied from interface: Set

Returns a new set containing all distinct elements from this set and the given set.

Specified by:

union in interface Set<T>

Specified by:

union in interface SortedSet<T>

Parameters:

elements - the set to union with

Returns:

a new set with all elements from both sets

unzip

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

Description copied from interface: Traversable

Unzips the elements of this Traversable by mapping each element to a pair and splitting them into two separate Traversable collections.

Specified by:

unzip in interface Set<T>

Specified by:

unzip in interface SortedSet<T>

Specified by:

unzip in interface Traversable<T>

Type Parameters:

T1 - type of the first element in the resulting pairs

T2 - type of the second element in the resulting pairs

Parameters:

unzipper - a function that maps elements of this Traversable to pairs

Returns:

a Tuple2 containing two Traversable collections with the split elements

unzip3

default <T1,T2,T3>
Tuple3<TreeSet<T1>, TreeSet<T2>, TreeSet<T3>> unzip3(@NonNull Function<? super T, Tuple3<? extends T1, ? extends T2, ? extends T3>> unzipper)

Description copied from interface: Traversable

Unzips the elements of this Traversable by mapping each element to a triple and splitting them into three separate Traversable collections.

Specified by:

unzip3 in interface Set<T>

Specified by:

unzip3 in interface SortedSet<T>

Specified by:

unzip3 in interface Traversable<T>

Type Parameters:

T1 - type of the first element in the resulting triples

T2 - type of the second element in the resulting triples

T3 - type of the third element in the resulting triples

Parameters:

unzipper - a function that maps elements of this Traversable to triples

Returns:

a Tuple3 containing three Traversable collections with the split elements

zip

default <U> TreeSet<Tuple2<T,U>> zip(@NonNull Iterable<? extends U> that)

Description copied from interface: Traversable

Returns a Traversable formed by pairing elements of this Traversable with elements of another Iterable. Pairing stops when either collection runs out of elements; any remaining elements in the longer collection are ignored.

The length of the resulting Traversable is the minimum of the lengths of this Traversable and that.

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 elements in the second half of each pair

Parameters:

that - an Iterable providing the second element of each pair

Returns:

a new Traversable containing pairs of corresponding elements

zipWith

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

Description copied from interface: Traversable

Returns a Traversable by combining elements of this Traversable with elements of another Iterable using a mapping function. Pairing stops when either collection runs out of elements.

The length of the resulting Traversable is the minimum of the lengths of this Traversable and that.

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 elements in the second parameter of the mapper

R - the type of elements in the resulting Traversable

Parameters:

that - an Iterable providing the second parameter of the mapper

mapper - a function that combines elements from this and that into a new element

Returns:

a new Traversable containing mapped elements

zipAll

default <U> TreeSet<Tuple2<T,U>> zipAll(@NonNull Iterable<? extends U> that,
 T thisElem,
 U thatElem)

Description copied from interface: Traversable

Returns a Traversable formed by pairing elements of this Traversable with elements of another Iterable, filling in placeholder elements when one collection is shorter than the other.

The length of the resulting Traversable is the maximum of the lengths of this Traversable and that.

If this Traversable is shorter than that, thisElem is used as a filler. Conversely, if that is shorter, thatElem is used.

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 elements in the second half of each pair

Parameters:

that - an Iterable providing the second element of each pair

thisElem - the element used to fill missing values if this Traversable is shorter than that

thatElem - the element used to fill missing values if that is shorter than this Traversable

Returns:

a new Traversable containing pairs of elements, including fillers as needed

zipWithIndex

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

Description copied from interface: Traversable

Zips this Traversable with its indices, starting at 0.

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 each element paired with its index

zipWithIndex

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

Description copied from interface: Traversable

Zips this Traversable with its indices and maps the resulting pairs using the provided mapper.

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 elements in the resulting Traversable

Parameters:

mapper - a function mapping an element and its index to a new element

Returns:

a new Traversable containing the mapped elements