Docs4dev
Docs
scala / 3.1 / scala / collection / bitsetops.html

Trait scala.collection.BitSetOps

Companion object • Source code

trait BitSetOps[+C <: BitSet & BitSetOps[C]] extends SortedSetOps[Int, SortedSet, C]

Base implementation type of bitsets

Supertypes
trait SortedSetOps[Int, SortedSet, C]
trait SortedOps[Int, C]
trait SetOps[Int, Set, C]
trait Int => Boolean
trait IterableOps[Int, Set, C]
trait IterableOnceOps[Int, Set, C]
trait IterableOnce[Int]
class Object
trait Matchable
class Any
Known subtypes
trait BitSet
class BitSet
class BitSet1
class BitSet2
class BitSetN
class BitSet
Self type
BitSetOps[C]

Abstract methods

Source
def bitSetFactory: SpecificIterableFactory[Int, C]

Source
def unsorted: Set[Int]

Concrete methods

Source@inline
final def ^(other: BitSet): C

Source
def collect(pf: PartialFunction[Int, Int]): C

Source
override def concat(other: IterableOnce[Int]): C

Definition Classes SetOps

Source
def contains(elem: Int): Boolean

Source
def diff(other: Set[Int]): C

Source
def flatMap(f: Int => IterableOnce[Int]): C

Source
override def foreach[U](f: Int => U): Unit

Definition Classes IterableOnceOps

Source
override def intersect(other: Set[Int]): C

Definition Classes SetOps

Source
override def isEmpty: Boolean

Definition Classes IterableOnceOps

Source
def iterator: Iterator[Int]

Source
def iteratorFrom(start: Int): Iterator[Int]

Source
def map(f: Int => Int): C

Builds a new bitset by applying a function to all elements of this bitset

Value parameters
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

Source
override def max[B >: Int](implicit ord: Ordering[B]): Int

Definition Classes SortedSetOps -> IterableOnceOps

Source
override def min[B >: Int](implicit ord: Ordering[B]): Int

Definition Classes SortedSetOps -> IterableOnceOps

Source
final def ordering: Ordering[Int]

Source
override def partition(p: Int => Boolean): (C, C)

Definition Classes IterableOps

Source
def rangeImpl(from: Option[Int], until: Option[Int]): C

Source
override def size: Int

Definition Classes IterableOnceOps

Source
override def stepper[S <: Stepper[_]](implicit shape: StepperShape[Int, S]): S & EfficientSplit

Definition Classes IterableOnce

Source
def toBitMask: Array[Long]

Creates a bit mask for this set as a new array of longs

Source
def xor(other: BitSet): C

Computes the symmetric difference of this bitset and another bitset by performing a bitwise "exclusive-or".

Value parameters
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.

Inherited methods

Source@inline
final def &(that: Set[Int]): C

Alias for intersect

Inherited from SetOps

Source@inline
final def &~(that: Set[Int]): C

Alias for diff

Inherited from SetOps

Source@inline
final def ++(that: IterableOnce[Int]): C

Alias for concat

Inherited from SetOps

Source@inline
final def ++[B >: Int](suffix: IterableOnce[B]): Set[B]

Alias for concat

Inherited from IterableOps

Source@inline
final def addString(b: StringBuilder): StringBuilder

Appends all elements of this collection to a string builder. The written text consists of the string representations (w.r.t. the method toString) of all elements of this collection without any separator string.

Example:

scala> val a = List(1,2,3,4)
a: List[Int] = List(1, 2, 3, 4)

scala> val b = new StringBuilder()
b: StringBuilder =

scala> val h = a.addString(b)
h: StringBuilder = 1234
Value parameters
b

the string builder to which elements are appended.
Returns

the string builder b to which elements were appended.
Inherited from IterableOnceOps

Source@inline
final def addString(b: StringBuilder, sep: String): StringBuilder

Appends all elements of this collection 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 collection, separated by the string sep.

Example:

scala> val a = List(1,2,3,4)
a: List[Int] = List(1, 2, 3, 4)

scala> val b = new StringBuilder()
b: StringBuilder =

scala> a.addString(b, ", ")
res0: StringBuilder = 1, 2, 3, 4
Value parameters
b

the string builder to which elements are appended.

sep

the separator string.
Returns

the string builder b to which elements were appended.
Inherited from IterableOnceOps

Source
def addString(b: StringBuilder, start: String, sep: String, end: String): StringBuilder

Appends all elements of this collection 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 collection are separated by the string sep.

Example:

scala> val a = List(1,2,3,4)
a: List[Int] = List(1, 2, 3, 4)

scala> val b = new StringBuilder()
b: StringBuilder =

scala> a.addString(b , "List(" , ", " , ")")
res5: StringBuilder = List(1, 2, 3, 4)
Value parameters
b

the string builder to which elements are appended.

end

the ending string.

sep

the separator string.

start

the starting string.
Returns

the string builder b to which elements were appended.
Inherited from IterableOnceOps

Source@unspecialized
def andThen[A](g: Boolean => A): Int => A

Composes two instances of Function1 in a new Function1, with this function applied first.

Type parameters
A

the result type of function g
Value parameters
g

a function R => A
Returns

a new function f such that f(x) == g(apply(x))
Inherited from Function1

Source@inline
final 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.

Value parameters
elem

the element to test for membership.
Returns

true if elem is contained in this set, false otherwise.
Inherited from SetOps

Source
def collect[B](pf: PartialFunction[Int, B])(implicit @implicitNotFound ev: Ordering[B]): SortedSet[B]

Builds a new sorted collection by applying a partial function to all elements of this set on which the function is defined.

Type parameters
B

the element type of the returned collection.
Value parameters
pf

the partial function which filters and maps the set.
Returns

a new set 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.
Inherited from SortedSetOps

Source
def collect[B](pf: PartialFunction[Int, B]): Set[B]

Inherited from IterableOps

Source
def collectFirst[B](pf: PartialFunction[Int, B]): Option[B]

Finds the first element of the collection 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.

Value parameters
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.
Example

Seq("a", 1, 5L).collectFirst({ case x: Int => x*10 }) = Some(10)
Inherited from IterableOnceOps

Source@unspecialized
def compose[A](g: A => Int): A => Boolean

Composes two instances of Function1 in a new Function1, with this function applied last.

Type parameters
A

the type to which function g can be applied
Value parameters
g

a function A => T1
Returns

a new function f such that f(x) == apply(g(x))
Inherited from Function1

Source
def concat[B >: Int](suffix: IterableOnce[B]): Set[B]

Returns a new iterable collection containing the elements from the left hand operand followed by the elements from the right hand operand. The element type of the iterable collection is the most specific superclass encompassing the element types of the two operands.

Type parameters
B

the element type of the returned collection.
Value parameters
suffix

the traversable to append.
Returns

a new iterable collection which contains all elements of this iterable collection followed by all elements of suffix.
Inherited from IterableOps

Source
def copyToArray[B >: Int](xs: Array[B], start: Int, len: Int): Int

Copy elements to an array, returning the number of elements written.

Fills the given array xs starting at index start with at most len elements of this collection.

Copying will stop once either all the elements of this collection have been copied, or the end of the array is reached, or len elements have been copied.

Type parameters
B

the type of the elements of the array.
Value parameters
len

the maximal number of elements to copy.

start

the starting index of xs.

xs

the array to fill.
Returns

the number of elements written to the array
Note

Reuse: After calling this method, one should discard the iterator it was called on. Using it is undefined and subject to change.
Inherited from IterableOnceOps

Source@deprecatedOverriding("This should always forward to the 3-arg version of this method", since = "2.13.4")
def copyToArray[B >: Int](xs: Array[B], start: Int): Int

Copy elements to an array, returning the number of elements written.

Fills the given array xs starting at index start with values of this collection.

Copying will stop once either all the elements of this collection have been copied, or the end of the array is reached.

Type parameters
B

the type of the elements of the array.
Value parameters
start

the starting index of xs.

xs

the array to fill.
Returns

the number of elements written to the array
Note

Reuse: After calling this method, one should discard the iterator it was called on. Using it is undefined and subject to change.
Inherited from IterableOnceOps

Source@deprecatedOverriding("This should always forward to the 3-arg version of this method", since = "2.13.4")
def copyToArray[B >: Int](xs: Array[B]): Int

Copy elements to an array, returning the number of elements written.

Fills the given array xs starting at index start with values of this collection.

Copying will stop once either all the elements of this collection have been copied, or the end of the array is reached.

Type parameters
B

the type of the elements of the array.
Value parameters
xs

the array to fill.
Returns

the number of elements written to the array
Note

Reuse: After calling this method, one should discard the iterator it was called on. Using it is undefined and subject to change.
Inherited from IterableOnceOps

Source
def corresponds[B](that: IterableOnce[B])(p: (Int, B) => Boolean): Boolean

Tests whether every element of this collection's iterator relates to the corresponding element of another collection by satisfying a test predicate.

Note: will not terminate for infinite-sized collections.

Type parameters
B

the type of the elements of that
Value parameters
p

the test predicate, which relates elements from both collections

that

the other collection
Returns

true if both collections have the same length and p(x, y) is true for all corresponding elements x of this iterator and y of that, otherwise false
Inherited from IterableOnceOps

Source
def count(p: Int => Boolean): Int

Counts the number of elements in the collection which satisfy a predicate.

Note: will not terminate for infinite-sized collections.

Value parameters
p

the predicate used to test elements.
Returns

the number of elements satisfying the predicate p.
Inherited from IterableOnceOps

Source
def drop(n: Int): C

Inherited from IterableOps

Source
def dropRight(n: Int): C

Selects all elements except last n ones.

Note: might return different results for different runs, unless the underlying collection type is ordered.

Value parameters
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 last n ones, or else the empty iterable collection, if this iterable collection has less than n elements. If n is negative, don't drop any elements.
Inherited from IterableOps

Source
def dropWhile(p: Int => Boolean): C

Inherited from IterableOps

Source
def empty: C

The empty iterable of the same type as this iterable

Returns

an empty iterable of type C.
Inherited from IterableOps

Source
def exists(p: Int => Boolean): Boolean

Tests whether a predicate holds for at least one element of this collection.

Note: may not terminate for infinite-sized collections.

Value parameters
p

the predicate used to test elements.
Returns

true if the given predicate p is satisfied by at least one element of this collection, otherwise false
Inherited from IterableOnceOps

Source
def filter(pred: Int => Boolean): C

Inherited from IterableOps

Source
def filterNot(pred: Int => Boolean): C

Inherited from IterableOps

Source
def find(p: Int => Boolean): Option[Int]

Finds the first element of the 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.

Value parameters
p

the predicate used to test elements.
Returns

an option value containing the first element in the collection that satisfies p, or None if none exists.
Inherited from IterableOnceOps

Source
def firstKey: Int

Inherited from SortedSetOps

Source
def flatMap[B](f: Int => IterableOnce[B])(implicit @implicitNotFound ev: Ordering[B]): SortedSet[B]

Builds a new sorted collection by applying a function to all elements of this set and using the elements of the resulting collections.

Type parameters
B

the element type of the returned collection.
Value parameters
f

the function to apply to each element.
Returns

a new set resulting from applying the given collection-valued function f to each element of this set and concatenating the results.
Inherited from SortedSetOps

Source
def flatMap[B](f: Int => IterableOnce[B]): Set[B]

Inherited from IterableOps

Source
def flatten[B](implicit asIterable: Int => IterableOnce[B]): Set[B]

Inherited from IterableOps

Source
def fold[A1 >: Int](z: A1)(op: (A1, A1) => A1): A1

Folds the elements of this collection using the specified associative binary operator. The default implementation in IterableOnce is equivalent to foldLeft but may be overridden for more efficient traversal orders.

The order in which operations are performed on elements is unspecified and may be nondeterministic.

Note: will not terminate for infinite-sized collections.

Type parameters
A1

a type parameter for the binary operator, a supertype of A.
Value parameters
op

a binary operator that must be associative.

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).
Returns

the result of applying the fold operator op between all the elements and z, or z if this collection is empty.
Inherited from IterableOnceOps

Source
def foldLeft[B](z: B)(op: (B, Int) => B): B

Applies a binary operator to a start value and all elements of this collection, 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.

Type parameters
B

the result type of the binary operator.
Value parameters
op

the binary operator.

z

the start value.
Returns

the result of inserting op between consecutive elements of this collection, going left to right with the start value z on the left: op(...op(z, x1), x2, ..., xn) where x1, ..., xn are the elements of this collection. Returns z if this collection is empty.
Inherited from IterableOnceOps

Source
def foldRight[B](z: B)(op: (Int, B) => B): B

Applies a binary operator to all elements of this 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.

Type parameters
B

the result type of the binary operator.
Value parameters
op

the binary operator.

z

the start value.
Returns

the result of inserting op between consecutive elements of this collection, going right to left with the start value z on the right: op(x1, op(x2, ... op(xn, z)...)) where x1, ..., xn are the elements of this collection. Returns z if this collection is empty.
Inherited from IterableOnceOps

Source
def forall(p: Int => Boolean): Boolean

Tests whether a predicate holds for all elements of this collection.

Note: may not terminate for infinite-sized collections.

Value parameters
p

the predicate used to test elements.
Returns

true if this collection is empty or the given predicate p holds for all elements of this collection, otherwise false.
Inherited from IterableOnceOps

Source
def groupBy[K](f: Int => K): Map[K, C]

Partitions this iterable collection into a map of iterable collections according to some discriminator function.

Note: Even when applied to a view or a lazy collection it will always force the elements.

Type parameters
K

the type of keys returned by the discriminator function.
Value parameters
f

the discriminator function.
Returns

A map from keys to iterable collections such that the following invariant holds:

(xs groupBy f)(k) = xs filter (x => f(x) == k)

That is, every key k is bound to a iterable collection of those elements x for which f(x) equals k.
Inherited from IterableOps

Source
def groupMap[K, B](key: Int => K)(f: Int => B): Map[K, Set[B]]

Partitions this iterable collection into a map of iterable collections according to a discriminator function key. Each element in a group is transformed into a value of type B using the value function.

It is equivalent to groupBy(key).mapValues(_.map(f)), but more efficient.

case class User(name: String, age: Int)

def namesByAge(users: Seq[User]): Map[Int, Seq[String]] =
  users.groupMap(_.age)(_.name)

Note: Even when applied to a view or a lazy collection it will always force the elements.

Type parameters
B

the type of values returned by the transformation function

K

the type of keys returned by the discriminator function
Value parameters
f

the element transformation function

key

the discriminator function
Inherited from IterableOps

Source
def groupMapReduce[K, B](key: Int => K)(f: Int => B)(reduce: (B, B) => B): Map[K, B]

Partitions this iterable collection into a map according to a discriminator function key. All the values that have the same discriminator are then transformed by the f function and then reduced into a single value with the reduce function.

It is equivalent to groupBy(key).mapValues(_.map(f).reduce(reduce)), but more efficient.

def occurrences[A](as: Seq[A]): Map[A, Int] =
  as.groupMapReduce(identity)(_ => 1)(_ + _)

Note: Even when applied to a view or a lazy collection it will always force the elements.

Inherited from IterableOps

Source
def grouped(size: Int): Iterator[C]

Partitions elements in fixed size iterable collections.

Value parameters
size

the number of elements per group
Returns

An iterator producing iterable collections of size size, except the last will be less than size size if the elements don't divide evenly.
See also

scala.collection.Iterator, method grouped
Inherited from IterableOps

Source
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.
Throws
NoSuchElementException

if the iterable collection is empty.
Inherited from IterableOps

Source
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 iterable collection if it is nonempty, None if it is empty.
Inherited from IterableOps

Source
def init: C

The initial part of the collection without its last element.

Note: Even when applied to a view or a lazy collection it will always force the elements.

Inherited from IterableOps

Source
def inits: Iterator[C]

Iterates over the inits of this iterable collection. The first value will be this iterable collection and the final one will be an empty iterable collection, with the intervening values the results of successive applications of init.

Note: Even when applied to a view or a lazy collection it will always force the elements.

Returns

an iterator over all the inits of this iterable collection
Example

List(1,2,3).inits = Iterator(List(1,2,3), List(1,2), List(1), Nil)
Inherited from IterableOps

Source
override def isTraversableAgain: Boolean

Definition Classes IterableOps -> IterableOnceOps
Inherited from IterableOps

Source
def iterableFactory: IterableFactory[Set]

The companion object of this iterable collection, providing various factory methods.

Note

When implementing a custom collection type and refining CC to the new type, this method needs to be overridden to return a factory for the new type (the compiler will issue an error otherwise).
Inherited from IterableOps

Source
def knownSize: Int

Returns

The number of elements in this collection, if it can be cheaply computed, -1 otherwise. Cheaply usually means: Not requiring a collection traversal.
Inherited from IterableOnce

Source
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 iterable collection.
Throws
NoSuchElementException

If the iterable collection is empty.
Inherited from IterableOps

Source
def lastKey: Int

Inherited from SortedSetOps

Source
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 iterable collection$ if it is nonempty, None if it is empty.
Inherited from IterableOps

Source
def map[B](f: Int => B)(implicit @implicitNotFound ev: Ordering[B]): SortedSet[B]

Builds a new sorted collection by applying a function to all elements of this set.

Type parameters
B

the element type of the returned collection.
Value parameters
f

the function to apply to each element.
Returns

a new set resulting from applying the given function f to each element of this set and collecting the results.
Inherited from SortedSetOps

Source
def map[B](f: Int => B): Set[B]

Inherited from IterableOps

Source
def maxBefore(key: Int): Option[Int]

Find the largest element less than a given key.

Value parameters
key

The given key.
Returns

None if there is no such node.
Inherited from SortedSetOps

Source
def maxBy[B](f: Int => B)(implicit cmp: Ordering[B]): Int

Finds the first element which yields the largest value measured by function f.

Note: will not terminate for infinite-sized collections.

Type parameters
B

The result type of the function f.
Value parameters
cmp

An ordering to be used for comparing elements.

f

The measuring function.
Returns

the first element of this collection with the largest value measured by function f with respect to the ordering cmp.
Throws
UnsupportedOperationException

if this collection is empty.
Inherited from IterableOnceOps

Source
def maxByOption[B](f: Int => B)(implicit cmp: Ordering[B]): Option[Int]

Finds the first element which yields the largest value measured by function f.

Note: will not terminate for infinite-sized collections.

Type parameters
B

The result type of the function f.
Value parameters
cmp

An ordering to be used for comparing elements.

f

The measuring function.
Returns

an option value containing the first element of this collection with the largest value measured by function f with respect to the ordering cmp.
Inherited from IterableOnceOps

Source
def maxOption[B >: Int](implicit ord: Ordering[B]): Option[Int]

Finds the largest element.

Note: will not terminate for infinite-sized collections.

Type parameters
B

The type over which the ordering is defined.
Value parameters
ord

An ordering to be used for comparing elements.
Returns

an option value containing the largest element of this collection with respect to the ordering ord.
Inherited from IterableOnceOps

Source
def minAfter(key: Int): Option[Int]

Find the smallest element larger than or equal to a given key.

Value parameters
key

The given key.
Returns

None if there is no such node.
Inherited from SortedSetOps

Source
def minBy[B](f: Int => B)(implicit cmp: Ordering[B]): Int

Finds the first element which yields the smallest value measured by function f.

Note: will not terminate for infinite-sized collections.

Type parameters
B

The result type of the function f.
Value parameters
cmp

An ordering to be used for comparing elements.

f

The measuring function.
Returns

the first element of this collection with the smallest value measured by function f with respect to the ordering cmp.
Throws
UnsupportedOperationException

if this collection is empty.
Inherited from IterableOnceOps

Source
def minByOption[B](f: Int => B)(implicit cmp: Ordering[B]): Option[Int]

Finds the first element which yields the smallest value measured by function f.

Note: will not terminate for infinite-sized collections.

Type parameters
B

The result type of the function f.
Value parameters
cmp

An ordering to be used for comparing elements.

f

The measuring function.
Returns

an option value containing the first element of this collection with the smallest value measured by function f with respect to the ordering cmp.
Inherited from IterableOnceOps

Source
def minOption[B >: Int](implicit ord: Ordering[B]): Option[Int]

Finds the smallest element.

Note: will not terminate for infinite-sized collections.

Type parameters
B

The type over which the ordering is defined.
Value parameters
ord

An ordering to be used for comparing elements.
Returns

an option value containing the smallest element of this collection with respect to the ordering ord.
Inherited from IterableOnceOps

Source@inline
final def mkString: String

Displays all elements of this collection in a string.

Delegates to addString, which can be overridden.

Returns

a string representation of this collection. In the resulting string the string representations (w.r.t. the method toString) of all elements of this collection follow each other without any separator string.
Inherited from IterableOnceOps

Source@inline
final def mkString(sep: String): String

Displays all elements of this collection in a string using a separator string.

Delegates to addString, which can be overridden.

Value parameters
sep

the separator string.
Returns

a string representation of this collection. In the resulting string the string representations (w.r.t. the method toString) of all elements of this collection are separated by the string sep.
Example

List(1, 2, 3).mkString("|") = "1|2|3"
Inherited from IterableOnceOps

Source
final def mkString(start: String, sep: String, end: String): String

Displays all elements of this collection in a string using start, end, and separator strings.

Delegates to addString, which can be overridden.

Value parameters
end

the ending string.

sep

the separator string.

start

the starting string.
Returns

a string representation of this collection. The resulting string 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 collection are separated by the string sep.
Example

List(1, 2, 3).mkString("(", "; ", ")") = "(1; 2; 3)"
Inherited from IterableOnceOps

Source@deprecatedOverriding("nonEmpty is defined as !isEmpty; override isEmpty instead", "2.13.0")
def nonEmpty: Boolean

Tests whether the collection is not empty.

Returns

true if the collection contains at least one element, false otherwise.
Inherited from IterableOnceOps

Source
def partitionMap[A1, A2](f: Int => Either[A1, A2]): (Set[A1], Set[A2])

Applies a function f to each element of the iterable collection and returns a pair of iterable collections: the first one made of those values returned by f that were wrapped in scala.util.Left, and the second one made of those wrapped in scala.util.Right.

Example:

val xs = Iterable(1, "one", 2, "two", 3, "three") partitionMap {
 case i: Int => Left(i)
 case s: String => Right(s)
}
// xs == (Iterable(1, 2, 3),
//        Iterable(one, two, three))
Type parameters
A1

the element type of the first resulting collection

A2

the element type of the second resulting collection
Value parameters
f

the 'split function' mapping the elements of this iterable collection to an scala.util.Either
Returns

a pair of iterable collections: the first one made of those values returned by f that were wrapped in scala.util.Left, and the second one made of those wrapped in scala.util.Right.
Inherited from IterableOps

Source
def product[B >: Int](implicit num: Numeric[B]): B

Multiplies up the elements of this collection.

Note: will not terminate for infinite-sized collections.

Type parameters
B

the result type of the * operator.
Value parameters
num

an implicit parameter defining a set of numeric operations which includes the * operator to be used in forming the product.
Returns

the product of all elements of this collection with respect to the * operator in num.
Inherited from IterableOnceOps

Source
def range(from: Int, until: Int): C

Creates a ranged projection of this collection with both a lower-bound and an upper-bound.

Value parameters
from

The lower-bound (inclusive) of the ranged projection.

until

The upper-bound (exclusive) of the ranged projection.
Inherited from SortedOps

Source
def rangeFrom(from: Int): C

Creates a ranged projection of this collection with no upper-bound.

Value parameters
from

The lower-bound (inclusive) of the ranged projection.
Inherited from SortedOps

Source
def rangeTo(to: Int): C

Inherited from SortedSetOps

Source
def rangeUntil(until: Int): C

Creates a ranged projection of this collection with no lower-bound.

Value parameters
until

The upper-bound (exclusive) of the ranged projection.
Inherited from SortedOps

Source
def reduce[B >: Int](op: (B, B) => B): B

Reduces the elements of this collection using the specified associative binary operator.

The order in which operations are performed on elements is unspecified and may be nondeterministic.

Type parameters
B

A type parameter for the binary operator, a supertype of A.
Value parameters
op

A binary operator that must be associative.
Returns

The result of applying reduce operator op between all the elements if the collection is nonempty.
Throws
UnsupportedOperationException

if this collection is empty.
Inherited from IterableOnceOps

Source
def reduceLeft[B >: Int](op: (B, Int) => B): B

Applies a binary operator to all elements of this collection, 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.

Type parameters
B

the result type of the binary operator.
Value parameters
op

the binary operator.
Returns

the result of inserting op between consecutive elements of this collection, going left to right: op( op( ... op(x1, x2) ..., xn-1), xn) where x1, ..., xn are the elements of this collection.
Throws
UnsupportedOperationException

if this collection is empty.
Inherited from IterableOnceOps

Source
def reduceLeftOption[B >: Int](op: (B, Int) => B): Option[B]

Optionally applies a binary operator to all elements of this collection, 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.

Type parameters
B

the result type of the binary operator.
Value parameters
op

the binary operator.
Returns

an option value containing the result of reduceLeft(op) if this collection is nonempty, None otherwise.
Inherited from IterableOnceOps

Source
def reduceOption[B >: Int](op: (B, B) => B): Option[B]

Reduces the elements of this collection, if any, using the specified associative binary operator.

The order in which operations are performed on elements is unspecified and may be nondeterministic.

Type parameters
B

A type parameter for the binary operator, a supertype of A.
Value parameters
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, and None otherwise.
Inherited from IterableOnceOps

Source
def reduceRight[B >: Int](op: (Int, B) => B): B

Applies a binary operator to all elements of this 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.

Type parameters
B

the result type of the binary operator.
Value parameters
op

the binary operator.
Returns

the result of inserting op between consecutive elements of this collection, going right to left: op(x1, op(x2, ..., op(xn-1, xn)...)) where x1, ..., xn are the elements of this collection.
Throws
UnsupportedOperationException

if this collection is empty.
Inherited from IterableOnceOps

Source
def reduceRightOption[B >: Int](op: (Int, B) => B): Option[B]

Optionally applies a binary operator to all elements of this 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.

Type parameters
B

the result type of the binary operator.
Value parameters
op

the binary operator.
Returns

an option value containing the result of reduceRight(op) if this collection is nonempty, None otherwise.
Inherited from IterableOnceOps

Source
protected def reversed: Iterable[Int]

Inherited from IterableOnceOps

Source
def scan[B >: Int](z: B)(op: (B, B) => B): Set[B]

Computes a prefix scan of the elements of the collection.

Note: The neutral element z may be applied more than once.

Type parameters
B

element type of the resulting collection
Value parameters
op

the associative operator for the scan

z

neutral element for the operator op
Returns

a new iterable collection containing the prefix scan of the elements in this iterable collection
Inherited from IterableOps

Source
def scanLeft[B](z: B)(op: (B, Int) => B): Set[B]

Inherited from IterableOps

Source
def scanRight[B](z: B)(op: (Int, B) => B): Set[B]

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.

Note: Even when applied to a view or a lazy collection it will always force the elements.

Example:

List(1, 2, 3, 4).scanRight(0)(_ + _) == List(10, 9, 7, 4, 0)
Type parameters
B

the type of the elements in the resulting collection
Value parameters
op

the binary operator applied to the intermediate result and the element

z

the initial value
Returns

collection with intermediate results
Inherited from IterableOps

Source
def sizeCompare(that: Iterable[_]): Int

Compares the size of this iterable collection to the size of another Iterable.

Value parameters
that

the Iterable whose size is compared with this iterable collection's size.
Returns

A value x where

x <  0       if this.size <  that.size
x == 0       if this.size == that.size
x >  0       if this.size >  that.size

The method as implemented here does not call size directly; its running time is O(this.size min that.size) instead of O(this.size + that.size). The method should be overridden if computing size is cheap and knownSize returns -1.
Inherited from IterableOps

Source
def sizeCompare(otherSize: Int): Int

Compares the size of this iterable collection to a test value.

Value parameters
otherSize

the test value that gets compared with the size.
Returns

A value x where

x <  0       if this.size <  otherSize
x == 0       if this.size == otherSize
x >  0       if this.size >  otherSize

The method as implemented here does not call size directly; its running time is O(size min otherSize) instead of O(size). The method should be overridden if computing size is cheap and knownSize returns -1.
See also

sizeIs
Inherited from IterableOps

Source@inline
final def sizeIs: SizeCompareOps

Returns a value class containing operations for comparing the size of this iterable collection to a test value.

These operations are implemented in terms of sizeCompare(Int), and allow the following more readable usages:

this.sizeIs < size     // this.sizeCompare(size) < 0
this.sizeIs <= size    // this.sizeCompare(size) <= 0
this.sizeIs == size    // this.sizeCompare(size) == 0
this.sizeIs != size    // this.sizeCompare(size) != 0
this.sizeIs >= size    // this.sizeCompare(size) >= 0
this.sizeIs > size     // this.sizeCompare(size) > 0
Inherited from IterableOps

Source
def slice(from: Int, until: Int): C

Inherited from IterableOps

Source
def sliding(size: Int, step: Int): Iterator[C]

Groups elements in fixed size blocks by passing a "sliding window" over them (as opposed to partitioning them, as is done in grouped.)

The returned iterator will be empty when called on an empty collection. The last element the iterator produces may be smaller than the window size when the original collection isn't exhausted by the window before it and its last element isn't skipped by the step before it.

Value parameters
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 element (which may be the only element) will be smaller if there are fewer than size elements remaining to be grouped.
See also

scala.collection.Iterator, method sliding
Example

List(1, 2, 3, 4, 5).sliding(2, 2) = Iterator(List(1, 2), List(3, 4), List(5))

List(1, 2, 3, 4, 5, 6).sliding(2, 3) = Iterator(List(1, 2), List(4, 5))
Inherited from IterableOps

Source
def sliding(size: Int): Iterator[C]

Groups elements in fixed size blocks by passing a "sliding window" over them (as opposed to partitioning them, as is done in grouped.)

An empty collection returns an empty iterator, and a non-empty collection containing fewer elements than the window size returns an iterator that will produce the original collection as its only element.

Value parameters
size

the number of elements per group
Returns

An iterator producing iterable collections of size size, except for a non-empty collection with less than size elements, which returns an iterator that produces the source collection itself as its only element.
See also

scala.collection.Iterator, method sliding
Example

List().sliding(2) = empty iterator

List(1).sliding(2) = Iterator(List(1))

List(1, 2).sliding(2) = Iterator(List(1, 2))

List(1, 2, 3).sliding(2) = Iterator(List(1, 2), List(2, 3))
Inherited from IterableOps

Source
def sortedIterableFactory: SortedIterableFactory[SortedSet]

The companion object of this sorted set, providing various factory methods.

Note

When implementing a custom collection type and refining CC to the new type, this method needs to be overridden to return a factory for the new type (the compiler will issue an error otherwise).
Inherited from SortedSetOps

Source
def span(p: Int => Boolean): (C, C)

Inherited from IterableOps

Source
override def splitAt(n: Int): (C, C)

Definition Classes IterableOps -> IterableOnceOps
Inherited from IterableOps

Source
def subsetOf(that: Set[Int]): Boolean

Tests whether this set is a subset of another set.

Value parameters
that

the set to test.
Returns

true if this set is a subset of that, i.e. if every element of this set is also an element of that.
Inherited from SetOps

Source
def subsets(): Iterator[C]

An iterator over all subsets of this set.

Returns

the iterator.
Inherited from SetOps

Source
def subsets(len: Int): Iterator[C]

An iterator over all subsets of this set of the given size. If the requested size is impossible, an empty iterator is returned.

Value parameters
len

the size of the subsets.
Returns

the iterator.
Inherited from SetOps

Source
def sum[B >: Int](implicit num: Numeric[B]): B

Sums up the elements of this collection.

Note: will not terminate for infinite-sized collections.

Type parameters
B

the result type of the + operator.
Value parameters
num

an implicit parameter defining a set of numeric operations which includes the + operator to be used in forming the sum.
Returns

the sum of all elements of this collection with respect to the + operator in num.
Inherited from IterableOnceOps

Source
def tail: C

The rest of the collection without its first element.

Inherited from IterableOps

Source
def tails: Iterator[C]

Iterates over the tails of this iterable collection. The first value will be this iterable collection and the final one will be an empty iterable collection, with the intervening values the results of successive applications of tail.

Returns

an iterator over all the tails of this iterable collection
Example

List(1,2,3).tails = Iterator(List(1,2,3), List(2,3), List(3), Nil)
Inherited from IterableOps

Source
def take(n: Int): C

Inherited from IterableOps

Source
def takeRight(n: Int): C

Selects the last n elements.

Note: might return different results for different runs, unless the underlying collection type is ordered.

Value parameters
n

the number of elements to take from this iterable collection.
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 than n elements. If n is negative, returns an empty iterable collection.
Inherited from IterableOps

Source
def takeWhile(p: Int => Boolean): C

Takes longest prefix of elements that satisfy a predicate.

Note: might return different results for different runs, unless the underlying collection type is ordered.

Value parameters
p

The predicate used to test elements.
Returns

the longest prefix of this iterable collection whose elements all satisfy the predicate p.
Inherited from IterableOps

Source
override def tapEach[U](f: Int => U): C

Definition Classes IterableOps -> IterableOnceOps
Inherited from IterableOps

Source
def to[C1](factory: Factory[Int, C1]): C1

Given a collection factory factory, convert this collection to the appropriate representation for the current element type A. Example uses:

xs.to(List) xs.to(ArrayBuffer) xs.to(BitSet) // for xs: Iterable[Int]

Inherited from IterableOnceOps

Source
def toArray[B >: Int : ClassTag]: Array[B]

Convert collection to array.

Implementation note: DO NOT call Array.from from this method.

Inherited from IterableOnceOps

Source@inline
final def toBuffer[B >: Int]: Buffer[B]

Inherited from IterableOnceOps

Source
def toIndexedSeq: IndexedSeq[Int]

Inherited from IterableOnceOps

Source
def toList: List[Int]

Inherited from IterableOnceOps

Source
def toMap[K, V](implicit ev: Int <:< (K, V)): Map[K, V]

Inherited from IterableOnceOps

Source
def toSeq: Seq[Int]

Returns

This collection as a Seq[A]. This is equivalent to to(Seq) but might be faster.
Inherited from IterableOnceOps

Source
def toSet[B >: Int]: Set[B]

Inherited from IterableOnceOps

Source
override def toString(): String

Definition Classes Function1 -> Any
Inherited from Function1

Source
def toVector: Vector[Int]

Inherited from IterableOnceOps

Source
def transpose[B](implicit asIterable: Int => Iterable[B]): Set[Set[B]]

Transposes this iterable collection of iterable collections into a iterable collection of iterable collections.

The resulting collection's type will be guided by the static type of iterable collection. For example:

val xs = List(
           Set(1, 2, 3),
           Set(4, 5, 6)).transpose
// xs == List(
//         List(1, 4),
//         List(2, 5),
//         List(3, 6))

val ys = Vector(
           List(1, 2, 3),
           List(4, 5, 6)).transpose
// ys == Vector(
//         Vector(1, 4),
//         Vector(2, 5),
//         Vector(3, 6))

Note: Even when applied to a view or a lazy collection it will always force the elements.

Type parameters
B

the type of the elements of each iterable collection.
Value parameters
asIterable

an implicit conversion which asserts that the element type of this iterable collection is an Iterable.
Returns

a two-dimensional iterable collection of iterable collections which has as nth row the nth column of this iterable collection.
Throws
IllegalArgumentException

if all collections in this iterable collection are not of the same size.
Inherited from IterableOps

Source@inline
final def union(that: Set[Int]): C

Computes the union between of set and another set.

Value parameters
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.
Inherited from SetOps

Source
def unzip[A1, A2](implicit asPair: Int => (A1, A2)): (Set[A1], Set[A2])

Converts this iterable collection of pairs into two collections of the first and second half of each pair.

val xs = Iterable(
           (1, "one"),
           (2, "two"),
           (3, "three")).unzip
// xs == (Iterable(1, 2, 3),
//        Iterable(one, two, three))
Type parameters
A1

the type of the first half of the element pairs

A2

the type of the second half of the element pairs
Value parameters
asPair

an implicit conversion which asserts that the element type of this iterable collection is a pair.
Returns

a pair of iterable collections, containing the first, respectively second half of each element pair of this iterable collection.
Inherited from IterableOps

Source
def unzip3[A1, A2, A3](implicit asTriple: Int => (A1, A2, A3)): (Set[A1], Set[A2], Set[A3])

Converts this iterable collection of triples into three collections of the first, second, and third element of each triple.

val xs = Iterable(
           (1, "one", '1'),
           (2, "two", '2'),
           (3, "three", '3')).unzip3
// xs == (Iterable(1, 2, 3),
//        Iterable(one, two, three),
//        Iterable(1, 2, 3))
Type parameters
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
Value parameters
asTriple

an implicit conversion which asserts that the element type of this iterable collection is a triple.
Returns

a triple of iterable collections, containing the first, second, respectively third member of each element triple of this iterable collection.
Inherited from IterableOps

Source
def view: View[Int]

A view over the elements of this collection.

Inherited from IterableOps

Source
def withFilter(p: Int => Boolean): WithFilter[Int, Set]

Creates a non-strict filter of this iterable 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.

Value parameters
p

the predicate used to test elements.
Returns

an object of class WithFilter, which supports map, flatMap, foreach, and withFilter operations. All these operations apply to those elements of this iterable collection which satisfy the predicate p.
Inherited from IterableOps

Source
def zip[B](that: IterableOnce[B])(implicit @implicitNotFound ev: Ordering[(Int, B)]): SortedSet[(Int, B)]

Returns a set formed from this set 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.

Type parameters
B

the type of the second half of the returned pairs
Value parameters
that

The iterable providing the second half of each result pair
Returns

a new set containing pairs consisting of corresponding elements of this set and that. The length of the returned collection is the minimum of the lengths of this set and that.
Inherited from SortedSetOps

Source
def zip[B](that: IterableOnce[B]): Set[(Int, B)]

Returns a iterable collection formed from this iterable collection 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.

Type parameters
B

the type of the second half of the returned pairs
Value parameters
that

The iterable providing the second half of each result pair
Returns

a new iterable collection containing pairs consisting of corresponding elements of this iterable collection and that. The length of the returned collection is the minimum of the lengths of this iterable collection and that.
Inherited from IterableOps

Source
def zipAll[A1 >: Int, B](that: Iterable[B], thisElem: A1, thatElem: B): Set[(A1, B)]

Returns a iterable collection formed from this iterable collection 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.

Value parameters
that

the iterable providing the second half of each result pair

thatElem

the element to be used to fill up the result if that is shorter than this iterable collection.

thisElem

the element to be used to fill up the result if this iterable collection is shorter than that.
Returns

a new collection of type That containing pairs consisting of corresponding elements of this iterable collection and that. The length of the returned collection is the maximum of the lengths of this iterable collection and that. If this iterable collection is shorter than that, thisElem values are used to pad the result. If that is shorter than this iterable collection, thatElem values are used to pad the result.
Inherited from IterableOps

Source
def zipWithIndex: Set[(Int, Int)]

Inherited from IterableOps

Source@inline
final def |(that: Set[Int]): C

Alias for union

Inherited from SetOps

© 2002-2022 EPFL, with contributions from Lightbend.
Licensed under the Apache License, Version 2.0.
https://scala-lang.org/api/3.1.1/scala/collection/BitSetOps.html