StrictOptimizedSetOps

scala.collection.immutable.StrictOptimizedSetOps
transparent trait StrictOptimizedSetOps[A, +CC[X], +C <: SetOps[A, CC, C]] extends SetOps[A, CC, C], StrictOptimizedSetOps[A, CC, C], StrictOptimizedIterableOps[A, CC, C]

Attributes

Source
Set.scala
Graph
Supertypes
trait StrictOptimizedSetOps[A, CC, C]
trait StrictOptimizedIterableOps[A, CC, C]
trait SetOps[A, CC, C]
trait SetOps[A, CC, C]
trait Pure
trait A -> Boolean
trait IterableOps[A, CC, C]
trait IterableOnceOps[A, CC, C]
trait IterableOnce[A]
class Object
trait Matchable
class Any
Show all
Known subtypes
class HashSet[A]
class ListSet[A]
trait StrictOptimizedSortedSetOps[A, CC, C]
class BitSet
class BitSet1
class BitSet2
class BitSetN
class TreeSet[A]
Show all

Members list

Value members

Concrete methods

override def concat(that: IterableOnce[A]^): C

Creates a new immutable set by adding all elements contained in another collection to this immutable set, omitting duplicates.

Creates a new immutable set by adding all elements contained in another collection to this immutable set, omitting duplicates.

Example:

  scala> val a = Set(1, 2) concat Set(2, 3)
  a: scala.collection.immutable.Set[Int] = Set(1, 2, 3)

Value parameters

that

the collection containing the elements to add.

Attributes

Returns

a new immutable set with the given elements added, omitting duplicates.

Definition Classes
Source
Set.scala

Inherited methods

final def &(that: Set[A]): C

Alias for intersect.

Alias for intersect.

Value parameters

that

the set to intersect with

Attributes

Inherited from:
SetOps
Source
Set.scala
final def &~(that: Set[A]): C

Alias for diff.

Alias for diff.

Value parameters

that

the set of elements to exclude

Attributes

Inherited from:
SetOps
Source
Set.scala
final override def +(elem: A): C

Alias for incl.

Alias for incl.

Value parameters

elem

the element to add

Attributes

Definition Classes
Inherited from:
SetOps
Source
Set.scala
final def ++[B >: A](suffix: IterableOnce[B]^): CC[B]^{suffix}

Alias for concat.

Alias for concat.

Type parameters

B

the element type of the returned collection

Value parameters

suffix

the iterable to append to this immutable set

Attributes

Inherited from:
IterableOps
Source
Iterable.scala
final def ++(that: IterableOnce[A]^): C

Alias for concat.

Alias for concat.

Value parameters

that

the collection containing the elements to add

Attributes

Inherited from:
SetOps
Source
Set.scala
final override def -(elem: A): C

Alias for excl.

Alias for excl.

Value parameters

elem

the element to remove

Attributes

Definition Classes
Inherited from:
SetOps
Source
Set.scala
final override def --(that: IterableOnce[A]^): C

Alias for removedAll.

Alias for removedAll.

Value parameters

that

the collection of elements to remove

Attributes

Definition Classes
Inherited from:
SetOps
Source
Set.scala
final def addString(b: StringBuilder): b.type

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

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

Example:

    val a = List(1,2,3,4) // List(1, 2, 3, 4)
    val b = new StringBuilder()
    val h = a.addString(b) // 1234

Value parameters

b

the string builder to which elements are appended.

Attributes

Returns

the string builder b to which elements were appended.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
final def addString(b: StringBuilder, sep: String): b.type

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

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

Example:

    val a = List(1,2,3,4) // List(1, 2, 3, 4)
    val b = new StringBuilder()
    a.addString(b, ", ") // 1, 2, 3, 4

Value parameters

b

the string builder to which elements are appended.

sep

the separator string.

Attributes

Returns

the string builder b to which elements were appended.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def addString(b: StringBuilder, start: String, sep: String, end: String): b.type

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

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

Example:

    val a = List(1,2,3,4) // List(1, 2, 3, 4)
    val b = new StringBuilder()
    a.addString(b , "List(" , ", " , ")") // 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.

Attributes

Returns

the string builder b to which elements were appended.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def andThen[A](g: Boolean -> A): A -> A

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

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

Attributes

Returns

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

Inherited from:
Function1
Source
Function1.scala
final def apply(elem: A): Boolean

Tests if some element is contained in this set.

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.

Attributes

Returns

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

Inherited from:
SetOps
Source
Set.scala
override def collect[B](pf: PartialFunction[A, B]^): CC[B]

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

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

Type parameters

B

the element type of the returned immutable set.

Value parameters

pf

the partial function which filters and maps the immutable set.

Attributes

Returns

a new immutable 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.

Definition Classes
Inherited from:
StrictOptimizedIterableOps
Source
StrictOptimizedIterableOps.scala
def collectFirst[B](pf: PartialFunction[A, B]^): Option[B]

Finds the first element of the immutable set for which the given partial function is defined, and applies the partial function to it.

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

Type parameters

B

the result type of the partial function

Value parameters

pf

the partial function

Attributes

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
IterableOnce.scala
def compose[A](g: A -> A): A -> Boolean

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

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

Attributes

Returns

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

Inherited from:
Function1
Source
Function1.scala
def concat[B >: A](suffix: IterableOnce[B]^): CC[B]^{suffix}

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

Returns a new immutable set containing the elements from the left hand operand followed by the elements from the right hand operand. The element type of the immutable set 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 iterable to append.

Attributes

Returns

a new immutable set which contains all elements of this immutable set followed by all elements of suffix.

Inherited from:
IterableOps
Source
Iterable.scala
def copyToArray[B >: A](dest: Array[B], start: Int, n: Int): Int

Copies elements to an array and returns the number of elements written.

Copies elements to an array and returns the number of elements written.

Fills the given array dest starting at index start with at most n elements of this immutable set.

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

If start is less than zero, it is taken as zero.

Type parameters

B

the type of the elements of the array.

Value parameters

dest

the array to fill.

n

the maximal number of elements to copy.

start

the starting index of xs.

Attributes

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
IterableOnce.scala
def copyToArray[B >: A](dest: Array[B], start: Int): Int

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

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

Fills the given array dest starting at index start with values of this immutable set.

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

Type parameters

B

the type of the elements of the array.

Value parameters

dest

the array to fill.

start

the starting index of xs.

Attributes

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
IterableOnce.scala
def copyToArray[B >: A](dest: Array[B]): Int

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

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

Fills the given array dest starting at index start with values of this immutable set.

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

Type parameters

B

the type of the elements of the array.

Value parameters

dest

the array to fill.

Attributes

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
IterableOnce.scala
def corresponds[B](that: IterableOnce[B]^)(p: (A, 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.

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

Attributes

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
IterableOnce.scala
def count(p: A => Boolean): Int

Counts the number of elements in the immutable set which satisfy a predicate.

Counts the number of elements in the immutable set which satisfy a predicate.

Note: will not terminate for infinite-sized collections.

Value parameters

p

the predicate used to test elements.

Attributes

Returns

the number of elements satisfying the predicate p.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def diff(that: Set[A]): C

Computes the difference of this set and another set.

Computes the difference of this set and another set.

Value parameters

that

the set of elements to exclude.

Attributes

Returns

a set containing those elements of this set that are not also contained in the given set that.

Inherited from:
SetOps
Source
Set.scala
def drop(n: Int): C

Selects all elements except the first n ones.

Selects all elements except the first 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 immutable set.

Attributes

Returns

a immutable set consisting of all elements of this immutable set except the first n ones, or else the empty immutable set, if this immutable set has less than n elements. If n is negative, don't drop any elements.

Inherited from:
IterableOps
Source
Iterable.scala
override def dropRight(n: Int): C

The rest of the collection without its n last elements. For linear, immutable collections this should avoid making a copy.

The rest of the collection without its n last elements. For linear, immutable collections this should avoid making a copy.

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

Value parameters

n

the number of elements to drop from the end of this collection

Attributes

Returns

a new collection containing all elements of this collection except the last n, or an empty collection if n is greater than or equal to the size, or all elements if n is non-positive

Definition Classes
Inherited from:
StrictOptimizedIterableOps
Source
StrictOptimizedIterableOps.scala
def dropWhile(p: A => Boolean): C

Selects all elements except the longest prefix that satisfies a predicate.

Selects all elements except the longest prefix that satisfies a predicate.

The matching prefix starts with the first element of this immutable set, and the element following the prefix is the first element that does not satisfy the predicate. The matching prefix may be empty, so that this method returns the entire immutable set.

Example:

    List(1, 2, 3, 100, 4).dropWhile(n => n < 10) // List(100, 4)
    List(1, 2, 3, 100, 4).dropWhile(n => n == 0) // List(1, 2, 3, 100, 4)

Use span to obtain both the prefix and suffix. Use filterNot to drop all elements that satisfy the 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.

Attributes

Returns

the longest suffix of this immutable set whose first element does not satisfy the predicate p.

Inherited from:
IterableOps
Source
Iterable.scala
def empty: C

The empty immutable set.

The empty immutable set.

Attributes

Returns

an empty iterable of type immutable.Set .

Inherited from:
IterableOps
Source
Iterable.scala
def exists(p: A => Boolean): Boolean

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

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

Note: may not terminate for infinite-sized collections.

Value parameters

p

the predicate used to test elements.

Attributes

Returns

true if the given predicate p is satisfied by at least one element of this immutable set, otherwise false

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
override def filter(pred: A => Boolean): C

Selects all elements of this immutable set which satisfy a predicate.

Selects all elements of this immutable set which satisfy a predicate.

Value parameters

p

the predicate used to test elements.

Attributes

Returns

a new immutable set consisting of all elements of this immutable set that satisfy the given predicate p. The order of the elements is preserved.

Definition Classes
Inherited from:
StrictOptimizedIterableOps
Source
StrictOptimizedIterableOps.scala
override def filterNot(pred: A => Boolean): C

Selects all elements of this immutable set which do not satisfy a predicate.

Selects all elements of this immutable set which do not satisfy a predicate.

Value parameters

pred

the predicate used to test elements.

Attributes

Returns

a new immutable set consisting of all elements of this immutable set that do not satisfy the given predicate pred. Their order may not be preserved.

Definition Classes
Inherited from:
StrictOptimizedIterableOps
Source
StrictOptimizedIterableOps.scala
def find(p: A => Boolean): Option[A]

Finds the first element of the immutable set satisfying a predicate, if any.

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

Attributes

Returns

an option value containing the first element in the immutable set that satisfies p, or None if none exists.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
override def flatMap[B](f: A => IterableOnce[B]^): CC[B]

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

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

For example:

    def getWords(lines: Seq[String]): Seq[String] = lines.flatMap(line => line.split("\\W+"))

The type of the resulting collection is guided by the static type of this immutable set. This might cause unexpected results sometimes. For example:

    // lettersOf will return a Seq[Char] of likely repeated letters, instead of a Set
    def lettersOf(words: Seq[String]) = words.flatMap(word => word.toSet)

    // lettersOf2 will return a Set[Char], not a Seq
    def lettersOf2(words: Seq[String]) = words.toSet.flatMap(word => word.toSeq)

    // xs will be an Iterable[Int]
    val xs = Map("a" -> List(11, 111), "b" -> List(22, 222)).flatMap(_._2)

    // ys will be a Map[Int, Int]
    val ys = Map("a" -> List(1 -> 11, 1 -> 111), "b" -> List(2 -> 22, 2 -> 222)).flatMap(_._2)

Type parameters

B

the element type of the returned collection.

Value parameters

f

the function to apply to each element.

Attributes

Returns

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

Definition Classes
Inherited from:
StrictOptimizedIterableOps
Source
StrictOptimizedIterableOps.scala
override def flatten[B](implicit toIterableOnce: A -> IterableOnce[B]): CC[B]

Given that the elements of this collection are themselves iterable collections, converts this immutable set into a immutable set comprising the elements of these iterable collections.

Given that the elements of this collection are themselves iterable collections, converts this immutable set into a immutable set comprising the elements of these iterable collections.

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

  val xs = List(
             Set(1, 2, 3),
             Set(1, 2, 3)
           ).flatten
  // xs == List(1, 2, 3, 1, 2, 3)

  val ys = Set(
             List(1, 2, 3),
             List(3, 2, 1)
           ).flatten
  // ys == Set(1, 2, 3)

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 immutable set is an Iterable.

Attributes

Returns

a new immutable set resulting from concatenating all element collections.

Definition Classes
Inherited from:
StrictOptimizedIterableOps
Source
StrictOptimizedIterableOps.scala
def fold[A1 >: A](z: A1)(op: (A1, A1) => A1): A1

Applies the given binary operator op to the given initial value z and all elements of this immutable set.

Applies the given binary operator op to the given initial value z and all elements of this immutable set.

For each application of the operator, each operand is either an element of this immutable set, the initial value, or another such application of the operator.

        The order of applications of the operator is unspecified and may be nondeterministic.
        Each element appears exactly once in the computation.

The initial value may be used an arbitrary number of times, but at least once.

If this collection is ordered, then for any application of the operator, the element(s) appearing in the left operand will precede those in the right.

        Note: might return different results for different runs, unless either
        of the following conditions is met: (1) the operator is associative,
        and the underlying collection type is ordered; or (2) the operator is
        associative and commutative. In either case, it is also necessary that the initial value

be a neutral value for the operator, e.g. Nil for List concatenation or 1 for multiplication.

The default implementation in IterableOnce is equivalent to foldLeft but may be overridden for more efficient traversal orders.

Note: will not terminate for infinite-sized collections.

Type parameters

A1

The type parameter for the binary operator, a supertype of A.

Value parameters

op

A binary operator; must be associative for the result to always be the same across runs.

z

An initial value; may be used an arbitrary number of times in the computation of the result; must be a neutral value for op for the result to always be the same across runs.

Attributes

Returns

The result of applying op between all the elements and z, or z if this immutable set is empty.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def foldLeft[B](z: B)(op: (B, A) => B): B

Applies the given binary operator op to the given initial value z and all elements of this immutable set, going left to right. Returns the initial value if this immutable set is empty.

Applies the given binary operator op to the given initial value z and all elements of this immutable set, going left to right. Returns the initial value if this immutable set is empty.

"Going left to right" only makes sense if this collection is ordered: then if x,,1,,, x,,2,,, ..., x,,n,, are the elements of this immutable set, the result is op( op( ... op( op(z, x,,1,,), x,,2,,) ... ), x,,n,,).

If this collection is not ordered, then for each application of the operator, each right operand is an element. In addition, the leftmost operand is the initial value, and each other left operand is itself an application of the operator. The elements of this immutable set and the initial value all appear exactly once in the computation.

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

Note: will not terminate for infinite-sized collections.

Type parameters

B

The result type of the binary operator.

Value parameters

op

A binary operator.

z

An initial value.

Attributes

Returns

The result of applying op to z and all elements of this immutable set, going left to right. Returns z if this immutable set is empty.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def foldRight[B](z: B)(op: (A, B) => B): B

Applies the given binary operator op to all elements of this immutable set and the given initial value z, going right to left. Returns the initial value if this immutable set is empty.

Applies the given binary operator op to all elements of this immutable set and the given initial value z, going right to left. Returns the initial value if this immutable set is empty.

"Going right to left" only makes sense if this collection is ordered: then if x,,1,,, x,,2,,, ..., x,,n,, are the elements of this immutable set, the result is op(x,,1,,, op(x,,2,,, op( ... op(x,,n,,, z) ... ))).

If this collection is not ordered, then for each application of the operator, each left operand is an element. In addition, the rightmost operand is the initial value, and each other right operand is itself an application of the operator. The elements of this immutable set and the initial value all appear exactly once in the computation.

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

Note: will not terminate for infinite-sized collections.

Type parameters

B

The result type of the binary operator.

Value parameters

op

A binary operator.

z

An initial value.

Attributes

Returns

The result of applying op to all elements of this immutable set and z, going right to left. Returns z if this immutable set is empty.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def forall(p: A => Boolean): Boolean

Tests whether a predicate holds for all elements of this immutable set.

Tests whether a predicate holds for all elements of this immutable set.

Note: may not terminate for infinite-sized collections.

Value parameters

p

the predicate used to test elements.

Attributes

Returns

true if this immutable set is empty or the given predicate p holds for all elements of this immutable set, otherwise false.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def foreach[U](f: A => U): Unit

Applies f to each element for its side effects. Note: U parameter needed to help scalac's type inference.

Applies f to each element for its side effects. Note: U parameter needed to help scalac's type inference.

Type parameters

U

the return type of f; the value is discarded, but the type parameter aids type inference

Value parameters

f

the function to apply to each element for its side effects

Attributes

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def groupBy[K](f: A => K): Map[K, C]

Partitions this immutable set into a map of immutable sets according to some discriminator function.

Partitions this immutable set into a map of immutable sets 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.

Attributes

Returns

A map from keys to immutable sets 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 immutable set of those elements `x`
         for which `f(x)` equals `k`.
Inherited from:
IterableOps
Source
Iterable.scala
def groupMap[K, B](key: A => K)(f: A => B): Map[K, CC[B]]

Partitions this immutable set into a map of immutable sets according to a discriminator function key. Each element in a group is transformed into a value of type B using the value function.

Partitions this immutable set into a map of immutable sets 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

Attributes

Returns

a map associating each key k produced by key with a immutable set of values produced by applying f to elements that map to k

Inherited from:
IterableOps
Source
Iterable.scala
def groupMapReduce[K, B](key: A => K)(f: A => B)(reduce: (B, B) => B): Map[K, B]

Partitions this immutable set 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.

Partitions this immutable set 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.

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

reduce

the reduction function used to combine values mapped to the same key

Attributes

Returns

a map associating each key k produced by key with the reduction of all values produced by applying f to elements that map to k

Inherited from:
IterableOps
Source
Iterable.scala
def grouped(size: Int): Iterator[C]

Partitions elements in fixed size immutable sets.

Partitions elements in fixed size immutable sets.

Value parameters

size

the number of elements per group

Attributes

Returns

An iterator producing immutable sets 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
Iterable.scala
def head: A

Selects the first element of this immutable set.

Selects the first element of this immutable set.

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

Attributes

Returns

the first element of this immutable set.

Throws
NoSuchElementException

if the immutable set is empty.

Inherited from:
IterableOps
Source
Iterable.scala
def headOption: Option[A]

Optionally selects the first element.

Optionally selects the first element.

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

Attributes

Returns

the first element of this immutable set if it is nonempty, None if it is empty.

Inherited from:
IterableOps
Source
Iterable.scala
def init: C

The initial part of the collection without its last element.

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.

Attributes

Inherited from:
IterableOps
Source
Iterable.scala
def inits: Iterator[C]

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

Iterates over the inits of this immutable set. The first value will be this immutable set and the final one will be an empty immutable set, 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.

Attributes

Returns

an iterator over all the inits of this immutable set

Example

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

Inherited from:
IterableOps
Source
Iterable.scala
def intersect(that: Set[A]): C

Computes the intersection between this set and another set.

Computes the intersection between this set and another set.

Value parameters

that

the set to intersect with.

Attributes

Returns

a new set consisting of all elements that are both in this set and in the given set that.

Inherited from:
SetOps
Source
Set.scala

Tests whether the immutable set is empty.

Tests whether the immutable set is empty.

Note: The default implementation creates and discards an iterator.

Note: Implementations in subclasses that are not repeatedly iterable must take care not to consume any elements when isEmpty is called.

Attributes

Returns

true if the immutable set contains no elements, false otherwise.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
override def isTraversableAgain: Boolean

Tests whether this immutable set can be repeatedly traversed. Always true for Iterables and false for Iterators unless overridden.

Tests whether this immutable set can be repeatedly traversed. Always true for Iterables and false for Iterators unless overridden.

Attributes

Returns

true if it is repeatedly traversable, false otherwise.

Definition Classes
Inherited from:
IterableOps
Source
Iterable.scala
def knownSize: Int

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

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

Attributes

Inherited from:
IterableOnce
Source
IterableOnce.scala
def last: A

Selects the last element.

Selects the last element.

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

Attributes

Returns

The last element of this immutable set.

Throws
NoSuchElementException

If the immutable set is empty.

Inherited from:
IterableOps
Source
Iterable.scala
def lastOption: Option[A]

Optionally selects the last element.

Optionally selects the last element.

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

Attributes

Returns

the last element of this immutable set if it is nonempty, None if it is empty.

Inherited from:
IterableOps
Source
Iterable.scala
override def map[B](f: A => B): CC[B]

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

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

Type parameters

B

the element type of the returned immutable set .

Value parameters

f

the function to apply to each element.

Attributes

Returns

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

Definition Classes
Inherited from:
StrictOptimizedIterableOps
Source
StrictOptimizedIterableOps.scala
def max[B >: A](implicit ord: Ordering[B]): A

Finds the largest element.

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.

Attributes

Returns

the largest element of this immutable set with respect to the ordering ord.

Throws
UnsupportedOperationException

if this immutable set is empty.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def maxBy[B](f: A -> B)(implicit ord: Ordering[B]): A

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

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

f

The measuring function.

ord

An ordering to be used for comparing elements.

Attributes

Returns

the first element of this immutable set with the largest value measured by function f with respect to the ordering ord.

Throws
UnsupportedOperationException

if this immutable set is empty.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def maxByOption[B](f: A -> B)(implicit ord: Ordering[B]): Option[A]

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

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

f

The measuring function.

ord

An ordering to be used for comparing elements.

Attributes

Returns

an option value containing the first element of this immutable set with the largest value measured by function f with respect to the ordering ord.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def maxOption[B >: A](implicit ord: Ordering[B]): Option[A]

Finds the largest element.

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.

Attributes

Returns

an option value containing the largest element of this immutable set with respect to the ordering ord.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def min[B >: A](implicit ord: Ordering[B]): A

Finds the smallest element.

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.

Attributes

Returns

the smallest element of this immutable set with respect to the ordering ord.

Throws
UnsupportedOperationException

if this immutable set is empty.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def minBy[B](f: A -> B)(implicit ord: Ordering[B]): A

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

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

f

The measuring function.

ord

An ordering to be used for comparing elements.

Attributes

Returns

the first element of this immutable set with the smallest value measured by function f with respect to the ordering ord.

Throws
UnsupportedOperationException

if this immutable set is empty.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def minByOption[B](f: A -> B)(implicit ord: Ordering[B]): Option[A]

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

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

f

The measuring function.

ord

An ordering to be used for comparing elements.

Attributes

Returns

an option value containing the first element of this immutable set with the smallest value measured by function f with respect to the ordering ord.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def minOption[B >: A](implicit ord: Ordering[B]): Option[A]

Finds the smallest element.

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.

Attributes

Returns

an option value containing the smallest element of this immutable set with respect to the ordering ord.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
final def mkString: String

Displays all elements of this immutable set in a string.

Displays all elements of this immutable set in a string.

Delegates to addString, which can be overridden.

Attributes

Returns

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

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
final def mkString(sep: String): String

Displays all elements of this immutable set in a string using a separator string.

Displays all elements of this immutable set in a string using a separator string.

Delegates to addString, which can be overridden.

Value parameters

sep

the separator string.

Attributes

Returns

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

Example

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

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
final def mkString(start: String, sep: String, end: String): String

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

Displays all elements of this immutable set 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.

Attributes

Returns

a string representation of this immutable set. 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 immutable set are separated by the string sep.

Example

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

Inherited from:
IterableOnceOps
Source
IterableOnce.scala

Tests whether the immutable set is not empty.

Tests whether the immutable set is not empty.

Attributes

Returns

true if the immutable set contains at least one element, false otherwise.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
override def partition(p: A => Boolean): (C, C)

A pair of, first, all elements that satisfy predicate p and, second, all elements that do not.

A pair of, first, all elements that satisfy predicate p and, second, all elements that do not.

The two immutable set correspond to the result of filter and filterNot, respectively.

The default implementation provided here needs to traverse the collection twice. Strict collections have an overridden version of partition in StrictOptimizedIterableOps, which requires only a single traversal.

Value parameters

p

the predicate used to test elements

Attributes

Returns

a pair of immutable sets: the first containing all elements that satisfy p, the second containing those that do not

Definition Classes
Inherited from:
StrictOptimizedIterableOps
Source
StrictOptimizedIterableOps.scala
override def partitionMap[A1, A2](f: A => Either[A1, A2]): (CC[A1], CC[A2])

Applies a function f to each element of the immutable set and returns a pair of immutable sets: 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.

Applies a function f to each element of the immutable set and returns a pair of immutable sets: 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 = $Coll(1, "one", 2, "two", 3, "three") partitionMap {
   case i: Int => Left(i)
   case s: String => Right(s)
  }
  // xs == ($Coll(1, 2, 3),
  //        $Coll(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 immutable set to an scala.util.Either

Attributes

Returns

a pair of immutable sets: 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.

Definition Classes
Inherited from:
StrictOptimizedIterableOps
Source
StrictOptimizedIterableOps.scala
def product[B >: A](implicit num: Numeric[B]): B

Multiplies together the elements of this collection.

Multiplies together the elements of this collection.

The default implementation uses reduce for a known non-empty collection, foldLeft otherwise.

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.

Attributes

Returns

the product of all elements of this immutable set with respect to the * operator in num.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def reduce[B >: A](op: (B, B) => B): B

Applies the given binary operator op to all elements of this immutable set.

Applies the given binary operator op to all elements of this immutable set.

For each application of the operator, each operand is either an element of this immutable set or another such application of the operator. The order of applications of the operator is unspecified and may be nondeterministic. Each element appears exactly once in the computation.

If this collection is ordered, then for any application of the operator, the element(s) appearing in the left operand will precede those in the right.

        Note: might return different results for different runs, unless either
        of the following conditions is met: (1) the operator is associative,
        and the underlying collection type is ordered; or (2) the operator is
        associative and commutative.

Note: will not terminate for infinite-sized collections.

Type parameters

B

The type parameter for the binary operator, a supertype of A.

Value parameters

op

A binary operator; must be associative for the result to always be the same across runs.

Attributes

Returns

The result of applying op between all the elements if the immutable set is nonempty.

Throws
UnsupportedOperationException

if this immutable set is empty.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def reduceLeft[B >: A](op: (B, A) => B): B

Applies the given binary operator op to all elements of this immutable set, going left to right.

Applies the given binary operator op to all elements of this immutable set, going left to right.

"Going left to right" only makes sense if this collection is ordered: then if x,,1,,, x,,2,,, ..., x,,n,, are the elements of this immutable set, the result is op( op( op( ... op(x,,1,,, x,,2,,) ... ), x,,n-1,,), x,,n,,).

If this collection is not ordered, then for each application of the operator, each right operand is an element. In addition, the leftmost operand is the first element of this immutable set and each other left operand is itself an application of the operator. Each element appears exactly once in the computation.

        Note: might return different results for different runs, unless the
        underlying collection type is ordered or the operator is associative
        and commutative.

Note: will not terminate for infinite-sized collections.

Type parameters

B

The result type of the binary operator, a supertype of A.

Value parameters

op

A binary operator.

Attributes

Returns

The result of applying op to all elements of this immutable set, going left to right.

Throws
UnsupportedOperationException

if this immutable set is empty.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def reduceLeftOption[B >: A](op: (B, A) => B): Option[B]

If this immutable set is nonempty, reduces it with the given binary operator op, going left to right.

If this immutable set is nonempty, reduces it with the given binary operator op, going left to right.

The behavior is the same as reduceLeft except that the value is None if the immutable set is empty. Each element appears exactly once in the computation.

        Note: might return different results for different runs, unless the
        underlying collection type is ordered or the operator is associative
        and commutative.

Note: will not terminate for infinite-sized collections.

Type parameters

B

The result type of the binary operator, a supertype of A.

Value parameters

op

A binary operator.

Attributes

Returns

The result of reducing this immutable set with op going left to right if the immutable set is nonempty, inside a Some, and None otherwise.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def reduceOption[B >: A](op: (B, B) => B): Option[B]

If this immutable set is nonempty, reduces it with the given binary operator op.

If this immutable set is nonempty, reduces it with the given binary operator op.

The behavior is the same as reduce except that the value is None if the immutable set is empty. The order of applications of the operator is unspecified and may be nondeterministic. Each element appears exactly once in the computation.

        Note: might return different results for different runs, unless either
        of the following conditions is met: (1) the operator is associative,
        and the underlying collection type is ordered; or (2) the operator is
        associative and commutative.

Note: will not terminate for infinite-sized collections.

Type parameters

B

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

Value parameters

op

A binary operator; must be associative for the result to always be the same across runs.

Attributes

Returns

The result of reducing this immutable set with op if the immutable set is nonempty, inside a Some, and None otherwise.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def reduceRight[B >: A](op: (A, B) => B): B

Applies the given binary operator op to all elements of this immutable set, going right to left.

Applies the given binary operator op to all elements of this immutable set, going right to left.

"Going right to left" only makes sense if this collection is ordered: then if x,,1,,, x,,2,,, ..., x,,n,, are the elements of this immutable set, the result is op(x,,1,,, op(x,,2,,, op( ... op(x,,n-1,,, x,,n,,) ... ))).

If this collection is not ordered, then for each application of the operator, each left operand is an element. In addition, the rightmost operand is the last element of this immutable set and each other right operand is itself an application of the operator. Each element appears exactly once in the computation.

        Note: might return different results for different runs, unless the
        underlying collection type is ordered or the operator is associative
        and commutative.

Note: will not terminate for infinite-sized collections.

Type parameters

B

The result type of the binary operator, a supertype of A.

Value parameters

op

A binary operator.

Attributes

Returns

The result of applying op to all elements of this immutable set, going right to left.

Throws
UnsupportedOperationException

if this immutable set is empty.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def reduceRightOption[B >: A](op: (A, B) => B): Option[B]

If this immutable set is nonempty, reduces it with the given binary operator op, going right to left.

If this immutable set is nonempty, reduces it with the given binary operator op, going right to left.

The behavior is the same as reduceRight except that the value is None if the immutable set is empty. Each element appears exactly once in the computation.

        Note: might return different results for different runs, unless the
        underlying collection type is ordered or the operator is associative
        and commutative.

Note: will not terminate for infinite-sized collections.

Type parameters

B

The result type of the binary operator, a supertype of A.

Value parameters

op

A binary operator.

Attributes

Returns

The result of reducing this immutable set with op going right to left if the immutable set is nonempty, inside a Some, and None otherwise.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def removedAll(that: IterableOnce[A]^): C

Creates a new immutable set from this immutable set by removing all elements of another collection.

Creates a new immutable set from this immutable set by removing all elements of another collection.

Value parameters

that

the collection containing the elements to remove.

Attributes

Returns

a new immutable set with the given elements removed, omitting duplicates.

Inherited from:
SetOps
Source
Set.scala
protected def reversed: Iterable[A]

Attributes

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def scan[B >: A](z: B)(op: (B, B) => B): CC[B]^{op}

Computes a prefix scan of the elements of the collection.

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

Attributes

Returns

a new immutable set containing the prefix scan of the elements in this immutable set

Inherited from:
IterableOps
Source
Iterable.scala
override def scanLeft[B](z: B)(op: (B, A) => B): CC[B]

Produces a immutable set containing cumulative results of applying the operator going left to right, including the initial value.

Produces a immutable set containing cumulative results of applying the operator going left to right, including the initial value.

Note: will not terminate for infinite-sized collections.

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

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

Attributes

Returns

collection with intermediate results

Definition Classes
Inherited from:
StrictOptimizedIterableOps
Source
StrictOptimizedIterableOps.scala
def scanRight[B](z: B)(op: (A, B) => B): CC[B]^{op}

Produces a collection containing cumulative results of applying the operator going right to left. The head of the collection is the last cumulative result.

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

Attributes

Returns

collection with intermediate results

Inherited from:
IterableOps
Source
Iterable.scala
def size: Int

The size of this immutable set.

The size of this immutable set.

Note: will not terminate for infinite-sized collections.

Attributes

Returns

the number of elements in this immutable set.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def sizeCompare(that: Iterable[_]^): Int

Compares the size of this immutable set to the size of another Iterable.

Compares the size of this immutable set to the size of another Iterable.

Value parameters

that

the Iterable whose size is compared with this immutable set's size.

Attributes

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
Iterable.scala
def sizeCompare(otherSize: Int): Int

Compares the size of this immutable set to a test value.

Compares the size of this immutable set to a test value.

Value parameters

otherSize

the test value that gets compared with the size.

Attributes

Returns

A value x where

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

The default implementation does not call size, which may be arbitrarily expensive. It will use knownSize if nonnegative. Otherwise, it will iterate to compute an element count, with complexity O(size min otherSize). This method should be overridden if computing size is cheap and knownSize returns -1. In that case, the custom implementation should just compare size and otherSize directly.

See also
Inherited from:
IterableOps
Source
Iterable.scala
final def sizeIs: SizeCompareOps

Returns a value class containing operations for comparing the size of this immutable set to a test value.

Returns a value class containing operations for comparing the size of this immutable set 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

Attributes

Returns

a wrapper that allows size comparisons using operators such as =, and >

Inherited from:
IterableOps
Source
Iterable.scala
def slice(from: Int, until: Int): C

Selects an interval of elements. The returned immutable set is made up of all elements x which satisfy the invariant:

Selects an interval of elements. The returned immutable set is made up of all elements x which satisfy the invariant:

  from <= indexOf(x) < until

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

Value parameters

from

the lowest index to include from this immutable set.

until

the lowest index to EXCLUDE from this immutable set.

Attributes

Returns

a immutable set containing the elements greater than or equal to index from extending up to (but not including) index until of this immutable set.

Example

List('a', 'b', 'c', 'd', 'e').slice(1, 3) == List('b', 'c')

Inherited from:
IterableOps
Source
Iterable.scala
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).

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

Attributes

Returns

An iterator producing immutable sets 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
Iterable.scala
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).

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

Attributes

Returns

An iterator producing immutable sets 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
Iterable.scala
override def span(p: A => Boolean): (C, C)

Splits this immutable set into a prefix/suffix pair according to a predicate.

Splits this immutable set 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.

Value parameters

p

the test predicate

Attributes

Returns

a pair consisting of the longest prefix of this immutable set whose elements all satisfy p, and the rest of this immutable set.

Definition Classes
Inherited from:
StrictOptimizedIterableOps
Source
StrictOptimizedIterableOps.scala
override def splitAt(n: Int): (C, C)

Splits this immutable set into a prefix/suffix pair at a given position.

Splits this immutable set into a prefix/suffix pair 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.

Value parameters

n

the position at which to split.

Attributes

Returns

a pair of immutable sets consisting of the first n elements of this immutable set, and the other elements.

Definition Classes
Inherited from:
IterableOps
Source
Iterable.scala
def stepper[S <: Stepper[_]](implicit shape: StepperShape[A, S]): S

Returns a scala.collection.Stepper for the elements of this collection.

Returns a scala.collection.Stepper for the elements of this collection.

The Stepper enables creating a Java stream to operate on the collection, see scala.jdk.StreamConverters. For collections holding primitive values, the Stepper can be used as an iterator which doesn't box the elements.

The implicit scala.collection.StepperShape parameter defines the resulting Stepper type according to the element type of this collection.

Note that this method is overridden in subclasses and the return type is refined to S with EfficientSplit, for example scala.collection.IndexedSeqOps.stepper. For Steppers marked with scala.collection.Stepper.EfficientSplit, the converters in scala.jdk.StreamConverters allow creating parallel streams, whereas bare Steppers can be converted only to sequential streams.

Type parameters

S

the type of the returned Stepper, determined by the implicit StepperShape

Value parameters

shape

the StepperShape that determines the concrete Stepper subtype to return

Attributes

Returns

a Stepper over the elements of this immutable set, using a primitive-typed Stepper subclass for Int/Long/Double (and related) element types

Inherited from:
IterableOnce
Source
IterableOnce.scala
final protected def strictOptimizedCollect[B, C2](b: Builder[B, C2]^, pf: PartialFunction[A, B]^): C2

Type parameters

B

Type of elements of the resulting collection (e.g. String)

C2

Type of the resulting collection (e.g. List[String])

Value parameters

b

Builder to use to build the resulting collection

pf

Element transformation partial function

Attributes

Returns

The resulting collection

Inherited from:
StrictOptimizedIterableOps
Source
StrictOptimizedIterableOps.scala
final protected def strictOptimizedConcat[B >: A, C2](that: IterableOnce[B]^, b: Builder[B, C2]^): C2

Type parameters

B

Type of elements of the resulting collections (e.g. Int)

C2

Type of the resulting collection (e.g. List[Int])

Value parameters

b

Builder to use to build the resulting collection

that

Elements to concatenate to this collection

Attributes

Returns

The resulting collection

Inherited from:
StrictOptimizedIterableOps
Source
StrictOptimizedIterableOps.scala
final protected def strictOptimizedFlatMap[B, C2](b: Builder[B, C2]^, f: A => IterableOnce[B]^): C2

Type parameters

B

Type of elements of the resulting collection (e.g. String)

C2

Type of the resulting collection (e.g. List[String])

Value parameters

b

Builder to use to build the resulting collection

f

Element transformation function

Attributes

Returns

The resulting collection

Inherited from:
StrictOptimizedIterableOps
Source
StrictOptimizedIterableOps.scala
final protected def strictOptimizedFlatten[B, C2](b: Builder[B, C2])(implicit toIterableOnce: A => IterableOnce[B]): C2

Type parameters

B

Type of elements of the resulting collection (e.g. Int)

C2

Type of the resulting collection (e.g. List[Int])

Value parameters

b

Builder to use to build the resulting collection

toIterableOnce

Evidence that A can be seen as an IterableOnce[B]

Attributes

Returns

The resulting collection

Inherited from:
StrictOptimizedIterableOps
Source
StrictOptimizedIterableOps.scala
final protected def strictOptimizedMap[B, C2](b: Builder[B, C2], f: A => B): C2

Type parameters

B

Type of elements of the resulting collection (e.g. String)

C2

Type of the resulting collection (e.g. List[String])

Value parameters

b

Builder to use to build the resulting collection

f

Element transformation function

Attributes

Returns

The resulting collection

Inherited from:
StrictOptimizedIterableOps
Source
StrictOptimizedIterableOps.scala
final protected def strictOptimizedZip[B, C2](that: IterableOnce[B]^, b: Builder[(A, B), C2]^): C2

Type parameters

B

Type of elements of the second collection (e.g. String)

C2

Type of the resulting collection (e.g. List[(Int, String)])

Value parameters

b

Builder to use to build the resulting collection

that

Collection to zip with this collection

Attributes

Returns

The resulting collection

Inherited from:
StrictOptimizedIterableOps
Source
StrictOptimizedIterableOps.scala
def subsetOf(that: Set[A]): Boolean

Tests whether this set is a subset of another set.

Tests whether this set is a subset of another set.

Value parameters

that

the set to test.

Attributes

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
Set.scala
def subsets(): Iterator[C]

An iterator over all subsets of this set.

An iterator over all subsets of this set.

Attributes

Returns

the iterator.

Inherited from:
SetOps
Source
Set.scala
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.

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.

Attributes

Returns

the iterator.

Inherited from:
SetOps
Source
Set.scala
def sum[B >: A](implicit num: Numeric[B]): B

Sums the elements of this collection.

Sums the elements of this collection.

The default implementation uses reduce for a known non-empty collection, foldLeft otherwise.

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.

Attributes

Returns

the sum of all elements of this immutable set with respect to the + operator in num.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def tail: C

The rest of the collection without its first element.

The rest of the collection without its first element.

Attributes

Inherited from:
IterableOps
Source
Iterable.scala
def tails: Iterator[C]

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

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

Attributes

Returns

an iterator over all the tails of this immutable set

Example

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

Inherited from:
IterableOps
Source
Iterable.scala
def take(n: Int): C

Selects the first n elements.

Selects the first 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 immutable set.

Attributes

Returns

a immutable set consisting only of the first n elements of this immutable set, or else the whole immutable set, if it has less than n elements. If n is negative, returns an empty immutable set.

Inherited from:
IterableOps
Source
Iterable.scala
override def takeRight(n: Int): C

A collection containing the last n elements of this collection.

A collection containing the last n elements of this collection.

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

Value parameters

n

the number of elements to take from the end of this collection

Attributes

Returns

a new collection containing the last n elements of this collection, or all elements if n is greater than the size, or an empty collection if n is non-positive

Definition Classes
Inherited from:
StrictOptimizedIterableOps
Source
StrictOptimizedIterableOps.scala
def takeWhile(p: A => Boolean): C

Takes longest prefix of elements that satisfy a predicate.

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.

Attributes

Returns

the longest prefix of this immutable set whose elements all satisfy the predicate p.

Inherited from:
IterableOps
Source
Iterable.scala
override def tapEach[U](f: A => U): C

Applies a side-effecting function to each element in this collection. Strict collections will apply f to their elements immediately, while lazy collections like Views and LazyLists will only apply f on each element if and when that element is evaluated, and each time that element is evaluated.

Applies a side-effecting function to each element in this collection. Strict collections will apply f to their elements immediately, while lazy collections like Views and LazyLists will only apply f on each element if and when that element is evaluated, and each time that element is evaluated.

Type parameters

U

the return type of f

Value parameters

f

a function to apply to each element in this immutable set

Attributes

Returns

The same logical collection as this

Definition Classes
Inherited from:
StrictOptimizedIterableOps
Source
StrictOptimizedIterableOps.scala
def to[C1](factory: Factory[A, C1]): C1

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

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

import scala.collection.mutable.ArrayBuffer
import scala.collection.immutable.BitSet
val xs: Iterable[Int] = Seq(1, 2, 3, 4, 5)
    xs.to(List)
    xs.to(ArrayBuffer)
    xs.to(BitSet) // for xs: Iterable[Int]

Type parameters

C1

the target collection type

Value parameters

factory

the factory for the target collection type

Attributes

Returns

a new collection of type C1 containing all elements of this immutable set

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def toArray[B >: A : ClassTag]: Array[B]

Converts this immutable set to an Array.

Converts this immutable set to an Array.

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

Type parameters

B

The type of elements of the result, a supertype of A.

Attributes

Returns

This immutable set as an Array[B].

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
final def toBuffer[B >: A]: Buffer[B]

Converts this immutable set to a Buffer.

Converts this immutable set to a Buffer.

Type parameters

B

The type of elements of the result, a supertype of A.

Attributes

Returns

This immutable set as a Buffer[B].

Inherited from:
IterableOnceOps
Source
IterableOnce.scala

Converts this immutable set to an IndexedSeq.

Converts this immutable set to an IndexedSeq.

Attributes

Returns

This immutable set as an IndexedSeq[A].

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def toList: List[A]

Converts this immutable set to a List.

Converts this immutable set to a List.

Attributes

Returns

This immutable set as a List[A].

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def toMap[K, V](implicit ev: A <:< (K, V)): Map[K, V]

Converts this immutable set to a Map, given an implicit coercion from the immutable set's type to a key-value tuple.

Converts this immutable set to a Map, given an implicit coercion from the immutable set's type to a key-value tuple.

Type parameters

K

The key type for the resulting map.

V

The value type for the resulting map.

Value parameters

ev

an implicit evidence that A is a subtype of (K, V)

Attributes

Returns

This immutable set as a Map[K, V].

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def toSeq: Seq[A]

Attributes

Returns

This immutable set as a Seq[A]. This is equivalent to to(Seq) but might be faster.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def toSet[B >: A]: Set[B]

Converts this immutable set to a Set.

Converts this immutable set to a Set.

Type parameters

B

The type of elements of the result, a supertype of A.

Attributes

Returns

This immutable set as a Set[B].

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
override def toString(): String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Definition Classes
Inherited from:
Function1
Source
Function1.scala
def toVector: Vector[A]

Converts this immutable set to a Vector.

Converts this immutable set to a Vector.

Attributes

Returns

This immutable set as a Vector[A].

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def transpose[B](implicit asIterable: A -> Iterable[B]): CC[CC[B]]

Transposes this immutable set of iterable collections into a immutable set of immutable sets.

Transposes this immutable set of iterable collections into a immutable set of immutable sets.

The resulting collection's type will be guided by the static type of immutable set. 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 immutable set is an Iterable.

Attributes

Returns

a two-dimensional immutable set of immutable sets which has as nth row the nth column of this immutable set.

Throws
IllegalArgumentException

if all collections in this immutable set are not of the same size.

Inherited from:
IterableOps
Source
Iterable.scala
final def union(that: Set[A]): C

Computes the union between of set and another set.

Computes the union between of set and another set.

Value parameters

that

the set to form the union with.

Attributes

Returns

a new set consisting of all elements that are in this set or in the given set that.

Inherited from:
SetOps
Source
Set.scala
override def unzip[A1, A2](implicit asPair: A -> (A1, A2)): (CC[A1], CC[A2])

Converts this immutable set of pairs into two collections of the first and second half of each pair.

Converts this immutable set of pairs into two collections of the first and second half of each pair.

  val xs = $Coll(
             (1, "one"),
             (2, "two"),
             (3, "three")).unzip
  // xs == ($Coll(1, 2, 3),
  //        $Coll(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 immutable set is a pair.

Attributes

Returns

a pair of immutable sets, containing the first, respectively second half of each element pair of this immutable set.

Definition Classes
Inherited from:
StrictOptimizedIterableOps
Source
StrictOptimizedIterableOps.scala
override def unzip3[A1, A2, A3](implicit asTriple: A -> (A1, A2, A3)): (CC[A1], CC[A2], CC[A3])

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

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

  val xs = $Coll(
             (1, "one", '1'),
             (2, "two", '2'),
             (3, "three", '3')).unzip3
  // xs == ($Coll(1, 2, 3),
  //        $Coll(one, two, three),
  //        $Coll(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 immutable set is a triple.

Attributes

Returns

a triple of immutable sets, containing the first, second, respectively third member of each element triple of this immutable set.

Definition Classes
Inherited from:
StrictOptimizedIterableOps
Source
StrictOptimizedIterableOps.scala
def view: View[A]

A view over the elements of this collection.

A view over the elements of this collection.

Attributes

Inherited from:
IterableOps
Source
Iterable.scala
def withFilter(p: A => Boolean): WithFilter[A, CC]^{p}

Creates a non-strict filter of this immutable set.

Creates a non-strict filter of this immutable set.

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.

Attributes

Returns

an object of class WithFilter, which supports map, flatMap, foreach, and withFilter operations. All these operations apply to those elements of this immutable set which satisfy the predicate p.

Inherited from:
IterableOps
Source
Iterable.scala
override def zip[B](that: IterableOnce[B]^): CC[(A, B)]

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

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

Attributes

Returns

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

Definition Classes
Inherited from:
StrictOptimizedIterableOps
Source
StrictOptimizedIterableOps.scala
def zipAll[A1 >: A, B](that: Iterable[B]^, thisElem: A1, thatElem: B): CC[(A1, B)]^{that}

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

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

Type parameters

A1

the type of the first element in each result pair (supertype of A)

B

the type of the second element in each result pair

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 immutable set.

thisElem

the element to be used to fill up the result if this immutable set is shorter than that.

Attributes

Returns

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

Inherited from:
IterableOps
Source
Iterable.scala
override def zipWithIndex: CC[(A, Int)]

Zips this immutable set with its indices.

Zips this immutable set with its indices.

Attributes

Returns

A new immutable set containing pairs consisting of all elements of this immutable set paired with their index. Indices start at 0.

Example

List("a", "b", "c").zipWithIndex == List(("a", 0), ("b", 1), ("c", 2))

Definition Classes
Inherited from:
StrictOptimizedIterableOps
Source
StrictOptimizedIterableOps.scala
final def |(that: Set[A]): C

Alias for union.

Alias for union.

Value parameters

that

the set to form the union with

Attributes

Inherited from:
SetOps
Source
Set.scala

Inherited and Abstract methods

def contains(elem: A): Boolean

Attributes

Inherited from:
SetOps
Source
Set.scala
def excl(elem: A): C

Creates a new set with a given element removed from this set.

Creates a new set with a given element removed from this set.

Value parameters

elem

the element to be removed

Attributes

Returns

a new set that contains all elements of this set but that does not contain elem.

Inherited from:
SetOps
Source
Set.scala
def incl(elem: A): C

Creates a new set with an additional element, unless the element is already present.

Creates a new set with an additional element, unless the element is already present.

Value parameters

elem

the element to be added

Attributes

Returns

a new set that contains all elements of this set and that also contains elem.

Inherited from:
SetOps
Source
Set.scala

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

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

Attributes

Returns

the companion factory object for this collection type

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
Iterable.scala
def iterator: Iterator[A]

An scala.collection.Iterator over the elements of this immutable set.

An scala.collection.Iterator over the elements of this immutable set.

If an IterableOnce object is in fact an scala.collection.Iterator, this method always returns itself, in its current state, but if it is an scala.collection.Iterable, this method always returns a new scala.collection.Iterator.

Attributes

Returns

an iterator over all elements of this immutable set

Inherited from:
IterableOnce
Source
IterableOnce.scala

Deprecated and Inherited methods

def +(elem1: A, elem2: A, elems: A*): C

Attributes

Deprecated
[Since version 2.13.0] Use ++ with an explicit collection argument instead of + with varargs
Inherited from:
SetOps
Source
Set.scala
def ++:[B >: A](that: IterableOnce[B]^): CC[B]^{that}

Attributes

Deprecated
[Since version 2.13.0] Use ++ instead of ++: for collections of type Iterable
Inherited from:
IterableOps
Source
Iterable.scala
def -(elem1: A, elem2: A, elems: A*): C

Attributes

Deprecated
[Since version 2.13.0] Use &- with an explicit collection argument instead of - with varargs
Inherited from:
SetOps
Source
Set.scala
final def /:[B](z: B)(op: (B, A) => B): B

Attributes

Deprecated
[Since version 2.13.0] Use foldLeft instead of /:
Inherited from:
IterableOnceOps
Source
IterableOnce.scala
final def :\[B](z: B)(op: (A, B) => B): B

Attributes

Deprecated
[Since version 2.13.0] Use foldRight instead of :\\
Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def aggregate[B](z: => B)(seqop: (B, A) => B, combop: (B, B) => B): B

Aggregates the results of applying an operator to subsequent elements.

Aggregates the results of applying an operator to subsequent elements.

Since this method degenerates to foldLeft for sequential (non-parallel) collections, where the combining operation is ignored, it is advisable to prefer foldLeft for that case.

For parallel collections, use the aggregate method specified by scala.collection.parallel.ParIterableLike.

Type parameters

B

the result type, produced by seqop, combop, and by this function as a final result.

Value parameters

combop

an associative operator for combining sequential results, unused for sequential collections.

seqop

the binary operator used to accumulate the result.

z

the start value, a neutral element for seqop.

Attributes

Deprecated
[Since version 2.13.0] For sequential collections, prefer `foldLeft(z)(seqop)`. For parallel collections, use `ParIterableLike#aggregate`.
Inherited from:
IterableOnceOps
Source
IterableOnce.scala

Attributes

Deprecated
[Since version 2.13.0] Use iterableFactory instead
Inherited from:
IterableOps
Source
Iterable.scala
final def copyToBuffer[B >: A](dest: Buffer[B]): Unit

Attributes

Deprecated
[Since version 2.13.0] Use `dest ++= coll` instead
Inherited from:
IterableOnceOps
Source
IterableOnce.scala

Tests whether this immutable set is known to have a finite size. All strict collections are known to have finite size. For a non-strict collection such as Stream, the predicate returns **true** if all elements have been computed. It returns **false** if the stream is not yet evaluated to the end. Non-empty Iterators usually return **false** even if they were created from a collection with a known finite size.

Tests whether this immutable set is known to have a finite size. All strict collections are known to have finite size. For a non-strict collection such as Stream, the predicate returns **true** if all elements have been computed. It returns **false** if the stream is not yet evaluated to the end. Non-empty Iterators usually return **false** even if they were created from a collection with a known finite size.

Note: many collection methods will not work on collections of infinite sizes. The typical failure mode is an infinite loop. These methods always attempt a traversal without checking first that hasDefiniteSize returns **true**. However, checking hasDefiniteSize can provide an assurance that size is well-defined and non-termination is not a concern.

Attributes

Returns

**true** if this collection is known to have finite size, **false** otherwise.

See also

method knownSize for a more useful alternative

Deprecated
[Since version 2.13.0] Check .knownSize instead of .hasDefiniteSize for more actionable information (see scaladoc for details)

This method is deprecated in 2.13 because it does not provide any actionable information. As noted above, even the collection library itself does not use it. When there is no guarantee that a collection is finite, it is generally best to attempt a computation anyway and document that it will not terminate for infinite collections rather than backing out because this would prevent performing the computation on collections that are in fact finite even though hasDefiniteSize returns false.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
final def repr: C

Attributes

Deprecated
[Since version 2.13.0] Use coll instead of repr in a collection implementation, use the collection value itself from the outside
Inherited from:
IterableOps
Source
Iterable.scala

Attributes

Returns

This collection as an Iterable[A]. No new collection will be built if this is already an Iterable[A].

Deprecated
[Since version 2.13.7] toIterable is internal and will be made protected; its name is similar to `toList` or `toSeq`, but it doesn\'t copy non-immutable collections
Inherited from:
IterableOps
Source
Iterable.scala
final def toIterator: Iterator[A]

Attributes

Deprecated
[Since version 2.13.0] Use .iterator instead of .toIterator
Inherited from:
IterableOnceOps
Source
IterableOnce.scala
final def toStream: Stream[A]

Attributes

Deprecated
[Since version 2.13.0] Use .to(LazyList) instead of .toStream
Inherited from:
IterableOnceOps
Source
IterableOnce.scala
final def toTraversable: Iterable[A]

Converts this immutable set to an unspecified Iterable. Will return the same collection if this instance is already Iterable.

Converts this immutable set to an unspecified Iterable. Will return the same collection if this instance is already Iterable.

Attributes

Returns

An Iterable containing all elements of this immutable set.

Deprecated
[Since version 2.13.0] toTraversable is internal and will be made protected; its name is similar to `toList` or `toSeq`, but it doesn\'t copy non-immutable collections
Inherited from:
IterableOps
Source
Iterable.scala
def view(from: Int, until: Int): View[A]

A view over a slice of the elements of this collection.

A view over a slice of the elements of this collection.

Attributes

Deprecated
[Since version 2.13.0] Use .view.slice(from, until) instead of .view(from, until)
Inherited from:
IterableOps
Source
Iterable.scala