Test two objects for inequality.

Equivalent to x.hashCode except for boxed numeric types and null. 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. For null returns a hashcode where null.hashCode throws a NullPointerException.

Alias for intersect

Alias for diff

Alias for incl

Alias for concat

Alias for concat

Alias for excl

Alias for removedAll

The expression x == that is equivalent to if (x eq null) that eq null else x.equals(that).

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.

Example:

scala> val a = List(1,2,3,4)
a: List[Int] = List(1, 2, 3, 4)

scala> val b = new StringBuilder()
b: StringBuilder =

scala> val h = a.addString(b)
h: StringBuilder = 1234

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.

Example:

scala> val a = List(1,2,3,4)
a: List[Int] = List(1, 2, 3, 4)

scala> val b = new StringBuilder()
b: StringBuilder =

scala> a.addString(b, ", ")
res0: StringBuilder = 1, 2, 3, 4

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.

Example:

scala> val a = List(1,2,3,4)
a: List[Int] = List(1, 2, 3, 4)

scala> val b = new StringBuilder()
b: StringBuilder =

scala> a.addString(b , "List(" , ", " , ")")
res5: StringBuilder = List(1, 2, 3, 4)

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

Tests if some element is contained in this set.

This method is equivalent to contains. It allows sets to be interpreted as predicates.

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.

A method that should be called from every well-designed equals method that is open to be overridden in a subclass. See Programming in Scala, Chapter 28 for discussion and design.

Defines the prefix of this object's toString representation.

It is recommended to return the name of the concrete collection type, but not implementation subclasses. For example, for ListMap this method should return "ListMap", not "Map" (the supertype) or "Node" (an implementation subclass).

The default implementation returns "Iterable". It is overridden for the basic collection kinds "Seq", "IndexedSeq", "LinearSeq", "Buffer", "Set", "Map", "SortedSet", "SortedMap" and "View".

Create a copy of the receiver object.

The default implementation of the clone method is platform dependent.

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

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

Note: may not terminate for infinite-sized collections.

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

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

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

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

Example:

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

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

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

Fills the given array xs starting at index start with at most len elements of this immutable set.

Copying will stop once either all the elements of this immutable set have been copied, or the end of the array is reached, or len elements have been copied.

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

Fills the given array xs starting at index start with values of this immutable set.

Copying will stop once either all the elements of this immutable set have been copied, or the end of the array is reached.

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

Fills the given array xs starting at index start with values of this immutable set.

Copying will stop once either all the elements of this immutable set have been copied, or the end of the array is reached.

Tests whether every element of this collection's iterator relates to the corresponding element of another collection by satisfying a test predicate.

Note: will not terminate for infinite-sized collections.

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

Note: will not terminate for infinite-sized collections.

Computes the difference of this set and another set.

Selects all elements except first n ones.

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

Selects all elements except last n ones.

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

Drops longest prefix of elements that satisfy a predicate.

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

The empty iterable of the same type as this iterable

Tests whether the argument (that) 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).

Equality of sets is implemented using the lookup method contains. This method returns true if

• the argument that is a Set,
• the two sets have the same size, and
• for every element this set, other.contains(element) == true.

The implementation of equals checks the canEqual method, so subclasses of Set can narrow down the equality to specific set types. The Set implementations in the standard library can all be compared, their canEqual methods return true.

Note: The equals method only respects the equality laws (symmetry, transitivity) if the two sets use the same element equivalence function in their lookup operation. For example, the element equivalence operation in a scala.collection.immutable.TreeSet is defined by its ordering. Comparing a TreeSet with a HashSet leads to unexpected results if ordering.equiv(e1, e2) (used for lookup in TreeSet) is different from e1 == e2 (used for lookup in HashSet).

scala> import scala.collection.immutable._
scala> val ord: Ordering[String] = _ compareToIgnoreCase _

scala> TreeSet("A")(ord) == HashSet("a")
val res0: Boolean = false

scala> HashSet("a") == TreeSet("A")(ord)
val res1: Boolean = true

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

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

Note: may not terminate for infinite-sized collections.

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

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

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.

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

Note: may not terminate for infinite-sized collections.

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

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

For example:

def getWords(lines: Seq[String]): Seq[String] = lines flatMap (line => line split "\\W+")

The type of the resulting collection is guided by the static type of immutable set. This might cause unexpected results sometimes. For example:

// lettersOf will return a Seq[Char] of likely repeated letters, instead of a Set
def lettersOf(words: Seq[String]) = words flatMap (word => word.toSet)

// lettersOf will return a Set[Char], not a Seq
def lettersOf(words: Seq[String]) = words.toSet flatMap ((word: String) => word.toSeq)

// xs will be an Iterable[Int]
val xs = Map("a" -> List(11,111), "b" -> List(22,222)).flatMap(_._2)

// ys will be a Map[Int, Int]
val ys = Map("a" -> List(1 -> 11,1 -> 111), "b" -> List(2 -> 22,2 -> 222)).flatMap(_._2)

Converts this immutable set of traversable collections into a immutable set formed by the elements of these traversable collections.

The resulting collection's type will be guided by the type of immutable set. For example:

val xs = List(
           Set(1, 2, 3),
           Set(1, 2, 3)
         ).flatten
// xs == List(1, 2, 3, 1, 2, 3)

val ys = Set(
           List(1, 2, 3),
           List(3, 2, 1)
         ).flatten
// ys == Set(1, 2, 3)

Folds the elements of this immutable set using the specified associative binary operator. The default implementation in IterableOnce is equivalent to foldLeft but may be overridden for more efficient traversal orders.

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

Note: will not terminate for infinite-sized collections.

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

Note: will not terminate for infinite-sized collections.

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

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

Note: will not terminate for infinite-sized collections.

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

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

Note: may not terminate for infinite-sized collections.

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

Defines how to turn a given Iterable[A] into a collection of type C.

This process can be done in a strict way or a non-strict way (ie. without evaluating the elements of the resulting collections). In other words, this methods defines the evaluation model of the collection.

Returns the runtime class representation of the object.

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

Note: Even when applied to a view or a lazy collection it will always force the elements.

Partitions this immutable set into a map of immutable sets according to a discriminator function key. Each element in a group is transformed into a value of type B using the value function.

It is equivalent to groupBy(key).mapValues(_.map(f)), but more efficient.

case class User(name: String, age: Int)

def namesByAge(users: Seq[User]): Map[Int, Seq[String]] =
  users.groupMap(_.age)(_.name)

Note: Even when applied to a view or a lazy collection it will always force the elements.

Partitions this immutable set into a map according to a discriminator function key. All the values that have the same discriminator are then transformed by the f function and then reduced into a single value with the reduce function.

It is equivalent to groupBy(key).mapValues(_.map(f).reduce(reduce)), but more efficient.

def occurrences[A](as: Seq[A]): Map[A, Int] =
  as.groupMapReduce(identity)(_ => 1)(_ + _)

Note: Even when applied to a view or a lazy collection it will always force the elements.

Partitions elements in fixed size immutable sets.

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

Selects the first element of this immutable set.

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

Optionally selects the first element.

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

Creates a new set with an additional element, unless the element is already present.

The initial part of the collection without its last element.

Note: Even when applied to a view or a lazy collection it will always force the elements.

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.

Note: Even when applied to a view or a lazy collection it will always force the elements.

Computes the intersection between this set and another set.

Test whether the dynamic type of the receiver object has the same erasure as T0.

Depending on what T0 is, the test is done in one of the below ways:

• T0 is a non-parameterized class type, e.g. BigDecimal: this method returns true if the value of the receiver object is a BigDecimal or a subtype of BigDecimal.
• T0 is a parameterized class type, e.g. List[Int]: this method returns true if the value of the receiver object is some List[X] for any X. For example, List(1, 2, 3).isInstanceOf[List[String]] will return true.
• T0 is some singleton type x.type or literal x: this method returns this.eq(x). For example, x.isInstanceOf[1] is equivalent to x.eq(1)
• T0 is an intersection X with Y or X & Y: this method is equivalent to x.isInstanceOf[X] && x.isInstanceOf[Y]
• T0 is a union X | Y: this method is equivalent to x.isInstanceOf[X] || x.isInstanceOf[Y]
• T0 is a type parameter or an abstract type member: this method is equivalent to isInstanceOf[U] where U is T0's upper bound, Any if T0 is unbounded. For example, x.isInstanceOf[A] where A is an unbounded type parameter will return true for any value of x.

This is exactly equivalent to the type pattern _: T0

Tests whether this immutable set can be repeatedly traversed. Always true for Iterables and false for Iterators unless overridden.

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

Selects the last element.

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

Optionally selects the last element.

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

Analogous to zip except that the elements in each collection are not consumed until a strict operation is invoked on the returned LazyZip2 decorator.

Calls to lazyZip can be chained to support higher arities (up to 4) without incurring the expense of constructing and deconstructing intermediary tuples.

val xs = List(1, 2, 3)
val res = (xs lazyZip xs lazyZip xs lazyZip xs).map((a, b, c, d) => a + b + c + d)
// res == List(4, 8, 12)

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

Finds the largest element.

Note: will not terminate for infinite-sized collections.

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

Note: will not terminate for infinite-sized collections.

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

Note: will not terminate for infinite-sized collections.

Finds the largest element.

Note: will not terminate for infinite-sized collections.

Finds the smallest element.

Note: will not terminate for infinite-sized collections.

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

Note: will not terminate for infinite-sized collections.

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

Note: will not terminate for infinite-sized collections.

Finds the smallest element.

Note: will not terminate for infinite-sized collections.

Displays all elements of this immutable set in a string.

Delegates to addString, which can be overridden.

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

Delegates to addString, which can be overridden.

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

Delegates to addString, which can be overridden.

Equivalent to !(this eq that).

Tests whether the immutable set is not empty.

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

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

A pair of, first, all elements that satisfy predicate p and, second, all elements that do not. Interesting because it splits a collection in two.

The default implementation provided here needs to traverse the collection twice. Strict collections have an overridden version of partition in StrictOptimizedIterableOps, which requires only a single traversal.

Applies a function f to each element of the immutable set and returns a pair of immutable sets: the first one made of those values returned by f that were wrapped in scala.util.Left, and the second one made of those wrapped in scala.util.Right.

Example:

val xs = `immutable.Set`(1, "one", 2, "two", 3, "three") partitionMap {
 case i: Int => Left(i)
 case s: String => Right(s)
}
// xs == (`immutable.Set`(1, 2, 3),
//        `immutable.Set`(one, two, three))

Multiplies up the elements of this collection.

Note: will not terminate for infinite-sized collections.

Reduces the elements of this immutable set using the specified associative binary operator.

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

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

Note: will not terminate for infinite-sized collections.

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

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

Note: will not terminate for infinite-sized collections.

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

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

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

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

Note: will not terminate for infinite-sized collections.

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

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

Note: will not terminate for infinite-sized collections.

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

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

Computes a prefix scan of the elements of the collection.

Note: The neutral element z may be applied more than once.

Produces a immutable set containing cumulative results of applying the operator going left to right, including the initial value.

Note: will not terminate for infinite-sized collections.

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

Produces a collection containing cumulative results of applying the operator going right to left. The head of the collection is the last cumulative result.

Note: will not terminate for infinite-sized collections.

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

Note: Even when applied to a view or a lazy collection it will always force the elements.

Example:

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

Compares the size of this immutable set to the size of another Iterable.

Compares the size of this immutable set to a test value.

Returns a value class containing operations for comparing the size of this immutable set to a test value.

These operations are implemented in terms of sizeCompare(Int), and allow the following more readable usages:

this.sizeIs < size     // this.sizeCompare(size) < 0
this.sizeIs <= size    // this.sizeCompare(size) <= 0
this.sizeIs == size    // this.sizeCompare(size) == 0
this.sizeIs != size    // this.sizeCompare(size) != 0
this.sizeIs >= size    // this.sizeCompare(size) >= 0
this.sizeIs > size     // this.sizeCompare(size) > 0

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

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

The returned iterator will be empty when called on an empty collection. The last element the iterator produces may be smaller than the window size when the original collection isn't exhausted by the window before it and its last element isn't skipped by the step before it.

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

An empty collection returns an empty iterator, and a non-empty collection containing fewer elements than the window size returns an iterator that will produce the original collection as its only element.

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.

Splits this immutable set into a prefix/suffix pair 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.

Returns a scala.collection.Stepper for the elements of this collection.

The Stepper enables creating a Java stream to operate on the collection, see scala.jdk.StreamConverters. For collections holding primitive values, the Stepper can be used as an iterator which doesn't box the elements.

The implicit scala.collection.StepperShape parameter defines the resulting Stepper type according to the element type of this collection.

• For collections of Int, Short, Byte or Char, an scala.collection.IntStepper is returned
• For collections of Double or Float, a scala.collection.DoubleStepper is returned
• For collections of Long a scala.collection.LongStepper is returned
• For any other element type, an scala.collection.AnyStepper is returned

Note that this method is overridden in subclasses and the return type is refined to S with EfficientSplit, for example scala.collection.IndexedSeqOps.stepper. For Steppers marked with scala.collection.Stepper.EfficientSplit, the converters in scala.jdk.StreamConverters allow creating parallel streams, whereas bare Steppers can be converted only to sequential streams.

Tests whether this set is a subset of another set.

An iterator over all subsets of this set.

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

Sums up the elements of this collection.

Note: will not terminate for infinite-sized collections.

Executes the code in body with an exclusive lock on this.

The rest of the collection without its first element.

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.

Selects the first n elements.

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

Selects the last n elements.

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

Takes longest prefix of elements that satisfy a predicate.

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

Applies a side-effecting function to each element in this collection. Strict collections will apply f to their elements immediately, while lazy collections like Views and LazyLists will only apply f on each element if and when that element is evaluated, and each time that element is evaluated.

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

xs.to(List) xs.to(ArrayBuffer) xs.to(BitSet) // for xs: Iterable[Int]

Convert collection to array.

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

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.

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

The resulting collection's type will be guided by the static type of immutable set. For example:

val xs = List(
           Set(1, 2, 3),
           Set(4, 5, 6)).transpose
// xs == List(
//         List(1, 4),
//         List(2, 5),
//         List(3, 6))

val ys = Vector(
           List(1, 2, 3),
           List(4, 5, 6)).transpose
// ys == Vector(
//         Vector(1, 4),
//         Vector(2, 5),
//         Vector(3, 6))

Note: Even when applied to a view or a lazy collection it will always force the elements.

Computes the union between of set and another set.

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

val xs = `immutable.Set`(
           (1, "one"),
           (2, "two"),
           (3, "three")).unzip
// xs == (`immutable.Set`(1, 2, 3),
//        `immutable.Set`(one, two, three))

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

val xs = `immutable.Set`(
           (1, "one", '1'),
           (2, "two", '2'),
           (3, "three", '3')).unzip3
// xs == (`immutable.Set`(1, 2, 3),
//        `immutable.Set`(one, two, three),
//        `immutable.Set`(1, 2, 3))

A view over the elements of this collection.

See https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--.

See https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-

See https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-.

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.

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.

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.

Zips this immutable set with its indices.

Alias for union

Returns string formatted according to given format string. Format strings are as for String.format (@see java.lang.String.format).

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. Non-empty Iterators usually return false even if they were created from a collection with a known finite size.

Note: many collection methods will not work on collections of infinite sizes. The typical failure mode is an infinite loop. These methods always attempt a traversal without checking first that hasDefiniteSize returns true. However, checking hasDefiniteSize can provide an assurance that size is well-defined and non-termination is not a concern.