# Set

#### trait Set [A] extends (A) ⇒ Boolean with Iterable[A] with GenericSetTemplate[A, Set] with SetLike[A, Set[A]]

A base trait for all sets, mutable as well as immutable.

A set is a collection that contains no duplicate elements.

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.

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: If your additions and mutations return the same kind of set as the set you are defining, you should inherit from `SetLike` as well.

A

the type of the elements of the set

go to: companion
linear super types: SetLike[A, Set[A]], Subtractable[A, Set[A]], Addable[A, Set[A]], GenericSetTemplate[A, Set], Iterable[A], IterableLike[A, Set[A]], Equals, Traversable[A], GenericTraversableTemplate[A, Set], TraversableLike[A, Set[A]], TraversableOnce[A], FilterMonadic[A, Set[A]], HasNewBuilder[A, Set[A]], (A) ⇒ Boolean, AnyRef, Any
source: Set.scala
version
1. 2.8

since
1. 1.0

Ordering
1. Alphabetic
2. By inheritance
Inherited
1. Hide All
2. Show all
1. Set
2. SetLike
3. Subtractable
4. Addable
5. GenericSetTemplate
6. Iterable
7. IterableLike
8. Equals
9. Traversable
10. GenericTraversableTemplate
11. TraversableLike
12. TraversableOnce
13. FilterMonadic
14. HasNewBuilder
15. Function1
16. AnyRef
17. Any
Visibility
1. Public
2. All
Impl.
1. Concrete
2. Abstract

### Type Members

1. #### type Self = Set[A]

The type implementing this traversable

The type implementing this traversable

attributes: protected
definition classes: TraversableLike
2. #### class WithFilter extends FilterMonadic[A, Repr]

A class supporting filtered operations.

### Value Members

1. #### def != (arg0: AnyRef) : Boolean

attributes: final
definition classes: AnyRef
2. #### def != (arg0: Any) : Boolean

`o != arg0` is the same as `!(o == (arg0))`.

`o != arg0` is the same as `!(o == (arg0))`.

arg0

the object to compare against this object for dis-equality.

returns

`false` if the receiver object is equivalent to the argument; `true` otherwise.

attributes: final
definition classes: Any
3. #### def ## () : Int

attributes: final
definition classes: AnyRef → Any
4. #### def \$asInstanceOf [T0] () : T0

attributes: final
definition classes: AnyRef
5. #### def \$isInstanceOf [T0] () : Boolean

attributes: final
definition classes: AnyRef
6. #### def & (that: Set[A]) : Set[A]

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: SetLike
7. #### def &~ (that: Set[A]) : Set[A]

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: SetLike
8. #### def ** (that: Set[A]) : Set[A]

This method is an alias for `intersect`.

This method is an alias for `intersect`. It computes an intersection with set `that`. It removes all the elements that are not present in `that`.

that

the set to intersect with

definition classes: SetLike
deprecated:
1. use & instead

9. #### def + (elem1: A, elem2: A, elems: A*) : Set[A]

Creates a new set with additional elements.

Creates a new set with additional elements.

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

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.

definition classes: Addable
10. #### def + (elem: A) : Set[A]

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

attributes: abstract
definition classes: SetLikeAddable
11. #### def ++ (xs: TraversableOnce[A]) : Set[A]

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

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

returns

a new set with the given elements added.

definition classes: Addable
12. #### def ++ (that: TraversableOnce[A]) : Set[A]

[use case] Concatenates this set with the elements of a traversable collection.

[use case]

Concatenates this set with the elements of a traversable collection.

that

the traversable to append.

returns

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

attributes: abstract
definition classes: TraversableLike
13. #### def ++ [B >: A, That] (that: TraversableOnce[B])(implicit bf: CanBuildFrom[Set[A], B, That]) : That

Concatenates this set with the elements of a traversable collection.

Concatenates this set with the elements of a traversable collection.

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 set followed by all elements of `that`.

definition classes: TraversableLike
14. #### def - (elem1: A, elem2: A, elems: A*) : Set[A]

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

Creates a new set from this set 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 set that contains all elements of the current set except one less occurrence of each of the given elements.

definition classes: Subtractable
15. #### def - (elem: A) : Set[A]

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

attributes: abstract
definition classes: SetLikeSubtractable
16. #### def -- (xs: TraversableOnce[A]) : Set[A]

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

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

returns

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

definition classes: Subtractable
17. #### def /: [B] (z: B)(op: (B, A) ⇒ B) : B

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

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

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

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 set, going left to right with the start value `z` on the left: op(...op(op(z, x1), x2), ..., xn) where `x,,1,,, ..., x,,n,,` are the elements of this set.

definition classes: TraversableOnce
18. #### def :\ [B] (z: B)(op: (A, B) ⇒ B) : B

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

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

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

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 set, going right to left with the start value `z` on the right: op(x1, op(x2, ... op(xn, z)...)) where `x,,1,,, ..., x,,n,,` are the elements of this set.

definition classes: TraversableOnce
19. #### def == (arg0: AnyRef) : Boolean

`o == arg0` is the same as `if (o eq null) arg0 eq null else o.equals(arg0)`.

`o == arg0` is the same as `if (o eq null) arg0 eq null else o.equals(arg0)`.

arg0

the object to compare against this object for equality.

returns

`true` if the receiver object is equivalent to the argument; `false` otherwise.

attributes: final
definition classes: AnyRef
20. #### def == (arg0: Any) : Boolean

`o == arg0` is the same as `o.equals(arg0)`.

`o == arg0` is the same as `o.equals(arg0)`.

arg0

the object to compare against this object for equality.

returns

`true` if the receiver object is equivalent to the argument; `false` otherwise.

attributes: final
definition classes: Any
21. #### def addString (b: StringBuilder) : StringBuilder

Appends all elements of this set to a string builder.

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

b

the string builder to which elements are appended.

returns

the string builder `b` to which elements were appended.

definition classes: TraversableOnce
22. #### def addString (b: StringBuilder, sep: String) : StringBuilder

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

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

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
23. #### def addString (b: StringBuilder, start: String, sep: String, end: String) : StringBuilder

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

Appends all elements of this set to a string builder using start, end, and separator strings. The written text begins with the string `start` and ends with the string `end`. Inside, the string representations (w.r.t. the method `toString`) of all elements of this set are separated by the string `sep`.

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
24. #### def andThen [A] (g: (Boolean) ⇒ A) : (A) ⇒ A

(f andThen g)(x) == g(f(x))

(f andThen g)(x) == g(f(x))

definition classes: Function1
25. #### 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.

elem

the element to test for membership.

returns

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

definition classes: SetLike
26. #### def asInstanceOf [T0] : T0

This method is used to cast the receiver object to be of type `T0`.

This method is used to cast the receiver object to be of type `T0`.

Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression`1.asInstanceOf[String]` will throw a `ClassCastException` at runtime, while the expression`List(1).asInstanceOf[List[String]]` will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

returns

the receiver object.

attributes: final
definition classes: Any
27. #### def canEqual (that: Any) : Boolean

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

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 set should be compared

returns

`true`, if this set 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
28. #### def clone () : AnyRef

This method creates and returns a copy of the receiver object.

This method creates and returns a copy of the receiver object.

The default implementation of the `clone` method is platform dependent.

returns

a copy of the receiver object.

attributes: protected[lang]
definition classes: AnyRef
29. #### def collect [B] (pf: PartialFunction[A, B]) : Set[B]

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

attributes: abstract
definition classes: TraversableLike
30. #### def collect [B, That] (pf: PartialFunction[A, B])(implicit bf: CanBuildFrom[Set[A], B, That]) : That

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

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.

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.

pf

the partial function which filters and maps the set.

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` resulting from applying the partial function `pf` to each element on which it is defined and collecting the results. The order of the elements is preserved.

definition classes: TraversableLike
31. #### def companion : GenericCompanion[Set]

The factory companion object that builds instances of class Set.

The factory companion object that builds instances of class Set. (or its `Iterable` superclass where class Set is not a `Seq`.)

definition classes: SetIterableTraversableGenericTraversableTemplate
32. #### def compose [A] (g: (A) ⇒ A) : (A) ⇒ Boolean

(f compose g)(x) == f(g(x))

(f compose g)(x) == f(g(x))

definition classes: Function1
33. #### def contains (elem: A) : Boolean

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.

attributes: abstract
definition classes: SetLike
34. #### def copyToArray (xs: Array[A], start: Int, len: Int) : Unit

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

[use case]

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

attributes: abstract
definition classes: TraversableLike
35. #### def copyToArray [B >: A] (xs: Array[B], start: Int, len: Int) : Unit

Copies elements of this set to an array.

Copies 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 array is reached, or `len` elements have been copied.

B

the type of the elements of the array.

xs

the array to fill.

start

the starting index.

len

the maximal number of elements to copy.

definition classes: IterableLikeTraversableLikeTraversableOnce
36. #### def copyToArray (xs: Array[A]) : Unit

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

[use case]

Copies values 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 array is reached.

xs

the array to fill.

attributes: abstract
definition classes: TraversableOnce
37. #### def copyToArray [B >: A] (xs: Array[B]) : Unit

Copies values of this set to an array.

Copies values 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 array is reached.

B

the type of the elements of the array.

xs

the array to fill.

definition classes: TraversableOnce
38. #### def copyToArray (xs: Array[A], start: Int) : Unit

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

[use case]

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

xs

the array to fill.

start

the starting index.

attributes: abstract
definition classes: TraversableOnce
39. #### def copyToArray [B >: A] (xs: Array[B], start: Int) : Unit

Copies values of this set to an array.

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

B

the type of the elements of the array.

xs

the array to fill.

start

the starting index.

definition classes: TraversableOnce
40. #### def copyToBuffer [B >: A] (dest: Buffer[B]) : Unit

Copies all elements of this set to a buffer.

Copies all elements of this set to a buffer.

dest

The buffer to which elements are copied.

definition classes: TraversableOnce
41. #### def count (p: (A) ⇒ Boolean) : Int

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

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

p

the predicate used to test elements.

returns

the number of elements satisfying the predicate `p`.

definition classes: TraversableOnce
42. #### def diff (that: Set[A]) : Set[A]

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: SetLike
43. #### def drop (n: Int) : Set[A]

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

returns

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

definition classes: TraversableLike
44. #### def dropRight (n: Int) : Set[A]

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 set consisting of all elements of this set except the first `n` ones, or else the empty set, if this set has less than `n` elements.

definition classes: IterableLike
45. #### def dropWhile (p: (A) ⇒ Boolean) : Set[A]

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.

p

The predicate used to test elements.

returns

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

definition classes: TraversableLike
46. #### def elements : Iterator[A]

definition classes: IterableLike
deprecated:
1. use `iterator' instead`

47. #### def empty : Set[A]

definition classes: GenericSetTemplate
48. #### def eq (arg0: AnyRef) : Boolean

This method is used to test whether the argument (`arg0`) is a reference to the receiver object (`this`).

This method is used to test whether the argument (`arg0`) is a reference to the receiver object (`this`).

The `eq` method implements an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation] on non-null instances of `AnyRef`: * It is reflexive: for any non-null instance `x` of type `AnyRef`, `x.eq(x)` returns `true`. * It is symmetric: for any non-null instances `x` and `y` of type `AnyRef`, `x.eq(y)` returns `true` if and only if `y.eq(x)` returns `true`. * It is transitive: for any non-null instances `x`, `y`, and `z` of type `AnyRef` if `x.eq(y)` returns `true` and `y.eq(z)` returns `true`, then `x.eq(z)` returns `true`.

Additionally, the `eq` method has three other properties. * It is consistent: for any non-null instances `x` and `y` of type `AnyRef`, multiple invocations of `x.eq(y)` consistently returns `true` or consistently returns `false`. * For any non-null instance `x` of type `AnyRef`, `x.eq(null)` and `null.eq(x)` returns `false`. * `null.eq(null)` returns `true`.

When overriding the `equals` or `hashCode` methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (`o1 eq o2`), they should be equal to each other (`o1 == o2`) and they should hash to the same value (`o1.hashCode == o2.hashCode`).

arg0

the object to compare against this object for reference equality.

returns

`true` if the argument is a reference to the receiver object; `false` otherwise.

attributes: final
definition classes: AnyRef
49. #### def equals (that: Any) : Boolean

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: SetLikeEquals → AnyRef → Any
50. #### def exists (p: (A) ⇒ Boolean) : Boolean

Tests whether a predicate holds for some of the elements of this set.

Tests whether a predicate holds for some of the elements of this set.

p

the predicate used to test elements.

returns

`true` if the given predicate `p` holds for some of the elements of this set, otherwise `false`.

definition classes: IterableLikeTraversableLikeTraversableOnce
51. #### def filter (p: (A) ⇒ Boolean) : Set[A]

Selects all elements of this set which satisfy a predicate.

Selects all elements of this set which satisfy a predicate.

p

the predicate used to test elements.

returns

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

definition classes: TraversableLike
52. #### def filterNot (p: (A) ⇒ Boolean) : Set[A]

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

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

p

the predicate used to test elements.

returns

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

definition classes: TraversableLike
53. #### def finalize () : Unit

This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

The details of when and if the `finalize` method are invoked, as well as the interaction between `finalize`and non-local returns and exceptions, are all platform dependent.

attributes: protected[lang]
definition classes: AnyRef
54. #### def find (p: (A) ⇒ Boolean) : Option[A]

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

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

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 set that satisfies `p`, or `None` if none exists.

definition classes: IterableLikeTraversableLikeTraversableOnce
55. #### def first : A

definition classes: IterableLike
deprecated:
1. use `head' instead`

56. #### def firstOption : Option[A]

`None` if iterable is empty.

`None` if iterable is empty.

definition classes: IterableLike
deprecated:
1. use `headOption' instead`

57. #### def flatMap [B] (f: (A) ⇒ Traversable[B]) : Set[B]

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

[use case]

Builds a new collection by applying a function to all elements of this set and concatenating the results.

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.

attributes: abstract
definition classes: TraversableLike
58. #### def flatMap [B, That] (f: (A) ⇒ Traversable[B])(implicit bf: CanBuildFrom[Set[A], B, That]) : That

Builds a new collection by applying a function to all elements of this set and concatenating the results.

Builds a new collection by applying a function to all elements of this set and concatenating the results.

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.

f

the function to apply to each 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

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

definition classes: TraversableLikeFilterMonadic
59. #### def flatten [B] : Set[B]

[use case] Converts this set of traversable collections into a set in which all element collections are concatenated.

[use case]

Converts this set of traversable collections into a set in which all element collections are concatenated.

B

the type of the elements of each traversable collection.

returns

a new set resulting from concatenating all element sets.

attributes: abstract
definition classes: GenericTraversableTemplate
60. #### def flatten [B] (implicit asTraversable: (A) ⇒ Traversable[B]) : Set[B]

Converts this set of traversable collections into a set in which all element collections are concatenated.

Converts this set of traversable collections into a set in which all element collections are concatenated.

B

the type of the elements of each traversable collection.

asTraversable

an implicit conversion which asserts that the element type of this set is a `Traversable`.

returns

a new set resulting from concatenating all element sets.

definition classes: GenericTraversableTemplate
61. #### def foldLeft [B] (z: B)(op: (B, A) ⇒ B) : B

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

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

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 set, going left to right with the start value `z` on the left: op(...op(z, x1), x2, ..., xn) where `x,,1,,, ..., x,,n,,` are the elements of this set.

definition classes: TraversableOnce
62. #### def foldRight [B] (z: B)(op: (A, B) ⇒ B) : B

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

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

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 set, going right to left with the start value `z` on the right: op(x1, op(x2, ... op(xn, z)...)) where `x,,1,,, ..., x,,n,,` are the elements of this set.

definition classes: IterableLikeTraversableOnce
63. #### def forall (p: (A) ⇒ Boolean) : Boolean

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

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

p

the predicate used to test elements.

returns

`true` if the given predicate `p` holds for all elements of this set, otherwise `false`.

definition classes: IterableLikeTraversableLikeTraversableOnce
64. #### def foreach (f: (A) ⇒ Unit) : Unit

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

[use case]

Applies a function `f` to all elements of this set.

f

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

attributes: abstract
definition classes: IterableLike
65. #### def foreach [U] (f: (A) ⇒ U) : Unit

Applies a function `f` to all elements of this set.

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.

U

the type parameter describing the result of function `f`. This result will always be ignored. Typically `U` is `Unit`, but this is not necessary.

f

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

definition classes: IterableLikeTraversableLikeTraversableOnceFilterMonadic
66. #### def genericBuilder [B] : Builder[B, Set[B]]

The generic builder that builds instances of Set at arbitrary element types.

The generic builder that builds instances of Set at arbitrary element types.

definition classes: GenericTraversableTemplate
67. #### def getClass () : java.lang.Class[_ <: java.lang.Object]

Returns a representation that corresponds to the dynamic class of the receiver object.

Returns a representation that corresponds to the dynamic class of the receiver object.

The nature of the representation is platform dependent.

returns

a representation that corresponds to the dynamic class of the receiver object.

attributes: final
definition classes: AnyRef
68. #### def groupBy [K] (f: (A) ⇒ K) : Map[K, Set[A]]

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

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

K

the type of keys returned by the discriminator function.

f

the discriminator function.

returns

A map from keys to sets such that the following invariant holds: (xs partition f)(k) = xs filter (x => f(x) == k) That is, every key `k` is bound to a set of those elements `x` for which `f(x)` equals `k`.

definition classes: TraversableLike
69. #### def grouped (size: Int) : Iterator[Set[A]]

Partitions elements in fixed size sets.

Partitions elements in fixed size sets.

size

the number of elements per group

returns

An iterator producing sets of size `size`, except the last will be truncated if the elements don't divide evenly.

definition classes: IterableLike
see also:
1. Iterator#grouped

70. #### def hasDefiniteSize : Boolean

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

Tests whether this set is known to have a finite size. All strict collections are known to have finite size. For a non-strict collection such as `Stream`, the predicate returns `true` if all elements have been computed. It returns `false` if the stream is not yet evaluated to the end.

Note: many collection methods will not work on collections of infinite sizes.

returns

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

definition classes: TraversableLikeTraversableOnce
71. #### def hashCode () : Int

Returns a hash code value for the object.

Returns a hash code value for the object.

The default hashing algorithm is platform dependent.

Note that it is allowed for two objects to have identical hash codes (`o1.hashCode.equals(o2.hashCode)`) yet not be equal (`o1.equals(o2)` returns `false`). A degenerate implementation could always return `0`. However, it is required that if two objects are equal (`o1.equals(o2)` returns `true`) that they have identical hash codes (`o1.hashCode.equals(o2.hashCode)`). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the `equals` method.

returns

the hash code value for the object.

definition classes: SetLike → AnyRef → Any
72. #### def head : A

Selects the first element of this set.

Selects the first element of this set.

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

returns

the first element of this set.

definition classes: IterableLikeTraversableLike
73. #### 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 set if it is nonempty, `None` if it is empty.

definition classes: TraversableLike
74. #### def init : Set[A]

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 set consisting of all elements of this set except the last one.

definition classes: TraversableLike
75. #### def intersect (that: Set[A]) : Set[A]

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: SetLike
76. #### def isEmpty : Boolean

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: SetLikeIterableLikeTraversableLikeTraversableOnce
77. #### def isInstanceOf [T0] : Boolean

This method is used to test whether the dynamic type of the receiver object is `T0`.

This method is used to test whether the dynamic type of the receiver object is `T0`.

Note that the test result of the test is modulo Scala's erasure semantics. Therefore the expression`1.isInstanceOf[String]` will return `false`, while the expression `List(1).isInstanceOf[List[String]]` will return `true`. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

returns

`true` if the receiver object is an instance of erasure of type `T0`; `false` otherwise.

attributes: final
definition classes: Any
78. #### def isTraversableAgain : Boolean

Tests whether this set can be repeatedly traversed.

Tests whether this set can be repeatedly traversed.

returns

`true`

attributes: final
definition classes: TraversableLikeTraversableOnce
79. #### def iterator : Iterator[A]

Creates a new iterator over all elements contained in this iterable object.

Creates a new iterator over all elements contained in this iterable object.

returns

the new iterator

attributes: abstract
definition classes: IterableLike
80. #### 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 set.

definition classes: TraversableLike
81. #### 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 set\$ if it is nonempty, `None` if it is empty.

definition classes: TraversableLike
82. #### def map [B] (f: (A) ⇒ B) : Set[B]

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

attributes: abstract
definition classes: TraversableLike
83. #### def map [B, That] (f: (A) ⇒ B)(implicit bf: CanBuildFrom[Set[A], B, That]) : That

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

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

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.

f

the function to apply to each 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

a new collection of type `That` resulting from applying the given function `f` to each element of this set and collecting the results.

definition classes: TraversableLikeFilterMonadic
84. #### def max : A

[use case] Finds the largest element.

[use case]

Finds the largest element.

returns

the largest element of this set.

attributes: abstract
definition classes: TraversableOnce
85. #### def max [B >: A] (implicit cmp: Ordering[B]) : A

Finds the largest element.

Finds the largest element.

B

The type over which the ordering is defined.

cmp

An ordering to be used for comparing elements.

returns

the largest element of this set with respect to the ordering `cmp`.

definition classes: TraversableOnce
86. #### def min : A

[use case] Finds the smallest element.

[use case]

Finds the smallest element.

returns

the smallest element of this set

attributes: abstract
definition classes: TraversableOnce
87. #### def min [B >: A] (implicit cmp: Ordering[B]) : A

Finds the smallest element.

Finds the smallest element.

B

The type over which the ordering is defined.

cmp

An ordering to be used for comparing elements.

returns

the smallest element of this set with respect to the ordering `cmp`.

definition classes: TraversableOnce
88. #### def mkString : String

Displays all elements of this set in a string.

Displays all elements of this set in a string.

returns

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

definition classes: TraversableOnce
89. #### def mkString (sep: String) : String

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

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

sep

the separator string.

returns

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

definition classes: TraversableOnce
90. #### def mkString (start: String, sep: String, end: String) : String

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

Displays all elements of this set 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 set. The resulting string begins with the string `start` and ends with the string `end`. Inside, the string representations (w.r.t. the method `toString`) of all elements of this set are separated by the string `sep`.

definition classes: TraversableOnce
91. #### def ne (arg0: AnyRef) : Boolean

`o.ne(arg0)` is the same as `!(o.eq(arg0))`.

`o.ne(arg0)` is the same as `!(o.eq(arg0))`.

arg0

the object to compare against this object for reference dis-equality.

returns

`false` if the argument is not a reference to the receiver object; `true` otherwise.

attributes: final
definition classes: AnyRef
92. #### def newBuilder : Builder[A, Set[A]]

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
93. #### def nonEmpty : Boolean

Tests whether the set is not empty.

Tests whether the set is not empty.

returns

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

definition classes: TraversableOnce
94. #### def notify () : Unit

Wakes up a single thread that is waiting on the receiver object's monitor.

Wakes up a single thread that is waiting on the receiver object's monitor.

attributes: final
definition classes: AnyRef
95. #### def notifyAll () : Unit

Wakes up all threads that are waiting on the receiver object's monitor.

Wakes up all threads that are waiting on the receiver object's monitor.

attributes: final
definition classes: AnyRef
96. #### def partition (p: (A) ⇒ Boolean) : (Set[A], Set[A])

Partitions this set in two sets according to a predicate.

Partitions this set in two sets according to a predicate.

p

the predicate on which to partition.

returns

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

definition classes: TraversableLike
97. #### def product : A

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

attributes: abstract
definition classes: TraversableOnce
98. #### def product [B >: A] (implicit num: Numeric[B]) : B

Multiplies up the elements of this collection.

Multiplies up the elements of this collection.

B

the result type of the `*` operator.

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 set with respect to the `*` operator in `num`.

definition classes: TraversableOnce
99. #### def projection : IterableView[A, Set[A]]

returns a projection that can be used to call non-strict `filter`,`map`, and `flatMap` methods that build projections of the collection.

returns a projection that can be used to call non-strict `filter`,`map`, and `flatMap` methods that build projections of the collection.

definition classes: IterableLike
deprecated:
1. use `view' instead`

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

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

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

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 set, going left to right: op(...(op(x1, x2), ... ) , xn) where `x,,1,,, ..., x,,n,,` are the elements of this set.

definition classes: TraversableOnce
101. #### def reduceLeftOption [B >: A] (op: (B, A) ⇒ B) : Option[B]

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

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

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)` is this set is nonempty, `None` otherwise.

definition classes: TraversableOnce
102. #### def reduceRight [B >: A] (op: (A, B) ⇒ B) : B

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

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

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 set, going right to left: op(x1, op(x2, ..., op(xn-1, xn)...)) where `x,,1,,, ..., x,,n,,` are the elements of this set.

definition classes: IterableLikeTraversableOnce
103. #### def reduceRightOption [B >: A] (op: (A, B) ⇒ B) : Option[B]

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

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

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)` is this set is nonempty, `None` otherwise.

definition classes: TraversableOnce
104. #### def repr : Set[A]

The collection of type set underlying this `TraversableLike` object.

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

definition classes: TraversableLike
105. #### def reversed : List[A]

attributes: protected[this]
definition classes: TraversableOnce
106. #### def sameElements (that: Iterable[A]) : Boolean

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

that

the collection to compare with.

returns

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

attributes: abstract
definition classes: IterableLike
107. #### def sameElements [B >: A] (that: Iterable[B]) : Boolean

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

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.

B

the type of the elements of collection `that`.

that

the collection to compare with.

returns

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

definition classes: IterableLike
108. #### def scanLeft [B, That] (z: B)(op: (B, A) ⇒ B)(implicit bf: CanBuildFrom[Set[A], B, That]) : That

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

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

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: TraversableLike
109. #### def scanRight [B, That] (z: B)(op: (A, B) ⇒ B)(implicit bf: CanBuildFrom[Set[A], B, That]) : That

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

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

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: TraversableLike
110. #### def size : Int

The size of this set.

The size of this set.

returns

the number of elements in this set.

definition classes: TraversableOnce
111. #### def slice (from: Int, until: Int) : Set[A]

Selects an interval of elements.

Selects an interval of elements.

Note: `c.slice(from, to)` is equivalent to (but possibly more efficient than) `c.drop(from).take(to - from)`

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

from

the index of the first returned element in this set.

until

the index one past the last returned element in this set.

returns

a set containing the elements starting at index `from` and extending up to (but not including) index `until` of this set.

definition classes: IterableLikeTraversableLike
112. #### def sliding [B >: A] (size: Int, step: Int) : Iterator[Set[A]]

definition classes: IterableLike
113. #### def sliding [B >: A] (size: Int) : Iterator[Set[A]]

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

returns

An iterator producing sets 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:
1. Iterator#sliding

114. #### def span (p: (A) ⇒ Boolean) : (Set[A], Set[A])

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

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

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

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

p

the test predicate

returns

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

definition classes: TraversableLike
115. #### def splitAt (n: Int) : (Set[A], Set[A])

Splits this set into two at a given position.

Splits this set 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 sets consisting of the first `n` elements of this set, and the other elements.

definition classes: TraversableLike
116. #### def stringPrefix : String

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: SetLikeTraversableLike
117. #### 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.

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: SetLike
118. #### def sum : A

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

attributes: abstract
definition classes: TraversableOnce
119. #### def sum [B >: A] (implicit num: Numeric[B]) : B

Sums up the elements of this collection.

Sums up the elements of this collection.

B

the result type of the `+` operator.

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 set with respect to the `+` operator in `num`.

definition classes: TraversableOnce
120. #### def synchronized [T0] (arg0: T0) : T0

attributes: final
definition classes: AnyRef
121. #### def tail : Set[A]

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 set consisting of all elements of this set except the first one.

definition classes: TraversableLike
122. #### def take (n: Int) : Set[A]

Selects first n elements.

Selects first n elements.

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

n

Tt number of elements to take from this set.

returns

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

definition classes: IterableLikeTraversableLike
123. #### def takeRight (n: Int) : Set[A]

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 set consisting only of the last `n` elements of this set, or else the whole set, if it has less than `n` elements.

definition classes: IterableLike
124. #### def takeWhile (p: (A) ⇒ Boolean) : Set[A]

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.

p

The predicate used to test elements.

returns

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

definition classes: IterableLikeTraversableLike
125. #### def thisCollection : Iterable[A]

The underlying collection seen as an instance of `Set`.

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

attributes: protected[this]
definition classes: IterableLikeTraversableLike
126. #### def toArray : Array[A]

[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. A `ClassManifest` must be available for the element type of this set.

attributes: abstract
definition classes: TraversableOnce
127. #### def toArray [B >: A] (implicit arg0: ClassManifest[B]) : Array[B]

Converts this set to an array.

Converts this set to an array.

B

the type of the elements of the array. A `ClassManifest` for this type must be available.

returns

an array containing all elements of this set.

definition classes: TraversableOnce
128. #### def toBuffer [B >: A] : Buffer[B]

Converts this set to a mutable buffer.

Converts this set to a mutable buffer.

returns

a buffer containing all elements of this set.

definition classes: TraversableOnce
129. #### def toCollection (repr: Set[A]) : Iterable[A]

A conversion from collections of type `Repr` to `Set` objects.

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

attributes: protected[this]
definition classes: IterableLikeTraversableLike
130. #### def toIndexedSeq [B >: A] : IndexedSeq[B]

Converts this set to an indexed sequence.

Converts this set to an indexed sequence.

returns

an indexed sequence containing all elements of this set.

definition classes: TraversableOnce
131. #### def toIterable : Iterable[A]

Converts this set to an iterable collection.

Converts this set to an iterable collection. Note that the choice of target `Iterable` is lazy in this default implementation as this `TraversableOnce` may be lazy and unevaluated (i.e. it may be an iterator which is only traversable once).

returns

an `Iterable` containing all elements of this set.

definition classes: IterableLikeTraversableOnce
132. #### def toIterator : Iterator[A]

Returns an Iterator over the elements in this set.

Returns an Iterator over the elements in this set. Will return the same Iterator if this instance is already an Iterator.

returns

an Iterator containing all elements of this set.

definition classes: TraversableLikeTraversableOnce
133. #### def toList : List[A]

Converts this set to a list.

Converts this set to a list.

returns

a list containing all elements of this set.

definition classes: TraversableOnce
134. #### def toMap [T, U] (implicit ev: <:<[A, (T, U)]) : Map[T, U]

Converts this set to a map.

Converts this set to a map. This method is unavailable unless the elements are members of Tuple2, each ((K, V)) 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 containing all elements of this set.

definition classes: TraversableOnce
135. #### def toSeq : Seq[A]

Converts this set to a sequence.

Converts this set to a sequence.

returns

a sequence containing all the elements of this set.

definition classes: IterableLikeTraversableOnce
136. #### def toSet [B >: A] : Set[B]

Converts this set to a set.

Converts this set to a set.

returns

a set containing all elements of this set.

definition classes: TraversableOnce
137. #### def toStream : Stream[A]

Converts this set to a stream.

Converts this set to a stream.

returns

a stream containing all elements of this set.

definition classes: IterableLikeTraversableLikeTraversableOnce
138. #### def toString () : String

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: SetLikeTraversableLike → AnyRef → Any
139. #### def toTraversable : Traversable[A]

Converts this set to an unspecified Traversable.

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

returns

a Traversable containing all elements of this set.

definition classes: TraversableLikeTraversableOnce
140. #### def transpose [B] (implicit asTraversable: (A) ⇒ Traversable[B]) : Set[Set[B]]

Transposes this set of traversable collections into a set of sets.

Transposes this set of traversable collections into a set of sets.

B

the type of the elements of each traversable collection.

asTraversable

an implicit conversion which asserts that the element type of this set is a `Traversable`.

returns

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

definition classes: GenericTraversableTemplate
141. #### def union (that: Set[A]) : Set[A]

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: SetLike
142. #### def unzip [A1, A2] (implicit asPair: (A) ⇒ (A1, A2)) : (Set[A1], Set[A2])

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

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

asPair

an implicit conversion which asserts that the element type of this set is a pair.

returns

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

definition classes: GenericTraversableTemplate
143. #### def view (from: Int, until: Int) : IterableView[A, Set[A]]

Creates a non-strict view of a slice of this set.

Creates a non-strict view of a slice of this set.

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

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 set, starting at index `from` and extending up to (but not including) index `until`.

definition classes: IterableLikeTraversableLike
144. #### def view : IterableView[A, Set[A]]

Creates a non-strict view of this set.

Creates a non-strict view of this set.

returns

a non-strict view of this set.

definition classes: IterableLikeTraversableLike
145. #### def wait () : Unit

attributes: final
definition classes: AnyRef
146. #### def wait (arg0: Long, arg1: Int) : Unit

attributes: final
definition classes: AnyRef
147. #### def wait (arg0: Long) : Unit

attributes: final
definition classes: AnyRef
148. #### def withFilter (p: (A) ⇒ Boolean) : FilterMonadic[A, Set[A]]

Creates a non-strict filter of this set.

Creates a non-strict filter of this set.

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

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

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 set which satisfy the predicate `p`.

definition classes: TraversableLikeFilterMonadic
149. #### def zip [B] (that: Iterable[B]) : Set[(A, B)]

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

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

attributes: abstract
definition classes: IterableLike
150. #### def zip [A1 >: A, B, That] (that: Iterable[B])(implicit bf: CanBuildFrom[Set[A], (A1, B), That]) : That

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.

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

A1

the type of the first half of the returned pairs (this is always a supertype of the collection's element type `A`).

B

the type of the second half of the returned pairs

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 `(A1, B)` being admissible for that class, which means that an implicit instance of type `CanBuildFrom[Repr, (A1, B), That]`. is found.

that

The iterable providing the second half of each result pair

bf

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

returns

a new collection of type `That` 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: IterableLike
151. #### def zipAll [B] (that: Iterable[B], thisElem: A, thatElem: B) : Set[(A, B)]

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

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.

attributes: abstract
definition classes: IterableLike
152. #### def zipAll [B, A1 >: A, That] (that: Iterable[B], thisElem: A1, thatElem: B)(implicit bf: CanBuildFrom[Set[A], (A1, B), That]) : That

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

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 collection of type `That` 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: IterableLike
153. #### def zipWithIndex : Set[(A, Int)]

[use case] Zips this set with its indices.

[use case]

Zips this set with its indices.

returns

A new set containing pairs consisting of all elements of this set paired with their index. Indices start at `0`. @example `List("a", "b", "c").zipWithIndex = List(("a", 0), ("b", 1), ("c", 2))`

attributes: abstract
definition classes: IterableLike
154. #### def zipWithIndex [A1 >: A, That] (implicit bf: CanBuildFrom[Set[A], (A1, Int), That]) : That

Zips this set with its indices.

Zips this set with its indices.

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

A1

the type of the first half of the returned pairs (this is always a supertype of the collection's element type `A`).

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 `(A1, Int)` being admissible for that class, which means that an implicit instance of type `CanBuildFrom[Repr, (A1, Int), That]`. is found.

returns

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

definition classes: IterableLike
155. #### def | (that: Set[A]) : Set[A]

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: SetLike