Scala 3/API/scala.collection.mutable/SortedSetOps

SortedSetOps

trait SortedSetOps[A, +CC <: ([X] =>> SortedSet[X]), +C <: SortedSetOps[A, CC, C]] extends SetOps[A, [A] =>> Set[A], C] with SortedSetOps[A, CC, C]
trait SortedSetOps[A, CC, C]
trait SortedOps[A, C]
trait SetOps[A, [A] =>> Set[A], C]
trait Shrinkable[A]
trait Builder[A, C]
trait Growable[A]
trait Clearable
trait Cloneable[C]
trait Cloneable
trait SetOps[A, [A] =>> Set[A], C]
trait A => Boolean
trait IterableOps[A, [A] =>> Set[A], C]
trait IterableOnceOps[A, [A] =>> Set[A], C]
class Object
trait Matchable
class Any
class BitSet
trait SortedSet[A]
class TreeSet[A]

Value members

Abstract methods

def unsorted: Set[A]

Inherited methods

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

Alias for intersect

Alias for intersect

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

Alias for diff

Alias for diff

Inherited from
SetOps
final def ++(that: IterableOnce[A]): C

Alias for concat

Alias for concat

Inherited from
SetOps
final def ++[B >: A](suffix: IterableOnce[B]): Set[B]

Alias for concat

Alias for concat

Inherited from
IterableOps
final def ++=(xs: IterableOnce[A]): SortedSetOps[A, CC, C]

Alias for addAll

Alias for addAll

Inherited from
Growable
final def +=(elem: A): SortedSetOps[A, CC, C]

Alias for addOne

Alias for addOne

Inherited from
Growable
final def --=(xs: IterableOnce[A]): SortedSetOps[A, CC, C]

Alias for subtractAll

Alias for subtractAll

Inherited from
Shrinkable
final def -=(elem: A): SortedSetOps[A, CC, C]

Alias for subtractOne

Alias for subtractOne

Inherited from
Shrinkable
def add(elem: A): Boolean

Check whether the set contains the given element, and add it if not.

Check whether the set contains the given element, and add it if not.

Value Params
elem

the element to be added

Returns

true if the element was added

Inherited from
SetOps
def addAll(xs: IterableOnce[A]): SortedSetOps[A, CC, C]

Adds all elements produced by an IterableOnce to this growable collection.

Adds all elements produced by an IterableOnce to this growable collection.

Value Params
xs

the IterableOnce producing the elements to add.

Returns

the growable collection itself.

Inherited from
Growable
def addOne(elem: A): SortedSetOps[A, CC, C]

Adds a single element to this growable collection.

Adds a single element to this growable collection.

Value Params
elem

the element to add.

Returns

the growable collection itself

Inherited from
Growable
final def addString(b: StringBuilder): StringBuilder

Appends all elements of this collection to a string builder.

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 Params
b

the string builder to which elements are appended.

Returns

the string builder b to which elements were appended.

Inherited from
IterableOnceOps
final def addString(b: StringBuilder, sep: String): StringBuilder

Appends all elements of this collection to a string builder using a separator string.

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 Params
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
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.

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 Params
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
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 Params
A

the result type of function g

Value Params
g

a function R => A

Returns

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

Inherited from
Function1
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 Params
elem

the element to test for membership.

Returns

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

Inherited from
SetOps
def clear(): Unit

Clears the contents of this builder.

Clears the contents of this builder. After execution of this method the builder will contain no elements.

Inherited from
Builder
override def clone(): C
Definition Classes
Inherited from
SetOps
def collect[B](pf: PartialFunction[A, B])(@implicitNotFound ev: Ordering[B]): CC[B]

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

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

Type Params
B

the element type of the returned collection.

Value Params
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
def collect[B](pf: PartialFunction[A, B]): Set[B]
Inherited from
IterableOps
def collectFirst[B](pf: PartialFunction[A, 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.

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 Params
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
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 Params
A

the type to which function g can be applied

Value Params
g

a function A => T1

Returns

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

Inherited from
Function1
def concat(that: IterableOnce[A]): C

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

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

This method takes a collection of elements and adds all elements, omitting duplicates, into set.

Example:

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

the collection containing the elements to add.

Returns

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

Inherited from
SetOps
def concat[B >: A](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.

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 Params
B

the element type of the returned collection.

Value Params
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
def contains(elem: A): Boolean
Inherited from
SetOps
def copyToArray[B >: A](xs: Array[B], start: Int, len: Int): Int

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

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 Params
B

the type of the elements of the array.

Value Params
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
@deprecatedOverriding("This should always forward to the 3-arg version of this method", since = "2.13.4")
def copyToArray[B >: A](xs: Array[B], start: Int): Int

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

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 Params
B

the type of the elements of the array.

Value Params
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
@deprecatedOverriding("This should always forward to the 3-arg version of this method", since = "2.13.4")
def copyToArray[B >: A](xs: Array[B]): Int

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

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 Params
B

the type of the elements of the array.

Value Params
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
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 Params
B

the type of the elements of that

Value Params
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
def count(p: A => Boolean): Int

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

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

Note: will not terminate for infinite-sized collections.

Value Params
p

the predicate used to test elements.

Returns

the number of elements satisfying the predicate p.

Inherited from
IterableOnceOps
def diff(that: Set[A]): C
Inherited from
SetOps
def drop(n: Int): C
Inherited from
IterableOps
def dropRight(n: Int): C

Selects all elements except last n ones.

Selects all elements except last n ones.

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

Value Params
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
def dropWhile(p: A => Boolean): C
Inherited from
IterableOps
def empty: C

The empty iterable of the same type as this iterable

The empty iterable of the same type as this iterable

Returns

an empty iterable of type C.

Inherited from
IterableOps
def exists(p: A => Boolean): Boolean

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

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

Note: may not terminate for infinite-sized collections.

Value Params
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
def filter(pred: A => Boolean): C
Inherited from
IterableOps
def filterInPlace(p: A => Boolean): SortedSetOps[A, CC, C]

Removes all elements from the set for which do not satisfy a predicate.

Removes all elements from the set for which do not satisfy a predicate.

Value Params
p

the predicate used to test elements. Only elements for which p returns true are retained in the set; all others are removed.

Inherited from
SetOps
def filterNot(pred: A => Boolean): C
Inherited from
IterableOps
def find(p: A => Boolean): Option[A]

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

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 Params
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
def firstKey: A
Inherited from
SortedSetOps
def flatMap[B](f: A => IterableOnce[B])(@implicitNotFound ev: Ordering[B]): CC[B]

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

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

Type Params
B

the element type of the returned collection.

Value Params
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
def flatMap[B](f: A => IterableOnce[B]): Set[B]
Inherited from
IterableOps
def flatten[B](asIterable: A => IterableOnce[B]): Set[B]
Inherited from
IterableOps
def fold[A1 >: A](z: A1)(op: (A1, A1) => A1): A1

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

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 Params
A1

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

Value Params
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
def foldLeft[B](z: B)(op: (B, A) => B): B

Applies a binary operator to a start value and all elements of this collection, going left to right.

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 Params
B

the result type of the binary operator.

Value Params
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
def foldRight[B](z: B)(op: (A, B) => B): B

Applies a binary operator to all elements of this collection and a start value, going right to left.

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 Params
B

the result type of the binary operator.

Value Params
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
def forall(p: A => Boolean): Boolean

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

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

Note: may not terminate for infinite-sized collections.

Value Params
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
def foreach[U](f: A => U): Unit

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

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

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

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

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 Params
K

the type of keys returned by the discriminator function.

Value Params
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
def groupMap[K, B](key: A => K)(f: A => B): Map[K, Set[B]]

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

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 Params
B

the type of values returned by the transformation function

K

the type of keys returned by the discriminator function

Value Params
f

the element transformation function

key

the discriminator function

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

Partitions this iterable collection into a map according to a discriminator function key.

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
def grouped(size: Int): Iterator[C]

Partitions elements in fixed size iterable collections.

Partitions elements in fixed size iterable collections.

Value Params
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
Inherited from
IterableOps
def head: A

Selects the first element of this iterable collection.

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

Returns

the first element of this iterable collection if it is nonempty, None if it is empty.

Inherited from
IterableOps
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.

Inherited from
IterableOps
def inits: Iterator[C]

Iterates over the inits of this iterable collection.

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
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 Params
that

the set to intersect with.

Returns

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

Inherited from
SetOps
def isEmpty: Boolean

Tests whether the collection is empty.

Tests whether the collection is empty.

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

Returns

true if the collection contains no elements, false otherwise.

Inherited from
IterableOnceOps
override def isTraversableAgain: Boolean
Definition Classes
Inherited from
IterableOps
def iterableFactory: IterableFactory[[A] =>> Set[A]]

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

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

Iterator can be used only once

Iterator can be used only once

Inherited from
IterableOnce
def iteratorFrom(start: A): Iterator[A]

Creates an iterator that contains all values from this collection greater than or equal to start according to the ordering of this collection.

Creates an iterator that contains all values from this collection greater than or equal to start according to the ordering of this collection. x.iteratorFrom(y) is equivalent to but will usually be more efficient than x.from(y).iterator

Value Params
start

The lower-bound (inclusive) of the iterator

Inherited from
SortedSetOps
override def knownSize: Int
Definition Classes
Inherited from
SetOps
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.

Returns

The last element of this iterable collection.

Throws
NoSuchElementException

If the iterable collection is empty.

Inherited from
IterableOps
def lastKey: A
Inherited from
SortedSetOps
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.

Returns

the last element of this iterable collection$ if it is nonempty, None if it is empty.

Inherited from
IterableOps
def map[B](f: A => B)(@implicitNotFound ev: Ordering[B]): CC[B]

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

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

Type Params
B

the element type of the returned collection.

Value Params
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
def map[B](f: A => B): Set[B]
Inherited from
IterableOps
def mapResult[NewTo](f: C => NewTo): Builder[A, NewTo]

A builder resulting from this builder my mapping the result using f.

A builder resulting from this builder my mapping the result using f.

Inherited from
Builder
override def max[B >: A](ord: Ordering[B]): A
Definition Classes
Inherited from
SortedSetOps
def maxBefore(key: A): Option[A]

Find the largest element less than a given key.

Find the largest element less than a given key.

Value Params
key

The given key.

Returns

None if there is no such node.

Inherited from
SortedSetOps
def maxBy[B](f: A => B)(cmp: 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 Params
B

The result type of the function f.

Value Params
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
def maxByOption[B](f: A => B)(cmp: 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 Params
B

The result type of the function f.

Value Params
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
def maxOption[B >: A](ord: Ordering[B]): Option[A]

Finds the largest element.

Finds the largest element.

Note: will not terminate for infinite-sized collections.

Type Params
B

The type over which the ordering is defined.

Value Params
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
override def min[B >: A](ord: Ordering[B]): A
Definition Classes
Inherited from
SortedSetOps
def minAfter(key: A): Option[A]

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

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

Value Params
key

The given key.

Returns

None if there is no such node.

Inherited from
SortedSetOps
def minBy[B](f: A => B)(cmp: 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 Params
B

The result type of the function f.

Value Params
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
def minByOption[B](f: A => B)(cmp: 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 Params
B

The result type of the function f.

Value Params
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
def minOption[B >: A](ord: Ordering[B]): Option[A]

Finds the smallest element.

Finds the smallest element.

Note: will not terminate for infinite-sized collections.

Type Params
B

The type over which the ordering is defined.

Value Params
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
final def mkString: String

Displays all elements of this collection in a 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
final def mkString(sep: String): String

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

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

Delegates to addString, which can be overridden.

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

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

Delegates to addString, which can be overridden.

Value Params
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
@deprecatedOverriding("nonEmpty is defined as !isEmpty; override isEmpty instead", "2.13.0")
def nonEmpty: Boolean

Tests whether the collection is not empty.

Tests whether the collection is not empty.

Returns

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

Inherited from
IterableOnceOps
def ordering: Ordering[A]
Inherited from
SortedOps
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. Interesting because it splits a collection in two.

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.

Inherited from
IterableOps
def partitionMap[A1, A2](f: A => 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.

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 Params
A1

the element type of the first resulting collection

A2

the element type of the second resulting collection

Value Params
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
def product[B >: A](num: Numeric[B]): B

Multiplies up the elements of this collection.

Multiplies up the elements of this collection.

Note: will not terminate for infinite-sized collections.

Type Params
B

the result type of the * operator.

Value Params
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
def range(from: A, until: A): C

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

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

Value Params
from

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

until

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

Inherited from
SortedOps
def rangeFrom(from: A): C

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

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

Value Params
from

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

Inherited from
SortedOps
def rangeImpl(from: Option[A], until: Option[A]): C

Creates a ranged projection of this collection.

Creates a ranged projection of this collection. Any mutations in the ranged projection will update this collection and vice versa.

Note: keys are not guaranteed to be consistent between this collection and the projection. This is the case for buffers where indexing is relative to the projection.

Value Params
from

The lower-bound (inclusive) of the ranged projection. None if there is no lower bound.

until

The upper-bound (exclusive) of the ranged projection. None if there is no upper bound.

Inherited from
SortedOps
def rangeTo(to: A): C
Inherited from
SortedSetOps
def rangeUntil(until: A): C

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

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

Value Params
until

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

Inherited from
SortedOps
def reduce[B >: A](op: (B, B) => B): B

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

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 Params
B

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

Value Params
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
def reduceLeft[B >: A](op: (B, A) => B): B

Applies a binary operator to all elements of this collection, going left to right.

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 Params
B

the result type of the binary operator.

Value Params
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
def reduceLeftOption[B >: A](op: (B, A) => B): Option[B]

Optionally applies a binary operator to all elements of this collection, going left to right.

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 Params
B

the result type of the binary operator.

Value Params
op

the binary operator.

Returns

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

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

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

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 Params
B

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

Value Params
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
def reduceRight[B >: A](op: (A, B) => B): B

Applies a binary operator to all elements of this collection, going right to left.

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 Params
B

the result type of the binary operator.

Value Params
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
def reduceRightOption[B >: A](op: (A, B) => B): Option[B]

Optionally applies a binary operator to all elements of this collection, going right to left.

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 Params
B

the result type of the binary operator.

Value Params
op

the binary operator.

Returns

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

Inherited from
IterableOnceOps
def remove(elem: A): Boolean

Removes an element from this set.

Removes an element from this set.

Value Params
elem

the element to be removed

Returns

true if this set contained the element before it was removed

Inherited from
SetOps
def result(): C
Inherited from
SetOps
protected def reversed: Iterable[A]
Inherited from
IterableOnceOps
def scan[B >: A](z: B)(op: (B, B) => B): Set[B]

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 Params
B

element type of the resulting collection

Value Params
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
def scanLeft[B](z: B)(op: (B, A) => B): Set[B]
Inherited from
IterableOps
def scanRight[B](z: B)(op: (A, B) => B): Set[B]

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

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 Params
B

the type of the elements in the resulting collection

Value Params
op

the binary operator applied to the intermediate result and the element

z

the initial value

Returns

collection with intermediate results

Inherited from
IterableOps
def size: Int

The size of this collection.

The size of this collection.

Note: will not terminate for infinite-sized collections.

Returns

the number of elements in this collection.

Inherited from
IterableOnceOps
def sizeCompare(that: Iterable[_]): Int

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

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

Value Params
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
def sizeCompare(otherSize: Int): Int

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

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

Value Params
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
Inherited from
IterableOps
final def sizeHint(coll: IterableOnce[_], delta: Int): Unit

Gives a hint that one expects the result of this builder to have the same size as the given collection, plus some delta.

Gives a hint that one expects the result of this builder to have the same size as the given collection, plus some delta. This will provide a hint only if the collection has a known size Some builder classes will optimize their representation based on the hint. However, builder implementations are still required to work correctly even if the hint is wrong, i.e. a different number of elements is added.

Value Params
coll

the collection which serves as a hint for the result's size.

delta

a correction to add to the coll.size to produce the size hint.

Inherited from
Builder
def sizeHint(size: Int): Unit

Gives a hint how many elements are expected to be added when the next result is called.

Gives a hint how many elements are expected to be added when the next result is called. Some builder classes will optimize their representation based on the hint. However, builder implementations are still required to work correctly even if the hint is wrong, i.e. a different number of elements is added.

Value Params
size

the hint how many elements will be added.

Inherited from
Builder
final def sizeHintBounded(size: Int, boundingColl: Iterable[_]): Unit

Gives a hint how many elements are expected to be added when the next result is called, together with an upper bound given by the size of some other collection.

Gives a hint how many elements are expected to be added when the next result is called, together with an upper bound given by the size of some other collection. Some builder classes will optimize their representation based on the hint. However, builder implementations are still required to work correctly even if the hint is wrong, i.e. a different number of elements is added.

Value Params
boundingColl

the bounding collection. If it is an IndexedSeqLike, then sizes larger than collection's size are reduced.

size

the hint how many elements will be added.

Inherited from
Builder
final def sizeIs: SizeCompareOps

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

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
def slice(from: Int, until: Int): C
Inherited from
IterableOps
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 Params
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
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
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 Params
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
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
def sortedIterableFactory: SortedIterableFactory[CC]

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

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
def span(p: A => Boolean): (C, C)
Inherited from
IterableOps
override def splitAt(n: Int): (C, C)
Definition Classes
Inherited from
IterableOps
def stepper[S <: Stepper[_]](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.

Inherited from
IterableOnce
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 Params
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
def subsets(): Iterator[C]

An iterator over all subsets of this set.

An iterator over all subsets of this set.

Returns

the iterator.

Inherited from
SetOps
def subsets(len: Int): Iterator[C]

An iterator over all subsets of this set of the given size.

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

Value Params
len

the size of the subsets.

Returns

the iterator.

Inherited from
SetOps
def subtractAll(xs: IterableOnce[A]): SortedSetOps[A, CC, C]

Removes all elements produced by an iterator from this shrinkable collection.

Removes all elements produced by an iterator from this shrinkable collection.

Value Params
xs

the iterator producing the elements to remove.

Returns

the shrinkable collection itself

Inherited from
Shrinkable
def subtractOne(elem: A): SortedSetOps[A, CC, C]

Removes a single element from this shrinkable collection.

Removes a single element from this shrinkable collection.

Value Params
elem

the element to remove.

Returns

the shrinkable collection itself

Inherited from
Shrinkable
def sum[B >: A](num: Numeric[B]): B

Sums up the elements of this collection.

Sums up the elements of this collection.

Note: will not terminate for infinite-sized collections.

Type Params
B

the result type of the + operator.

Value Params
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
def tail: C

The rest of the collection without its first element.

The rest of the collection without its first element.

Inherited from
IterableOps
def tails: Iterator[C]

Iterates over the tails of this iterable collection.

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
def take(n: Int): C
Inherited from
IterableOps
def takeRight(n: Int): C

Selects the last n elements.

Selects the last n elements.

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

Value Params
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
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 Params
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
override def tapEach[U](f: A => U): C
Definition Classes
Inherited from
IterableOps
def to[C1](factory: Factory[A, C1]): C1

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

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
def toArray[B >: A](`evidence$1`: ClassTag[B]): Array[B]

Convert collection to array.

Convert collection to array.

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

Inherited from
IterableOnceOps
final def toBuffer[B >: A]: Buffer[B]
Inherited from
IterableOnceOps
def toIterable: Iterable[A]
Returns

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

Inherited from
IterableOps
def toList: List[A]
Inherited from
IterableOnceOps
def toMap[K, V](ev: A <:< (K, V)): Map[K, V]
Inherited from
IterableOnceOps
def toSeq: Seq[A]
Returns

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

Inherited from
IterableOnceOps
def toSet[B >: A]: Set[B]
Inherited from
IterableOnceOps
override def toString(): String
Definition Classes
Function1 -> Any
Inherited from
Function1
def toVector: Vector[A]
Inherited from
IterableOnceOps
def transpose[B](asIterable: A => Iterable[B]): Set[Set[B]]

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

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 Params
B

the type of the elements of each iterable collection.

Value Params
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
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 Params
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
def unzip[A1, A2](asPair: A => (A1, A2)): (Set[A1], Set[A2])

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

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 Params
A1

the type of the first half of the element pairs

A2

the type of the second half of the element pairs

Value Params
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
def unzip3[A1, A2, A3](asTriple: A => (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.

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 Params
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 Params
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
def update(elem: A, included: Boolean): Unit

Updates the presence of a single element in this set.

Updates the presence of a single element in this set.

This method allows one to add or remove an element elem from this set depending on the value of parameter included. Typically, one would use the following syntax:

set(elem) = true  // adds element
set(elem) = false // removes element
Value Params
elem

the element to be added or removed

included

a flag indicating whether element should be included or excluded.

Inherited from
SetOps
def view: View[A]

A view over the elements of this collection.

A view over the elements of this collection.

Inherited from
IterableOps
def withFilter(p: A => Boolean): WithFilter[A, [A] =>> Set[A]]

Creates a non-strict filter of this iterable collection.

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 Params
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
def zip[B](that: IterableOnce[B])(@implicitNotFound ev: Ordering[(A, B)]): CC[(A, B)]

Returns a set formed from this set and another iterable collection by combining corresponding elements in pairs.

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 Params
B

the type of the second half of the returned pairs

Value Params
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
def zip[B](that: IterableOnce[B]): Set[(A, B)]

Returns a iterable collection formed from this iterable collection and another iterable collection by combining corresponding elements in pairs.

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 Params
B

the type of the second half of the returned pairs

Value Params
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
def zipAll[A1 >: A, 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.

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 Params
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
def zipWithIndex: Set[(A, Int)]
Inherited from
IterableOps
final def |(that: Set[A]): C

Alias for union

Alias for union

Inherited from
SetOps

Deprecated and Inherited methods

@deprecated("Use ++ with an explicit collection argument instead of + with varargs", "2.13.0")
def +(elem1: A, elem2: A, elems: A*): C
Deprecated
Inherited from
SetOps
@deprecated("Consider requiring an immutable Set or fall back to Set.union", "2.13.0")
def +(elem: A): C
Deprecated
Inherited from
SetOps
@deprecated("Use ++ instead of ++: for collections of type Iterable", "2.13.0")
def ++:[B >: A](that: IterableOnce[B]): Set[B]
Deprecated
Inherited from
IterableOps
@deprecated("Use `++=` aka `addAll` instead of varargs `+=`; infix operations with an operand of multiple args will be deprecated", "2.13.0") @inline
final def +=(elem1: A, elem2: A, elems: A*): SortedSetOps[A, CC, C]

Adds two or more elements to this growable collection.

Adds two or more elements to this growable collection.

Value Params
elem1

the first element to add.

elem2

the second element to add.

elems

the remaining elements to add.

Returns

the growable collection itself

Deprecated
Inherited from
Growable
@deprecated("Use &- with an explicit collection argument instead of - with varargs", "2.13.0")
def -(elem1: A, elem2: A, elems: A*): C
Deprecated
Inherited from
SetOps
@deprecated("Consider requiring an immutable Set or fall back to Set.diff", "2.13.0")
def -(elem: A): C
Deprecated
Inherited from
SetOps
@deprecated("Consider requiring an immutable Set", "2.13.0")
def --(that: IterableOnce[A]): C
Deprecated
Inherited from
SetOps
@deprecated("Use `--=` aka `subtractAll` instead of varargs `-=`; infix operations with an operand of multiple args will be deprecated", "2.13.3")
def -=(elem1: A, elem2: A, elems: A*): SortedSetOps[A, CC, C]

Removes two or more elements from this shrinkable collection.

Removes two or more elements from this shrinkable collection.

Value Params
elem1

the first element to remove.

elem2

the second element to remove.

elems

the remaining elements to remove.

Returns

the shrinkable collection itself

Deprecated
Inherited from
Shrinkable
@deprecated("Use foldLeft instead of /:", "2.13.0") @inline
final def /:[B](z: B)(op: (B, A) => B): B
Deprecated
Inherited from
IterableOnceOps
@deprecated("Use foldRight instead of :\\", "2.13.0") @inline
final def :\[B](z: B)(op: (A, B) => B): B
Deprecated
Inherited from
IterableOnceOps
@deprecated("`aggregate` is not relevant for sequential collections. Use `foldLeft(z)(seqop)` instead.", "2.13.0")
def aggregate[B](z: => B)(seqop: (B, A) => B, combop: (B, B) => B): B
Deprecated
Inherited from
IterableOnceOps
@deprecated("Use iterableFactory instead", "2.13.0") @deprecatedOverriding("Use iterableFactory instead", "2.13.0") @inline
def companion: IterableFactory[[A] =>> Set[A]]
Deprecated
Inherited from
IterableOps
@deprecated("Use ordering.compare instead", "2.13.0") @deprecatedOverriding("Use ordering.compare instead", "2.13.0") @inline
def compare(k0: A, k1: A): Int

Comparison function that orders keys.

Comparison function that orders keys.

Deprecated
Inherited from
SortedOps
@deprecated("Use `dest ++= coll` instead", "2.13.0") @inline
final def copyToBuffer[B >: A](dest: Buffer[B]): Unit
Deprecated
Inherited from
IterableOnceOps
@deprecated("Use rangeFrom", "2.13.0")
final def from(from: A): C

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

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

Value Params
from

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

Deprecated
Inherited from
SortedOps
@deprecated("Check .knownSize instead of .hasDefiniteSize for more actionable information (see scaladoc for details)", "2.13.0")
def hasDefiniteSize: Boolean

Tests whether this collection is known to have a finite size.

Tests whether this collection 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.

Returns

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

See also

method knownSize for a more useful alternative

Deprecated

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
@deprecated("Use `iteratorFrom` instead.", "2.13.0") @inline
def keysIteratorFrom(start: A): Iterator[A]
Deprecated
Inherited from
SortedSetOps
@deprecated("Use coll instead of repr in a collection implementation, use the collection value itself from the outside", "2.13.0")
final def repr: C
Deprecated
Inherited from
IterableOps
@deprecated("Use filterInPlace instead", "2.13.0") @inline
final def retain(p: A => Boolean): Unit
Deprecated
Inherited from
SetOps
@deprecated("Use rangeTo", "2.13.0")
final def to(to: A): C

Create a range projection of this collection with no lower-bound.

Create a range projection of this collection with no lower-bound.

Value Params
to

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

Deprecated
Inherited from
SortedOps
@deprecated("Use .iterator instead of .toIterator", "2.13.0") @inline
final def toIterator: Iterator[A]
Deprecated
Inherited from
IterableOnceOps
@deprecated("Use .to(LazyList) instead of .toStream", "2.13.0") @inline
final def toStream: Stream[A]
Deprecated
Inherited from
IterableOnceOps
@deprecated("Use toIterable instead", "2.13.0")
final def toTraversable: Iterable[A]

Converts this iterable collection to an unspecified Iterable.

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

Returns

An Iterable containing all elements of this iterable collection.

Deprecated
Inherited from
IterableOps
@deprecated("Use rangeUntil", "2.13.0")
final def until(until: A): C

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

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

Value Params
until

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

Deprecated
Inherited from
SortedOps
@deprecated("Use .view.slice(from, until) instead of .view(from, until)", "2.13.0")
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.

Deprecated
Inherited from
IterableOps