scala.collection.immutable.Set

Set1

class Set1 [A] extends Set[A] with Serializable

An optimized representation for immutable sets of size 1

An optimized representation for immutable sets of size 1

linear super types: Serializable, Serializable, Set[A], Set[A], SetLike[A, Set[A]], Subtractable[A, Set[A]], GenericSetTemplate[A, Set], (A) ⇒ Boolean, Iterable[A], Iterable[A], IterableLike[A, Set[A]], Equals, Traversable[A], Immutable, Traversable[A], GenericTraversableTemplate[A, Set], TraversableLike[A, Set[A]], Parallelizable[A, ParSet[A]], TraversableOnce[A], FilterMonadic[A, Set[A]], HasNewBuilder[A, Set[A]], AnyRef, Any
annotations: @SerialVersionUID( uid = 1233385750652442003L )
source: Set.scala
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. Set1
  2. Serializable
  3. Serializable
  4. Set
  5. Set
  6. SetLike
  7. Subtractable
  8. GenericSetTemplate
  9. Function1
  10. Iterable
  11. Iterable
  12. IterableLike
  13. Equals
  14. Traversable
  15. Immutable
  16. Traversable
  17. GenericTraversableTemplate
  18. TraversableLike
  19. Parallelizable
  20. TraversableOnce
  21. FilterMonadic
  22. HasNewBuilder
  23. AnyRef
  24. 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
    annotations: @deprecated( message = "use & instead" )
      deprecated:
    1. use & instead

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

    definition classes: Set1SetLike
  10. def + ( elem1 : A , elem2 : A , elems : A* ) : Set[A]

    Creates a new immutable set with additional elements.

    Creates a new immutable 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 immutable set with the given elements added.

    definition classes: SetLike
  11. def ++ ( elems : TraversableOnce[A] ) : Set[A]

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

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

    elems

    the collection containing the added elements.

    returns

    a new immutable set with the given elements added.

    definition classes: SetLike
  12. def ++ [B] ( that : TraversableOnce[B] ) : immutable.Set[B]

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

    [use case]

    Concatenates this immutable set with the elements of a traversable collection.

    B

    the element type of the returned collection.

    that

    the traversable to append.

    returns

    a new immutable set which contains all elements of this immutable 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 immutable set with the elements of a traversable collection.

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

    definition classes: TraversableLike
  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] ) : immutable.Set[B]

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

    [use case]

    Concatenates this immutable 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 immutable set which contains all elements of this immutable 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 immutable set with the elements of a traversable collection.

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

    definition classes: TraversableLike
  17. 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.

    definition classes: Set1SetLikeSubtractable
  18. def - ( elem1 : A , elem2 : A , elems : A* ) : Set[A]

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

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

    definition classes: Subtractable
  19. def -- ( xs : TraversableOnce[A] ) : Set[A]

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

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

    returns

    a new immutable set that contains all elements of the current immutable 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 immutable set, going left to right.

    Applies a binary operator to a start value and all elements of this immutable 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 immutable 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 immutable set.

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

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

    Applies a binary operator to all elements of this immutable 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 immutable 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 immutable set.

    definition classes: TraversableOnce
  22. 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
  23. 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
  24. def addString ( b : StringBuilder ) : StringBuilder

    Appends all elements of this immutable set to a string builder.

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

    b

    the string builder to which elements are appended.

    returns

    the string builder b to which elements were appended.

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

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

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

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

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

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

    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
  27. 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
  28. 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
  29. 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
  30. 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 immutable set should be compared

    returns

    true, if this immutable 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
  31. 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
    annotations: @throws()
  32. def collect [B] ( pf : PartialFunction[A, B] ) : immutable.Set[B]

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

    [use case]

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

    B

    the element type of the returned collection.

    pf

    the partial function which filters and maps the immutable set.

    returns

    a new immutable set resulting from applying the given partial function pf to each element on which it is defined and collecting the results. The order of the elements is preserved.

    attributes: abstract
    definition classes: TraversableLike
  33. 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 immutable set on which the function is defined.

    Builds a new collection by applying a partial function to all elements of this immutable 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 immutable 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
  34. def collectFirst [B] ( pf : PartialFunction[A, B] ) : Option[B]

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

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

    Note: 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)

  35. def companion : GenericCompanion[Set]

    The factory companion object that builds instances of class immutable.

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

    definition classes: SetSetIterableIterableTraversableTraversableGenericTraversableTemplate
  36. 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
  37. 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.

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

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

    [use case]

    Copies elements of this immutable set to an array. Fills the given array xs with at most len elements of this immutable set, starting at position start. Copying will stop once either the end of the current immutable 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
  39. def copyToArray [B >: A] ( xs : Array[B] , start : Int , len : Int ) : Unit

    Copies elements of this immutable set to an array.

    Copies elements of this immutable set to an array. Fills the given array xs with at most len elements of this immutable set, starting at position start. Copying will stop once either the end of the current immutable 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
  40. def copyToArray ( xs : Array[A] ) : Unit

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

    [use case]

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

    xs

    the array to fill.

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

    Copies values of this immutable set to an array.

    Copies values of this immutable set to an array. Fills the given array xs with values of this immutable set. Copying will stop once either the end of the current immutable 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
  42. def copyToArray ( xs : Array[A] , start : Int ) : Unit

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

    [use case]

    Copies values of this immutable set to an array. Fills the given array xs with values of this immutable set, after skipping start values. Copying will stop once either the end of the current immutable 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
  43. def copyToArray [B >: A] ( xs : Array[B] , start : Int ) : Unit

    Copies values of this immutable set to an array.

    Copies values of this immutable set to an array. Fills the given array xs with values of this immutable set, after skipping start values. Copying will stop once either the end of the current immutable 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
  44. def copyToBuffer [B >: A] ( dest : Buffer[B] ) : Unit

    Copies all elements of this immutable set to a buffer.

    Copies all elements of this immutable set to a buffer.

    dest

    The buffer to which elements are copied.

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

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

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

    p

    the predicate used to test elements.

    returns

    the number of elements satisfying the predicate p.

    definition classes: TraversableOnce
  46. 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
  47. 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 immutable set.

    returns

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

    definition classes: TraversableLike
  48. 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 immutable set consisting of all elements of this immutable set except the last n ones, or else the empty immutable set, if this immutable set has less than n elements.

    definition classes: IterableLike
  49. 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 immutable set whose first element does not satisfy the predicate p.

    definition classes: TraversableLike
  50. def elements : Iterator[A]

    definition classes: IterableLike
    annotations: @deprecated( message = "use `iterator' instead" )
      deprecated:
    1. use iterator' instead

  51. def empty : Set[A]

    definition classes: GenericSetTemplate
  52. 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
  53. 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
  54. def exists ( p : (A) ⇒ Boolean ) : Boolean

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

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

    p

    the predicate used to test elements.

    returns

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

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

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

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

    p

    the predicate used to test elements.

    returns

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

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

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

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

    p

    the predicate used to test elements.

    returns

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

    definition classes: TraversableLike
  57. 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
    annotations: @throws()
  58. def find ( p : (A) ⇒ Boolean ) : Option[A]

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

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

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

    definition classes: IterableLikeTraversableLikeTraversableOnce
  59. def first : A

    definition classes: IterableLike
    annotations: @deprecated( message = "use `head' instead" )
      deprecated:
    1. use head' instead

  60. def firstOption : Option[A]

    None if iterable is empty.

    None if iterable is empty.

    definition classes: IterableLike
    annotations: @deprecated( message = "use `headOption' instead" )
      deprecated:
    1. use headOption' instead

  61. def flatMap [B] ( f : (A) ⇒ TraversableOnce[B] ) : immutable.Set[B]

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

    [use case]

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

    B

    the element type of the returned collection.

    f

    the function to apply to each element.

    returns

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

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

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

    Builds a new collection by applying a function to all elements of this immutable 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 immutable set and concatenating the results.

    definition classes: TraversableLikeFilterMonadic
  63. def flatten [B] : immutable.Set[B]

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

    [use case]

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

    B

    the type of the elements of each traversable collection.

    returns

    a new immutable set resulting from concatenating all element immutable sets.

    attributes: abstract
    definition classes: GenericTraversableTemplate
  64. def flatten [B] (implicit asTraversable : (A) ⇒ TraversableOnce[B] ) : Set[B]

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

    Converts this immutable set of traversable collections into a immutable 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 immutable set is a Traversable.

    returns

    a new immutable set resulting from concatenating all element immutable sets.

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

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

    Applies a binary operator to a start value and all elements of this immutable 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 immutable 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 immutable set.

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

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

    Applies a binary operator to all elements of this immutable 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 immutable 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 immutable set.

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

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

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

    p

    the predicate used to test elements.

    returns

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

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

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

    [use case]

    Applies a function f to all elements of this immutable 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 immutable set.

    Applies a function f to all elements of this immutable 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.

  70. def genericBuilder [B] : Builder[B, Set[B]]

    The generic builder that builds instances of immutable.

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

    definition classes: GenericTraversableTemplate
  71. 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
  72. def groupBy [K] ( f : (A) ⇒ K ) : Map[K, Set[A]]

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

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

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

    K

    the type of keys returned by the discriminator function.

    f

    the discriminator function.

    returns

    A map from keys to immutable 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 immutable set of those elements x for which f(x) equals k.

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

    Partitions elements in fixed size immutable sets.

    Partitions elements in fixed size immutable sets.

    size

    the number of elements per group

    returns

    An iterator producing immutable 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

  74. def hasDefiniteSize : Boolean

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

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

    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
  75. 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
  76. def head : A

    Selects the first element of this immutable set.

    Selects the first element of this immutable set.

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

    returns

    the first element of this immutable set.

    definition classes: IterableLikeTraversableLike
  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 immutable 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 immutable set consisting of all elements of this immutable set except the last one.

    definition classes: TraversableLike
  79. def inits : Iterator[Set[A]]

    Iterates over the inits of this immutable set.

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

    returns

    an iterator over all the inits of this immutable 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]

    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
  81. 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
  82. 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
  83. def isTraversableAgain : Boolean

    Tests whether this immutable set can be repeatedly traversed.

    Tests whether this immutable set can be repeatedly traversed.

    returns

    true

    attributes: final
    definition classes: TraversableLikeTraversableOnce
  84. 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

    definition classes: Set1IterableLike
  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 immutable 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 immutable set$ if it is nonempty, None if it is empty.

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

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

    [use case]

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

    B

    the element type of the returned collection.

    f

    the function to apply to each element.

    returns

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

    attributes: abstract
    definition classes: TraversableLike
  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 immutable set.

    Builds a new collection by applying a function to all elements of this immutable 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 immutable set and collecting the results.

    definition classes: SetLikeTraversableLikeFilterMonadic
    annotations: @migration( 2 , 8 , ... )
  89. def max : A

    [use case] Finds the largest element.

    [use case]

    Finds the largest element.

    returns

    the largest element of this immutable set.

    attributes: abstract
    definition classes: TraversableOnce
  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 immutable set with respect to the ordering cmp.

    definition classes: TraversableOnce
  91. def maxBy [B] ( f : (A) ⇒ B )(implicit cmp : Ordering[B] ) : A

    definition classes: TraversableOnce
  92. def min : A

    [use case] Finds the smallest element.

    [use case]

    Finds the smallest element.

    returns

    the smallest element of this immutable set

    attributes: abstract
    definition classes: TraversableOnce
  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 immutable set with respect to the ordering cmp.

    definition classes: TraversableOnce
  94. def minBy [B] ( f : (A) ⇒ B )(implicit cmp : Ordering[B] ) : A

    definition classes: TraversableOnce
  95. def mkString : String

    Displays all elements of this immutable set in a string.

    Displays all elements of this immutable set in a string.

    returns

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

    definition classes: TraversableOnce
  96. def mkString ( sep : String ) : String

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

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

    sep

    the separator string.

    returns

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

    definition classes: TraversableOnce
    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 immutable set in a string using start, end, and separator strings.

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

    start

    the starting string.

    sep

    the separator string.

    end

    the ending string.

    returns

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

    definition classes: TraversableOnce
    Example :
    1. List(1, 2, 3).mkString("(", "; ", ")") = "(1; 2; 3)"

  98. 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
  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 immutable set is not empty.

    Tests whether the immutable set is not empty.

    returns

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

    definition classes: TraversableOnce
  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: ParallelizableParallelizable
  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
    definition classes: SetSetLikeIterableTraversableLikeParallelizable
  105. def partition ( p : (A) ⇒ Boolean ) : (Set[A], Set[A])

    Partitions this immutable set in two immutable sets according to a predicate.

    Partitions this immutable set in two immutable sets according to a predicate.

    p

    the predicate on which to partition.

    returns

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

    definition classes: TraversableLike
  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 in this immutable 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 immutable set and as result type of product. Examples of such types are: Long, Float, Double, BigInt.

    attributes: abstract
    definition classes: TraversableOnce
  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 immutable set with respect to the * operator in num.

    definition classes: TraversableOnce
  108. 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( message = "use `view' instead" )
      deprecated:
    1. use view' instead

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

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

    Applies a binary operator to all elements of this immutable 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 immutable set, going left to right:

                op(...(op(x,,1,,, x,,2,,), ... ) , x,,n,,)
    

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

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

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

    Optionally applies a binary operator to all elements of this immutable 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 immutable set is nonempty, None otherwise.

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

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

    Applies a binary operator to all elements of this immutable 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 immutable 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 immutable set.

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

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

    Optionally applies a binary operator to all elements of this immutable 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 immutable set is nonempty, None otherwise.

    definition classes: TraversableOnce
  113. def repr : Set[A]

    The collection of type immutable set underlying this TraversableLike object.

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

    definition classes: TraversableLike
  114. def reversed : List[A]

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

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

    [use case]

    Checks if the other iterable collection contains the same elements in the same order as this immutable 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
  116. def sameElements [B >: A] ( that : Iterable[B] ) : Boolean

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

    Checks if the other iterable collection contains the same elements in the same order as this immutable 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
  117. 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
  118. 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
    annotations: @migration( 2 , 9 , ... )
  119. 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: SetSetTraversableOnce
  120. def size : Int

    The size of this immutable set.

    The size of this immutable set.

    returns

    the number of elements in this immutable set.

    definition classes: Set1TraversableOnce
  121. 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 immutable set.

    until

    the highest index to EXCLUDE from this immutable set.

    returns

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

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

    definition classes: IterableLike
  123. 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 immutable 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

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

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

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

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

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

    p

    the test predicate

    returns

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

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

    Splits this immutable set into two at a given position.

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

    definition classes: TraversableLike
  126. 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
  127. 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
  128. 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
  129. 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
  130. 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 immutable 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 immutable set and as result type of sum. Examples of such types are: Long, Float, Double, BigInt.

    attributes: abstract
    definition classes: TraversableOnce
  131. 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 immutable set with respect to the + operator in num.

    definition classes: TraversableOnce
  132. def synchronized [T0] ( arg0 : ⇒ T0 ) : T0

    attributes: final
    definition classes: AnyRef
  133. 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 immutable set consisting of all elements of this immutable set except the first one.

    definition classes: TraversableLike
  134. def tails : Iterator[Set[A]]

    Iterates over the tails of this immutable set.

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

    returns

    an iterator over all the tails of this immutable set

    definition classes: TraversableLike
    Example :
    1. List(1,2,3).tails = Iterator(List(1,2,3), List(2,3), List(3), Nil)

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

    returns

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

    definition classes: TraversableLike
  136. 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 immutable set consisting only of the last n elements of this immutable set, or else the whole immutable set, if it has less than n elements.

    definition classes: IterableLike
  137. 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 immutable set whose elements all satisfy the predicate p.

    definition classes: IterableLikeTraversableLike
  138. def thisCollection : Iterable[A]

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

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

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

    [use case] Converts this immutable set to an array.

    [use case]

    Converts this immutable set to an array.

    returns

    an array containing all elements of this immutable set. A ClassManifest must be available for the element type of this immutable set.

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

    Converts this immutable set to an array.

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

    definition classes: TraversableOnce
  141. def toBuffer [A1 >: A] : Buffer[A1]

    Converts this immutable set to a mutable buffer.

    Converts this immutable set to a mutable buffer.

    returns

    a buffer containing all elements of this immutable set.

    definition classes: SetLikeTraversableOnce
  142. def toCollection ( repr : Set[A] ) : Iterable[A]

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

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

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

    Converts this immutable set to an indexed sequence.

    Converts this immutable set to an indexed sequence.

    returns

    an indexed sequence containing all elements of this immutable set.

    definition classes: TraversableOnce
  144. def toIterable : Iterable[A]

    Converts this immutable set to an iterable collection.

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

    definition classes: IterableLikeTraversableOnce
  145. def toIterator : Iterator[A]

    Returns an Iterator over the elements in this immutable set.

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

    returns

    an Iterator containing all elements of this immutable set.

    definition classes: TraversableLikeTraversableOnce
  146. def toList : List[A]

    Converts this immutable set to a list.

    Converts this immutable set to a list.

    returns

    a list containing all elements of this immutable set.

    definition classes: TraversableOnce
  147. def toMap [T, U] : Map[T, U]

    [use case] Converts this immutable set to a map.

    [use case]

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

    returns

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

    attributes: abstract
    definition classes: TraversableOnce
  148. def toMap [T, U] (implicit ev : <:<[A, (T, U)] ) : Map[T, U]

    Converts this immutable set to a map.

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

    definition classes: TraversableOnce
  149. def toSeq : Seq[A]

    Overridden for efficiency.

    Overridden for [email protected] a sequence containing all elements of this immutable set.

    definition classes: SetLikeTraversableOnce
  150. def toSet [B >: A] : Set[B]

    Converts this immutable set to a set.

    Converts this immutable set to a set.

    returns

    a set containing all elements of this immutable set.

    definition classes: SetTraversableOnce
  151. def toStream : Stream[A]

    Converts this immutable set to a stream.

    Converts this immutable set to a stream.

    returns

    a stream containing all elements of this immutable set.

    definition classes: IterableLikeTraversableLikeTraversableOnce
  152. def toString () : String

    Converts this immutable set to a string.

    Converts this immutable set to a string.

    returns

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

    definition classes: SetLikeTraversableLike → AnyRef → Any
  153. def toTraversable : Traversable[A]

    Converts this immutable set to an unspecified Traversable.

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

    returns

    a Traversable containing all elements of this immutable set.

    definition classes: TraversableLikeTraversableOnce
  154. def transpose [B] (implicit asTraversable : (A) ⇒ TraversableOnce[B] ) : Set[Set[B]]

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

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

    B

    the type of the elements of each traversable collection.

    asTraversable

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

    returns

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

    definition classes: GenericTraversableTemplate
    annotations: @migration( 2 , 9 , ... )
  155. 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
  156. def unzip [A1, A2] (implicit asPair : (A) ⇒ (A1, A2) ) : (Set[A1], Set[A2])

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

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

    asPair

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

    returns

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

    definition classes: GenericTraversableTemplate
  157. def unzip3 [A1, A2, A3] (implicit asTriple : (A) ⇒ (A1, A2, A3) ) : (Set[A1], Set[A2], Set[A3])

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

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

    returns

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

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

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

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

    Note: the difference between view and slice is that view produces a view of the current immutable set, whereas slice produces a new immutable 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 immutable set, starting at index from and extending up to (but not including) index until.

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

    Creates a non-strict view of this immutable set.

    Creates a non-strict view of this immutable set.

    returns

    a non-strict view of this immutable set.

    definition classes: IterableLikeTraversableLike
  160. def wait () : Unit

    attributes: final
    definition classes: AnyRef
    annotations: @throws()
  161. def wait ( arg0 : Long , arg1 : Int ) : Unit

    attributes: final
    definition classes: AnyRef
    annotations: @throws()
  162. def wait ( arg0 : Long ) : Unit

    attributes: final
    definition classes: AnyRef
    annotations: @throws()
  163. def withFilter ( p : (A) ⇒ Boolean ) : FilterMonadic[A, Set[A]]

    Creates a non-strict filter of this immutable set.

    Creates a non-strict filter of this immutable set.

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

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

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

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

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

    [use case]

    Returns a immutable set formed from this immutable set and another iterable collection by combining corresponding elements in pairs. If one of the two collections is longer than the other, its remaining elements are ignored.

    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 immutable set containing pairs consisting of corresponding elements of this immutable set and that. The length of the returned collection is the minimum of the lengths of this immutable set and that.

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

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

    Returns a immutable set formed from this immutable set and another iterable collection by combining corresponding elements in pairs. If one of the two collections is longer than the other, its remaining elements are ignored.

    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 immutable set and that. The length of the returned collection is the minimum of the lengths of this immutable set and that.

    definition classes: IterableLike
  166. def zipAll [B] ( that : Iterable[B] , thisElem : A , thatElem : B ) : immutable.Set[(A, B)]

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

    [use case]

    Returns a immutable set formed from this immutable set and another iterable collection by combining corresponding elements in pairs. If one of the two collections is shorter than the other, placeholder elements are used to extend the shorter collection to the length of the longer.

    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 immutable set is shorter than that.

    thatElem

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

    returns

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

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

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

    Returns a immutable set formed from this immutable set and another iterable collection by combining corresponding elements in pairs. If one of the two collections is shorter than the other, placeholder elements are used to extend the shorter collection to the length of the longer.

    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 immutable set is shorter than that.

    thatElem

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

    returns

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

    definition classes: IterableLike
  168. def zipWithIndex : immutable.Set[(A, Int)]

    [use case] Zips this immutable set with its indices.

    [use case]

    Zips this immutable set with its indices.

    returns

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

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

    Zips this immutable set with its indices.

    Zips this immutable 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 immutable set paired with their index. Indices start at 0.

    definition classes: IterableLike
  170. 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

Inherited from Serializable

Inherited from Serializable

Inherited from Set[A]

Inherited from Set[A]

Inherited from SetLike[A, Set[A]]

Inherited from Subtractable[A, Set[A]]

Inherited from GenericSetTemplate[A, Set]

Inherited from (A) ⇒ Boolean

Inherited from Iterable[A]

Inherited from Iterable[A]

Inherited from IterableLike[A, Set[A]]

Inherited from Equals

Inherited from Traversable[A]

Inherited from Immutable

Inherited from Traversable[A]

Inherited from GenericTraversableTemplate[A, Set]

Inherited from TraversableLike[A, Set[A]]

Inherited from Parallelizable[A, ParSet[A]]

Inherited from TraversableOnce[A]

Inherited from FilterMonadic[A, Set[A]]

Inherited from HasNewBuilder[A, Set[A]]

Inherited from AnyRef

Inherited from Any