Class BitSet<T>
- java.lang.Object
-
- io.vavr.collection.BitSet<T>
-
- All Implemented Interfaces:
Foldable<T>
,Ordered<T>
,Set<T>
,SortedSet<T>
,Traversable<T>
,Function1<T,java.lang.Boolean>
,Iterable<T>
,Value<T>
,java.io.Serializable
,java.lang.Iterable<T>
,java.util.function.Function<T,java.lang.Boolean>
public abstract class BitSet<T> extends java.lang.Object implements SortedSet<T>, java.io.Serializable
An immutableBitSet
implementation.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
BitSet.Builder<T>
-
Method Summary
Modifier and Type Method Description abstract BitSet<T>
add(T element)
Add the given element to this set, if it is not already contained.abstract BitSet<T>
addAll(java.lang.Iterable<? extends T> elements)
Adds all of the given elements to this set, if not already contained.<R> SortedSet<R>
collect(PartialFunction<? super T,? extends R> partialFunction)
Collects all elements that are in the domain of the givenpartialFunction
by mapping the elements to typeR
.static java.util.stream.Collector<java.lang.Integer,java.util.ArrayList<java.lang.Integer>,BitSet<java.lang.Integer>>
collector()
Returns aCollector
which may be used in conjunction withStream.collect(java.util.stream.Collector)
to obtain aBitSet
.BitSet<T>
diff(Set<? extends T> elements)
Calculates the difference between this set and another set.BitSet<T>
distinct()
Returns a new version of this which contains no duplicates.abstract BitSet<T>
distinctBy(java.util.Comparator<? super T> comparator)
Returns a new version of this which contains no duplicates.abstract <U> BitSet<T>
distinctBy(java.util.function.Function<? super T,? extends U> keyExtractor)
Returns a new version of this which contains no duplicates.abstract BitSet<T>
drop(int n)
Drops the first n elements of this or all elements, if this length < n.abstract BitSet<T>
dropRight(int n)
Drops the last n elements of this or all elements, if this length < n.BitSet<T>
dropUntil(java.util.function.Predicate<? super T> predicate)
Drops elements until the predicate holds for the current element.abstract BitSet<T>
dropWhile(java.util.function.Predicate<? super T> predicate)
Drops elements while the predicate holds for the current element.static BitSet<java.lang.Integer>
empty()
static BitSet<java.lang.Integer>
fill(int n, java.util.function.Supplier<java.lang.Integer> s)
Returns a BitSet containingn
values supplied by a given Suppliers
.abstract BitSet<T>
filter(java.util.function.Predicate<? super T> predicate)
Returns a new traversable consisting of all elements which satisfy the given predicate.abstract BitSet<T>
filterNot(java.util.function.Predicate<? super T> predicate)
Returns a new traversable consisting of all elements which do not satisfy the given predicate.<U> SortedSet<U>
flatMap(java.util.Comparator<? super U> comparator, java.util.function.Function<? super T,? extends java.lang.Iterable<? extends U>> mapper)
Same asSortedSet.flatMap(Function)
but using a specific comparator for values of the codomain of the givenmapper
.<U> SortedSet<U>
flatMap(java.util.function.Function<? super T,? extends java.lang.Iterable<? extends U>> mapper)
FlatMaps this Traversable.<U> U
foldRight(U zero, java.util.function.BiFunction<? super T,? super U,? extends U> f)
Folds this elements from the right, starting withzero
and successively callingcombine
.abstract <C> Map<C,BitSet<T>>
groupBy(java.util.function.Function<? super T,? extends C> classifier)
Groups this elements by classifying the elements.Iterator<BitSet<T>>
grouped(int size)
Groups thisTraversable
into fixed size blocks.boolean
hasDefiniteSize()
Checks if this Traversable is known to have a finite size.abstract BitSet<T>
init()
Dual of Traversable.tail(), returning all elements except the last.Option<BitSet<T>>
initOption()
Dual of Traversable.tailOption(), returning all elements except the last asOption
.abstract BitSet<T>
intersect(Set<? extends T> elements)
Computes the intersection between this set and another set.boolean
isAsync()
AnBitSet
's value is computed synchronously.boolean
isLazy()
AnBitSet
's value is computed eagerly.boolean
isTraversableAgain()
Checks if this Traversable can be repeatedly traversed.T
last()
Dual of Traversable.head(), returning the last element.<U> SortedSet<U>
map(java.util.Comparator<? super U> comparator, java.util.function.Function<? super T,? extends U> mapper)
Same asSortedSet.map(Function)
but using a specific comparator for values of the codomain of the givenmapper
.<U> SortedSet<U>
map(java.util.function.Function<? super T,? extends U> mapper)
Maps the elements of thisTraversable
to elements of a new type preserving their order, if any.static BitSet<java.lang.Integer>
of(java.lang.Integer value)
static BitSet<java.lang.Integer>
of(java.lang.Integer... values)
static BitSet<java.lang.Boolean>
ofAll(boolean... elements)
Creates a BitSet from boolean values.static BitSet<java.lang.Byte>
ofAll(byte... elements)
Creates a BitSet from byte values.static BitSet<java.lang.Character>
ofAll(char... elements)
Creates a BitSet from char values.static BitSet<java.lang.Integer>
ofAll(int... elements)
Creates a BitSet from int values.static BitSet<java.lang.Long>
ofAll(long... elements)
Creates a BitSet from long values.static BitSet<java.lang.Short>
ofAll(short... elements)
Creates a BitSet from short values.static BitSet<java.lang.Integer>
ofAll(java.lang.Iterable<java.lang.Integer> values)
static BitSet<java.lang.Integer>
ofAll(java.util.stream.Stream<java.lang.Integer> javaStream)
abstract Tuple2<BitSet<T>,BitSet<T>>
partition(java.util.function.Predicate<? super T> predicate)
Creates a partition of thisTraversable
by splitting this elements in two in distinct traversables according to a predicate.BitSet<T>
peek(java.util.function.Consumer<? super T> action)
Performs the givenaction
on the first element if this is an eager implementation.static BitSet<java.lang.Character>
range(char from, char toExclusive)
static BitSet<java.lang.Integer>
range(int from, int toExclusive)
Creates a BitSet of int numbers starting fromfrom
, extending totoExclusive - 1
.static BitSet<java.lang.Long>
range(long from, long toExclusive)
static BitSet<java.lang.Character>
rangeBy(char from, char toExclusive, int step)
static BitSet<java.lang.Integer>
rangeBy(int from, int toExclusive, int step)
Creates a BitSet of int numbers starting fromfrom
, extending totoExclusive - 1
, withstep
.static BitSet<java.lang.Long>
rangeBy(long from, long toExclusive, long step)
static BitSet<java.lang.Character>
rangeClosed(char from, char toInclusive)
static BitSet<java.lang.Integer>
rangeClosed(int from, int toInclusive)
Creates a BitSet of int numbers starting fromfrom
, extending totoInclusive
.static BitSet<java.lang.Long>
rangeClosed(long from, long toInclusive)
static BitSet<java.lang.Character>
rangeClosedBy(char from, char toInclusive, int step)
static BitSet<java.lang.Integer>
rangeClosedBy(int from, int toInclusive, int step)
Creates a BitSet of int numbers starting fromfrom
, extending totoInclusive
, withstep
.static BitSet<java.lang.Long>
rangeClosedBy(long from, long toInclusive, long step)
abstract BitSet<T>
reject(java.util.function.Predicate<? super T> predicate)
Deprecated.abstract BitSet<T>
remove(T element)
Removes a specific element from this set, if present.abstract BitSet<T>
removeAll(java.lang.Iterable<? extends T> elements)
Removes all of the given elements from this set, if present.BitSet<T>
replace(T currentElement, T newElement)
Replaces the first occurrence (if exists) of the given currentElement with newElement.BitSet<T>
replaceAll(T currentElement, T newElement)
Replaces all occurrences of the given currentElement with newElement.BitSet<T>
retainAll(java.lang.Iterable<? extends T> elements)
Keeps all occurrences of the given elements from this.abstract BitSet<T>
scan(T zero, java.util.function.BiFunction<? super T,? super T,? extends T> operation)
Computes a prefix scan of the elements of the collection.<U> Set<U>
scanLeft(U zero, java.util.function.BiFunction<? super U,? super T,? extends U> operation)
Produces a collection containing cumulative results of applying the operator going left to right.<U> Set<U>
scanRight(U zero, java.util.function.BiFunction<? super T,? super U,? extends U> operation)
Produces a collection containing cumulative results of applying the operator going right to left.abstract Iterator<BitSet<T>>
slideBy(java.util.function.Function<? super T,?> classifier)
Slides a non-overlapping window of a variable size over thisTraversable
.Iterator<BitSet<T>>
sliding(int size)
Slides a window of a specificsize
and step size 1 over thisTraversable
by callingTraversable.sliding(int, int)
.abstract Iterator<BitSet<T>>
sliding(int size, int step)
Slides a window of a specificsize
andstep
size over thisTraversable
.abstract Tuple2<BitSet<T>,BitSet<T>>
span(java.util.function.Predicate<? super T> predicate)
Returns a tuple where the first element is the longest prefix of elements that satisfy the givenpredicate
and the second element is the remainder.java.lang.String
stringPrefix()
Returns the name of this Value type, which is used by toString().static BitSet<java.lang.Integer>
tabulate(int n, java.util.function.Function<java.lang.Integer,java.lang.Integer> f)
Returns a BitSet containingn
values of a given Functionf
over a range of integer values from 0 ton - 1
.BitSet<T>
tail()
Drops the first element of a non-empty Traversable.Option<BitSet<T>>
tailOption()
Drops the first element of a non-empty Traversable and returns anOption
.abstract BitSet<T>
take(int n)
Takes the first n elements of this or all elements, if this length < n.abstract BitSet<T>
takeRight(int n)
Takes the last n elements of this or all elements, if this length < n.BitSet<T>
takeUntil(java.util.function.Predicate<? super T> predicate)
Takes elements until the predicate holds for the current element.abstract BitSet<T>
takeWhile(java.util.function.Predicate<? super T> predicate)
Takes elements while the predicate holds for the current element.java.util.SortedSet<T>
toJavaSet()
Converts this VavrSet
to ajava.util.Set
while preserving characteristics like insertion order (LinkedHashSet
) and sort order (SortedSet
).BitSet<T>
union(Set<? extends T> elements)
Adds all of the elements ofthat
set to this set, if not already present.<T1,T2>
Tuple2<TreeSet<T1>,TreeSet<T2>>unzip(java.util.function.Function<? super T,Tuple2<? extends T1,? extends T2>> unzipper)
Unzips this elements by mapping this elements to pairs which are subsequently split into two distinct sets.<T1,T2,T3>
Tuple3<TreeSet<T1>,TreeSet<T2>,TreeSet<T3>>unzip3(java.util.function.Function<? super T,Tuple3<? extends T1,? extends T2,? extends T3>> unzipper)
Unzips this elements by mapping this elements to triples which are subsequently split into three distinct sets.static BitSet.Builder<java.lang.Byte>
withBytes()
static BitSet.Builder<java.lang.Character>
withCharacters()
static <T extends java.lang.Enum<T>>
BitSet.Builder<T>withEnum(java.lang.Class<T> enumClass)
static BitSet.Builder<java.lang.Long>
withLongs()
static <T> BitSet.Builder<T>
withRelations(Function1<java.lang.Integer,T> fromInt, Function1<T,java.lang.Integer> toInt)
static BitSet.Builder<java.lang.Short>
withShorts()
<U> TreeSet<Tuple2<T,U>>
zip(java.lang.Iterable<? extends U> that)
Returns a traversable formed from this traversable and another Iterable collection by combining corresponding elements in pairs.<U> TreeSet<Tuple2<T,U>>
zipAll(java.lang.Iterable<? extends U> that, T thisElem, U thatElem)
Returns a traversable formed from this traversable and another Iterable by combining corresponding elements in pairs.<U,R>
TreeSet<R>zipWith(java.lang.Iterable<? extends U> that, java.util.function.BiFunction<? super T,? super U,? extends R> mapper)
Returns a traversable formed from this traversable and another Iterable collection by mapping elements.TreeSet<Tuple2<T,java.lang.Integer>>
zipWithIndex()
Zips this traversable with its indices.<U> TreeSet<U>
zipWithIndex(java.util.function.BiFunction<? super T,? super java.lang.Integer,? extends U> mapper)
Returns a traversable formed from this traversable and another Iterable collection by mapping elements.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
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.Traversable
arrangeBy, average, containsAll, count, equals, existsUnique, find, findLast, fold, foldLeft, forEachWithIndex, get, hashCode, head, headOption, isEmpty, isSequential, isSingleValued, lastOption, max, maxBy, maxBy, min, minBy, minBy, mkCharSeq, mkCharSeq, mkCharSeq, mkString, mkString, mkString, nonEmpty, product, reduce, reduceLeft, reduceLeftOption, reduceOption, 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
-
-
-
-
Method Detail
-
withRelations
public static <T> BitSet.Builder<T> withRelations(Function1<java.lang.Integer,T> fromInt, Function1<T,java.lang.Integer> toInt)
-
withEnum
public static <T extends java.lang.Enum<T>> BitSet.Builder<T> withEnum(java.lang.Class<T> enumClass)
-
withCharacters
public static BitSet.Builder<java.lang.Character> withCharacters()
-
withBytes
public static BitSet.Builder<java.lang.Byte> withBytes()
-
withLongs
public static BitSet.Builder<java.lang.Long> withLongs()
-
withShorts
public static BitSet.Builder<java.lang.Short> withShorts()
-
collector
public static java.util.stream.Collector<java.lang.Integer,java.util.ArrayList<java.lang.Integer>,BitSet<java.lang.Integer>> collector()
Returns aCollector
which may be used in conjunction withStream.collect(java.util.stream.Collector)
to obtain aBitSet
.- Returns:
- A
BitSet
Collector.
-
empty
public static BitSet<java.lang.Integer> empty()
-
of
public static BitSet<java.lang.Integer> of(java.lang.Integer value)
-
of
public static BitSet<java.lang.Integer> of(java.lang.Integer... values)
-
tabulate
public static BitSet<java.lang.Integer> tabulate(int n, java.util.function.Function<java.lang.Integer,java.lang.Integer> f)
Returns a BitSet containingn
values of a given Functionf
over a range of integer values from 0 ton - 1
.- Parameters:
n
- The number of elements in the BitSetf
- The Function computing element values- Returns:
- A BitSet consisting of elements
f(0),f(1), ..., f(n - 1)
- Throws:
java.lang.NullPointerException
- iff
is null
-
fill
public static BitSet<java.lang.Integer> fill(int n, java.util.function.Supplier<java.lang.Integer> s)
Returns a BitSet containingn
values supplied by a given Suppliers
.- Parameters:
n
- The number of elements in the BitSets
- The Supplier computing element values- Returns:
- A BitSet of size
n
, where each element contains the result supplied bys
. - Throws:
java.lang.NullPointerException
- ifs
is null
-
ofAll
public static BitSet<java.lang.Integer> ofAll(java.lang.Iterable<java.lang.Integer> values)
-
ofAll
public static BitSet<java.lang.Integer> ofAll(java.util.stream.Stream<java.lang.Integer> javaStream)
-
ofAll
public static BitSet<java.lang.Boolean> ofAll(boolean... elements)
Creates a BitSet from boolean values.- Parameters:
elements
- boolean values- Returns:
- A new BitSet of boolean values
- Throws:
java.lang.NullPointerException
- if elements is null
-
ofAll
public static BitSet<java.lang.Byte> ofAll(byte... elements)
Creates a BitSet from byte values.- Parameters:
elements
- byte values- Returns:
- A new BitSet of byte values
- Throws:
java.lang.NullPointerException
- if elements is null
-
ofAll
public static BitSet<java.lang.Character> ofAll(char... elements)
Creates a BitSet from char values.- Parameters:
elements
- char values- Returns:
- A new BitSet of char values
- Throws:
java.lang.NullPointerException
- if elements is null
-
ofAll
public static BitSet<java.lang.Integer> ofAll(int... elements)
Creates a BitSet from int values.- Parameters:
elements
- int values- Returns:
- A new BitSet of int values
- Throws:
java.lang.NullPointerException
- if elements is null
-
ofAll
public static BitSet<java.lang.Long> ofAll(long... elements)
Creates a BitSet from long values.- Parameters:
elements
- long values- Returns:
- A new BitSet of long values
- Throws:
java.lang.NullPointerException
- if elements is null
-
ofAll
public static BitSet<java.lang.Short> ofAll(short... elements)
Creates a BitSet from short values.- Parameters:
elements
- short values- Returns:
- A new BitSet of short values
- Throws:
java.lang.NullPointerException
- if elements is null
-
range
public static BitSet<java.lang.Integer> range(int from, int toExclusive)
Creates a BitSet of int numbers starting fromfrom
, extending totoExclusive - 1
.- Parameters:
from
- the first numbertoExclusive
- the last number + 1- Returns:
- a range of int values as specified or the empty range if
from >= toExclusive
-
range
public static BitSet<java.lang.Character> range(char from, char toExclusive)
-
range
public static BitSet<java.lang.Long> range(long from, long toExclusive)
-
rangeBy
public static BitSet<java.lang.Integer> rangeBy(int from, int toExclusive, int step)
Creates a BitSet of int numbers starting fromfrom
, extending totoExclusive - 1
, withstep
.- Parameters:
from
- the first numbertoExclusive
- the last number + 1step
- the step- Returns:
- a range of long values as specified or the empty range if
from >= toInclusive
andstep > 0
or
from <= toInclusive
andstep < 0
- Throws:
java.lang.IllegalArgumentException
- ifstep
is zero
-
rangeBy
public static BitSet<java.lang.Character> rangeBy(char from, char toExclusive, int step)
-
rangeBy
public static BitSet<java.lang.Long> rangeBy(long from, long toExclusive, long step)
-
rangeClosed
public static BitSet<java.lang.Integer> rangeClosed(int from, int toInclusive)
Creates a BitSet of int numbers starting fromfrom
, extending totoInclusive
.- Parameters:
from
- the first numbertoInclusive
- the last number- Returns:
- a range of int values as specified or the empty range if
from > toInclusive
-
rangeClosed
public static BitSet<java.lang.Character> rangeClosed(char from, char toInclusive)
-
rangeClosed
public static BitSet<java.lang.Long> rangeClosed(long from, long toInclusive)
-
rangeClosedBy
public static BitSet<java.lang.Integer> rangeClosedBy(int from, int toInclusive, int step)
Creates a BitSet of int numbers starting fromfrom
, extending totoInclusive
, withstep
.- Parameters:
from
- the first numbertoInclusive
- the last numberstep
- the step- Returns:
- a range of int values as specified or the empty range if
from > toInclusive
andstep > 0
or
from < toInclusive
andstep < 0
- Throws:
java.lang.IllegalArgumentException
- ifstep
is zero
-
rangeClosedBy
public static BitSet<java.lang.Character> rangeClosedBy(char from, char toInclusive, int step)
-
rangeClosedBy
public static BitSet<java.lang.Long> rangeClosedBy(long from, long toInclusive, long step)
-
add
public abstract BitSet<T> add(T element)
Description copied from interface:Set
Add the given element to this set, if it is not already contained.
-
addAll
public abstract BitSet<T> addAll(java.lang.Iterable<? extends T> elements)
Description copied from interface:Set
Adds all of the given elements to this set, if not already contained.
-
collect
public final <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 givenpartialFunction
by mapping the elements to typeR
.More specifically, for each of this elements in iteration order first it is checked
If the elements makes it through that filter, the mapped instance is added to the result collectionpartialFunction.isDefinedAt(element)
Note:If thisR newElement = partialFunction.apply(element)
Traversable
is ordered (i.e. extendsOrdered
, the caller ofcollect
has to ensure that the elements are comparable (i.e. extendComparable
).- Specified by:
collect
in interfaceSet<T>
- Specified by:
collect
in interfaceSortedSet<T>
- Specified by:
collect
in interfaceTraversable<T>
- Type Parameters:
R
- The new element type- Parameters:
partialFunction
- A function that is not necessarily defined of all elements of this traversable.- Returns:
- A new
Traversable
instance containing elements of typeR
-
diff
public final 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)
.
-
distinct
public final BitSet<T> distinct()
Description copied from interface:Traversable
Returns a new version of this which contains no duplicates. Elements are compared usingequals
.
-
distinctBy
public abstract BitSet<T> distinctBy(java.util.Comparator<? super T> comparator)
Description copied from interface:Traversable
Returns a new version of this which contains no duplicates. Elements are compared using the givencomparator
.- Specified by:
distinctBy
in interfaceSet<T>
- Specified by:
distinctBy
in interfaceSortedSet<T>
- Specified by:
distinctBy
in interfaceTraversable<T>
- Parameters:
comparator
- A comparator- Returns:
- a new
Traversable
containing this elements without duplicates
-
distinctBy
public abstract <U> BitSet<T> distinctBy(java.util.function.Function<? super T,? extends U> keyExtractor)
Description copied from interface:Traversable
Returns a new version of this which contains no duplicates. Elements mapped to keys which are compared usingequals
.The elements of the result are determined in the order of their occurrence - first match wins.
- Specified by:
distinctBy
in interfaceSet<T>
- Specified by:
distinctBy
in interfaceSortedSet<T>
- Specified by:
distinctBy
in interfaceTraversable<T>
- Type Parameters:
U
- key type- Parameters:
keyExtractor
- A key extractor- Returns:
- a new
Traversable
containing this elements without duplicates
-
drop
public abstract 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 interfaceSet<T>
- Specified by:
drop
in interfaceSortedSet<T>
- Specified by:
drop
in interfaceTraversable<T>
- Parameters:
n
- The number of elements to drop.- Returns:
- a new instance consisting of all elements of this except the first n ones, or else the empty instance, if this has less than n elements.
-
dropRight
public abstract 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 interfaceSet<T>
- Specified by:
dropRight
in interfaceSortedSet<T>
- Specified by:
dropRight
in interfaceTraversable<T>
- Parameters:
n
- The number of elements to drop.- Returns:
- a new instance consisting of all elements of this except the last n ones, or else the empty instance, if this has less than n elements.
-
dropUntil
public final BitSet<T> dropUntil(java.util.function.Predicate<? super T> predicate)
Description copied from interface:Traversable
Drops elements until the predicate holds for the current element.- Specified by:
dropUntil
in interfaceSet<T>
- Specified by:
dropUntil
in interfaceSortedSet<T>
- Specified by:
dropUntil
in interfaceTraversable<T>
- Parameters:
predicate
- A condition tested subsequently for this elements.- Returns:
- a new instance consisting of all elements starting from the first one which does satisfy the given predicate.
-
dropWhile
public abstract BitSet<T> dropWhile(java.util.function.Predicate<? super T> predicate)
Description copied from interface:Traversable
Drops elements while the predicate holds for the current element.Note: This is essentially the same as
dropUntil(predicate.negate())
. It is intended to be used with method references, which cannot be negated directly.- Specified by:
dropWhile
in interfaceSet<T>
- Specified by:
dropWhile
in interfaceSortedSet<T>
- Specified by:
dropWhile
in interfaceTraversable<T>
- Parameters:
predicate
- A condition tested subsequently for this elements.- Returns:
- a new instance consisting of all elements starting from the first one which does not satisfy the given predicate.
-
filter
public abstract BitSet<T> filter(java.util.function.Predicate<? super T> predicate)
Description copied from interface:Traversable
Returns a new traversable consisting of all elements which satisfy the given predicate.
-
filterNot
public abstract BitSet<T> filterNot(java.util.function.Predicate<? super T> predicate)
Description copied from interface:Traversable
Returns a new traversable consisting of all elements which do not satisfy the given predicate.The default implementation is equivalent to
filter(predicate.negate()
-
reject
@Deprecated public abstract BitSet<T> reject(java.util.function.Predicate<? super T> predicate)
Deprecated.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()
-
flatMap
public final <U> SortedSet<U> flatMap(java.util.Comparator<? super U> comparator, java.util.function.Function<? super T,? extends java.lang.Iterable<? extends U>> mapper)
Description copied from interface:SortedSet
Same asSortedSet.flatMap(Function)
but using a specific comparator for values of the codomain of the givenmapper
.
-
flatMap
public final <U> SortedSet<U> flatMap(java.util.function.Function<? super T,? extends java.lang.Iterable<? extends U>> mapper)
Description copied from interface:Traversable
FlatMaps this Traversable.
-
foldRight
public final <U> U foldRight(U zero, java.util.function.BiFunction<? super T,? super U,? extends U> f)
Description copied from interface:Traversable
Folds this elements from the right, starting withzero
and successively callingcombine
.Example:
// = "!cba" List("a", "b", "c").foldRight("!", (x, xs) -> xs + x)
-
groupBy
public abstract <C> Map<C,BitSet<T>> groupBy(java.util.function.Function<? super T,? extends C> classifier)
Description copied from interface:Traversable
Groups this elements by classifying the elements.- Specified by:
groupBy
in interfaceSet<T>
- Specified by:
groupBy
in interfaceSortedSet<T>
- Specified by:
groupBy
in interfaceTraversable<T>
- Type Parameters:
C
- classified class type- Parameters:
classifier
- A function which classifies elements into classes- Returns:
- A Map containing the grouped elements
- See Also:
Traversable.arrangeBy(Function)
-
grouped
public final Iterator<BitSet<T>> grouped(int size)
Description copied from interface:Traversable
Groups thisTraversable
into fixed size blocks.Let length be the length of this Iterable. Then grouped is defined as follows:
- If
this.isEmpty()
, the resultingIterator
is empty. - If
size <= length
, the resultingIterator
will containlength / size
blocks of sizesize
and maybe a non-empty block of sizelength % size
, if there are remaining elements. - If
size > length
, the resultingIterator
will contain one block of sizelength
.
[].grouped(1) = [] [].grouped(0) throws [].grouped(-1) throws [1,2,3,4].grouped(2) = [[1,2],[3,4]] [1,2,3,4,5].grouped(2) = [[1,2],[3,4],[5]] [1,2,3,4].grouped(5) = [[1,2,3,4]]
grouped(int)
is a special case of Traversable.sliding(int, int), i.e.grouped(size)
is the same assliding(size, size)
. - If
-
hasDefiniteSize
public final 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 interfaceTraversable<T>
- Returns:
- true, if this Traversable is known to have a finite size, false otherwise.
-
init
public abstract BitSet<T> init()
Description copied from interface:Traversable
Dual of Traversable.tail(), returning all elements except the last.
-
initOption
public final Option<BitSet<T>> initOption()
Description copied from interface:Traversable
Dual of Traversable.tailOption(), returning all elements except the last asOption
.- Specified by:
initOption
in interfaceSet<T>
- Specified by:
initOption
in interfaceSortedSet<T>
- Specified by:
initOption
in interfaceTraversable<T>
- Returns:
Some(traversable)
orNone
if this is empty.
-
isAsync
public final boolean isAsync()
AnBitSet
's value is computed synchronously.
-
isTraversableAgain
public final 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 interfaceTraversable<T>
- Returns:
- true, if this Traversable is known to be traversable repeatedly, false otherwise.
-
isLazy
public final boolean isLazy()
AnBitSet
's value is computed eagerly.
-
intersect
public abstract 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)
.
-
last
public final T last()
Description copied from interface:Traversable
Dual of Traversable.head(), returning the last element.- Specified by:
last
in interfaceTraversable<T>
- Returns:
- the last element.
-
partition
public abstract Tuple2<BitSet<T>,BitSet<T>> partition(java.util.function.Predicate<? super T> predicate)
Description copied from interface:Traversable
Creates a partition of thisTraversable
by splitting this elements in two in distinct traversables according to a predicate.- Specified by:
partition
in interfaceSet<T>
- Specified by:
partition
in interfaceSortedSet<T>
- Specified by:
partition
in interfaceTraversable<T>
- Parameters:
predicate
- A predicate which classifies an element if it is in the first or the second traversable.- Returns:
- A disjoint union of two traversables. The first
Traversable
contains all elements that satisfy the givenpredicate
, the secondTraversable
contains all elements that don't. The original order of elements is preserved.
-
peek
public final BitSet<T> peek(java.util.function.Consumer<? super T> action)
Description copied from interface:Value
Performs the givenaction
on the first element if this is an eager implementation. Performs the givenaction
on all elements (the first immediately, successive deferred), if this is a lazy implementation.
-
stringPrefix
public final java.lang.String stringPrefix()
Description copied from interface:Value
Returns the name of this Value type, which is used by toString().- Specified by:
stringPrefix
in interfaceValue<T>
- Returns:
- This type name.
-
map
public final <U> SortedSet<U> map(java.util.Comparator<? super U> comparator, java.util.function.Function<? super T,? extends U> mapper)
Description copied from interface:SortedSet
Same asSortedSet.map(Function)
but using a specific comparator for values of the codomain of the givenmapper
.
-
map
public final <U> SortedSet<U> map(java.util.function.Function<? super T,? extends U> mapper)
Description copied from interface:Traversable
Maps the elements of thisTraversable
to elements of a new type preserving their order, if any.
-
remove
public abstract BitSet<T> remove(T element)
Description copied from interface:Set
Removes a specific element from this set, if present.
-
removeAll
public abstract BitSet<T> removeAll(java.lang.Iterable<? extends T> elements)
Description copied from interface:Set
Removes all of the given elements from this set, if present.
-
replace
public final 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 interfaceSet<T>
- Specified by:
replace
in interfaceSortedSet<T>
- Specified by:
replace
in interfaceTraversable<T>
- Parameters:
currentElement
- An element to be substituted.newElement
- A replacement for currentElement.- Returns:
- a Traversable containing all elements of this where the first occurrence of currentElement is replaced with newElement.
-
replaceAll
public final 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 interfaceSet<T>
- Specified by:
replaceAll
in interfaceSortedSet<T>
- Specified by:
replaceAll
in interfaceTraversable<T>
- Parameters:
currentElement
- An element to be substituted.newElement
- A replacement for currentElement.- Returns:
- a Traversable containing all elements of this where all occurrences of currentElement are replaced with newElement.
-
retainAll
public final BitSet<T> retainAll(java.lang.Iterable<? extends T> elements)
Description copied from interface:Traversable
Keeps all occurrences of the given elements from this.
-
scan
public abstract BitSet<T> scan(T zero, java.util.function.BiFunction<? super T,? super T,? extends T> operation)
Description copied from interface:Traversable
Computes a prefix scan of the elements of the collection. Note: The neutral element z may be applied more than once.- Specified by:
scan
in interfaceSet<T>
- Specified by:
scan
in interfaceSortedSet<T>
- Specified by:
scan
in interfaceTraversable<T>
- Parameters:
zero
- neutral element for the operator opoperation
- the associative operator for the scan- Returns:
- a new traversable collection containing the prefix scan of the elements in this traversable collection
-
scanLeft
public final <U> Set<U> scanLeft(U zero, java.util.function.BiFunction<? super U,? super T,? extends U> operation)
Description copied from interface:Traversable
Produces a collection containing cumulative results of applying the operator going left to right. Note: will not terminate for infinite-sized collections. Note: might return different results for different runs, unless the underlying collection type is ordered.- Specified by:
scanLeft
in interfaceSet<T>
- Specified by:
scanLeft
in interfaceSortedSet<T>
- Specified by:
scanLeft
in interfaceTraversable<T>
- Type Parameters:
U
- the type of the elements in the resulting collection- Parameters:
zero
- the initial valueoperation
- the binary operator applied to the intermediate result and the element- Returns:
- collection with intermediate results
-
scanRight
public final <U> Set<U> scanRight(U zero, java.util.function.BiFunction<? super T,? super U,? extends U> operation)
Description copied from interface:Traversable
Produces a collection containing cumulative results of applying the operator going right to left. The head of the collection is the last cumulative result. Note: will not terminate for infinite-sized collections. Note: might return different results for different runs, unless the underlying collection type is ordered.- Specified by:
scanRight
in interfaceSet<T>
- Specified by:
scanRight
in interfaceSortedSet<T>
- Specified by:
scanRight
in interfaceTraversable<T>
- Type Parameters:
U
- the type of the elements in the resulting collection- Parameters:
zero
- the initial valueoperation
- the binary operator applied to the intermediate result and the element- Returns:
- collection with intermediate results
-
slideBy
public abstract Iterator<BitSet<T>> slideBy(java.util.function.Function<? super T,?> classifier)
Description copied from interface:Traversable
Slides a non-overlapping window of a variable size over thisTraversable
.Each window contains elements with the same class, as determined by
classifier
. Two consecutive values in thisTraversable
will be in the same window only ifclassifier
returns equal values for them. Otherwise, the values will constitute the last element of the previous window and the first element of the next window.Examples:
[].slideBy(Function.identity()) = [] [1,2,3,4,4,5].slideBy(Function.identity()) = [[1],[2],[3],[4,4],[5]] [1,2,3,10,12,5,7,20,29].slideBy(x -> x/10) = [[1,2,3],[10,12],[5,7],[20,29]]
-
sliding
public final Iterator<BitSet<T>> sliding(int size)
Description copied from interface:Traversable
Slides a window of a specificsize
and step size 1 over thisTraversable
by callingTraversable.sliding(int, int)
.
-
sliding
public abstract Iterator<BitSet<T>> sliding(int size, int step)
Description copied from interface:Traversable
Slides a window of a specificsize
andstep
size over thisTraversable
.Examples:
[].sliding(1,1) = [] [1,2,3,4,5].sliding(2,3) = [[1,2],[4,5]] [1,2,3,4,5].sliding(2,4) = [[1,2],[5]] [1,2,3,4,5].sliding(2,5) = [[1,2]] [1,2,3,4].sliding(5,3) = [[1,2,3,4],[4]]
-
span
public abstract Tuple2<BitSet<T>,BitSet<T>> span(java.util.function.Predicate<? super T> predicate)
Description copied from interface:Traversable
Returns a tuple where the first element is the longest prefix of elements that satisfy the givenpredicate
and the second element is the remainder.
-
tail
public final BitSet<T> tail()
Description copied from interface:Traversable
Drops the first element of a non-empty Traversable.
-
tailOption
public final Option<BitSet<T>> tailOption()
Description copied from interface:Traversable
Drops the first element of a non-empty Traversable and returns anOption
.- Specified by:
tailOption
in interfaceSet<T>
- Specified by:
tailOption
in interfaceSortedSet<T>
- Specified by:
tailOption
in interfaceTraversable<T>
- Returns:
Some(traversable)
orNone
if this is empty.
-
take
public abstract 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 ifn < 0
orn > length()
.In the case of
n < 0
the empty instance is returned, in the case ofn > length()
this is returned.
-
takeRight
public abstract 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 ifn < 0
orn > length()
.In the case of
n < 0
the empty instance is returned, in the case ofn > length()
this is returned.- Specified by:
takeRight
in interfaceSet<T>
- Specified by:
takeRight
in interfaceSortedSet<T>
- Specified by:
takeRight
in interfaceTraversable<T>
- Parameters:
n
- The number of elements to take.- Returns:
- A new instance consisting of the last n elements of this or all elements, if this has less than n elements.
-
takeUntil
public final BitSet<T> takeUntil(java.util.function.Predicate<? super T> predicate)
Description copied from interface:Traversable
Takes elements until the predicate holds for the current element.Note: This is essentially the same as
takeWhile(predicate.negate())
. It is intended to be used with method references, which cannot be negated directly.- Specified by:
takeUntil
in interfaceSet<T>
- Specified by:
takeUntil
in interfaceSortedSet<T>
- Specified by:
takeUntil
in interfaceTraversable<T>
- Parameters:
predicate
- A condition tested subsequently for this elements.- Returns:
- a new instance consisting of all elements before the first one which does satisfy the given predicate.
-
takeWhile
public abstract BitSet<T> takeWhile(java.util.function.Predicate<? super T> predicate)
Description copied from interface:Traversable
Takes elements while the predicate holds for the current element.- Specified by:
takeWhile
in interfaceSet<T>
- Specified by:
takeWhile
in interfaceSortedSet<T>
- Specified by:
takeWhile
in interfaceTraversable<T>
- Parameters:
predicate
- A condition tested subsequently for the contained elements.- Returns:
- a new instance consisting of all elements before the first one which does not satisfy the given predicate.
-
toJavaSet
public final java.util.SortedSet<T> toJavaSet()
Description copied from interface:Set
Converts this VavrSet
to ajava.util.Set
while preserving characteristics like insertion order (LinkedHashSet
) and sort order (SortedSet
).
-
union
public final BitSet<T> union(Set<? extends T> elements)
Description copied from interface:Set
Adds all of the elements ofthat
set to this set, if not already present.See also
Set.addAll(Iterable)
.
-
unzip
public final <T1,T2> Tuple2<TreeSet<T1>,TreeSet<T2>> unzip(java.util.function.Function<? super T,Tuple2<? extends T1,? extends T2>> unzipper)
Description copied from interface:Traversable
Unzips this elements by mapping this elements to pairs which are subsequently split into two distinct sets.- Specified by:
unzip
in interfaceSet<T>
- Specified by:
unzip
in interfaceSortedSet<T>
- Specified by:
unzip
in interfaceTraversable<T>
- Type Parameters:
T1
- 1st element type of a pair returned by unzipperT2
- 2nd element type of a pair returned by unzipper- Parameters:
unzipper
- a function which converts elements of this to pairs- Returns:
- A pair of set containing elements split by unzipper
-
unzip3
public final <T1,T2,T3> Tuple3<TreeSet<T1>,TreeSet<T2>,TreeSet<T3>> unzip3(java.util.function.Function<? super T,Tuple3<? extends T1,? extends T2,? extends T3>> unzipper)
Description copied from interface:Traversable
Unzips this elements by mapping this elements to triples which are subsequently split into three distinct sets.- Specified by:
unzip3
in interfaceSet<T>
- Specified by:
unzip3
in interfaceSortedSet<T>
- Specified by:
unzip3
in interfaceTraversable<T>
- Type Parameters:
T1
- 1st element type of a triplet returned by unzipperT2
- 2nd element type of a triplet returned by unzipperT3
- 3rd element type of a triplet returned by unzipper- Parameters:
unzipper
- a function which converts elements of this to pairs- Returns:
- A triplet of set containing elements split by unzipper
-
zip
public final <U> TreeSet<Tuple2<T,U>> zip(java.lang.Iterable<? extends U> that)
Description copied from interface:Traversable
Returns a traversable formed from this traversable and another Iterable collection by combining corresponding elements in pairs. If one of the two iterables is longer than the other, its remaining elements are ignored.The length of the returned traversable is the minimum of the lengths of this traversable and
that
iterable.- Specified by:
zip
in interfaceSet<T>
- Specified by:
zip
in interfaceSortedSet<T>
- Specified by:
zip
in interfaceTraversable<T>
- Type Parameters:
U
- The type of the second half of the returned pairs.- Parameters:
that
- The Iterable providing the second half of each result pair.- Returns:
- a new traversable containing pairs consisting of corresponding elements of this traversable and
that
iterable.
-
zipWith
public final <U,R> TreeSet<R> zipWith(java.lang.Iterable<? extends U> that, java.util.function.BiFunction<? super T,? super U,? extends R> mapper)
Description copied from interface:Traversable
Returns a traversable formed from this traversable and another Iterable collection by mapping elements. If one of the two iterables is longer than the other, its remaining elements are ignored.The length of the returned traversable is the minimum of the lengths of this traversable and
that
iterable.- Specified by:
zipWith
in interfaceSet<T>
- Specified by:
zipWith
in interfaceSortedSet<T>
- Specified by:
zipWith
in interfaceTraversable<T>
- Type Parameters:
U
- The type of the second parameter of the mapper.R
- The type of the mapped elements.- Parameters:
that
- The Iterable providing the second parameter of the mapper.mapper
- a mapper.- Returns:
- a new traversable containing mapped elements of this traversable and
that
iterable.
-
zipAll
public final <U> TreeSet<Tuple2<T,U>> zipAll(java.lang.Iterable<? extends U> that, T thisElem, U thatElem)
Description copied from interface:Traversable
Returns a traversable formed from this traversable and another Iterable by combining corresponding elements in pairs. If one of the two collections is shorter than the other, placeholder elements are used to extend the shorter collection to the length of the longer.The length of the returned traversable is the maximum of the lengths of this traversable and
that
iterable.Special case: if this traversable is shorter than that elements, and that elements contains duplicates, the resulting traversable may be shorter than the maximum of the lengths of this and that because a traversable contains an element at most once.
If this Traversable is shorter than that, thisElem values are used to fill the result. If that is shorter than this Traversable, thatElem values are used to fill the result.
- Specified by:
zipAll
in interfaceSet<T>
- Specified by:
zipAll
in interfaceSortedSet<T>
- Specified by:
zipAll
in interfaceTraversable<T>
- Type Parameters:
U
- The type of the second half of the returned pairs.- Parameters:
that
- The Iterable providing the second half of each result pair.thisElem
- The element to be used to fill up the result if this traversable is shorter than that.thatElem
- The element to be used to fill up the result if that is shorter than this traversable.- Returns:
- A new traversable containing pairs consisting of corresponding elements of this traversable and that.
-
zipWithIndex
public final TreeSet<Tuple2<T,java.lang.Integer>> zipWithIndex()
Description copied from interface:Traversable
Zips this traversable with its indices.- Specified by:
zipWithIndex
in interfaceSet<T>
- Specified by:
zipWithIndex
in interfaceSortedSet<T>
- Specified by:
zipWithIndex
in interfaceTraversable<T>
- Returns:
- A new traversable containing all elements of this traversable paired with their index, starting with 0.
-
zipWithIndex
public final <U> TreeSet<U> zipWithIndex(java.util.function.BiFunction<? super T,? super java.lang.Integer,? extends U> mapper)
Description copied from interface:Traversable
Returns a traversable formed from this traversable and another Iterable collection by mapping elements. If one of the two iterables is longer than the other, its remaining elements are ignored.The length of the returned traversable is the minimum of the lengths of this traversable and
that
iterable.- Specified by:
zipWithIndex
in interfaceSet<T>
- Specified by:
zipWithIndex
in interfaceSortedSet<T>
- Specified by:
zipWithIndex
in interfaceTraversable<T>
- Type Parameters:
U
- The type of the mapped elements.- Parameters:
mapper
- a mapper.- Returns:
- a new traversable containing mapped elements of this traversable and
that
iterable.
-
-