Scala Library: scala.collection.BitSet
scala.collection.BitSet
A common base class for mutable and immutable bitsets.
Bitsets are sets of non-negative integers which are represented as variable-size arrays of bits packed into 64-bit words. The memory footprint of a bitset is determined by the largest number stored in it.
Type Members
type Self = BitSet
The type implementing this traversable
- Attributes
- protected[this]
- Definition Classes
- TraversableLike
class WithFilter extends FilterMonadic[A, Repr]
A class supporting filtered operations. Instances of this class are returned by
method withFilter
.
- Definition Classes
- TraversableLike
Concrete Value Members From scala.Function1
def andThen[A](g: (Boolean) ⇒ A): (Int) ⇒ A
Composes two instances of Function1 in a new Function1, with this function applied first.
- A
- the result type of function
g
- the result type of function
- g
- a function R => A
- returns
- a new function
f
such thatf(x) == g(apply(x))
- a new function
- Definition Classes
- Function1
- Annotations
- @ unspecialized ()
(defined at scala.Function1)
def compose[A](g: (A) ⇒ Int): (A) ⇒ Boolean
Composes two instances of Function1 in a new Function1, with this function applied last.
- A
- the type to which function
g
can be applied
- the type to which function
- g
- a function A => T1
- returns
- a new function
f
such thatf(x) == apply(g(x))
- a new function
- Definition Classes
- Function1
- Annotations
- @ unspecialized ()
(defined at scala.Function1)
Concrete Value Members From scala.collection.BitSet
def empty: BitSet
The empty set of the same type as this set
- returns
- an empty set of type
This
.
- an empty set of type
- Definition Classes
- BitSet → BitSetLike → SortedSet → SetLike → GenericSetTemplate
(defined at scala.collection.BitSet)
Abstract Value Members From scala.collection.BitSetLike
abstract def fromBitMaskNoCopy(elems: Array[Long]): BitSet
Creates a new set of this kind from an array of longs
- Attributes
- protected
- Definition Classes
- BitSetLike
(defined at scala.collection.BitSetLike)
abstract def word(idx: Int): Long
The words at index idx
, or 0L if outside the range of the set Note:
requires idx >= 0
- Attributes
- protected
- Definition Classes
- BitSetLike
(defined at scala.collection.BitSetLike)
Concrete Value Members From scala.collection.BitSetLike
abstract def nwords: Int
The number of words (each with 64 bits) making up the set
- Attributes
- protected
- Definition Classes
- BitSetLike
(defined at scala.collection.BitSetLike)
def &(other: BitSet): BitSet
Computes the intersection between this bitset and another bitset by performing a bitwise “and”.
- other
- the bitset to intersect with.
- returns
- a new bitset consisting of all elements that are both in this bitset and in
the given bitset
other
.
- a new bitset consisting of all elements that are both in this bitset and in
the given bitset
- Definition Classes
- BitSetLike
(defined at scala.collection.BitSetLike)
def &~(other: BitSet): BitSet
Computes the difference of this bitset and another bitset by performing a bitwise “and-not”.
- other
- the set of bits to exclude.
- returns
- a bitset containing those bits of this bitset that are not also contained in
the given bitset
other
.
- a bitset containing those bits of this bitset that are not also contained in
the given bitset
- Definition Classes
- BitSetLike
(defined at scala.collection.BitSetLike)
def ^(other: BitSet): BitSet
Computes the symmetric difference of this bitset and another bitset by performing a bitwise “exclusive-or”.
- other
- the other bitset to take part in the symmetric difference.
- returns
- a bitset containing those bits of this bitset or the other bitset that are not contained in both bitsets.
- Definition Classes
- BitSetLike
(defined at scala.collection.BitSetLike)
def addString(sb: mutable.StringBuilder, start: String, sep: String, end: String): mutable.StringBuilder
Appends all elements of this bitset to a string builder using start, end, and
separator strings. The written text begins with the string start
and ends with
the string end
. Inside, the string representations (w.r.t. the method
toString
) of all elements of this bitset are separated by the string sep
.
Example:
- start
- the starting string.
- sep
- the separator string.
- end
- the ending string.
- returns
- the string builder
b
to which elements were appended.
- the string builder
- Definition Classes
- BitSetLike → TraversableOnce
(defined at scala.collection.BitSetLike)
def contains(elem: Int): Boolean
Tests if some element is contained in this set.
- elem
- the element to test for membership.
- returns
true
ifelem
is contained in this set,false
otherwise.
- Definition Classes
- BitSetLike → SetLike → GenSetLike
(defined at scala.collection.BitSetLike)
def foreach[U](f: (Int) ⇒ U): Unit
[use case]
Applies a function f
to all elements of this bitset.
Note: this method underlies the implementation of most other bulk operations. Subclasses should re-implement this method if a more efficient implementation exists.
- f
- the function that is applied for its side-effect to every element. The
result of function
f
is discarded.
- the function that is applied for its side-effect to every element. The
result of function
- Definition Classes
- BitSetLike → IterableLike → TraversableLike → GenTraversableLike → TraversableOnce → GenTraversableOnce → FilterMonadic
(defined at scala.collection.BitSetLike)
def keysIteratorFrom(start: Int): AbstractIterator[Int]
Creates an iterator over all the keys(or elements) contained in this collection
greater than or equal to start
according to the ordering of this collection.
x.keysIteratorFrom(y) is equivalent to but often more efficient than
x.from(y).keysIterator.
- start
- The lower bound (inclusive) on the keys to be returned
- Definition Classes
- BitSetLike → Sorted
(defined at scala.collection.BitSetLike)
def rangeImpl(from: Option[Int], until: Option[Int]): BitSet
Creates a ranged projection of this collection. Any mutations in the ranged projection will update this collection and vice versa.
Note: keys are not guaranteed to be consistent between this collection and the projection. This is the case for buffers where indexing is relative to the projection.
- from
- The lower-bound (inclusive) of the ranged projection.
None
if there is no lower bound.
- The lower-bound (inclusive) of the ranged projection.
- until
- The upper-bound (exclusive) of the ranged projection.
None
if there is no upper bound.
- The upper-bound (exclusive) of the ranged projection.
- Definition Classes
- BitSetLike → SortedSetLike → Sorted
(defined at scala.collection.BitSetLike)
def subsetOf(other: BitSet): Boolean
Tests whether this bitset is a subset of another bitset.
- other
- the bitset to test.
- returns
true
if this bitset is a subset ofother
, i.e. if every bit of this set is also an element inother
.
- Definition Classes
- BitSetLike
(defined at scala.collection.BitSetLike)
def |(other: BitSet): BitSet
Computes the union between this bitset and another bitset by performing a bitwise “or”.
- other
- the bitset to form the union with.
- returns
- a new bitset consisting of all bits that are in this bitset or in the given
bitset
other
.
- a new bitset consisting of all bits that are in this bitset or in the given
bitset
- Definition Classes
- BitSetLike
(defined at scala.collection.BitSetLike)
Concrete Value Members From scala.collection.GenSetLike
def &(that: GenSet[Int]): BitSet
Computes the intersection between this set and another set.
Note: Same as intersect
.
- that
- the set to intersect with.
- returns
- a new set consisting of all elements that are both in this set and in the
given set
that
.
- a new set consisting of all elements that are both in this set and in the
given set
- Definition Classes
- GenSetLike
(defined at scala.collection.GenSetLike)
def &~(that: GenSet[Int]): BitSet
The difference of this set and another set.
Note: Same as diff
.
- that
- the set of elements to exclude.
- returns
- a set containing those elements of this set that are not also contained in
the given set
that
.
- a set containing those elements of this set that are not also contained in
the given set
- Definition Classes
- GenSetLike
(defined at scala.collection.GenSetLike)
def apply(elem: Int): Boolean
Tests if some element is contained in this set.
This method is equivalent to contains
. It allows sets to be interpreted as
predicates.
- elem
- the element to test for membership.
- returns
true
ifelem
is contained in this set,false
otherwise.
- Definition Classes
- GenSetLike → Function1
(defined at scala.collection.GenSetLike)
def equals(that: Any): Boolean
Compares this set with another object for equality.
Note: This operation contains an unchecked cast: if that
is a set, it will
assume with an unchecked cast that it has the same element type as this set. Any
subsequent ClassCastException is treated as a false
result.
- that
- the other object
- returns
true
ifthat
is a set which contains the same elements as this set.
- Definition Classes
- GenSetLike → Equals → AnyRef → Any
(defined at scala.collection.GenSetLike)
def intersect(that: GenSet[Int]): BitSet
Computes the intersection between this set and another set.
- that
- the set to intersect with.
- returns
- a new set consisting of all elements that are both in this set and in the
given set
that
.
- a new set consisting of all elements that are both in this set and in the
given set
- Definition Classes
- GenSetLike
(defined at scala.collection.GenSetLike)
def |(that: GenSet[Int]): BitSet
Computes the union between this set and another set.
Note: Same as union
.
- that
- the set to form the union with.
- returns
- a new set consisting of all elements that are in this set or in the given
set
that
.
- a new set consisting of all elements that are in this set or in the given
set
- Definition Classes
- GenSetLike
(defined at scala.collection.GenSetLike)
Concrete Value Members From scala.collection.IterableLike
def canEqual(that: Any): Boolean
Method called from equality methods, so that user-defined subclasses can refuse to be equal to other collections of the same kind.
- that
- The object with which this iterable collection should be compared
- returns
true
, if this iterable collection can possibly equalthat
,false
otherwise. The test takes into consideration only the run-time types of objects but ignores their elements.
- Definition Classes
- IterableLike → Equals
(defined at scala.collection.IterableLike)
def copyToArray[B >: Int](xs: Array[B], start: Int, len: Int): Unit
[use case]
Copies the elements of this bitset to an array. Fills the given array xs
with
at most len
elements of this bitset, starting at position start
. Copying
will stop once either the end of the current bitset is reached, or the end of
the target array is reached, or len
elements have been copied.
- xs
- the array to fill.
- start
- the starting index.
- len
- the maximal number of elements to copy.
- Definition Classes
- IterableLike → TraversableLike → TraversableOnce → GenTraversableOnce
(defined at scala.collection.IterableLike)
def drop(n: Int): BitSet
Selects all elements except first n ones.
Note: might return different results for different runs, unless the underlying collection type is ordered.
- n
- the number of elements to drop from this iterable collection.
- returns
- a iterable collection consisting of all elements of this iterable collection
except the first
n
ones, or else the empty iterable collection, if this iterable collection has less thann
elements.
- a iterable collection consisting of all elements of this iterable collection
except the first
- Definition Classes
- IterableLike → TraversableLike → GenTraversableLike
(defined at scala.collection.IterableLike)
def dropRight(n: Int): BitSet
Selects all elements except last n ones.
Note: might return different results for different runs, unless the underlying collection type is ordered.
- n
- The number of elements to take
- returns
- a iterable collection consisting of all elements of this iterable collection
except the last
n
ones, or else the empty iterable collection, if this iterable collection has less thann
elements.
- a iterable collection consisting of all elements of this iterable collection
except the last
- Definition Classes
- IterableLike
(defined at scala.collection.IterableLike)
def exists(p: (Int) ⇒ Boolean): Boolean
Tests whether a predicate holds for at least one element of this iterable collection.
Note: may not terminate for infinite-sized collections.
- p
- the predicate used to test elements.
- returns
false
if this iterable collection is empty, otherwisetrue
if the given predicatep
holds for some of the elements of this iterable collection, otherwisefalse
- Definition Classes
- IterableLike → TraversableLike → TraversableOnce → GenTraversableOnce
(defined at scala.collection.IterableLike)
def find(p: (Int) ⇒ Boolean): Option[Int]
Finds the first element of the iterable collection satisfying a predicate, if any.
Note: may not terminate for infinite-sized collections.
Note: might return different results for different runs, unless the underlying collection type is ordered.
- p
- the predicate used to test elements.
- returns
- an option value containing the first element in the iterable collection that
satisfies
p
, orNone
if none exists.
- an option value containing the first element in the iterable collection that
satisfies
- Definition Classes
- IterableLike → TraversableLike → TraversableOnce → GenTraversableOnce
(defined at scala.collection.IterableLike)
def foldRight[B](z: B)(op: (Int, B) ⇒ B): B
Applies a binary operator to all elements of this iterable collection and a start value, going right to left.
Note: will not terminate for infinite-sized collections.
Note: might return different results for different runs, unless the underlying collection type is ordered. or the operator is associative and commutative.
- B
- the result type of the binary operator.
- z
- the start value.
- op
- the binary operator.
- returns
- the result of inserting
op
between consecutive elements of this iterable collection, going right to left with the start valuez
on the right:
- the result of inserting
where `x1, ..., xn` are the elements of this iterable collection. Returns
`z` if this iterable collection is empty.
- Definition Classes
- IterableLike → TraversableOnce → GenTraversableOnce
(defined at scala.collection.IterableLike)
def forall(p: (Int) ⇒ Boolean): Boolean
Tests whether a predicate holds for all elements of this iterable collection.
Note: may not terminate for infinite-sized collections.
- p
- the predicate used to test elements.
- returns
true
if this iterable collection is empty or the given predicatep
holds for all elements of this iterable collection, otherwisefalse
.
- Definition Classes
- IterableLike → TraversableLike → TraversableOnce → GenTraversableOnce
(defined at scala.collection.IterableLike)
def grouped(size: Int): Iterator[BitSet]
Partitions elements in fixed size iterable collections.
- size
- the number of elements per group
- returns
- An iterator producing iterable collections of size
size
, except the last will be less than sizesize
if the elements don’t divide evenly.
- An iterator producing iterable collections of size
- Definition Classes
- IterableLike
- See also
- scala.collection.Iterator, method
grouped
- scala.collection.Iterator, method
(defined at scala.collection.IterableLike)
def head: Int
Selects the first element of this iterable collection.
Note: might return different results for different runs, unless the underlying collection type is ordered.
- returns
- the first element of this iterable collection.
- Definition Classes
- IterableLike → TraversableLike → GenTraversableLike
- Exceptions thrown
- NoSuchElementException if the iterable collection is empty.
(defined at scala.collection.IterableLike)
def reduceRight[B >: Int](op: (Int, B) ⇒ B): B
Applies a binary operator to all elements of this iterable collection, going right to left.
Note: will not terminate for infinite-sized collections.
Note: might return different results for different runs, unless the underlying collection type is ordered. or the operator is associative and commutative.
- B
- the result type of the binary operator.
- op
- the binary operator.
- returns
- the result of inserting
op
between consecutive elements of this iterable collection, going right to left:
- the result of inserting
where `x1, ..., xn` are the elements of this iterable collection.
- Definition Classes
- IterableLike → TraversableOnce → GenTraversableOnce
- Exceptions thrown
- UnsupportedOperationException if this iterable collection is empty.
(defined at scala.collection.IterableLike)
def sameElements[B >: Int](that: GenIterable[B]): Boolean
[use case]
Checks if the other iterable collection contains the same elements in the same order as this bitset.
Note: might return different results for different runs, unless the underlying collection type is ordered.
- that
- the collection to compare with.
- returns
true
, if both collections contain the same elements in the same order,false
otherwise.
- Definition Classes
- IterableLike → GenIterableLike
(defined at scala.collection.IterableLike)
def slice(from: Int, until: Int): BitSet
Selects an interval of elements. The returned collection is made up of all
elements x
which satisfy the invariant:
Note: might return different results for different runs, unless the underlying collection type is ordered.
- returns
- a iterable collection containing the elements greater than or equal to index
from
extending up to (but not including) indexuntil
of this iterable collection.
- a iterable collection containing the elements greater than or equal to index
- Definition Classes
- IterableLike → TraversableLike → GenTraversableLike
(defined at scala.collection.IterableLike)
def sliding(size: Int): Iterator[BitSet]
Groups elements in fixed size blocks by passing a “sliding window” over them (as opposed to partitioning them, as is done in grouped.) “Sliding window” step is 1 by default.
- size
- the number of elements per group
- returns
- An iterator producing iterable collections of size
size
, except the last and the only element will be truncated if there are fewer elements than size.
- An iterator producing iterable collections of size
- Definition Classes
- IterableLike
- See also
- scala.collection.Iterator, method
sliding
- scala.collection.Iterator, method
(defined at scala.collection.IterableLike)
def sliding(size: Int, step: Int): Iterator[BitSet]
Groups elements in fixed size blocks by passing a “sliding window” over them (as opposed to partitioning them, as is done in grouped.)
- size
- the number of elements per group
- step
- the distance between the first elements of successive groups
- returns
- An iterator producing iterable collections of size
size
, except the last and the only element will be truncated if there are fewer elements than size.
- An iterator producing iterable collections of size
- Definition Classes
- IterableLike
- See also
- scala.collection.Iterator, method
sliding
- scala.collection.Iterator, method
(defined at scala.collection.IterableLike)
def take(n: Int): BitSet
Selects first n elements.
Note: might return different results for different runs, unless the underlying collection type is ordered.
- n
- the number of elements to take from this iterable collection.
- returns
- a iterable collection consisting only of the first
n
elements of this iterable collection, or else the whole iterable collection, if it has less thann
elements.
- a iterable collection consisting only of the first
- Definition Classes
- IterableLike → TraversableLike → GenTraversableLike
(defined at scala.collection.IterableLike)
def takeRight(n: Int): BitSet
Selects last n elements.
Note: might return different results for different runs, unless the underlying collection type is ordered.
- n
- the number of elements to take
- returns
- a iterable collection consisting only of the last
n
elements of this iterable collection, or else the whole iterable collection, if it has less thann
elements.
- a iterable collection consisting only of the last
- Definition Classes
- IterableLike
(defined at scala.collection.IterableLike)
def takeWhile(p: (Int) ⇒ Boolean): BitSet
Takes longest prefix of elements that satisfy a predicate.
Note: might return different results for different runs, unless the underlying collection type is ordered.
- returns
- the longest prefix of this iterable collection whose elements all satisfy
the predicate
p
.
- the longest prefix of this iterable collection whose elements all satisfy
the predicate
- Definition Classes
- IterableLike → TraversableLike → GenTraversableLike
(defined at scala.collection.IterableLike)
def thisCollection: Iterable[Int]
The underlying collection seen as an instance of Iterable
. By default this is
implemented as the current collection object itself, but this can be overridden.
- Attributes
- protected[this]
- Definition Classes
- IterableLike → TraversableLike
(defined at scala.collection.IterableLike)
def toCollection(repr: BitSet): Iterable[Int]
A conversion from collections of type Repr
to Iterable
objects. By default
this is implemented as just a cast, but this can be overridden.
- Attributes
- protected[this]
- Definition Classes
- IterableLike → TraversableLike
(defined at scala.collection.IterableLike)
def toIterable: Iterable[Int]
Returns this iterable collection as an iterable collection.
A new collection will not be built; lazy collections will stay lazy.
Note: will not terminate for infinite-sized collections.
- returns
- an
Iterable
containing all elements of this iterable collection.
- an
- Definition Classes
- IterableLike → TraversableOnce → GenTraversableOnce
(defined at scala.collection.IterableLike)
def toIterator: Iterator[Int]
Returns an Iterator over the elements in this iterable collection. Produces the
same result as iterator
.
Note: will not terminate for infinite-sized collections.
- returns
- an Iterator containing all elements of this iterable collection.
- Definition Classes
- IterableLike → TraversableLike → GenTraversableOnce
- Annotations
- @ deprecatedOverriding (message =…, since = “2.11.0”)
(defined at scala.collection.IterableLike)
def toStream: immutable.Stream[Int]
Converts this iterable collection to a stream.
- returns
- a stream containing all elements of this iterable collection.
- Definition Classes
- IterableLike → TraversableLike → GenTraversableOnce
(defined at scala.collection.IterableLike)
def view(from: Int, until: Int): IterableView[Int, BitSet]
Creates a non-strict view of a slice of this iterable collection.
Note: the difference between view
and slice
is that view
produces a view
of the current iterable collection, whereas slice
produces a new iterable
collection.
Note: view(from, to)
is equivalent to view.slice(from, to)
Note: might return different results for different runs, unless the underlying collection type is ordered.
- from
- the index of the first element of the view
- until
- the index of the element following the view
- returns
- a non-strict view of a slice of this iterable collection, starting at index
from
and extending up to (but not including) indexuntil
.
- a non-strict view of a slice of this iterable collection, starting at index
- Definition Classes
- IterableLike → TraversableLike
(defined at scala.collection.IterableLike)
def view: IterableView[Int, BitSet]
Creates a non-strict view of this iterable collection.
- returns
- a non-strict view of this iterable collection.
- Definition Classes
- IterableLike → TraversableLike
(defined at scala.collection.IterableLike)
def zipAll[B, A1 >: Int, That](that: GenIterable[B], thisElem: A1, thatElem: B)(implicit bf: CanBuildFrom[BitSet, (A1, B), That]): That
[use case]
Returns a bitset formed from this bitset and another iterable collection 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.
Note: might return different results for different runs, unless the underlying collection type is ordered.
- B
- the type of the second half of the returned pairs
- that
- The iterable providing the second half of each result pair
- thisElem
- the element to be used to fill up the result if this bitset is shorter than
that
.
- the element to be used to fill up the result if this bitset is shorter than
- thatElem
- the element to be used to fill up the result if
that
is shorter than this bitset.
- the element to be used to fill up the result if
- returns
- a new bitset containing pairs consisting of corresponding elements of this
bitset and
that
. The length of the returned collection is the maximum of the lengths of this bitset andthat
. If this bitset is shorter thanthat
,thisElem
values are used to pad the result. Ifthat
is shorter than this bitset,thatElem
values are used to pad the result.
- a new bitset containing pairs consisting of corresponding elements of this
bitset and
- Definition Classes
- IterableLike → GenIterableLike
(defined at scala.collection.IterableLike)
def zipWithIndex[A1 >: Int, That](implicit bf: CanBuildFrom[BitSet, (A1, Int), That]): That
[use case]
Zips this bitset with its indices.
Note: might return different results for different runs, unless the underlying collection type is ordered.
- returns
- A new bitset containing pairs consisting of all elements of this bitset
paired with their index. Indices start at
0
.
- A new bitset containing pairs consisting of all elements of this bitset
paired with their index. Indices start at
- Definition Classes
- IterableLike → GenIterableLike
Example:
(defined at scala.collection.IterableLike)
def zip[A1 >: Int, B, That](that: GenIterable[B])(implicit bf: CanBuildFrom[BitSet, (A1, B), That]): That
[use case]
Returns a bitset formed from this bitset and another iterable collection by combining corresponding elements in pairs. If one of the two collections is longer than the other, its remaining elements are ignored.
Note: might return different results for different runs, unless the underlying collection type is ordered.
- B
- the type of the second half of the returned pairs
- that
- The iterable providing the second half of each result pair
- returns
- a new bitset containing pairs consisting of corresponding elements of this
bitset and
that
. The length of the returned collection is the minimum of the lengths of this bitset andthat
.
- a new bitset containing pairs consisting of corresponding elements of this
bitset and
- Definition Classes
- IterableLike → GenIterableLike
(defined at scala.collection.IterableLike)
Concrete Value Members From scala.collection.Parallelizable
def par: ParSet[Int]
Returns a parallel implementation of this collection.
For most collection types, this method creates a new parallel collection by
copying all the elements. For these collection, par
takes linear time. Mutable
collections in this category do not produce a mutable parallel collection that
has the same underlying dataset, so changes in one collection will not be
reflected in the other one.
Specific collections (e.g. ParArray
or mutable.ParHashMap
) override this
default behaviour by creating a parallel collection which shares the same
underlying dataset. For these collections, par
takes constant or sublinear
time.
All parallel collections return a reference to themselves.
- returns
- a parallel implementation of this collection
- Definition Classes
- Parallelizable
(defined at scala.collection.Parallelizable)
Concrete Value Members From scala.collection.Set
def companion: GenericCompanion[Set]
The factory companion object that builds instances of class Set. (or its
Iterable
superclass where class Set is not a Seq
.)
- Definition Classes
- Set → GenSet → Iterable → GenIterable → Traversable → GenTraversable → GenericTraversableTemplate
(defined at scala.collection.Set)
def seq: Set[Int]
A version of this collection with all of the operations implemented sequentially (i.e., in a single-threaded manner).
This method returns a reference to this collection. In parallel collections, it is redefined to return a sequential implementation of this collection. In both cases, it has O(1) complexity.
- returns
- a sequential view of the collection.
- Definition Classes
- Set → GenSet → GenSetLike → Iterable → GenIterable → Traversable → GenTraversable → Parallelizable → TraversableOnce → GenTraversableOnce
(defined at scala.collection.Set)
Abstract Value Members From scala.collection.SetLike
abstract def +(elem: Int): BitSet
Creates a new set with an additional element, unless the element is already present.
- elem
- the element to be added
- returns
- a new set that contains all elements of this set and that also contains
elem
.
- a new set that contains all elements of this set and that also contains
- Definition Classes
- SetLike → GenSetLike
(defined at scala.collection.SetLike)
abstract def -(elem: Int): BitSet
Creates a new set with a given element removed from this set.
- elem
- the element to be removed
- returns
- a new set that contains all elements of this set but that does not contain
elem
.
- a new set that contains all elements of this set but that does not contain
- Definition Classes
- SetLike → Subtractable → GenSetLike
(defined at scala.collection.SetLike)
Concrete Value Members From scala.collection.SetLike
def +(elem1: Int, elem2: Int, elems: Int*): BitSet
Creates a new set with additional elements, omitting duplicates.
This method takes two or more elements to be added. Elements that already exist in the set will not be added. Another overloaded variant of this method handles the case where a single element is added.
Example:
- elem1
- the first element to add.
- elem2
- the second element to add.
- elems
- the remaining elements to add.
- returns
- a new set with the given elements added, omitting duplicates.
- Definition Classes
- SetLike
(defined at scala.collection.SetLike)
def ++(elems: GenTraversableOnce[Int]): BitSet
Creates a new set by adding all elements contained in another collection to this set, omitting duplicates.
This method takes a collection of elements and adds all elements, omitting duplicates, into set.
Example:
- elems
- the collection containing the elements to add.
- returns
- a new set with the given elements added, omitting duplicates.
- Definition Classes
- SetLike
(defined at scala.collection.SetLike)
def diff(that: GenSet[Int]): BitSet
Computes the difference of this set and another set.
- that
- the set of elements to exclude.
- returns
- a set containing those elements of this set that are not also contained in
the given set
that
.
- a set containing those elements of this set that are not also contained in
the given set
- Definition Classes
- SetLike → GenSetLike
(defined at scala.collection.SetLike)
def map[B, That](f: (Int) ⇒ B)(implicit bf: CanBuildFrom[BitSet, B, That]): That
[use case]
Builds a new collection by applying a function to all elements of this bitset.
- B
- the element type of the returned collection.
- f
- the function to apply to each element.
- returns
- a new bitset resulting from applying the given function
f
to each element of this bitset and collecting the results.
- a new bitset resulting from applying the given function
- Definition Classes
- SetLike → TraversableLike → GenTraversableLike → FilterMonadic
(defined at scala.collection.SetLike)
def newBuilder: Builder[Int, BitSet]
A common implementation of newBuilder
for all sets in terms of empty
.
Overridden for mutable sets in mutable.SetLike
.
- Attributes
- protected[this]
- Definition Classes
- SetLike → TraversableLike → HasNewBuilder
(defined at scala.collection.SetLike)
def parCombiner: Combiner[Int, ParSet[Int]]
The default par
implementation uses the combiner provided by this method to
create a new parallel collection.
- returns
- a combiner for the parallel collection of type
ParRepr
- a combiner for the parallel collection of type
- Attributes
- protected[this]
- Definition Classes
- SetLike → TraversableLike → Parallelizable
(defined at scala.collection.SetLike)
def subsets(): Iterator[BitSet]
An iterator over all subsets of this set.
- returns
- the iterator.
- Definition Classes
- SetLike
(defined at scala.collection.SetLike)
def subsets(len: Int): Iterator[BitSet]
An iterator over all subsets of this set of the given size. If the requested size is impossible, an empty iterator is returned.
- len
- the size of the subsets.
- returns
- the iterator.
- Definition Classes
- SetLike
(defined at scala.collection.SetLike)
def toBuffer[A1 >: Int]: Buffer[A1]
Uses the contents of this set to create a new mutable buffer.
- returns
- a buffer containing all elements of this set.
- Definition Classes
- SetLike → TraversableOnce → GenTraversableOnce
(defined at scala.collection.SetLike)
def toSeq: Seq[Int]
Converts this set to a sequence. As with toIterable
, it’s lazy in this
default implementation, as this TraversableOnce
may be lazy and unevaluated.
- returns
- a sequence containing all elements of this set.
- Definition Classes
- SetLike → TraversableOnce → GenTraversableOnce
(defined at scala.collection.SetLike)
def union(that: GenSet[Int]): BitSet
Computes the union between of set and another set.
- that
- the set to form the union with.
- returns
- a new set consisting of all elements that are in this set or in the given
set
that
.
- a new set consisting of all elements that are in this set or in the given
set
- Definition Classes
- SetLike → GenSetLike
(defined at scala.collection.SetLike)
Concrete Value Members From scala.collection.SortedSetLike
def firstKey: Int
Returns the first key of the collection.
- Definition Classes
- SortedSetLike → Sorted
(defined at scala.collection.SortedSetLike)
def from(from: Int): BitSet
Creates a ranged projection of this collection with no upper-bound.
- from
- The lower-bound (inclusive) of the ranged projection.
- Definition Classes
- SortedSetLike → Sorted
(defined at scala.collection.SortedSetLike)
def iteratorFrom(start: Int): Iterator[Int]
Creates an iterator that contains all values from this collection greater than
or equal to start
according to the ordering of this collection.
x.iteratorFrom(y) is equivalent to but will usually be more efficient than
x.from(y).iterator
- start
- The lower-bound (inclusive) of the iterator
- Definition Classes
- SortedSetLike
(defined at scala.collection.SortedSetLike)
def keySet: BitSet
return as a projection the set of keys in this collection
- Definition Classes
- SortedSetLike → Sorted
(defined at scala.collection.SortedSetLike)
def lastKey: Int
Returns the last key of the collection.
- Definition Classes
- SortedSetLike → Sorted
(defined at scala.collection.SortedSetLike)
def range(from: Int, until: Int): BitSet
Creates a ranged projection of this collection with both a lower-bound and an upper-bound.
- from
- The lower-bound (inclusive) of the ranged projection.
- until
- The upper-bound (exclusive) of the ranged projection.
- Definition Classes
- SortedSetLike → Sorted
(defined at scala.collection.SortedSetLike)
def subsetOf(that: GenSet[Int]): Boolean
Tests whether this set is a subset of another set.
- that
- the set to test.
- returns
true
if this set is a subset ofthat
, i.e. if every element of this set is also an element ofthat
.
- Definition Classes
- SortedSetLike → GenSetLike
(defined at scala.collection.SortedSetLike)
def until(until: Int): BitSet
Creates a ranged projection of this collection with no lower-bound.
- until
- The upper-bound (exclusive) of the ranged projection.
- Definition Classes
- SortedSetLike → Sorted
(defined at scala.collection.SortedSetLike)
Concrete Value Members From scala.collection.TraversableLike
def ++:[B >: Int, That](that: Traversable[B])(implicit bf: CanBuildFrom[BitSet, B, That]): That
As with ++
, returns a new collection containing the elements from the left
operand followed by the elements from the right operand.
It differs from ++
in that the right operand determines the type of the
resulting collection rather than the left one. Mnemonic: the COLon is on the
side of the new COLlection type.
Example:
This overload exists because: for the implementation of ++:
we should reuse
that of ++
because many collections override it with more efficient versions.
Since TraversableOnce
has no ++
method, we have to implement that directly,
but Traversable
and down can use the overload.
- B
- the element type of the returned collection.
- That
- the class of the returned collection. Where possible,
That
is the same class as the current collection classRepr
, but this depends on the element typeB
being admissible for that class, which means that an implicit instance of typeCanBuildFrom[Repr, B, That]
is found.
- the class of the returned collection. Where possible,
- that
- the traversable to append.
- bf
- an implicit value of class
CanBuildFrom
which determines the result classThat
from the current representation typeRepr
and and the new element typeB
.
- an implicit value of class
- returns
- a new collection of type
That
which contains all elements of this traversable collection followed by all elements ofthat
.
- a new collection of type
- Definition Classes
- TraversableLike
(defined at scala.collection.TraversableLike)
def ++:[B >: Int, That](that: TraversableOnce[B])(implicit bf: CanBuildFrom[BitSet, B, That]): That
[use case]
As with ++
, returns a new collection containing the elements from the left
operand followed by the elements from the right operand.
It differs from ++
in that the right operand determines the type of the
resulting collection rather than the left one. Mnemonic: the COLon is on the
side of the new COLlection type.
Example:
- B
- the element type of the returned collection.
- that
- the traversable to append.
- returns
- a new bitset which contains all elements of this bitset followed by all
elements of
that
.
- a new bitset which contains all elements of this bitset followed by all
elements of
- Definition Classes
- TraversableLike
(defined at scala.collection.TraversableLike)
def ++[B >: Int, That](that: GenTraversableOnce[B])(implicit bf: CanBuildFrom[BitSet, B, That]): That
[use case]
Returns a new bitset containing the elements from the left hand operand followed by the elements from the right hand operand. The element type of the bitset is the most specific superclass encompassing the element types of the two operands.
Example:
- B
- the element type of the returned collection.
- that
- the traversable to append.
- returns
- a new bitset which contains all elements of this bitset followed by all
elements of
that
.
- a new bitset which contains all elements of this bitset followed by all
elements of
- Definition Classes
- TraversableLike → GenTraversableLike
(defined at scala.collection.TraversableLike)
def collect[B, That](pf: PartialFunction[Int, B])(implicit bf: CanBuildFrom[BitSet, B, That]): That
[use case]
Builds a new collection by applying a partial function to all elements of this bitset on which the function is defined.
- B
- the element type of the returned collection.
- pf
- the partial function which filters and maps the bitset.
- returns
- a new bitset resulting from applying the given partial function
pf
to each element on which it is defined and collecting the results. The order of the elements is preserved.
- a new bitset resulting from applying the given partial function
- Definition Classes
- TraversableLike → GenTraversableLike
(defined at scala.collection.TraversableLike)
def dropWhile(p: (Int) ⇒ Boolean): BitSet
Drops longest prefix of elements that satisfy a predicate.
Note: might return different results for different runs, unless the underlying collection type is ordered.
- returns
- the longest suffix of this traversable collection whose first element does
not satisfy the predicate
p
.
- the longest suffix of this traversable collection whose first element does
not satisfy the predicate
- Definition Classes
- TraversableLike → GenTraversableLike
(defined at scala.collection.TraversableLike)
def filter(p: (Int) ⇒ Boolean): BitSet
Selects all elements of this traversable collection which satisfy a predicate.
- p
- the predicate used to test elements.
- returns
- a new traversable collection consisting of all elements of this traversable
collection that satisfy the given predicate
p
. The order of the elements is preserved.
- a new traversable collection consisting of all elements of this traversable
collection that satisfy the given predicate
- Definition Classes
- TraversableLike → GenTraversableLike
(defined at scala.collection.TraversableLike)
def filterNot(p: (Int) ⇒ Boolean): BitSet
Selects all elements of this traversable collection which do not satisfy a predicate.
- p
- the predicate used to test elements.
- returns
- a new traversable collection consisting of all elements of this traversable
collection that do not satisfy the given predicate
p
. The order of the elements is preserved.
- a new traversable collection consisting of all elements of this traversable
collection that do not satisfy the given predicate
- Definition Classes
- TraversableLike → GenTraversableLike
(defined at scala.collection.TraversableLike)
def flatMap[B, That](f: (Int) ⇒ GenTraversableOnce[B])(implicit bf: CanBuildFrom[BitSet, B, That]): That
[use case]
Builds a new collection by applying a function to all elements of this bitset and using the elements of the resulting collections.
For example:
The type of the resulting collection is guided by the static type of bitset. This might cause unexpected results sometimes. For example:
- B
- the element type of the returned collection.
- f
- the function to apply to each element.
- returns
- a new bitset resulting from applying the given collection-valued function
f
to each element of this bitset and concatenating the results.
- a new bitset resulting from applying the given collection-valued function
- Definition Classes
- TraversableLike → GenTraversableLike → FilterMonadic
(defined at scala.collection.TraversableLike)
def groupBy[K](f: (Int) ⇒ K): immutable.Map[K, BitSet]
Partitions this traversable collection into a map of traversable collections according to some discriminator function.
Note: this method is not re-implemented by views. This means when applied to a view it will always force the view and return a new traversable collection.
- K
- the type of keys returned by the discriminator function.
- f
- the discriminator function.
- returns
- A map from keys to traversable collections such that the following invariant holds:
That is, every key `k` is bound to a traversable collection of those
elements `x` for which `f(x)` equals `k` .
- Definition Classes
- TraversableLike → GenTraversableLike
(defined at scala.collection.TraversableLike)
def headOption: Option[Int]
Optionally selects the first element.
Note: might return different results for different runs, unless the underlying collection type is ordered.
- returns
- the first element of this traversable collection if it is nonempty,
None
if it is empty.
- the first element of this traversable collection if it is nonempty,
- Definition Classes
- TraversableLike → GenTraversableLike
(defined at scala.collection.TraversableLike)
def init: BitSet
Selects all elements except the last.
Note: might return different results for different runs, unless the underlying collection type is ordered.
- returns
- a traversable collection consisting of all elements of this traversable collection except the last one.
- Definition Classes
- TraversableLike → GenTraversableLike
- Exceptions thrown
- UnsupportedOperationException if the traversable collection is empty.
(defined at scala.collection.TraversableLike)
def inits: Iterator[BitSet]
Iterates over the inits of this traversable collection. The first value will be
this traversable collection and the final one will be an empty traversable
collection, with the intervening values the results of successive applications
of init
.
- returns
- an iterator over all the inits of this traversable collection
- Definition Classes
- TraversableLike
Example:
(defined at scala.collection.TraversableLike)
def last: Int
Selects the last element.
Note: might return different results for different runs, unless the underlying collection type is ordered.
- returns
- The last element of this traversable collection.
- Definition Classes
- TraversableLike → GenTraversableLike
- Exceptions thrown
- NoSuchElementException If the traversable collection is empty.
(defined at scala.collection.TraversableLike)
def lastOption: Option[Int]
Optionally selects the last element.
Note: might return different results for different runs, unless the underlying collection type is ordered.
- returns
- the last element of this traversable collection$ if it is nonempty,
None
if it is empty.
- the last element of this traversable collection$ if it is nonempty,
- Definition Classes
- TraversableLike → GenTraversableLike
(defined at scala.collection.TraversableLike)
def partition(p: (Int) ⇒ Boolean): (BitSet, BitSet)
Partitions this traversable collection in two traversable collections according to a predicate.
- p
- the predicate on which to partition.
- returns
- a pair of traversable collections: the first traversable collection consists
of all elements that satisfy the predicate
p
and the second traversable collection consists of all elements that don’t. The relative order of the elements in the resulting traversable collections is the same as in the original traversable collection.
- a pair of traversable collections: the first traversable collection consists
of all elements that satisfy the predicate
- Definition Classes
- TraversableLike → GenTraversableLike
(defined at scala.collection.TraversableLike)
def repr: BitSet
The collection of type traversable collection underlying this TraversableLike
object. By default this is implemented as the TraversableLike
object itself,
but this can be overridden.
- Definition Classes
- TraversableLike → GenTraversableLike
(defined at scala.collection.TraversableLike)
def scanLeft[B, That](z: B)(op: (B, Int) ⇒ B)(implicit bf: CanBuildFrom[BitSet, B, That]): That
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.
- B
- the type of the elements in the resulting collection
- That
- the actual type of the resulting collection
- z
- the initial value
- op
- the binary operator applied to the intermediate result and the element
- bf
- an implicit value of class
CanBuildFrom
which determines the result classThat
from the current representation typeRepr
and and the new element typeB
.
- an implicit value of class
- returns
- collection with intermediate results
- Definition Classes
- TraversableLike → GenTraversableLike
(defined at scala.collection.TraversableLike)
def scanRight[B, That](z: B)(op: (Int, B) ⇒ B)(implicit bf: CanBuildFrom[BitSet, B, That]): That
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.
Example:
- B
- the type of the elements in the resulting collection
- That
- the actual type of the resulting collection
- z
- the initial value
- op
- the binary operator applied to the intermediate result and the element
- bf
- an implicit value of class
CanBuildFrom
which determines the result classThat
from the current representation typeRepr
and and the new element typeB
.
- an implicit value of class
- returns
- collection with intermediate results
- Definition Classes
- TraversableLike → GenTraversableLike
- Annotations
- @migration
- Migration
- (Changed in version 2.9.0) The behavior of
scanRight
has changed. The previous behavior can be reproduced with scanRight.reverse.
- (Changed in version 2.9.0) The behavior of
(defined at scala.collection.TraversableLike)
def scan[B >: Int, That](z: B)(op: (B, B) ⇒ B)(implicit cbf: CanBuildFrom[BitSet, B, That]): That
Computes a prefix scan of the elements of the collection.
Note: The neutral element z
may be applied more than once.
- B
- element type of the resulting collection
- That
- type of the resulting collection
- z
- neutral element for the operator
op
- neutral element for the operator
- op
- the associative operator for the scan
- cbf
- combiner factory which provides a combiner
- returns
- a new traversable collection containing the prefix scan of the elements in this traversable collection
- Definition Classes
- TraversableLike → GenTraversableLike
(defined at scala.collection.TraversableLike)
def span(p: (Int) ⇒ Boolean): (BitSet, BitSet)
Splits this traversable collection into a prefix/suffix pair according to a predicate.
Note: c span p
is equivalent to (but possibly more efficient than)
(c takeWhile p, c dropWhile p)
, provided the evaluation of the predicate
p
does not cause any side-effects.
Note: might return different results for different runs, unless the underlying collection type is ordered.
- returns
- a pair consisting of the longest prefix of this traversable collection whose
elements all satisfy
p
, and the rest of this traversable collection.
- a pair consisting of the longest prefix of this traversable collection whose
elements all satisfy
- Definition Classes
- TraversableLike → GenTraversableLike
(defined at scala.collection.TraversableLike)
def splitAt(n: Int): (BitSet, BitSet)
Splits this traversable collection into two at a given position. Note:
c splitAt n
is equivalent to (but possibly more efficient than)
(c take n, c drop n)
.
Note: might return different results for different runs, unless the underlying collection type is ordered.
- n
- the position at which to split.
- returns
- a pair of traversable collections consisting of the first
n
elements of this traversable collection, and the other elements.
- a pair of traversable collections consisting of the first
- Definition Classes
- TraversableLike → GenTraversableLike
(defined at scala.collection.TraversableLike)
def tail: BitSet
Selects all elements except the first.
Note: might return different results for different runs, unless the underlying collection type is ordered.
- returns
- a traversable collection consisting of all elements of this traversable collection except the first one.
- Definition Classes
- TraversableLike → GenTraversableLike
- Exceptions thrown
UnsupportedOperationException
if the traversable collection is empty.
(defined at scala.collection.TraversableLike)
def tails: Iterator[BitSet]
Iterates over the tails of this traversable collection. The first value will be
this traversable collection and the final one will be an empty traversable
collection, with the intervening values the results of successive applications
of tail
.
- returns
- an iterator over all the tails of this traversable collection
- Definition Classes
- TraversableLike
Example:
(defined at scala.collection.TraversableLike)
def toTraversable: Traversable[Int]
Converts this traversable collection to an unspecified Traversable. Will return the same collection if this instance is already Traversable.
Note: will not terminate for infinite-sized collections.
- returns
- a Traversable containing all elements of this traversable collection.
- Definition Classes
- TraversableLike → TraversableOnce → GenTraversableOnce
- Annotations
- @ deprecatedOverriding (message =…, since = “2.11.0”)
(defined at scala.collection.TraversableLike)
def withFilter(p: (Int) ⇒ Boolean): FilterMonadic[Int, BitSet]
Creates a non-strict filter of this traversable collection.
Note: the difference between c filter p
and c withFilter p
is that the
former creates a new collection, whereas the latter only restricts the domain of
subsequent map
, flatMap
, foreach
, and withFilter
operations.
Note: might return different results for different runs, unless the underlying collection type is ordered.
- p
- the predicate used to test elements.
- returns
- an object of class
WithFilter
, which supportsmap
,flatMap
,foreach
, andwithFilter
operations. All these operations apply to those elements of this traversable collection which satisfy the predicatep
.
- an object of class
- Definition Classes
- TraversableLike → FilterMonadic
(defined at scala.collection.TraversableLike)
Concrete Value Members From scala.collection.TraversableOnce
def /:[B](z: B)(op: (B, Int) ⇒ B): B
Applies a binary operator to a start value and all elements of this traversable or iterator, going left to right.
Note: /:
is alternate syntax for foldLeft
; z /: xs
is the same as
xs foldLeft z
.
Examples:
Note that the folding function used to compute b is equivalent to that used to compute c.
Note: will not terminate for infinite-sized collections.
Note: might return different results for different runs, unless the underlying collection type is ordered or the operator is associative and commutative.
- B
- the result type of the binary operator.
- z
- the start value.
- op
- the binary operator.
- returns
- the result of inserting
op
between consecutive elements of this traversable or iterator, going left to right with the start valuez
on the left:
- the result of inserting
where `x1, ..., xn` are the elements of this traversable or iterator.
- Definition Classes
- TraversableOnce → GenTraversableOnce
(defined at scala.collection.TraversableOnce)
def :\[B](z: B)(op: (Int, B) ⇒ B): B
Applies a binary operator to all elements of this traversable or iterator and a start value, going right to left.
Note: :\
is alternate syntax for foldRight
; xs :\ z
is the same as
xs foldRight z
.
Note: will not terminate for infinite-sized collections.
Note: might return different results for different runs, unless the underlying collection type is ordered or the operator is associative and commutative.
Examples:
Note that the folding function used to compute b is equivalent to that used to compute c.
- B
- the result type of the binary operator.
- z
- the start value
- op
- the binary operator
- returns
- the result of inserting
op
between consecutive elements of this traversable or iterator, going right to left with the start valuez
on the right:
- the result of inserting
where `x1, ..., xn` are the elements of this traversable or iterator.
- Definition Classes
- TraversableOnce → GenTraversableOnce
(defined at scala.collection.TraversableOnce)
def addString(b: StringBuilder): StringBuilder
Appends all elements of this traversable or iterator to a string builder. The
written text consists of the string representations (w.r.t. the method
toString
) of all elements of this traversable or iterator without any
separator string.
Example:
- b
- the string builder to which elements are appended.
- returns
- the string builder
b
to which elements were appended.
- the string builder
- Definition Classes
- TraversableOnce
(defined at scala.collection.TraversableOnce)
def addString(b: StringBuilder, sep: String): StringBuilder
Appends all elements of this traversable or iterator to a string builder using a
separator string. The written text consists of the string representations
(w.r.t. the method toString
) of all elements of this traversable or iterator,
separated by the string sep
.
Example:
- b
- the string builder to which elements are appended.
- sep
- the separator string.
- returns
- the string builder
b
to which elements were appended.
- the string builder
- Definition Classes
- TraversableOnce
(defined at scala.collection.TraversableOnce)
def aggregate[B](z: ⇒ B)(seqop: (B, Int) ⇒ B, combop: (B, B) ⇒ B): B
Aggregates the results of applying an operator to subsequent elements.
This is a more general form of fold
and reduce
. It is similar to
foldLeft
in that it doesn’t require the result to be a supertype of the
element type. In addition, it allows parallel collections to be processed in
chunks, and then combines the intermediate results.
aggregate
splits the traversable or iterator into partitions and processes
each partition by sequentially applying seqop
, starting with z
(like
foldLeft
). Those intermediate results are then combined by using combop
(like fold
). The implementation of this operation may operate on an arbitrary
number of collection partitions (even 1), so combop
may be invoked an
arbitrary number of times (even 0).
As an example, consider summing up the integer values of a list of chars. The
initial value for the sum is 0. First, seqop
transforms each input character
to an Int and adds it to the sum (of the partition). Then, combop
just needs
to sum up the intermediate results of the partitions:
- B
- the type of accumulated results
- z
- the initial value for the accumulated result of the partition - this will
typically be the neutral element for the
seqop
operator (e.g.Nil
for list concatenation or0
for summation) and may be evaluated more than once
- the initial value for the accumulated result of the partition - this will
typically be the neutral element for the
- seqop
- an operator used to accumulate results within a partition
- combop
- an associative operator used to combine results from different partitions
- Definition Classes
- TraversableOnce → GenTraversableOnce
(defined at scala.collection.TraversableOnce)
def collectFirst[B](pf: PartialFunction[Int, B]): Option[B]
Finds the first element of the traversable or iterator for which the given partial function is defined, and applies the partial function to it.
Note: may not terminate for infinite-sized collections.
Note: might return different results for different runs, unless the underlying collection type is ordered.
- pf
- the partial function
- returns
- an option value containing pf applied to the first value for which it is
defined, or
None
if none exists.
- an option value containing pf applied to the first value for which it is
defined, or
- Definition Classes
- TraversableOnce
Example:
(defined at scala.collection.TraversableOnce)
def copyToArray[B >: Int](xs: Array[B]): Unit
[use case]
Copies the elements of this bitset to an array. Fills the given array xs
with
values of this bitset. Copying will stop once either the end of the current
bitset is reached, or the end of the target array is reached.
- xs
- the array to fill.
- Definition Classes
- TraversableOnce → GenTraversableOnce
(defined at scala.collection.TraversableOnce)
def copyToArray[B >: Int](xs: Array[B], start: Int): Unit
[use case]
Copies the elements of this bitset to an array. Fills the given array xs
with
values of this bitset, beginning at index start
. Copying will stop once
either the end of the current bitset is reached, or the end of the target array
is reached.
- xs
- the array to fill.
- start
- the starting index.
- Definition Classes
- TraversableOnce → GenTraversableOnce
(defined at scala.collection.TraversableOnce)
def copyToBuffer[B >: Int](dest: Buffer[B]): Unit
Copies all elements of this traversable or iterator to a buffer.
Note: will not terminate for infinite-sized collections.
- dest
- The buffer to which elements are copied.
- Definition Classes
- TraversableOnce
(defined at scala.collection.TraversableOnce)
def count(p: (Int) ⇒ Boolean): Int
Counts the number of elements in the traversable or iterator which satisfy a predicate.
- p
- the predicate used to test elements.
- returns
- the number of elements satisfying the predicate
p
.
- the number of elements satisfying the predicate
- Definition Classes
- TraversableOnce → GenTraversableOnce
(defined at scala.collection.TraversableOnce)
def foldLeft[B](z: B)(op: (B, Int) ⇒ B): B
Applies a binary operator to a start value and all elements of this traversable or iterator, 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 or the operator is associative and commutative.
- B
- the result type of the binary operator.
- z
- the start value.
- op
- the binary operator.
- returns
- the result of inserting
op
between consecutive elements of this traversable or iterator, going left to right with the start valuez
on the left:
- the result of inserting
where `x1, ..., xn` are the elements of this traversable or iterator.
Returns `z` if this traversable or iterator is empty.
- Definition Classes
- TraversableOnce → GenTraversableOnce
(defined at scala.collection.TraversableOnce)
def fold[A1 >: Int](z: A1)(op: (A1, A1) ⇒ A1): A1
Folds the elements of this traversable or iterator using the specified associative binary operator.
The order in which operations are performed on elements is unspecified and may be nondeterministic.
Note: will not terminate for infinite-sized collections.
- A1
- a type parameter for the binary operator, a supertype of
A
.
- a type parameter for the binary operator, a supertype of
- z
- a neutral element for the fold operation; may be added to the result an
arbitrary number of times, and must not change the result (e.g.,
Nil
for list concatenation, 0 for addition, or 1 for multiplication).
- a neutral element for the fold operation; may be added to the result an
arbitrary number of times, and must not change the result (e.g.,
- op
- a binary operator that must be associative.
- returns
- the result of applying the fold operator
op
between all the elements andz
, orz
if this traversable or iterator is empty.
- the result of applying the fold operator
- Definition Classes
- TraversableOnce → GenTraversableOnce
(defined at scala.collection.TraversableOnce)
def maxBy[B](f: (Int) ⇒ B)(implicit cmp: Ordering[B]): Int
[use case]
Finds the first element which yields the largest value measured by function f.
- B
- The result type of the function f.
- f
- The measuring function.
- returns
- the first element of this bitset with the largest value measured by function f.
- Definition Classes
- TraversableOnce → GenTraversableOnce
(defined at scala.collection.TraversableOnce)
def minBy[B](f: (Int) ⇒ B)(implicit cmp: Ordering[B]): Int
[use case]
Finds the first element which yields the smallest value measured by function f.
- B
- The result type of the function f.
- f
- The measuring function.
- returns
- the first element of this bitset with the smallest value measured by function f.
- Definition Classes
- TraversableOnce → GenTraversableOnce
(defined at scala.collection.TraversableOnce)
def mkString(sep: String): String
Displays all elements of this traversable or iterator in a string using a separator string.
- sep
- the separator string.
- returns
- a string representation of this traversable or iterator. In the resulting
string the string representations (w.r.t. the method
toString
) of all elements of this traversable or iterator are separated by the stringsep
.
- a string representation of this traversable or iterator. In the resulting
string the string representations (w.r.t. the method
- Definition Classes
- TraversableOnce → GenTraversableOnce
Example:
(defined at scala.collection.TraversableOnce)
def mkString(start: String, sep: String, end: String): String
Displays all elements of this traversable or iterator in a string using start, end, and separator strings.
- start
- the starting string.
- sep
- the separator string.
- end
- the ending string.
- returns
- a string representation of this traversable or iterator. The resulting
string begins with the string
start
and ends with the stringend
. Inside, the string representations (w.r.t. the methodtoString
) of all elements of this traversable or iterator are separated by the stringsep
.
- a string representation of this traversable or iterator. The resulting
string begins with the string
- Definition Classes
- TraversableOnce → GenTraversableOnce
Example:
(defined at scala.collection.TraversableOnce)
def reduceLeftOption[B >: Int](op: (B, Int) ⇒ B): Option[B]
Optionally applies a binary operator to all elements of this traversable or iterator, 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 or the operator is associative and commutative.
- B
- the result type of the binary operator.
- op
- the binary operator.
- returns
- an option value containing the result of
reduceLeft(op)
if this traversable or iterator is nonempty,None
otherwise.
- an option value containing the result of
- Definition Classes
- TraversableOnce → GenTraversableOnce
(defined at scala.collection.TraversableOnce)
def reduceLeft[B >: Int](op: (B, Int) ⇒ B): B
Applies a binary operator to all elements of this traversable or iterator, 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 or the operator is associative and commutative.
- B
- the result type of the binary operator.
- op
- the binary operator.
- returns
- the result of inserting
op
between consecutive elements of this traversable or iterator, going left to right:
- the result of inserting
where `x1, ..., xn` are the elements of this traversable or iterator.
- Definition Classes
- TraversableOnce
- Exceptions thrown
- UnsupportedOperationException if this traversable or iterator is empty.
(defined at scala.collection.TraversableOnce)
def reduceOption[A1 >: Int](op: (A1, A1) ⇒ A1): Option[A1]
Reduces the elements of this traversable or iterator, if any, using the specified associative binary operator.
The order in which operations are performed on elements is unspecified and may be nondeterministic.
- A1
- A type parameter for the binary operator, a supertype of
A
.
- A type parameter for the binary operator, a supertype of
- op
- A binary operator that must be associative.
- returns
- An option value containing result of applying reduce operator
op
between all the elements if the collection is nonempty, andNone
otherwise.
- An option value containing result of applying reduce operator
- Definition Classes
- TraversableOnce → GenTraversableOnce
(defined at scala.collection.TraversableOnce)
def reduceRightOption[B >: Int](op: (Int, B) ⇒ B): Option[B]
Optionally applies a binary operator to all elements of this traversable or iterator, going right to left.
Note: will not terminate for infinite-sized collections.
Note: might return different results for different runs, unless the underlying collection type is ordered or the operator is associative and commutative.
- B
- the result type of the binary operator.
- op
- the binary operator.
- returns
- an option value containing the result of
reduceRight(op)
if this traversable or iterator is nonempty,None
otherwise.
- an option value containing the result of
- Definition Classes
- TraversableOnce → GenTraversableOnce
(defined at scala.collection.TraversableOnce)
def reduce[A1 >: Int](op: (A1, A1) ⇒ A1): A1
Reduces the elements of this traversable or iterator using the specified associative binary operator.
The order in which operations are performed on elements is unspecified and may be nondeterministic.
- A1
- A type parameter for the binary operator, a supertype of
A
.
- A type parameter for the binary operator, a supertype of
- op
- A binary operator that must be associative.
- returns
- The result of applying reduce operator
op
between all the elements if the traversable or iterator is nonempty.
- The result of applying reduce operator
- Definition Classes
- TraversableOnce → GenTraversableOnce
- Exceptions thrown
- UnsupportedOperationException if this traversable or iterator is empty.
(defined at scala.collection.TraversableOnce)
def reversed: List[Int]
- Attributes
- protected[this]
- Definition Classes
- TraversableOnce
(defined at scala.collection.TraversableOnce)
def toIndexedSeq: immutable.IndexedSeq[Int]
Converts this traversable or iterator to an indexed sequence.
Note: will not terminate for infinite-sized collections.
- returns
- an indexed sequence containing all elements of this traversable or iterator.
- Definition Classes
- TraversableOnce → GenTraversableOnce
(defined at scala.collection.TraversableOnce)
def toList: List[Int]
Converts this traversable or iterator to a list.
Note: will not terminate for infinite-sized collections.
- returns
- a list containing all elements of this traversable or iterator.
- Definition Classes
- TraversableOnce → GenTraversableOnce
(defined at scala.collection.TraversableOnce)
def toMap[T, U](implicit ev: <:<[Int, (T, U)]): immutable.Map[T, U]
[use case]
Converts this bitset to a map. This method is unavailable unless the elements are members of Tuple2, each ((T, U)) becoming a key-value pair in the map. Duplicate keys will be overwritten by later keys: if this is an unordered collection, which key is in the resulting map is undefined.
- returns
- a map of type
immutable.Map[T, U]
containing all key/value pairs of type(T, U)
of this bitset.
- a map of type
- Definition Classes
- TraversableOnce → GenTraversableOnce
(defined at scala.collection.TraversableOnce)
def toSet[B >: Int]: immutable.Set[B]
Converts this traversable or iterator to a set.
Note: will not terminate for infinite-sized collections.
- returns
- a set containing all elements of this traversable or iterator.
- Definition Classes
- TraversableOnce → GenTraversableOnce
(defined at scala.collection.TraversableOnce)
def toVector: Vector[Int]
Converts this traversable or iterator to a Vector.
Note: will not terminate for infinite-sized collections.
- returns
- a vector containing all elements of this traversable or iterator.
- Definition Classes
- TraversableOnce → GenTraversableOnce
(defined at scala.collection.TraversableOnce)
Concrete Value Members From scala.collection.generic.GenericTraversableTemplate ——————————————————————————–
def flatten[B](implicit asTraversable: (Int) ⇒ GenTraversableOnce[B]): Set[B]
[use case]
Converts this bitset of traversable collections into a bitset formed by the elements of these traversable collections.
The resulting collection’s type will be guided by the static type of bitset. For example:
- B
- the type of the elements of each traversable collection.
- returns
- a new bitset resulting from concatenating all element bitsets.
- Definition Classes
- GenericTraversableTemplate
(defined at scala.collection.generic.GenericTraversableTemplate)
def genericBuilder[B]: Builder[B, Set[B]]
The generic builder that builds instances of Traversable at arbitrary element types.
- Definition Classes
- GenericTraversableTemplate
(defined at scala.collection.generic.GenericTraversableTemplate)
def transpose[B](implicit asTraversable: (Int) ⇒ GenTraversableOnce[B]): Set[Set[B]]
Transposes this collection of traversable collections into a collection of collections.
The resulting collection’s type will be guided by the static type of collection. For example:
- B
- the type of the elements of each traversable collection.
- asTraversable
- an implicit conversion which asserts that the element type of this
collection is a
Traversable
.
- an implicit conversion which asserts that the element type of this
collection is a
- returns
- a two-dimensional collection of collections which has as n th row the n th column of this collection.
- Definition Classes
- GenericTraversableTemplate
- Annotations
- @migration
- Migration
- (Changed in version 2.9.0)
transpose
throws anIllegalArgumentException
if collections are not uniformly sized.
- (Changed in version 2.9.0)
- Exceptions thrown
- IllegalArgumentException if all collections in this collection are not of the same size.
(defined at scala.collection.generic.GenericTraversableTemplate)
def unzip3[A1, A2, A3](implicit asTriple: (Int) ⇒ (A1, A2, A3)): (Set[A1], Set[A2], Set[A3])
Converts this collection of triples into three collections of the first, second, and third element of each triple.
- A1
- the type of the first member of the element triples
- A2
- the type of the second member of the element triples
- A3
- the type of the third member of the element triples
- asTriple
- an implicit conversion which asserts that the element type of this collection is a triple.
- returns
- a triple of collections, containing the first, second, respectively third member of each element triple of this collection.
- Definition Classes
- GenericTraversableTemplate
(defined at scala.collection.generic.GenericTraversableTemplate)
def unzip[A1, A2](implicit asPair: (Int) ⇒ (A1, A2)): (Set[A1], Set[A2])
Converts this collection of pairs into two collections of the first and second half of each pair.
- A1
- the type of the first half of the element pairs
- A2
- the type of the second half of the element pairs
- asPair
- an implicit conversion which asserts that the element type of this collection is a pair.
- returns
- a pair of collections, containing the first, respectively second half of each element pair of this collection.
- Definition Classes
- GenericTraversableTemplate
(defined at scala.collection.generic.GenericTraversableTemplate)
Concrete Value Members From scala.collection.generic.Sorted
def compare(k0: Int, k1: Int): Int
Comparison function that orders keys.
- Definition Classes
- Sorted
(defined at scala.collection.generic.Sorted)
def hasAll(j: Iterator[Int]): Boolean
- Attributes
- protected
- Definition Classes
- Sorted
(defined at scala.collection.generic.Sorted)
def to(to: Int): BitSet
Create a range projection of this collection with no lower-bound.
- to
- The upper-bound (inclusive) of the ranged projection.
- Definition Classes
- Sorted
(defined at scala.collection.generic.Sorted)
Concrete Value Members From scala.collection.generic.Subtractable
def -(elem1: Int, elem2: Int, elems: Int*): BitSet
Creates a new collection from this collection with some elements removed.
This method takes two or more elements to be removed. Another overloaded variant of this method handles the case where a single element is removed.
- elem1
- the first element to remove.
- elem2
- the second element to remove.
- elems
- the remaining elements to remove.
- returns
- a new collection that contains all elements of the current collection except one less occurrence of each of the given elements.
- Definition Classes
- Subtractable
(defined at scala.collection.generic.Subtractable)
def --(xs: GenTraversableOnce[Int]): BitSet
Creates a new collection from this collection by removing all elements of another collection.
- xs
- the collection containing the removed elements.
- returns
- a new collection that contains all elements of the current collection except
one less occurrence of each of the elements of
elems
.
- a new collection that contains all elements of the current collection except
one less occurrence of each of the elements of
- Definition Classes
- Subtractable
(defined at scala.collection.generic.Subtractable)
Concrete Value Members From Implicit scala.collection.parallel.CollectionsHaveToParArray ——————————————————————————–
def toParArray: ParArray[T]
- Implicit information
- This member is added by an implicit conversion from BitSet to CollectionsHaveToParArray [BitSet, T] performed by method CollectionsHaveToParArray in scala.collection.parallel. This conversion will take place only if an implicit value of type (BitSet) ⇒ GenTraversableOnce [ T] is in scope.
- Definition Classes
- CollectionsHaveToParArray (added by implicit convertion: scala.collection.parallel.CollectionsHaveToParArray)
Full Source:
Interested in Scala?
I send out weekly, personalized emails with articles and conference talks.
Subscribe now.