Trait

scala.collection

SetLike

Related Doc: package collection

Permalink

trait SetLike[A, +This <: SetLike[A, This] with Set[A]] extends IterableLike[A, This] with GenSetLike[A, This] with Subtractable[A, This] with Parallelizable[A, ParSet[A]]

A template trait for sets.

A set is a collection that contains no duplicate elements.

To implement a concrete set, you need to provide implementations of the following methods:

def contains(key: A): Boolean
def iterator: Iterator[A]
def +(elem: A): This
def -(elem: A): This

If you wish that methods like take, drop, filter return the same kind of set, you should also override:

def empty: This

It is also good idea to override methods foreach and size for efficiency.

Implementation note: This trait provides most of the operations of a Set independently of its representation. It is typically inherited by concrete implementations of sets.

Self Type
SetLike[A, This]
Since

2.8

Linear Supertypes
Subtractable[A, This], GenSetLike[A, This], (A) ⇒ Boolean, IterableLike[A, This], GenIterableLike[A, This], TraversableLike[A, This], GenTraversableLike[A, This], Parallelizable[A, ParSet[A]], TraversableOnce[A], GenTraversableOnce[A], FilterMonadic[A, This], HasNewBuilder[A, This], Equals, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SetLike
  2. Subtractable
  3. GenSetLike
  4. Function1
  5. IterableLike
  6. GenIterableLike
  7. TraversableLike
  8. GenTraversableLike
  9. Parallelizable
  10. TraversableOnce
  11. GenTraversableOnce
  12. FilterMonadic
  13. HasNewBuilder
  14. Equals
  15. AnyRef
  16. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. type Self = This

    Permalink

    The type implementing this traversable

    The type implementing this traversable

    Attributes
    protected[this]
    Definition Classes
    TraversableLike
  2. class WithFilter extends FilterMonadic[A, Repr]

    Permalink

    A class supporting filtered operations.

    A class supporting filtered operations. Instances of this class are returned by method withFilter.

    Definition Classes
    TraversableLike

Abstract Value Members

  1. abstract def +(elem: A): This

    Permalink

    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.

    elem

    the element to be added

    returns

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

    Definition Classes
    SetLikeGenSetLike
  2. abstract def -(elem: A): This

    Permalink

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

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

    elem

    the element to be removed

    returns

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

    Definition Classes
    SetLikeSubtractableGenSetLike
  3. abstract def contains(elem: A): Boolean

    Permalink

    Tests if some element is contained in this set.

    Tests if some element is contained in this set.

    elem

    the element to test for membership.

    returns

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

    Definition Classes
    SetLikeGenSetLike
  4. abstract def empty: This

    Permalink

    The empty set of the same type as this set

    The empty set of the same type as this set

    returns

    an empty set of type This.

  5. abstract def iterator: Iterator[A]

    Permalink
    Definition Classes
    GenSetLikeGenIterableLike
  6. abstract def seq: Set[A]

    Permalink
    Definition Classes
    GenSetLikeParallelizableGenTraversableOnce

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. def &(that: GenSet[A]): This

    Permalink

    Computes the intersection between this set and another set.

    Computes the intersection between this set and another set.

    Note: Same as intersect.

    that

    the set to intersect with.

    returns

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

    Definition Classes
    GenSetLike
  4. def &~(that: GenSet[A]): This

    Permalink

    The difference of this set and another set.

    The difference of this set and another set.

    Note: Same as diff.

    that

    the set of elements to exclude.

    returns

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

    Definition Classes
    GenSetLike
  5. def +(elem1: A, elem2: A, elems: A*): This

    Permalink

    Creates a new set with additional elements, omitting duplicates.

    Creates a new set with additional elements, omitting duplicates.

    This method takes two or more elements to be added. Elements that already exist in the set will not be added. Another overloaded variant of this method handles the case where a single element is added.

    Example:

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

    the first element to add.

    elem2

    the second element to add.

    elems

    the remaining elements to add.

    returns

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

  6. def ++(elems: GenTraversableOnce[A]): This

    Permalink

    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) ++ Set(2, "a")
    a: scala.collection.immutable.Set[Any] = Set(1, 2, a)
    elems

    the collection containing the elements to add.

    returns

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

  7. def ++[B](that: GenTraversableOnce[B]): Set[B]

    Permalink

    [use case] Returns a new set containing the elements from the left hand operand followed by the elements from the right hand operand.

    [use case]

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

    Example:

    scala> val a = List(1)
    a: List[Int] = List(1)
    
    scala> val b = List(2)
    b: List[Int] = List(2)
    
    scala> val c = a ++ b
    c: List[Int] = List(1, 2)
    
    scala> val d = List('a')
    d: List[Char] = List(a)
    
    scala> val e = c ++ d
    e: List[AnyVal] = List(1, 2, a)
    B

    the element type of the returned collection.

    that

    the traversable to append.

    returns

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

    Definition Classes
    TraversableLikeGenTraversableLike
    Full Signature

    def ++[B >: A, That](that: GenTraversableOnce[B])(implicit bf: CanBuildFrom[This, B, That]): That

  8. def ++:[B >: A, That](that: Traversable[B])(implicit bf: CanBuildFrom[This, B, That]): That

    Permalink

    As with ++, returns a new collection containing the elements from the left operand followed by the elements from the right operand.

    As with ++, returns a new collection containing the elements from the left operand followed by the elements from the right operand.

    It differs from ++ in that the right operand determines the type of the resulting collection rather than the left one. Mnemonic: the COLon is on the side of the new COLlection type.

    Example:

    scala> val x = List(1)
    x: List[Int] = List(1)
    
    scala> val y = LinkedList(2)
    y: scala.collection.mutable.LinkedList[Int] = LinkedList(2)
    
    scala> val z = x ++: y
    z: scala.collection.mutable.LinkedList[Int] = LinkedList(1, 2)

    This overload exists because: for the implementation of ++: we should reuse that of ++ because many collections override it with more efficient versions.

    Since TraversableOnce has no ++ method, we have to implement that directly, but Traversable and down can use the overload.

    B

    the element type of the returned collection.

    That

    the class of the returned collection. Where possible, That is the same class as the current collection class Repr, but this depends on the element type B being admissible for that class, which means that an implicit instance of type CanBuildFrom[Repr, B, That] is found.

    that

    the traversable to append.

    bf

    an implicit value of class CanBuildFrom which determines the result class That from the current representation type Repr and and the new element type B.

    returns

    a new collection of type That which contains all elements of this traversable collection followed by all elements of that.

    Definition Classes
    TraversableLike
  9. def ++:[B](that: TraversableOnce[B]): Set[B]

    Permalink

    [use case] As with ++, returns a new collection containing the elements from the left operand followed by the elements from the right operand.

    [use case]

    As with ++, returns a new collection containing the elements from the left operand followed by the elements from the right operand.

    It differs from ++ in that the right operand determines the type of the resulting collection rather than the left one. Mnemonic: the COLon is on the side of the new COLlection type.

    Example:

    scala> val x = List(1)
    x: List[Int] = List(1)
    
    scala> val y = LinkedList(2)
    y: scala.collection.mutable.LinkedList[Int] = LinkedList(2)
    
    scala> val z = x ++: y
    z: scala.collection.mutable.LinkedList[Int] = LinkedList(1, 2)
    B

    the element type of the returned collection.

    that

    the traversable to append.

    returns

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

    Definition Classes
    TraversableLike
    Full Signature

    def ++:[B >: A, That](that: TraversableOnce[B])(implicit bf: CanBuildFrom[This, B, That]): That

  10. def -(elem1: A, elem2: A, elems: A*): This

    Permalink

    Creates a new collection from this collection with some elements removed.

    Creates a new collection from this collection with some elements removed.

    This method takes two or more elements to be removed. Another overloaded variant of this method handles the case where a single element is removed.

    elem1

    the first element to remove.

    elem2

    the second element to remove.

    elems

    the remaining elements to remove.

    returns

    a new collection that contains all elements of the current collection except one less occurrence of each of the given elements.

    Definition Classes
    Subtractable
  11. def --(xs: GenTraversableOnce[A]): This

    Permalink

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

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

    xs

    the collection containing the removed elements.

    returns

    a new collection that contains all elements of the current collection except one less occurrence of each of the elements of elems.

    Definition Classes
    Subtractable
  12. def /:[B](z: B)(op: (B, A) ⇒ B): B

    Permalink

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

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

    Note: /: is alternate syntax for foldLeft; z /: xs is the same as xs foldLeft z.

    Examples:

    Note that the folding function used to compute b is equivalent to that used to compute c.

    scala> val a = List(1,2,3,4)
    a: List[Int] = List(1, 2, 3, 4)
    
    scala> val b = (5 /: a)(_+_)
    b: Int = 15
    
    scala> val c = (5 /: a)((x,y) => x + y)
    c: Int = 15

    Note: will not terminate for infinite-sized collections.

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

    B

    the result type of the binary operator.

    z

    the start value.

    op

    the binary operator.

    returns

    the result of inserting op between consecutive elements of this traversable or iterator, going left to right with the start value z on the left:

    op(...op(op(z, x_1), x_2), ..., x_n)

    where x1, ..., xn are the elements of this traversable or iterator.

    Definition Classes
    TraversableOnceGenTraversableOnce
  13. def :\[B](z: B)(op: (A, B) ⇒ B): B

    Permalink

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

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

    Note: :\ is alternate syntax for foldRight; xs :\ z is the same as xs foldRight z.

    Note: will not terminate for infinite-sized collections.

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

    Examples:

    Note that the folding function used to compute b is equivalent to that used to compute c.

    scala> val a = List(1,2,3,4)
    a: List[Int] = List(1, 2, 3, 4)
    
    scala> val b = (a :\ 5)(_+_)
    b: Int = 15
    
    scala> val c = (a :\ 5)((x,y) => x + y)
    c: Int = 15
    B

    the result type of the binary operator.

    z

    the start value

    op

    the binary operator

    returns

    the result of inserting op between consecutive elements of this traversable or iterator, going right to left with the start value z on the right:

    op(x_1, op(x_2, ... op(x_n, z)...))

    where x1, ..., xn are the elements of this traversable or iterator.

    Definition Classes
    TraversableOnceGenTraversableOnce
  14. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  15. def addString(b: StringBuilder): StringBuilder

    Permalink

    Appends all elements of this traversable or iterator to a string builder.

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

    Example:

    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
    b

    the string builder to which elements are appended.

    returns

    the string builder b to which elements were appended.

    Definition Classes
    TraversableOnce
  16. def addString(b: StringBuilder, sep: String): StringBuilder

    Permalink

    Appends all elements of this traversable or iterator to a string builder using a separator string.

    Appends all elements of this traversable or iterator to a string builder using a separator string. The written text consists of the string representations (w.r.t. the method toString) of all elements of this traversable or iterator, separated by the string sep.

    Example:

    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
    b

    the string builder to which elements are appended.

    sep

    the separator string.

    returns

    the string builder b to which elements were appended.

    Definition Classes
    TraversableOnce
  17. def addString(b: StringBuilder, start: String, sep: String, end: String): StringBuilder

    Permalink

    Appends all elements of this traversable or iterator to a string builder using start, end, and separator strings.

    Appends all elements of this traversable or iterator 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 traversable or iterator 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)
    b

    the string builder to which elements are appended.

    start

    the starting string.

    sep

    the separator string.

    end

    the ending string.

    returns

    the string builder b to which elements were appended.

    Definition Classes
    TraversableOnce
  18. def aggregate[B](z: ⇒ B)(seqop: (B, A) ⇒ B, combop: (B, B) ⇒ B): B

    Permalink

    Aggregates the results of applying an operator to subsequent elements.

    Aggregates the results of applying an operator to subsequent elements.

    This is a more general form of fold and reduce. It is similar to foldLeft in that it doesn't require the result to be a supertype of the element type. In addition, it allows parallel collections to be processed in chunks, and then combines the intermediate results.

    aggregate splits the traversable or iterator into partitions and processes each partition by sequentially applying seqop, starting with z (like foldLeft). Those intermediate results are then combined by using combop (like fold). The implementation of this operation may operate on an arbitrary number of collection partitions (even 1), so combop may be invoked an arbitrary number of times (even 0).

    As an example, consider summing up the integer values of a list of chars. The initial value for the sum is 0. First, seqop transforms each input character to an Int and adds it to the sum (of the partition). Then, combop just needs to sum up the intermediate results of the partitions:

    List('a', 'b', 'c').aggregate(0)({ (sum, ch) => sum + ch.toInt }, { (p1, p2) => p1 + p2 })
    B

    the type of accumulated results

    z

    the initial value for the accumulated result of the partition - this will typically be the neutral element for the seqop operator (e.g. Nil for list concatenation or 0 for summation) and may be evaluated more than once

    seqop

    an operator used to accumulate results within a partition

    combop

    an associative operator used to combine results from different partitions

    Definition Classes
    TraversableOnceGenTraversableOnce
  19. def andThen[A](g: (Boolean) ⇒ A): (A) ⇒ A

    Permalink

    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.

    A

    the result type of function g

    g

    a function R => A

    returns

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

    Definition Classes
    Function1
    Annotations
    @unspecialized()
  20. def apply(elem: A): Boolean

    Permalink

    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.

    elem

    the element to test for membership.

    returns

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

    Definition Classes
    GenSetLikeFunction1
  21. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  22. def canEqual(that: Any): Boolean

    Permalink

    Method called from equality methods, so that user-defined subclasses can refuse to be equal to other collections of the same kind.

    Method called from equality methods, so that user-defined subclasses can refuse to be equal to other collections of the same kind.

    that

    The object with which this iterable collection should be compared

    returns

    true, if this iterable collection can possibly equal that, false otherwise. The test takes into consideration only the run-time types of objects but ignores their elements.

    Definition Classes
    IterableLikeEquals
  23. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. def collect[B](pf: PartialFunction[A, B]): Set[B]

    Permalink

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

    [use case]

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

    B

    the element type of the returned collection.

    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.

    Definition Classes
    TraversableLikeGenTraversableLike
    Full Signature

    def collect[B, That](pf: PartialFunction[A, B])(implicit bf: CanBuildFrom[This, B, That]): That

  25. def collectFirst[B](pf: PartialFunction[A, B]): Option[B]

    Permalink

    Finds the first element of the traversable or iterator for which the given partial function is defined, and applies the partial function to it.

    Finds the first element of the traversable or iterator for which the given partial function is defined, and applies the partial function to it.

    Note: may not terminate for infinite-sized collections.

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

    pf

    the partial function

    returns

    an option value containing pf applied to the first value for which it is defined, or None if none exists.

    Definition Classes
    TraversableOnce
    Example:
    1. Seq("a", 1, 5L).collectFirst({ case x: Int => x*10 }) = Some(10)

  26. def compose[A](g: (A) ⇒ A): (A) ⇒ Boolean

    Permalink

    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.

    A

    the type to which function g can be applied

    g

    a function A => T1

    returns

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

    Definition Classes
    Function1
    Annotations
    @unspecialized()
  27. def copyToArray(xs: Array[A], start: Int, len: Int): Unit

    Permalink

    [use case] Copies the elements of this set to an array.

    [use case]

    Copies the elements of this set to an array. Fills the given array xs with at most len elements of this set, starting at position start. Copying will stop once either the end of the current set is reached, or the end of the target array is reached, or len elements have been copied.

    xs

    the array to fill.

    start

    the starting index.

    len

    the maximal number of elements to copy.

    Definition Classes
    IterableLikeTraversableLikeTraversableOnceGenTraversableOnce
    Full Signature

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

  28. def copyToArray(xs: Array[A]): Unit

    Permalink

    [use case] Copies the elements of this set to an array.

    [use case]

    Copies the elements of this set to an array. Fills the given array xs with values of this set. Copying will stop once either the end of the current set is reached, or the end of the target array is reached.

    xs

    the array to fill.

    Definition Classes
    TraversableOnceGenTraversableOnce
    Full Signature

    def copyToArray[B >: A](xs: Array[B]): Unit

  29. def copyToArray(xs: Array[A], start: Int): Unit

    Permalink

    [use case] Copies the elements of this set to an array.

    [use case]

    Copies the elements of this set to an array. Fills the given array xs with values of this set, beginning at index start. Copying will stop once either the end of the current set is reached, or the end of the target array is reached.

    xs

    the array to fill.

    start

    the starting index.

    Definition Classes
    TraversableOnceGenTraversableOnce
    Full Signature

    def copyToArray[B >: A](xs: Array[B], start: Int): Unit

  30. def copyToBuffer[B >: A](dest: Buffer[B]): Unit

    Permalink

    Copies all elements of this traversable or iterator to a buffer.

    Copies all elements of this traversable or iterator to a buffer.

    Note: will not terminate for infinite-sized collections.

    dest

    The buffer to which elements are copied.

    Definition Classes
    TraversableOnce
  31. def count(p: (A) ⇒ Boolean): Int

    Permalink

    Counts the number of elements in the traversable or iterator which satisfy a predicate.

    Counts the number of elements in the traversable or iterator which satisfy a predicate.

    p

    the predicate used to test elements.

    returns

    the number of elements satisfying the predicate p.

    Definition Classes
    TraversableOnceGenTraversableOnce
  32. def diff(that: GenSet[A]): This

    Permalink

    Computes the difference of this set and another set.

    Computes the difference of this set and another set.

    that

    the set of elements to exclude.

    returns

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

    Definition Classes
    SetLikeGenSetLike
  33. def drop(n: Int): This

    Permalink

    Selects all elements except first n ones.

    Selects all elements except first n ones.

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

    n

    the number of elements to drop from this iterable collection.

    returns

    a iterable collection consisting of all elements of this iterable collection except the first n ones, or else the empty iterable collection, if this iterable collection has less than n elements.

    Definition Classes
    IterableLikeTraversableLikeGenTraversableLike
  34. def dropRight(n: Int): This

    Permalink

    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.

    n

    The number of elements to take

    returns

    a iterable collection consisting of all elements of this iterable collection except the last n ones, or else the empty iterable collection, if this iterable collection has less than n elements.

    Definition Classes
    IterableLike
  35. def dropWhile(p: (A) ⇒ Boolean): This

    Permalink

    Drops longest prefix of elements that satisfy a predicate.

    Drops longest prefix of elements that satisfy a predicate.

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

    returns

    the longest suffix of this traversable collection whose first element does not satisfy the predicate p.

    Definition Classes
    TraversableLikeGenTraversableLike
  36. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  37. def equals(that: Any): Boolean

    Permalink

    Compares this set with another object for equality.

    Compares this set with another object for equality.

    Note: This operation contains an unchecked cast: if that is a set, it will assume with an unchecked cast that it has the same element type as this set. Any subsequent ClassCastException is treated as a false result.

    that

    the other object

    returns

    true if that is a set which contains the same elements as this set.

    Definition Classes
    GenSetLikeEquals → AnyRef → Any
  38. def exists(p: (A) ⇒ Boolean): Boolean

    Permalink

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

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

    Note: may not terminate for infinite-sized collections.

    p

    the predicate used to test elements.

    returns

    false if this iterable collection is empty, otherwise true if the given predicate p holds for some of the elements of this iterable collection, otherwise false

    Definition Classes
    IterableLikeTraversableLikeTraversableOnceGenTraversableOnce
  39. def filter(p: (A) ⇒ Boolean): This

    Permalink

    Selects all elements of this traversable collection which satisfy a predicate.

    Selects all elements of this traversable collection which satisfy a predicate.

    p

    the predicate used to test elements.

    returns

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

    Definition Classes
    TraversableLikeGenTraversableLike
  40. def filterNot(p: (A) ⇒ Boolean): This

    Permalink

    Selects all elements of this traversable collection which do not satisfy a predicate.

    Selects all elements of this traversable collection which do not satisfy a predicate.

    p

    the predicate used to test elements.

    returns

    a new traversable collection consisting of all elements of this traversable collection that do not satisfy the given predicate p. The order of the elements is preserved.

    Definition Classes
    TraversableLikeGenTraversableLike
  41. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  42. def find(p: (A) ⇒ Boolean): Option[A]

    Permalink

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

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

    Note: may not terminate for infinite-sized collections.

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

    p

    the predicate used to test elements.

    returns

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

    Definition Classes
    IterableLikeTraversableLikeTraversableOnceGenTraversableOnce
  43. def flatMap[B](f: (A) ⇒ GenTraversableOnce[B]): Set[B]

    Permalink

    [use case] Builds a new collection by applying a function to all elements of this set and using the elements of the resulting collections.

    [use case]

    Builds a new collection by applying a function to all elements of this 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 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)
    
    // lettersOf will return a Set[Char], not a Seq
    def lettersOf(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)
    B

    the element type of the returned collection.

    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.

    Definition Classes
    TraversableLikeGenTraversableLikeFilterMonadic
    Full Signature

    def flatMap[B, That](f: (A) ⇒ GenTraversableOnce[B])(implicit bf: CanBuildFrom[This, B, That]): That

  44. def fold[A1 >: A](z: A1)(op: (A1, A1) ⇒ A1): A1

    Permalink

    Folds the elements of this traversable or iterator using the specified associative binary operator.

    Folds the elements of this traversable or iterator using the specified associative binary operator.

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

    Note: will not terminate for infinite-sized collections.

    A1

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

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

    op

    a binary operator that must be associative.

    returns

    the result of applying the fold operator op between all the elements and z, or z if this traversable or iterator is empty.

    Definition Classes
    TraversableOnceGenTraversableOnce
  45. def foldLeft[B](z: B)(op: (B, A) ⇒ B): B

    Permalink

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

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

    Note: will not terminate for infinite-sized collections.

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

    B

    the result type of the binary operator.

    z

    the start value.

    op

    the binary operator.

    returns

    the result of inserting op between consecutive elements of this traversable or iterator, going left to right with the start value z on the left:

    op(...op(z, x_1), x_2, ..., x_n)

    where x1, ..., xn are the elements of this traversable or iterator. Returns z if this traversable or iterator is empty.

    Definition Classes
    TraversableOnceGenTraversableOnce
  46. def foldRight[B](z: B)(op: (A, B) ⇒ B): B

    Permalink

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

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

    Note: will not terminate for infinite-sized collections.

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

    B

    the result type of the binary operator.

    z

    the start value.

    op

    the binary operator.

    returns

    the result of inserting op between consecutive elements of this iterable collection, going right to left with the start value z on the right:

    op(x_1, op(x_2, ... op(x_n, z)...))

    where x1, ..., xn are the elements of this iterable collection. Returns z if this iterable collection is empty.

    Definition Classes
    IterableLikeTraversableOnceGenTraversableOnce
  47. def forall(p: (A) ⇒ Boolean): Boolean

    Permalink

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

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

    Note: may not terminate for infinite-sized collections.

    p

    the predicate used to test elements.

    returns

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

    Definition Classes
    IterableLikeTraversableLikeTraversableOnceGenTraversableOnce
  48. def foreach(f: (A) ⇒ Unit): Unit

    Permalink

    [use case] Applies a function f to all elements of this set.

    [use case]

    Applies a function f to all elements of this set.

    Note: this method underlies the implementation of most other bulk operations. Subclasses should re-implement this method if a more efficient implementation exists.

    f

    the function that is applied for its side-effect to every element. The result of function f is discarded.

    Definition Classes
    IterableLikeTraversableLikeGenTraversableLikeTraversableOnceGenTraversableOnceFilterMonadic
    Full Signature

    def foreach[U](f: (A) ⇒ U): Unit

  49. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  50. def groupBy[K](f: (A) ⇒ K): immutable.Map[K, This]

    Permalink

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

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

    Note: this method is not re-implemented by views. This means when applied to a view it will always force the view and return a new traversable collection.

    K

    the type of keys returned by the discriminator function.

    f

    the discriminator function.

    returns

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

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

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

    Definition Classes
    TraversableLikeGenTraversableLike
  51. def grouped(size: Int): Iterator[This]

    Permalink

    Partitions elements in fixed size iterable collections.

    Partitions elements in fixed size iterable collections.

    size

    the number of elements per group

    returns

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

    Definition Classes
    IterableLike
    See also

    scala.collection.Iterator, method grouped

  52. def hasDefiniteSize: Boolean

    Permalink

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

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

    Definition Classes
    TraversableLikeTraversableOnceGenTraversableOnce
  53. def hashCode(): Int

    Permalink
    Definition Classes
    GenSetLike → AnyRef → Any
  54. def head: A

    Permalink

    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.

    Definition Classes
    IterableLikeTraversableLikeGenTraversableLike
    Exceptions thrown

    NoSuchElementException if the iterable collection is empty.

  55. def headOption: Option[A]

    Permalink

    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 traversable collection if it is nonempty, None if it is empty.

    Definition Classes
    TraversableLikeGenTraversableLike
  56. def init: This

    Permalink

    Selects all elements except the last.

    Selects all elements except the last.

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

    returns

    a traversable collection consisting of all elements of this traversable collection except the last one.

    Definition Classes
    TraversableLikeGenTraversableLike
    Exceptions thrown

    UnsupportedOperationException if the traversable collection is empty.

  57. def inits: Iterator[This]

    Permalink

    Iterates over the inits of this traversable collection.

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

    returns

    an iterator over all the inits of this traversable collection

    Definition Classes
    TraversableLike
    Example:
    1. List(1,2,3).inits = Iterator(List(1,2,3), List(1,2), List(1), Nil)

  58. def intersect(that: GenSet[A]): This

    Permalink

    Computes the intersection between this set and another set.

    Computes the intersection between this set and another set.

    that

    the set to intersect with.

    returns

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

    Definition Classes
    GenSetLike
  59. def isEmpty: Boolean

    Permalink

    Tests if this set is empty.

    Tests if this set is empty.

    returns

    true if there is no element in the set, false otherwise.

    Definition Classes
    SetLikeIterableLikeTraversableLikeTraversableOnceGenTraversableOnce
  60. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  61. final def isTraversableAgain: Boolean

    Permalink

    Tests whether this traversable collection can be repeatedly traversed.

    Tests whether this traversable collection can be repeatedly traversed.

    returns

    true

    Definition Classes
    TraversableLikeGenTraversableLikeGenTraversableOnce
  62. def last: A

    Permalink

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

    Definition Classes
    TraversableLikeGenTraversableLike
    Exceptions thrown

    NoSuchElementException If the traversable collection is empty.

  63. def lastOption: Option[A]

    Permalink

    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 traversable collection$ if it is nonempty, None if it is empty.

    Definition Classes
    TraversableLikeGenTraversableLike
  64. def map[B](f: (A) ⇒ B): Set[B]

    Permalink

    [use case] Builds a new collection by applying a function to all elements of this set.

    [use case]

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

    B

    the element type of the returned collection.

    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.

    Definition Classes
    SetLikeTraversableLikeGenTraversableLikeFilterMonadic
    Full Signature

    def map[B, That](f: (A) ⇒ B)(implicit bf: CanBuildFrom[This, B, That]): That

  65. def max: A

    Permalink

    [use case] Finds the largest element.

    [use case]

    Finds the largest element.

    returns

    the largest element of this set.

    Definition Classes
    TraversableOnceGenTraversableOnce
    Full Signature

    def max[B >: A](implicit cmp: Ordering[B]): A

  66. def maxBy[B](f: (A) ⇒ B): A

    Permalink

    [use case] Finds the first element which yields the largest value measured by function f.

    [use case]

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

    B

    The result type of the function f.

    f

    The measuring function.

    returns

    the first element of this set with the largest value measured by function f.

    Definition Classes
    TraversableOnceGenTraversableOnce
    Full Signature

    def maxBy[B](f: (A) ⇒ B)(implicit cmp: Ordering[B]): A

  67. def min: A

    Permalink

    [use case] Finds the smallest element.

    [use case]

    Finds the smallest element.

    returns

    the smallest element of this set

    Definition Classes
    TraversableOnceGenTraversableOnce
    Full Signature

    def min[B >: A](implicit cmp: Ordering[B]): A

  68. def minBy[B](f: (A) ⇒ B): A

    Permalink

    [use case] Finds the first element which yields the smallest value measured by function f.

    [use case]

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

    B

    The result type of the function f.

    f

    The measuring function.

    returns

    the first element of this set with the smallest value measured by function f.

    Definition Classes
    TraversableOnceGenTraversableOnce
    Full Signature

    def minBy[B](f: (A) ⇒ B)(implicit cmp: Ordering[B]): A

  69. def mkString: String

    Permalink

    Displays all elements of this traversable or iterator in a string.

    Displays all elements of this traversable or iterator in a string.

    returns

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

    Definition Classes
    TraversableOnceGenTraversableOnce
  70. def mkString(sep: String): String

    Permalink

    Displays all elements of this traversable or iterator in a string using a separator string.

    Displays all elements of this traversable or iterator in a string using a separator string.

    sep

    the separator string.

    returns

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

    Definition Classes
    TraversableOnceGenTraversableOnce
    Example:
    1. List(1, 2, 3).mkString("|") = "1|2|3"

  71. def mkString(start: String, sep: String, end: String): String

    Permalink

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

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

    start

    the starting string.

    sep

    the separator string.

    end

    the ending string.

    returns

    a string representation of this traversable or iterator. The resulting string begins with the string start and ends with the string end. Inside, the string representations (w.r.t. the method toString) of all elements of this traversable or iterator are separated by the string sep.

    Definition Classes
    TraversableOnceGenTraversableOnce
    Example:
    1. List(1, 2, 3).mkString("(", "; ", ")") = "(1; 2; 3)"

  72. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  73. def newBuilder: Builder[A, This]

    Permalink

    A common implementation of newBuilder for all sets in terms of empty.

    A common implementation of newBuilder for all sets in terms of empty. Overridden for mutable sets in `mutable.SetLike`.

    Attributes
    protected[this]
    Definition Classes
    SetLikeTraversableLikeHasNewBuilder
  74. def nonEmpty: Boolean

    Permalink

    Tests whether the traversable or iterator is not empty.

    Tests whether the traversable or iterator is not empty.

    returns

    true if the traversable or iterator contains at least one element, false otherwise.

    Definition Classes
    TraversableOnceGenTraversableOnce
  75. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  76. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  77. def par: ParSet[A]

    Permalink

    Returns a parallel implementation of this collection.

    Returns a parallel implementation of this collection.

    For most collection types, this method creates a new parallel collection by copying all the elements. For these collection, par takes linear time. Mutable collections in this category do not produce a mutable parallel collection that has the same underlying dataset, so changes in one collection will not be reflected in the other one.

    Specific collections (e.g. ParArray or mutable.ParHashMap) override this default behaviour by creating a parallel collection which shares the same underlying dataset. For these collections, par takes constant or sublinear time.

    All parallel collections return a reference to themselves.

    returns

    a parallel implementation of this collection

    Definition Classes
    Parallelizable
  78. def parCombiner: Combiner[A, ParSet[A]]

    Permalink

    The default par implementation uses the combiner provided by this method to create a new parallel collection.

    The default par implementation uses the combiner provided by this method to create a new parallel collection.

    returns

    a combiner for the parallel collection of type ParRepr

    Attributes
    protected[this]
    Definition Classes
    SetLikeTraversableLikeParallelizable
  79. def partition(p: (A) ⇒ Boolean): (This, This)

    Permalink

    Partitions this traversable collection in two traversable collections according to a predicate.

    Partitions this traversable collection in two traversable collections according to a predicate.

    p

    the predicate on which to partition.

    returns

    a pair of traversable collections: the first traversable collection consists of all elements that satisfy the predicate p and the second traversable collection consists of all elements that don't. The relative order of the elements in the resulting traversable collections is the same as in the original traversable collection.

    Definition Classes
    TraversableLikeGenTraversableLike
  80. def product: A

    Permalink

    [use case] Multiplies up the elements of this collection.

    [use case]

    Multiplies up the elements of this collection.

    returns

    the product of all elements in this set of numbers of type Int. Instead of Int, any other type T with an implicit Numeric[T] implementation can be used as element type of the set and as result type of product. Examples of such types are: Long, Float, Double, BigInt.

    Definition Classes
    TraversableOnceGenTraversableOnce
    Full Signature

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

  81. def reduce[A1 >: A](op: (A1, A1) ⇒ A1): A1

    Permalink

    Reduces the elements of this traversable or iterator using the specified associative binary operator.

    Reduces the elements of this traversable or iterator using the specified associative binary operator.

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

    A1

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

    op

    A binary operator that must be associative.

    returns

    The result of applying reduce operator op between all the elements if the traversable or iterator is nonempty.

    Definition Classes
    TraversableOnceGenTraversableOnce
    Exceptions thrown

    UnsupportedOperationException if this traversable or iterator is empty.

  82. def reduceLeft[B >: A](op: (B, A) ⇒ B): B

    Permalink

    Applies a binary operator to all elements of this traversable or iterator, going left to right.

    Applies a binary operator to all elements of this traversable or iterator, going left to right.

    Note: will not terminate for infinite-sized collections.

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

    B

    the result type of the binary operator.

    op

    the binary operator.

    returns

    the result of inserting op between consecutive elements of this traversable or iterator, going left to right:

    op( op( ... op(x_1, x_2) ..., x_{n-1}), x_n)

    where x1, ..., xn are the elements of this traversable or iterator.

    Definition Classes
    TraversableOnce
    Exceptions thrown

    UnsupportedOperationException if this traversable or iterator is empty.

  83. def reduceLeftOption[B >: A](op: (B, A) ⇒ B): Option[B]

    Permalink

    Optionally applies a binary operator to all elements of this traversable or iterator, going left to right.

    Optionally applies a binary operator to all elements of this traversable or iterator, going left to right.

    Note: will not terminate for infinite-sized collections.

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

    B

    the result type of the binary operator.

    op

    the binary operator.

    returns

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

    Definition Classes
    TraversableOnceGenTraversableOnce
  84. def reduceOption[A1 >: A](op: (A1, A1) ⇒ A1): Option[A1]

    Permalink

    Reduces the elements of this traversable or iterator, if any, using the specified associative binary operator.

    Reduces the elements of this traversable or iterator, if any, using the specified associative binary operator.

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

    A1

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

    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.

    Definition Classes
    TraversableOnceGenTraversableOnce
  85. def reduceRight[B >: A](op: (A, B) ⇒ B): B

    Permalink

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

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

    Note: will not terminate for infinite-sized collections.

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

    B

    the result type of the binary operator.

    op

    the binary operator.

    returns

    the result of inserting op between consecutive elements of this iterable collection, going right to left:

    op(x_1, op(x_2, ..., op(x_{n-1}, x_n)...))

    where x1, ..., xn are the elements of this iterable collection.

    Definition Classes
    IterableLikeTraversableOnceGenTraversableOnce
    Exceptions thrown

    UnsupportedOperationException if this iterable collection is empty.

  86. def reduceRightOption[B >: A](op: (A, B) ⇒ B): Option[B]

    Permalink

    Optionally applies a binary operator to all elements of this traversable or iterator, going right to left.

    Optionally applies a binary operator to all elements of this traversable or iterator, going right to left.

    Note: will not terminate for infinite-sized collections.

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

    B

    the result type of the binary operator.

    op

    the binary operator.

    returns

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

    Definition Classes
    TraversableOnceGenTraversableOnce
  87. def repr: This

    Permalink

    The collection of type traversable collection underlying this TraversableLike object.

    The collection of type traversable collection underlying this TraversableLike object. By default this is implemented as the TraversableLike object itself, but this can be overridden.

    Definition Classes
    TraversableLikeGenTraversableLike
  88. def reversed: List[A]

    Permalink
    Attributes
    protected[this]
    Definition Classes
    TraversableOnce
  89. def sameElements(that: GenIterable[A]): Boolean

    Permalink

    [use case] Checks if the other iterable collection contains the same elements in the same order as this set.

    [use case]

    Checks if the other iterable collection contains the same elements in the same order as this set.

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

    that

    the collection to compare with.

    returns

    true, if both collections contain the same elements in the same order, false otherwise.

    Definition Classes
    IterableLikeGenIterableLike
    Full Signature

    def sameElements[B >: A](that: GenIterable[B]): Boolean

  90. def scan[B >: A, That](z: B)(op: (B, B) ⇒ B)(implicit cbf: CanBuildFrom[This, B, That]): That

    Permalink

    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.

    B

    element type of the resulting collection

    That

    type of the resulting collection

    z

    neutral element for the operator op

    op

    the associative operator for the scan

    cbf

    combiner factory which provides a combiner

    returns

    a new traversable collection containing the prefix scan of the elements in this traversable collection

    Definition Classes
    TraversableLikeGenTraversableLike
  91. def scanLeft[B, That](z: B)(op: (B, A) ⇒ B)(implicit bf: CanBuildFrom[This, B, That]): That

    Permalink

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

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

    Note: will not terminate for infinite-sized collections.

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

    B

    the type of the elements in the resulting collection

    That

    the actual type of the resulting collection

    z

    the initial value

    op

    the binary operator applied to the intermediate result and the element

    bf

    an implicit value of class CanBuildFrom which determines the result class That from the current representation type Repr and and the new element type B.

    returns

    collection with intermediate results

    Definition Classes
    TraversableLikeGenTraversableLike
  92. def scanRight[B, That](z: B)(op: (A, B) ⇒ B)(implicit bf: CanBuildFrom[This, B, That]): That

    Permalink

    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.

    Example:

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

    the type of the elements in the resulting collection

    That

    the actual type of the resulting collection

    z

    the initial value

    op

    the binary operator applied to the intermediate result and the element

    bf

    an implicit value of class CanBuildFrom which determines the result class That from the current representation type Repr and and the new element type B.

    returns

    collection with intermediate results

    Definition Classes
    TraversableLikeGenTraversableLike
    Annotations
    @migration
    Migration

    (Changed in version 2.9.0) The behavior of scanRight has changed. The previous behavior can be reproduced with scanRight.reverse.

  93. def size: Int

    Permalink

    The size of this traversable or iterator.

    The size of this traversable or iterator.

    Note: will not terminate for infinite-sized collections.

    returns

    the number of elements in this traversable or iterator.

    Definition Classes
    TraversableOnceGenTraversableOnce
  94. def slice(from: Int, until: Int): This

    Permalink

    Selects an interval of elements.

    Selects an interval of elements. The returned collection 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.

    returns

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

    Definition Classes
    IterableLikeTraversableLikeGenTraversableLike
  95. def sliding(size: Int, step: Int): Iterator[This]

    Permalink

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

    size

    the number of elements per group

    step

    the distance between the first elements of successive groups

    returns

    An iterator producing iterable collections of size size, except the last and the only element will be truncated if there are fewer elements than size.

    Definition Classes
    IterableLike
    See also

    scala.collection.Iterator, method sliding

  96. def sliding(size: Int): Iterator[This]

    Permalink

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

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

    size

    the number of elements per group

    returns

    An iterator producing iterable collections of size size, except the last and the only element will be truncated if there are fewer elements than size.

    Definition Classes
    IterableLike
    See also

    scala.collection.Iterator, method sliding

  97. def span(p: (A) ⇒ Boolean): (This, This)

    Permalink

    Splits this traversable collection into a prefix/suffix pair according to a predicate.

    Splits this traversable collection into a prefix/suffix pair according to a predicate.

    Note: c span p is equivalent to (but possibly more efficient than) (c takeWhile p, c dropWhile p), provided the evaluation of the predicate p does not cause any side-effects.

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

    returns

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

    Definition Classes
    TraversableLikeGenTraversableLike
  98. def splitAt(n: Int): (This, This)

    Permalink

    Splits this traversable collection into two at a given position.

    Splits this traversable collection into two at a given position. Note: c splitAt n is equivalent to (but possibly more efficient than) (c take n, c drop n).

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

    n

    the position at which to split.

    returns

    a pair of traversable collections consisting of the first n elements of this traversable collection, and the other elements.

    Definition Classes
    TraversableLikeGenTraversableLike
  99. def stringPrefix: String

    Permalink

    Defines the prefix of this object's toString representation.

    Defines the prefix of this object's toString representation.

    returns

    a string representation which starts the result of toString applied to this set. Unless overridden this is simply "Set".

    Definition Classes
    SetLikeTraversableLikeGenTraversableLike
  100. def subsetOf(that: GenSet[A]): Boolean

    Permalink

    Tests whether this set is a subset of another set.

    Tests whether this set is a subset of another set.

    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.

    Definition Classes
    GenSetLike
  101. def subsets(): Iterator[This]

    Permalink

    An iterator over all subsets of this set.

    An iterator over all subsets of this set.

    returns

    the iterator.

  102. def subsets(len: Int): Iterator[This]

    Permalink

    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.

    len

    the size of the subsets.

    returns

    the iterator.

  103. def sum: A

    Permalink

    [use case] Sums up the elements of this collection.

    [use case]

    Sums up the elements of this collection.

    returns

    the sum of all elements in this set of numbers of type Int. Instead of Int, any other type T with an implicit Numeric[T] implementation can be used as element type of the set and as result type of sum. Examples of such types are: Long, Float, Double, BigInt.

    Definition Classes
    TraversableOnceGenTraversableOnce
    Full Signature

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

  104. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  105. def tail: This

    Permalink

    Selects all elements except the first.

    Selects all elements except the first.

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

    returns

    a traversable collection consisting of all elements of this traversable collection except the first one.

    Definition Classes
    TraversableLikeGenTraversableLike
    Exceptions thrown

    `UnsupportedOperationException` if the traversable collection is empty.

  106. def tails: Iterator[This]

    Permalink

    Iterates over the tails of this traversable collection.

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

    returns

    an iterator over all the tails of this traversable collection

    Definition Classes
    TraversableLike
    Example:
    1. List(1,2,3).tails = Iterator(List(1,2,3), List(2,3), List(3), Nil)

  107. def take(n: Int): This

    Permalink

    Selects first n elements.

    Selects first n elements.

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

    n

    the number of elements to take from this iterable collection.

    returns

    a iterable collection consisting only of the first n elements of this iterable collection, or else the whole iterable collection, if it has less than n elements.

    Definition Classes
    IterableLikeTraversableLikeGenTraversableLike
  108. def takeRight(n: Int): This

    Permalink

    Selects last n elements.

    Selects last n elements.

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

    n

    the number of elements to take

    returns

    a iterable collection consisting only of the last n elements of this iterable collection, or else the whole iterable collection, if it has less than n elements.

    Definition Classes
    IterableLike
  109. def takeWhile(p: (A) ⇒ Boolean): This

    Permalink

    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.

    returns

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

    Definition Classes
    IterableLikeTraversableLikeGenTraversableLike
  110. def thisCollection: Iterable[A]

    Permalink

    The underlying collection seen as an instance of Iterable.

    The underlying collection seen as an instance of Iterable. By default this is implemented as the current collection object itself, but this can be overridden.

    Attributes
    protected[this]
    Definition Classes
    IterableLikeTraversableLike
  111. def to[Col[_]]: Col[A]

    Permalink

    [use case] Converts this set into another by copying all elements.

    [use case]

    Converts this set into another by copying all elements.

    Col

    The collection type to build.

    returns

    a new collection containing all elements of this set.

    Definition Classes
    TraversableLikeTraversableOnceGenTraversableOnce
    Full Signature

    def to[Col[_]](implicit cbf: CanBuildFrom[Nothing, A, Col[A]]): Col[A]

  112. def toArray: Array[A]

    Permalink

    [use case] Converts this set to an array.

    [use case]

    Converts this set to an array.

    returns

    an array containing all elements of this set. An ClassTag must be available for the element type of this set.

    Definition Classes
    TraversableOnceGenTraversableOnce
    Full Signature

    def toArray[B >: A](implicit arg0: ClassTag[B]): Array[B]

  113. def toBuffer[A1 >: A]: Buffer[A1]

    Permalink

    Uses the contents of this set to create a new mutable buffer.

    Uses the contents of this set to create a new mutable buffer.

    returns

    a buffer containing all elements of this set.

    Definition Classes
    SetLikeTraversableOnceGenTraversableOnce
  114. def toCollection(repr: This): Iterable[A]

    Permalink

    A conversion from collections of type Repr to Iterable objects.

    A conversion from collections of type Repr to Iterable objects. By default this is implemented as just a cast, but this can be overridden.

    Attributes
    protected[this]
    Definition Classes
    IterableLikeTraversableLike
  115. def toIndexedSeq: immutable.IndexedSeq[A]

    Permalink

    Converts this traversable or iterator to an indexed sequence.

    Converts this traversable or iterator to an indexed sequence.

    Note: will not terminate for infinite-sized collections.

    returns

    an indexed sequence containing all elements of this traversable or iterator.

    Definition Classes
    TraversableOnceGenTraversableOnce
  116. def toIterable: Iterable[A]

    Permalink

    Returns this iterable collection as an iterable collection.

    Returns this iterable collection as an iterable collection.

    A new collection will not be built; lazy collections will stay lazy.

    Note: will not terminate for infinite-sized collections.

    returns

    an Iterable containing all elements of this iterable collection.

    Definition Classes
    IterableLikeTraversableOnceGenTraversableOnce
  117. def toIterator: Iterator[A]

    Permalink

    Returns an Iterator over the elements in this iterable collection.

    Returns an Iterator over the elements in this iterable collection. Produces the same result as iterator.

    Note: will not terminate for infinite-sized collections.

    returns

    an Iterator containing all elements of this iterable collection.

    Definition Classes
    IterableLikeTraversableLikeGenTraversableOnce
    Annotations
    @deprecatedOverriding( ... , "2.11.0" )
  118. def toList: List[A]

    Permalink

    Converts this traversable or iterator to a list.

    Converts this traversable or iterator to a list.

    Note: will not terminate for infinite-sized collections.

    returns

    a list containing all elements of this traversable or iterator.

    Definition Classes
    TraversableOnceGenTraversableOnce
  119. def toMap[T, U]: Map[T, U]

    Permalink

    [use case] Converts this set to a map.

    [use case]

    Converts this set to a map. This method is unavailable unless the elements are members of Tuple2, each ((T, U)) becoming a key-value pair in the map. Duplicate keys will be overwritten by later keys: if this is an unordered collection, which key is in the resulting map is undefined.

    returns

    a map of type immutable.Map[T, U] containing all key/value pairs of type (T, U) of this set.

    Definition Classes
    TraversableOnceGenTraversableOnce
    Full Signature

    def toMap[T, U](implicit ev: <:<[A, (T, U)]): immutable.Map[T, U]

  120. def toSeq: Seq[A]

    Permalink

    Converts this set to a sequence.

    Converts this set to a sequence. As with toIterable, it's lazy in this default implementation, as this TraversableOnce may be lazy and unevaluated.

    returns

    a sequence containing all elements of this set.

    Definition Classes
    SetLikeTraversableOnceGenTraversableOnce
  121. def toSet[B >: A]: immutable.Set[B]

    Permalink

    Converts this traversable or iterator to a set.

    Converts this traversable or iterator to a set.

    Note: will not terminate for infinite-sized collections.

    returns

    a set containing all elements of this traversable or iterator.

    Definition Classes
    TraversableOnceGenTraversableOnce
  122. def toStream: immutable.Stream[A]

    Permalink

    Converts this iterable collection to a stream.

    Converts this iterable collection to a stream.

    returns

    a stream containing all elements of this iterable collection.

    Definition Classes
    IterableLikeTraversableLikeGenTraversableOnce
  123. def toString(): String

    Permalink

    Converts this set to a string.

    Converts this set to a string.

    returns

    a string representation of this collection. By default this string consists of the stringPrefix of this set, followed by all elements separated by commas and enclosed in parentheses.

    Definition Classes
    SetLikeFunction1TraversableLike → AnyRef → Any
  124. def toTraversable: Traversable[A]

    Permalink

    Converts this traversable collection to an unspecified Traversable.

    Converts this traversable collection to an unspecified Traversable. Will return the same collection if this instance is already Traversable.

    Note: will not terminate for infinite-sized collections.

    returns

    a Traversable containing all elements of this traversable collection.

    Definition Classes
    TraversableLikeTraversableOnceGenTraversableOnce
    Annotations
    @deprecatedOverriding( ... , "2.11.0" )
  125. def toVector: Vector[A]

    Permalink

    Converts this traversable or iterator to a Vector.

    Converts this traversable or iterator to a Vector.

    Note: will not terminate for infinite-sized collections.

    returns

    a vector containing all elements of this traversable or iterator.

    Definition Classes
    TraversableOnceGenTraversableOnce
  126. def union(that: GenSet[A]): This

    Permalink

    Computes the union between of set and another set.

    Computes the union between of set and another set.

    that

    the set to form the union with.

    returns

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

    Definition Classes
    SetLikeGenSetLike
  127. def view(from: Int, until: Int): IterableView[A, This]

    Permalink

    Creates a non-strict view of a slice of this iterable collection.

    Creates a non-strict view of a slice of this iterable collection.

    Note: the difference between view and slice is that view produces a view of the current iterable collection, whereas slice produces a new iterable collection.

    Note: view(from, to) is equivalent to view.slice(from, to)

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

    from

    the index of the first element of the view

    until

    the index of the element following the view

    returns

    a non-strict view of a slice of this iterable collection, starting at index from and extending up to (but not including) index until.

    Definition Classes
    IterableLikeTraversableLike
  128. def view: IterableView[A, This]

    Permalink

    Creates a non-strict view of this iterable collection.

    Creates a non-strict view of this iterable collection.

    returns

    a non-strict view of this iterable collection.

    Definition Classes
    IterableLikeTraversableLike
  129. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  130. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  131. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  132. def withFilter(p: (A) ⇒ Boolean): FilterMonadic[A, This]

    Permalink

    Creates a non-strict filter of this traversable collection.

    Creates a non-strict filter of this traversable collection.

    Note: the difference between c filter p and c withFilter p is that the former creates a new collection, whereas the latter only restricts the domain of subsequent map, flatMap, foreach, and withFilter operations.

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

    p

    the predicate used to test elements.

    returns

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

    Definition Classes
    TraversableLikeFilterMonadic
  133. def zip[B](that: GenIterable[B]): Set[(A, B)]

    Permalink

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

    [use case]

    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.

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

    B

    the type of the second half of the returned pairs

    that

    The iterable providing the second half of each result pair

    returns

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

    Definition Classes
    IterableLikeGenIterableLike
    Full Signature

    def zip[A1 >: A, B, That](that: GenIterable[B])(implicit bf: CanBuildFrom[This, (A1, B), That]): That

  134. def zipAll[B](that: Iterable[B], thisElem: A, thatElem: B): Set[(A, B)]

    Permalink

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

    [use case]

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

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

    B

    the type of the second half of the returned pairs

    that

    The iterable providing the second half of each result pair

    thisElem

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

    thatElem

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

    returns

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

    Definition Classes
    IterableLikeGenIterableLike
    Full Signature

    def zipAll[B, A1 >: A, That](that: GenIterable[B], thisElem: A1, thatElem: B)(implicit bf: CanBuildFrom[This, (A1, B), That]): That

  135. def zipWithIndex: Set[(A, Int)]

    Permalink

    [use case] Zips this set with its indices.

    [use case]

    Zips this set with its indices.

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

    returns

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

    Definition Classes
    IterableLikeGenIterableLike
    Full Signature

    def zipWithIndex[A1 >: A, That](implicit bf: CanBuildFrom[This, (A1, Int), That]): That

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

  136. def |(that: GenSet[A]): This

    Permalink

    Computes the union between this set and another set.

    Computes the union between this set and another set.

    Note: Same as union.

    that

    the set to form the union with.

    returns

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

    Definition Classes
    GenSetLike

Inherited from Subtractable[A, This]

Inherited from GenSetLike[A, This]

Inherited from (A) ⇒ Boolean

Inherited from IterableLike[A, This]

Inherited from GenIterableLike[A, This]

Inherited from TraversableLike[A, This]

Inherited from GenTraversableLike[A, This]

Inherited from Parallelizable[A, ParSet[A]]

Inherited from TraversableOnce[A]

Inherited from GenTraversableOnce[A]

Inherited from FilterMonadic[A, This]

Inherited from HasNewBuilder[A, This]

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped