# Set

#### trait Set [A] extends (A) ⇒ Boolean with Iterable[A] with GenSet[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.

Source
Set.scala
Since

1.0

Linear Supertypes
SetLike[A, Set[A]], Subtractable[A, Set[A]], GenSet[A], GenericSetTemplate[A, Set], GenSetLike[A, Set[A]], Iterable[A], IterableLike[A, Set[A]], Equals, GenIterable[A], GenIterableLike[A, Set[A]], Traversable[A], GenTraversable[A], GenericTraversableTemplate[A, Set], TraversableLike[A, Set[A]], GenTraversableLike[A, Set[A]], Parallelizable[A, ParSet[A]], TraversableOnce[A], GenTraversableOnce[A], FilterMonadic[A, Set[A]], HasNewBuilder[A, Set[A]], (A) ⇒ Boolean, AnyRef, Any
Known Subclasses
Ordering
1. Alphabetic
2. By inheritance
Inherited
1. Hide All
2. Show all
1. Set
2. SetLike
3. Subtractable
4. GenSet
5. GenericSetTemplate
6. GenSetLike
7. Iterable
8. IterableLike
9. Equals
10. GenIterable
11. GenIterableLike
12. Traversable
13. GenTraversable
14. GenericTraversableTemplate
15. TraversableLike
16. GenTraversableLike
17. Parallelizable
18. TraversableOnce
19. GenTraversableOnce
21. HasNewBuilder
22. Function1
23. AnyRef
24. Any
Visibility
1. Public
2. All

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

### Abstract Value Members

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

returns

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

Attributes
abstract
Definition Classes
SetLike → GenSetLike
2. #### 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 → GenSetLike
3. #### 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 → GenSetLike
4. #### def iterator : Iterator[A]

Attributes
abstract
Definition Classes
GenSetLike → GenIterableLike

### Concrete Value Members

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

Attributes
final
Definition Classes
AnyRef
2. #### def != (arg0: Any): Boolean

Test two objects for inequality.

Test two objects for inequality.

returns

true if !(this == that), false otherwise.

Attributes
final
Definition Classes
Any
3. #### def ## (): Int

Equivalent to x.hashCode except for boxed numeric types.

Equivalent to x.hashCode except for boxed numeric types. For numerics, it returns a hash value which is consistent with value equality: if two value type instances compare as true, then ## will produce the same hash value for each of them.

returns

a hash value consistent with ==

Attributes
final
Definition Classes
AnyRef → Any
4. #### def & (that: Set[A]): Set[A]

Definition Classes
GenSetLike
Annotations
@bridge()
5. #### def & (that: GenSet[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
GenSetLike
6. #### def &~ (that: Set[A]): Set[A]

Definition Classes
GenSetLike
Annotations
@bridge()
7. #### def &~ (that: GenSet[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
GenSetLike
8. #### 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

elem2

elems

returns

a new set with the given elements added.

Definition Classes
SetLike
9. #### def ++ (elems: TraversableOnce[A]): Set[A]

Definition Classes
SetLike
Annotations
@bridge()
10. #### def ++ (elems: GenTraversableOnce[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.

elems

the collection containing the added elements.

returns

a new set with the given elements added.

Definition Classes
SetLike
11. #### def ++ [B >: A, That] (that: TraversableOnce[B])(implicit bf: CanBuildFrom[Set[A], B, That]): That

Definition Classes
TraversableLike
Annotations
@bridge()
12. #### def ++ [B] (that: GenTraversableOnce[B]): Set[B]

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

[use case]

Concatenates this set with the elements of a traversable collection.

B

the element type of the returned collection.

that

the traversable to append.

returns

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

Attributes
abstract
Definition Classes
GenTraversableLike
13. #### def ++ [B >: A, That] (that: GenTraversableOnce[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 → GenTraversableLike
14. #### def ++: [B >: A, That] (that: Traversable[B])(implicit bf: CanBuildFrom[Set[A], B, That]): That

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

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.

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

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

[use case]

Concatenates this set with the elements of a traversable collection. It differs from ++ in that the right operand determines the type of the resulting collection rather than the left one.

B

the element type of the returned collection.

that

the traversable to append.

returns

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

Attributes
abstract
Definition Classes
TraversableLike
16. #### 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. It differs from ++ in that the right operand determines the type of the resulting collection rather than the left one.

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
17. #### 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
18. #### def -- (xs: TraversableOnce[A]): Set[A]

Definition Classes
Subtractable
Annotations
@bridge()
19. #### def -- (xs: GenTraversableOnce[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
20. #### 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, x,,1,,), x,,2,,), ..., x,,n,,)

where x,,1,,, ..., x,,n,, are the elements of this set.

Definition Classes
TraversableOnceGenTraversableOnce
21. #### def /:\ [A1 >: A] (z: A1)(op: (A1, A1) ⇒ A1): A1

A syntactic sugar for out of order folding.

A syntactic sugar for out of order folding. See fold.

Definition Classes
GenTraversableOnce
22. #### 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(x,,1,,, op(x,,2,,, ... op(x,,n,,, z)...))

where x,,1,,, ..., x,,n,, are the elements of this set.

Definition Classes
TraversableOnceGenTraversableOnce
23. #### def == (arg0: AnyRef): Boolean

Attributes
final
Definition Classes
AnyRef
24. #### def == (arg0: Any): Boolean

Test two objects for equality.

Test two objects for equality.

returns

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

Attributes
final
Definition Classes
Any
25. #### 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
26. #### 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
27. #### 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
28. #### def aggregate [B] (z: B)(seqop: (B, A) ⇒ B, combop: (B, B) ⇒ B): B

Aggregates the results of applying an operator to subsequent elements.

Aggregates the results of applying an operator to subsequent elements.

This is a more general form of fold and reduce. It has similar semantics, but does not require the result to be a supertype of the element type. It traverses the elements in different partitions sequentially, using seqop to update the result, and then applies combop to results from different partitions. The implementation of this operation may operate on an arbitrary number of collection partitions, so combop may be invoked arbitrary number of times.

For example, one might want to process some elements and then produce a Set. In this case, seqop would process an element and append it to the list, while combop would concatenate two lists from different partitions together. The initial value z would be an empty set.

pc.aggregate(Set[Int]())(_ += process(_), _ ++ _)

Another example is calculating geometric mean from a collection of doubles (one would typically require big doubles for this).

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)

seqop

an operator used to accumulate results within a partition

combop

an associative operator used to combine results from different partitions

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

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

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

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
30. #### 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
GenSetLike → Function1
31. #### def asInstanceOf [T0] : T0

Cast the receiver object to be of type T0.

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

returns

Attributes
final
Definition Classes
Any
32. #### 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
33. #### def clone (): AnyRef

Create a copy of the receiver object.

Create 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
Annotations
()
34. #### 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 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.

Attributes
abstract
Definition Classes
GenTraversableLike
35. #### 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 → GenTraversableLike
36. #### def collectFirst [B] (pf: PartialFunction[A, B]): Option[B]

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

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

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)

37. #### 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
SetGenSetIterableGenIterableTraversableGenTraversableGenericTraversableTemplate
38. #### def compose [A] (g: (A) ⇒ A): (A) ⇒ Boolean

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

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

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
39. #### 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
40. #### 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
IterableLikeTraversableLikeTraversableOnceGenTraversableOnce
41. #### 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
GenTraversableOnce
42. #### 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
TraversableOnceGenTraversableOnce
43. #### 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, beginning at index start. 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
GenTraversableOnce
44. #### 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, beginning at index start. 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
TraversableOnceGenTraversableOnce
45. #### 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
46. #### 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
TraversableOnceGenTraversableOnce
47. #### def diff (that: Set[A]): Set[A]

Definition Classes
SetLike
Annotations
@bridge()
48. #### def diff (that: GenSet[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 → GenSetLike
49. #### 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
IterableLikeTraversableLike → GenTraversableLike
50. #### 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 last n ones, or else the empty set, if this set has less than n elements.

Definition Classes
IterableLike
51. #### 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 → GenTraversableLike
52. #### def empty : Set[A]

Definition Classes
GenericSetTemplate
53. #### def eq (arg0: AnyRef): Boolean

Tests whether the argument (arg0) is a reference to the receiver object (this).

Tests whether the argument (arg0) is a reference to the receiver object (this).

The eq method implements an equivalence relation on non-null instances of AnyRef, and has three additional 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).

returns

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

Attributes
final
Definition Classes
AnyRef
54. #### 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
GenSetLike → Equals → AnyRef → Any
55. #### 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
IterableLikeTraversableLikeTraversableOnceGenTraversableOnce
56. #### 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 → GenTraversableLike
57. #### 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 → GenTraversableLike
58. #### def finalize (): Unit

Called by the garbage collector on the receiver object when there are no more references to the object.

Called by the garbage collector on the receiver object when there are no more references to the object.

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

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
()
59. #### 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
IterableLikeTraversableLikeTraversableOnceGenTraversableOnce
60. #### def flatMap [B] (f: (A) ⇒ GenTraversableOnce[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 collection of type That resulting from applying the given collection-valued function f to each element of this set and concatenating the results.

Attributes
abstract
Definition Classes
GenTraversableLike
61. #### def flatMap [B, That] (f: (A) ⇒ GenTraversableOnce[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
62. #### 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
63. #### def flatten [B] (implicit asTraversable: (A) ⇒ TraversableOnce[B]): Traversable[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
TraversableGenericTraversableTemplate
Annotations
@bridge()
64. #### def fold [A1 >: A] (z: A1)(op: (A1, A1) ⇒ A1): A1

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

Folds the elements of this sequence using the specified associative binary operator. The order in which the elements are reduced is unspecified and may be nondeterministic.

Note this method has a different signature than the foldLeft and foldRight methods of the trait Traversable. The result of folding may only be a supertype of this parallel collection's type parameter T.

z

a neutral element for the fold operation, it may be added to the result an arbitrary number of times, not changing 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 fold operator op between all the elements and z

Definition Classes
TraversableOnceGenTraversableOnce
65. #### 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, x,,1,,), x,,2,,, ..., x,,n,,)

where x,,1,,, ..., x,,n,, are the elements of this set.

Definition Classes
TraversableOnceGenTraversableOnce
66. #### 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(x,,1,,, op(x,,2,,, ... op(x,,n,,, z)...))

where x,,1,,, ..., x,,n,, are the elements of this set.

Definition Classes
IterableLikeTraversableOnceGenTraversableOnce
67. #### 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
IterableLikeTraversableLikeTraversableOnceGenTraversableOnce
68. #### 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
69. #### 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
70. #### 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
71. #### def getClass (): java.lang.Class[_ <: java.lang.Object]

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

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
72. #### 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 → GenTraversableLike
73. #### 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

Iterator#grouped

74. #### 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
TraversableLikeTraversableOnceGenTraversableOnce
75. #### def hashCode (): Int

The hashCode method for reference types.

The hashCode method for reference types. See hashCode in Any.

returns

the hash code value for this object.

Definition Classes
GenSetLike → AnyRef → Any
76. #### 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
IterableLike → GenIterableLike → TraversableLike → GenTraversableLike
77. #### 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
78. #### 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
79. #### def inits : Iterator[Set[A]]

Iterates over the inits of this set.

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

returns

an iterator over all the inits of this set

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

80. #### def intersect (that: Set[A]): Set[A]

Definition Classes
GenSetLike
Annotations
@bridge()
81. #### def intersect (that: GenSet[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
GenSetLike
82. #### 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
SetLikeIterableLike → GenIterableLike → TraversableLikeTraversableOnceGenTraversableOnce
83. #### def isInstanceOf [T0] : Boolean

Test whether the dynamic type of the receiver object is T0.

Test whether the dynamic type of the receiver object is T0.

Note that the 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 specified type.

returns

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

Attributes
final
Definition Classes
Any
84. #### 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
GenTraversableLike → GenTraversableOnce
85. #### 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
86. #### 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
87. #### 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 collection of type That resulting from applying the given function f to each element of this set and collecting the results.

Attributes
abstract
Definition Classes
GenTraversableLike
88. #### 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
Annotations
@migration
Migration

"Set.map now returns a Set, so it will discard duplicate values."

89. #### def max : A

[use case] Finds the largest element.

[use case]

Finds the largest element.

returns

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

Attributes
abstract
Definition Classes
GenTraversableOnce
90. #### 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
TraversableOnceGenTraversableOnce
91. #### def maxBy [B] (f: (A) ⇒ B)(implicit cmp: Ordering[B]): A

Definition Classes
TraversableOnceGenTraversableOnce
92. #### def min : A

[use case] Finds the smallest element.

[use case]

Finds the smallest element.

returns

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

Attributes
abstract
Definition Classes
GenTraversableOnce
93. #### 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
TraversableOnceGenTraversableOnce
94. #### def minBy [B] (f: (A) ⇒ B)(implicit cmp: Ordering[B]): A

Definition Classes
TraversableOnceGenTraversableOnce
95. #### 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
TraversableOnceGenTraversableOnce
96. #### 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
TraversableOnceGenTraversableOnce
Example:
1. List(1, 2, 3).mkString("|") = "1|2|3"

97. #### 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
TraversableOnceGenTraversableOnce
Example:
1. List(1, 2, 3).mkString("(", "; ", ")") = "(1; 2; 3)"

98. #### def ne (arg0: AnyRef): Boolean

Equivalent to !(this eq that).

Equivalent to !(this eq that).

returns

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

Attributes
final
Definition Classes
AnyRef
99. #### 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
100. #### 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
TraversableOnceGenTraversableOnce
101. #### 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
102. #### 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
103. #### def par : ParSet[A]

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
104. #### def parCombiner : Combiner[A, ParSet[A]]

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
105. #### 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 → GenTraversableLike
106. #### 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 of this set with respect to the * operator in num.

Attributes
abstract
Definition Classes
GenTraversableOnce
107. #### 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
TraversableOnceGenTraversableOnce
108. #### def reduce [A1 >: A] (op: (A1, A1) ⇒ A1): A1

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

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

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

Note this method has a different signature than the reduceLeft and reduceRight methods of the trait Traversable. The result of reducing may only be a supertype of this parallel collection's type parameter T.

op

A binary operator that must be associative.

returns

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

Definition Classes
TraversableOnceGenTraversableOnce
109. #### def reduceLeft [B >: A] (op: (B, A) ⇒ B): B

Definition Classes
TraversableOnce
110. #### 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
TraversableOnceGenTraversableOnce
111. #### def reduceOption [A1 >: A] (op: (A1, A1) ⇒ A1): Option[A1]

Optionally reduces the elements of this sequence using the specified associative binary operator.

Optionally reduces the elements of this sequence using the specified associative binary operator.

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

Note this method has a different signature than the reduceLeftOption and reduceRightOption methods of the trait Traversable. The result of reducing may only be a supertype of this parallel collection's type parameter T.

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
112. #### 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(x,,1,,, op(x,,2,,, ..., op(x,,n-1,,, x,,n,,)...))

where x,,1,,, ..., x,,n,, are the elements of this set.

Definition Classes
IterableLikeTraversableOnceGenTraversableOnce
113. #### 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
TraversableOnceGenTraversableOnce
114. #### 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 → GenTraversableLike
115. #### def reversed : List[A]

Attributes
protected[this]
Definition Classes
TraversableOnce
116. #### def sameElements [B >: A] (that: Iterable[B]): Boolean

Definition Classes
IterableLike
Annotations
@bridge()
117. #### def sameElements (that: GenIterable[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
GenIterableLike
118. #### def sameElements [B >: A] (that: GenIterable[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 → GenIterableLike
119. #### def scan [B >: A, That] (z: B)(op: (B, B) ⇒ B)(implicit cbf: CanBuildFrom[Set[A], B, That]): That

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 set containing the prefix scan of the elements in this set

Definition Classes
TraversableLike → GenTraversableLike
120. #### 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 → GenTraversableLike
121. #### 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. The head of the collection is the last cummulative result.

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
TraversableLike → GenTraversableLike
Annotations
@migration
Migration

"This scanRight definition has changed in 2.9.\n" + "The previous behavior can be reproduced with scanRight.reverse."

122. #### def seq : Set[A]

A version of this collection with all of the operations implemented sequentially (i.

A version of this collection with all of the operations implemented sequentially (i.e. in a single-threaded manner).

This method returns a reference to this collection. In parallel collections, it is redefined to return a sequential implementation of this collection. In both cases, it has O(1) complexity.

returns

a sequential view of the collection.

Definition Classes
SetGenSet → GenSetLike → IterableGenIterableTraversableGenTraversableParallelizableTraversableOnceGenTraversableOnce
123. #### def size : Int

The size of this set.

The size of this set.

returns

the number of elements in this set.

Definition Classes
TraversableOnceGenTraversableOnce
124. #### def slice (from: Int, until: Int): Set[A]

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.

from

the lowest index to include from this set.

until

the highest index to EXCLUDE from this set.

returns

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

Definition Classes
IterableLikeTraversableLike → GenTraversableLike
125. #### def sliding [B >: A] (size: Int, step: Int): Iterator[Set[A]]

Definition Classes
IterableLike
126. #### 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

Iterator#sliding

127. #### 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 → GenTraversableLike
128. #### 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 → GenTraversableLike
129. #### 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 → GenTraversableLike
130. #### def subsetOf (that: Set[A]): Boolean

Definition Classes
GenSetLike
Annotations
@bridge()
131. #### def subsetOf (that: GenSet[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
GenSetLike
132. #### def subsets : Iterator[Set[A]]

An iterator over all subsets of this set.

An iterator over all subsets of this set.

returns

the iterator.

Definition Classes
SetLike
133. #### def subsets (len: Int): Iterator[Set[A]]

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.

Definition Classes
SetLike
134. #### 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 of this set with respect to the + operator in num.

Attributes
abstract
Definition Classes
GenTraversableOnce
135. #### 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
TraversableOnceGenTraversableOnce
136. #### def synchronized [T0] (arg0: ⇒ T0): T0

Attributes
final
Definition Classes
AnyRef
137. #### 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 → GenTraversableLike
138. #### def tails : Iterator[Set[A]]

Iterates over the tails of this set.

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

returns

an iterator over all the tails of this set

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

139. #### 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 → GenTraversableLike
140. #### 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
141. #### 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 → GenTraversableLike
142. #### 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
143. #### 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.

Attributes
abstract
Definition Classes
GenTraversableOnce
144. #### 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
TraversableOnceGenTraversableOnce
145. #### def toBuffer [A1 >: A] : Buffer[A1]

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
SetLikeTraversableOnceGenTraversableOnce
146. #### 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
147. #### 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
TraversableOnceGenTraversableOnce
148. #### 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
IterableLikeTraversableOnceGenTraversableOnce
149. #### 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
TraversableLikeGenTraversableOnce
150. #### 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
TraversableOnceGenTraversableOnce
151. #### def toMap [T, U] : Map[T, U]

[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 containing all elements of this set.

Attributes
abstract
Definition Classes
GenTraversableOnce
152. #### 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 ((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 containing all elements of this set.

Definition Classes
TraversableOnceGenTraversableOnce
153. #### def toSeq : Seq[A]

Overridden for efficiency.

Overridden for efficiency.

returns

a sequence containing all elements of this set.

Definition Classes
SetLikeTraversableOnceGenTraversableOnce
154. #### 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
TraversableOnceGenTraversableOnce
155. #### 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
IterableLikeTraversableLikeGenTraversableOnce
156. #### def toString (): String

Creates a String representation of this object.

Creates a String representation of this object. The default representation is platform dependent. On the java platform it is the concatenation of the class name, "@", and the object's hashcode in hexadecimal.

returns

a String representation of the object.

Definition Classes
SetLikeFunction1TraversableLike → AnyRef → Any
157. #### 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
TraversableLikeTraversableOnceGenTraversableOnce
158. #### def transpose [B] (implicit asTraversable: (A) ⇒ TraversableOnce[B]): Traversable[Traversable[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
TraversableGenericTraversableTemplate
Annotations
@bridge()
159. #### def union (that: Set[A]): Set[A]

Definition Classes
SetLike
Annotations
@bridge()
160. #### def union (that: GenSet[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 → GenSetLike
161. #### 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 half of each pair.

Converts this set of pairs into two collections of the first and second half 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
162. #### def unzip3 [A1, A2, A3] (implicit asTriple: (A) ⇒ (A1, A2, A3)): (Set[A1], Set[A2], Set[A3])

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

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

returns

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

Definition Classes
GenericTraversableTemplate
163. #### 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
164. #### 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
165. #### def wait (): Unit

Attributes
final
Definition Classes
AnyRef
Annotations
()
166. #### def wait (arg0: Long, arg1: Int): Unit

Attributes
final
Definition Classes
AnyRef
Annotations
()
167. #### def wait (arg0: Long): Unit

Attributes
final
Definition Classes
AnyRef
Annotations
()
168. #### 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
169. #### def zip [A1 >: A, B, That] (that: Iterable[B])(implicit bf: CanBuildFrom[Set[A], (A1, B), That]): That

Definition Classes
IterableLike
Annotations
@bridge()
170. #### def zip [B] (that: GenIterable[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 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.

Attributes
abstract
Definition Classes
GenIterableLike
171. #### def zip [A1 >: A, B, That] (that: GenIterable[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 → GenIterableLike
172. #### def zipAll [B, A1 >: A, That] (that: Iterable[B], thisElem: A1, thatElem: B)(implicit bf: CanBuildFrom[Set[A], (A1, B), That]): That

Definition Classes
IterableLike
Annotations
@bridge()
173. #### 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.

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.

Attributes
abstract
Definition Classes
GenIterableLike
174. #### def zipAll [B, A1 >: A, That] (that: GenIterable[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 → GenIterableLike
175. #### def zipWithIndex : Set[(A, Int)]

[use case] Zips this set with its indices.

[use case]

Zips this set with its indices.

returns

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

Attributes
abstract
Definition Classes
GenIterableLike
176. #### 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 → GenIterableLike
177. #### def | (that: Set[A]): Set[A]

Definition Classes
GenSetLike
Annotations
@bridge()
178. #### def | (that: GenSet[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
GenSetLike
179. #### 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
Annotations
Deprecated

180. #### def elements : Iterator[A]

Definition Classes
IterableLike
Annotations
Deprecated

181. #### def first : A

Definition Classes
IterableLike
Annotations
Deprecated

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

None if iterable is empty.

None if iterable is empty.

Definition Classes
IterableLike
Annotations
Deprecated

183. #### 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
Annotations
Deprecated