StrictOptimizedSetOps
Attributes
Members list
Value members
Concrete methods
Creates a new immutable set by adding all elements contained in another collection to this immutable set, omitting duplicates.
Creates a new immutable set by adding all elements contained in another collection to this immutable set, omitting duplicates.
Example:
scala> val a = Set(1, 2) concat Set(2, 3)
a: scala.collection.immutable.Set[Int] = Set(1, 2, 3)
Value parameters
- that
-
the collection containing the elements to add.
Attributes
- Returns
-
a new immutable set with the given elements added, omitting duplicates.
- Definition Classes
- Source
- Set.scala
Inherited methods
Alias for concat.
Alias for concat.
Type parameters
- B
-
the element type of the returned collection
Value parameters
- suffix
-
the iterable to append to this immutable set
Attributes
- Inherited from:
- IterableOps
- Source
- Iterable.scala
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.
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:
val a = List(1,2,3,4) // List(1, 2, 3, 4)
val b = new StringBuilder()
val h = a.addString(b) // 1234
Value parameters
- b
-
the string builder to which elements are appended.
Attributes
- Returns
-
the string builder
bto which elements were appended. - Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
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.
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:
val a = List(1,2,3,4) // List(1, 2, 3, 4)
val b = new StringBuilder()
a.addString(b, ", ") // 1, 2, 3, 4
Value parameters
- b
-
the string builder to which elements are appended.
- sep
-
the separator string.
Attributes
- Returns
-
the string builder
bto which elements were appended. - Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
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.
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:
val a = List(1,2,3,4) // List(1, 2, 3, 4)
val b = new StringBuilder()
a.addString(b , "List(" , ", " , ")") // List(1, 2, 3, 4)
Value parameters
- b
-
the string builder to which elements are appended.
- end
-
the ending string.
- sep
-
the separator string.
- start
-
the starting string.
Attributes
- Returns
-
the string builder
bto which elements were appended. - Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
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.
Type parameters
- A
-
the result type of function
g
Value parameters
- g
-
a function R => A
Attributes
- Returns
-
a new function
fsuch thatf(x) == g(apply(x)) - Inherited from:
- Function1
- Source
- Function1.scala
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.
Value parameters
- elem
-
the element to test for membership.
Attributes
Builds a new immutable set by applying a partial function to all elements of this immutable set on which the function is defined.
Builds a new immutable set by applying a partial function to all elements of this immutable set on which the function is defined.
Type parameters
- B
-
the element type of the returned immutable set.
Value parameters
- pf
-
the partial function which filters and maps the immutable set.
Attributes
- Returns
-
a new immutable set resulting from applying the given partial function
pfto each element on which it is defined and collecting the results. The order of the elements is preserved. - Definition Classes
- Inherited from:
- StrictOptimizedIterableOps
- Source
- StrictOptimizedIterableOps.scala
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: may not terminate for infinite-sized collections.
Note: might return different results for different runs, unless the underlying collection type is ordered.
Type parameters
- B
-
the result type of the partial function
Value parameters
- pf
-
the partial function
Attributes
- Returns
-
an option value containing pf applied to the first value for which it is defined, or
Noneif none exists. - Example
-
Seq("a", 1, 5L).collectFirst { case x: Int => x*10 } = Some(10) - Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
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.
Type parameters
- A
-
the type to which function
gcan be applied
Value parameters
- g
-
a function A => T1
Attributes
- Returns
-
a new function
fsuch thatf(x) == apply(g(x)) - Inherited from:
- Function1
- Source
- Function1.scala
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.
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.
Type parameters
- B
-
the element type of the returned collection.
Value parameters
- suffix
-
the iterable to append.
Attributes
- Returns
-
a new immutable set which contains all elements of this immutable set followed by all elements of
suffix. - Inherited from:
- IterableOps
- Source
- Iterable.scala
Copies elements to an array and returns the number of elements written.
Copies elements to an array and returns the number of elements written.
Fills the given array dest starting at index start with at most n 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 n elements have been copied.
If start is less than zero, it is taken as zero.
Type parameters
- B
-
the type of the elements of the array.
Value parameters
- dest
-
the array to fill.
- n
-
the maximal number of elements to copy.
- start
-
the starting index of xs.
Attributes
- Returns
-
the number of elements written to the array
- Note
-
Reuse: After calling this method, one should discard the iterator it was called on. Using it is undefined and subject to change.
- Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
Copies elements to an array, returning the number of elements written.
Copies elements to an array, returning the number of elements written.
Fills the given array dest 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.
Type parameters
- B
-
the type of the elements of the array.
Value parameters
- dest
-
the array to fill.
- start
-
the starting index of xs.
Attributes
- Returns
-
the number of elements written to the array
- Note
-
Reuse: After calling this method, one should discard the iterator it was called on. Using it is undefined and subject to change.
- Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
Copies elements to an array, returning the number of elements written.
Copies elements to an array, returning the number of elements written.
Fills the given array dest 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.
Type parameters
- B
-
the type of the elements of the array.
Value parameters
- dest
-
the array to fill.
Attributes
- Returns
-
the number of elements written to the array
- Note
-
Reuse: After calling this method, one should discard the iterator it was called on. Using it is undefined and subject to change.
- Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
Tests whether every element of this collection's iterator relates to the corresponding element of another collection by satisfying a test predicate.
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.
Type parameters
- B
-
the type of the elements of
that
Value parameters
- p
-
the test predicate, which relates elements from both collections
- that
-
the other collection
Attributes
- Returns
-
trueif both collections have the same length andp(x, y)istruefor all corresponding elementsxof this iterator andyofthat, otherwisefalse - Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
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.
Note: will not terminate for infinite-sized collections.
Value parameters
- p
-
the predicate used to test elements.
Attributes
- Returns
-
the number of elements satisfying the predicate
p. - Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
Computes the difference of this set and another set.
Selects all elements except the first n ones.
Selects all elements except the first n ones.
Note: might return different results for different runs, unless the underlying collection type is ordered.
Value parameters
- n
-
the number of elements to drop from this immutable set.
Attributes
- Returns
-
a immutable set consisting of all elements of this immutable set except the first
nones, or else the empty immutable set, if this immutable set has less thannelements. Ifnis negative, don't drop any elements. - Inherited from:
- IterableOps
- Source
- Iterable.scala
The rest of the collection without its n last elements. For linear, immutable collections this should avoid making a copy.
The rest of the collection without its n last elements. For linear, immutable collections this should avoid making a copy.
Note: Even when applied to a view or a lazy collection it will always force the elements.
Value parameters
- n
-
the number of elements to drop from the end of this collection
Attributes
- Returns
-
a new collection containing all elements of this collection except the last
n, or an empty collection ifnis greater than or equal to the size, or all elements ifnis non-positive - Definition Classes
- Inherited from:
- StrictOptimizedIterableOps
- Source
- StrictOptimizedIterableOps.scala
Selects all elements except the longest prefix that satisfies a predicate.
Selects all elements except the longest prefix that satisfies a predicate.
The matching prefix starts with the first element of this immutable set, and the element following the prefix is the first element that does not satisfy the predicate. The matching prefix may be empty, so that this method returns the entire immutable set.
Example:
List(1, 2, 3, 100, 4).dropWhile(n => n < 10) // List(100, 4)
List(1, 2, 3, 100, 4).dropWhile(n => n == 0) // List(1, 2, 3, 100, 4)
Use span to obtain both the prefix and suffix. Use filterNot to drop all elements that satisfy the predicate.
Note: might return different results for different runs, unless the underlying collection type is ordered.
Value parameters
- p
-
The predicate used to test elements.
Attributes
- Returns
-
the longest suffix of this immutable set whose first element does not satisfy the predicate
p. - Inherited from:
- IterableOps
- Source
- Iterable.scala
The empty immutable set.
The empty immutable set.
Attributes
- Returns
-
an empty iterable of type
immutable.Set. - Inherited from:
- IterableOps
- Source
- Iterable.scala
Tests whether a predicate holds for at least one element of this immutable set.
Tests whether a predicate holds for at least one element of this immutable set.
Note: may not terminate for infinite-sized collections.
Value parameters
- p
-
the predicate used to test elements.
Attributes
- Returns
-
trueif the given predicatepis satisfied by at least one element of this immutable set, otherwisefalse - Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
Selects all elements of this immutable set which satisfy a predicate.
Selects all elements of this immutable set which satisfy a predicate.
Value parameters
- p
-
the predicate used to test elements.
Attributes
- 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
- Inherited from:
- StrictOptimizedIterableOps
- Source
- StrictOptimizedIterableOps.scala
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.
Value parameters
- pred
-
the predicate used to test elements.
Attributes
- Returns
-
a new immutable set consisting of all elements of this immutable set that do not satisfy the given predicate
pred. Their order may not be preserved. - Definition Classes
- Inherited from:
- StrictOptimizedIterableOps
- Source
- StrictOptimizedIterableOps.scala
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: may not terminate for infinite-sized collections.
Note: might return different results for different runs, unless the underlying collection type is ordered.
Value parameters
- p
-
the predicate used to test elements.
Attributes
- Returns
-
an option value containing the first element in the immutable set that satisfies
p, orNoneif none exists. - Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
Builds a new immutable set by applying a function to all elements of this immutable set and using the elements of the resulting collections.
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 this 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)
// lettersOf2 will return a Set[Char], not a Seq
def lettersOf2(words: Seq[String]) = words.toSet.flatMap(word => word.toSeq)
// xs will be an Iterable[Int]
val xs = Map("a" -> List(11, 111), "b" -> List(22, 222)).flatMap(_._2)
// ys will be a Map[Int, Int]
val ys = Map("a" -> List(1 -> 11, 1 -> 111), "b" -> List(2 -> 22, 2 -> 222)).flatMap(_._2)
Type parameters
- B
-
the element type of the returned collection.
Value parameters
- f
-
the function to apply to each element.
Attributes
- Returns
-
a new immutable set resulting from applying the given collection-valued function
fto each element of this immutable set and concatenating the results. - Definition Classes
- Inherited from:
- StrictOptimizedIterableOps
- Source
- StrictOptimizedIterableOps.scala
Given that the elements of this collection are themselves iterable collections, converts this immutable set into a immutable set comprising the elements of these iterable collections.
Given that the elements of this collection are themselves iterable collections, converts this immutable set into a immutable set comprising the elements of these iterable 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)
Type parameters
- B
-
the type of the elements of each iterable collection.
Value parameters
- asIterable
-
an implicit conversion which asserts that the element type of this immutable set is an
Iterable.
Attributes
- Returns
-
a new immutable set resulting from concatenating all element collections.
- Definition Classes
- Inherited from:
- StrictOptimizedIterableOps
- Source
- StrictOptimizedIterableOps.scala
Applies the given binary operator op to the given initial value z and all elements of this immutable set.
Applies the given binary operator op to the given initial value z and all elements of this immutable set.
For each application of the operator, each operand is either an element of this immutable set, the initial value, or another such application of the operator.
The order of applications of the operator is unspecified and may be nondeterministic.
Each element appears exactly once in the computation.
The initial value may be used an arbitrary number of times, but at least once.
If this collection is ordered, then for any application of the operator, the element(s) appearing in the left operand will precede those in the right.
Note: might return different results for different runs, unless either
of the following conditions is met: (1) the operator is associative,
and the underlying collection type is ordered; or (2) the operator is
associative and commutative. In either case, it is also necessary that the initial value
be a neutral value for the operator, e.g. Nil for List concatenation or 1 for multiplication.
The default implementation in IterableOnce is equivalent to foldLeft but may be overridden for more efficient traversal orders.
Note: will not terminate for infinite-sized collections.
Type parameters
- A1
-
The type parameter for the binary operator, a supertype of
A.
Value parameters
- op
-
A binary operator; must be associative for the result to always be the same across runs.
- z
-
An initial value; may be used an arbitrary number of times in the computation of the result; must be a neutral value for
opfor the result to always be the same across runs.
Attributes
- Returns
-
The result of applying
opbetween all the elements andz, orzif this immutable set is empty. - Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
Applies the given binary operator op to the given initial value z and all elements of this immutable set, going left to right. Returns the initial value if this immutable set is empty.
Applies the given binary operator op to the given initial value z and all elements of this immutable set, going left to right. Returns the initial value if this immutable set is empty.
"Going left to right" only makes sense if this collection is ordered: then if x,,1,,, x,,2,,, ..., x,,n,, are the elements of this immutable set, the result is op( op( ... op( op(z, x,,1,,), x,,2,,) ... ), x,,n,,).
If this collection is not ordered, then for each application of the operator, each right operand is an element. In addition, the leftmost operand is the initial value, and each other left operand is itself an application of the operator. The elements of this immutable set and the initial value all appear exactly once in the computation.
Note: might return different results for different runs, unless the underlying collection type is ordered.
Note: will not terminate for infinite-sized collections.
Type parameters
- B
-
The result type of the binary operator.
Value parameters
- op
-
A binary operator.
- z
-
An initial value.
Attributes
- Returns
-
The result of applying
optozand all elements of this immutable set, going left to right. Returnszif this immutable set is empty. - Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
Applies the given binary operator op to all elements of this immutable set and the given initial value z, going right to left. Returns the initial value if this immutable set is empty.
Applies the given binary operator op to all elements of this immutable set and the given initial value z, going right to left. Returns the initial value if this immutable set is empty.
"Going right to left" only makes sense if this collection is ordered: then if x,,1,,, x,,2,,, ..., x,,n,, are the elements of this immutable set, the result is op(x,,1,,, op(x,,2,,, op( ... op(x,,n,,, z) ... ))).
If this collection is not ordered, then for each application of the operator, each left operand is an element. In addition, the rightmost operand is the initial value, and each other right operand is itself an application of the operator. The elements of this immutable set and the initial value all appear exactly once in the computation.
Note: might return different results for different runs, unless the underlying collection type is ordered.
Note: will not terminate for infinite-sized collections.
Type parameters
- B
-
The result type of the binary operator.
Value parameters
- op
-
A binary operator.
- z
-
An initial value.
Attributes
- Returns
-
The result of applying
opto all elements of this immutable set andz, going right to left. Returnszif this immutable set is empty. - Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
Tests whether a predicate holds for all elements of this immutable set.
Tests whether a predicate holds for all elements of this immutable set.
Note: may not terminate for infinite-sized collections.
Value parameters
- p
-
the predicate used to test elements.
Attributes
- Returns
-
trueif this immutable set is empty or the given predicatepholds for all elements of this immutable set, otherwisefalse. - Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
Applies f to each element for its side effects. Note: U parameter needed to help scalac's type inference.
Applies f to each element for its side effects. Note: U parameter needed to help scalac's type inference.
Type parameters
- U
-
the return type of
f; the value is discarded, but the type parameter aids type inference
Value parameters
- f
-
the function to apply to each element for its side effects
Attributes
- Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
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: Even when applied to a view or a lazy collection it will always force the elements.
Type parameters
- K
-
the type of keys returned by the discriminator function.
Value parameters
- f
-
the discriminator function.
Attributes
- Returns
-
A map from keys to immutable sets such that the following invariant holds:
(xs groupBy f)(k) = xs filter (x => f(x) == k)That is, every key `k` is bound to a immutable set of those elements `x` for which `f(x)` equals `k`. - Inherited from:
- IterableOps
- Source
- Iterable.scala
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.
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.
Type parameters
- B
-
the type of values returned by the transformation function
- K
-
the type of keys returned by the discriminator function
Value parameters
- f
-
the element transformation function
- key
-
the discriminator function
Attributes
- Returns
-
a map associating each key
kproduced bykeywith a immutable set of values produced by applyingfto elements that map tok - Inherited from:
- IterableOps
- Source
- Iterable.scala
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.
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.
Type parameters
- B
-
the type of values returned by the transformation function
- K
-
the type of keys returned by the discriminator function
Value parameters
- f
-
the element transformation function
- key
-
the discriminator function
- reduce
-
the reduction function used to combine values mapped to the same key
Attributes
- Returns
-
a map associating each key
kproduced bykeywith the reduction of all values produced by applyingfto elements that map tok - Inherited from:
- IterableOps
- Source
- Iterable.scala
Partitions elements in fixed size immutable sets.
Partitions elements in fixed size immutable sets.
Value parameters
- size
-
the number of elements per group
Attributes
- Returns
-
An iterator producing immutable sets of size
size, except the last will be less than sizesizeif the elements don't divide evenly. - See also
-
scala.collection.Iterator, method
grouped - Inherited from:
- IterableOps
- Source
- Iterable.scala
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.
Attributes
- Returns
-
the first element of this immutable set.
- Throws
-
NoSuchElementException
if the immutable set is empty.
- Inherited from:
- IterableOps
- Source
- Iterable.scala
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.
Attributes
- Returns
-
the first element of this immutable set if it is nonempty,
Noneif it is empty. - Inherited from:
- IterableOps
- Source
- Iterable.scala
The initial part of the collection without its last element.
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.
Attributes
- Inherited from:
- IterableOps
- Source
- Iterable.scala
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.
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.
Attributes
- Returns
-
an iterator over all the inits of this immutable set
- Example
-
List(1,2,3).inits = Iterator(List(1,2,3), List(1,2), List(1), Nil) - Inherited from:
- IterableOps
- Source
- Iterable.scala
Computes the intersection between this set and another set.
Tests whether the immutable set is empty.
Tests whether the immutable set is empty.
Note: The default implementation creates and discards an iterator.
Note: Implementations in subclasses that are not repeatedly iterable must take care not to consume any elements when isEmpty is called.
Attributes
- Returns
-
trueif the immutable set contains no elements,falseotherwise. - Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
Tests whether this immutable set can be repeatedly traversed. Always true for Iterables and false for Iterators unless overridden.
Tests whether this immutable set can be repeatedly traversed. Always true for Iterables and false for Iterators unless overridden.
Attributes
- Returns
-
trueif it is repeatedly traversable,falseotherwise. - Definition Classes
- Inherited from:
- IterableOps
- Source
- Iterable.scala
The number of elements in this immutable set, if it can be cheaply computed, -1 otherwise. Cheaply usually means: Not requiring a collection traversal.
The number of elements in this immutable set, if it can be cheaply computed, -1 otherwise. Cheaply usually means: Not requiring a collection traversal.
Attributes
- Inherited from:
- IterableOnce
- Source
- IterableOnce.scala
Selects the last element.
Selects the last element.
Note: might return different results for different runs, unless the underlying collection type is ordered.
Attributes
- Returns
-
The last element of this immutable set.
- Throws
-
NoSuchElementException
If the immutable set is empty.
- Inherited from:
- IterableOps
- Source
- Iterable.scala
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.
Attributes
- Returns
-
the last element of this immutable set if it is nonempty,
Noneif it is empty. - Inherited from:
- IterableOps
- Source
- Iterable.scala
Builds a new immutable set by applying a function to all elements of this immutable set.
Builds a new immutable set by applying a function to all elements of this immutable set.
Type parameters
- B
-
the element type of the returned immutable set .
Value parameters
- f
-
the function to apply to each element.
Attributes
- Returns
-
a new immutable set resulting from applying the given function
fto each element of this immutable set and collecting the results. - Definition Classes
- Inherited from:
- StrictOptimizedIterableOps
- Source
- StrictOptimizedIterableOps.scala
Finds the largest element.
Finds the largest element.
Note: will not terminate for infinite-sized collections.
Type parameters
- B
-
The type over which the ordering is defined.
Value parameters
- ord
-
An ordering to be used for comparing elements.
Attributes
- Returns
-
the largest element of this immutable set with respect to the ordering
ord. - Throws
-
UnsupportedOperationException
if this immutable set is empty.
- Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
Finds the first element which yields the largest value measured by function f.
Finds the first element which yields the largest value measured by function f.
Note: will not terminate for infinite-sized collections.
Type parameters
- B
-
The result type of the function
f.
Value parameters
- f
-
The measuring function.
- ord
-
An ordering to be used for comparing elements.
Attributes
- Returns
-
the first element of this immutable set with the largest value measured by function
fwith respect to the orderingord. - Throws
-
UnsupportedOperationException
if this immutable set is empty.
- Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
Finds the first element which yields the largest value measured by function f.
Finds the first element which yields the largest value measured by function f.
Note: will not terminate for infinite-sized collections.
Type parameters
- B
-
The result type of the function
f.
Value parameters
- f
-
The measuring function.
- ord
-
An ordering to be used for comparing elements.
Attributes
- Returns
-
an option value containing the first element of this immutable set with the largest value measured by function
fwith respect to the orderingord. - Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
Finds the largest element.
Finds the largest element.
Note: will not terminate for infinite-sized collections.
Type parameters
- B
-
The type over which the ordering is defined.
Value parameters
- ord
-
An ordering to be used for comparing elements.
Attributes
- Returns
-
an option value containing the largest element of this immutable set with respect to the ordering
ord. - Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
Finds the smallest element.
Finds the smallest element.
Note: will not terminate for infinite-sized collections.
Type parameters
- B
-
The type over which the ordering is defined.
Value parameters
- ord
-
An ordering to be used for comparing elements.
Attributes
- Returns
-
the smallest element of this immutable set with respect to the ordering
ord. - Throws
-
UnsupportedOperationException
if this immutable set is empty.
- Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
Finds the first element which yields the smallest value measured by function f.
Finds the first element which yields the smallest value measured by function f.
Note: will not terminate for infinite-sized collections.
Type parameters
- B
-
The result type of the function
f.
Value parameters
- f
-
The measuring function.
- ord
-
An ordering to be used for comparing elements.
Attributes
- Returns
-
the first element of this immutable set with the smallest value measured by function
fwith respect to the orderingord. - Throws
-
UnsupportedOperationException
if this immutable set is empty.
- Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
Finds the first element which yields the smallest value measured by function f.
Finds the first element which yields the smallest value measured by function f.
Note: will not terminate for infinite-sized collections.
Type parameters
- B
-
The result type of the function
f.
Value parameters
- f
-
The measuring function.
- ord
-
An ordering to be used for comparing elements.
Attributes
- Returns
-
an option value containing the first element of this immutable set with the smallest value measured by function
fwith respect to the orderingord. - Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
Finds the smallest element.
Finds the smallest element.
Note: will not terminate for infinite-sized collections.
Type parameters
- B
-
The type over which the ordering is defined.
Value parameters
- ord
-
An ordering to be used for comparing elements.
Attributes
- Returns
-
an option value containing the smallest element of this immutable set with respect to the ordering
ord. - Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
Displays all elements of this immutable set in a string.
Displays all elements of this immutable set in a string.
Delegates to addString, which can be overridden.
Attributes
- 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. - Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
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.
Delegates to addString, which can be overridden.
Value parameters
- sep
-
the separator string.
Attributes
- 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 stringsep. - Example
-
List(1, 2, 3).mkString("|") = "1|2|3" - Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
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.
Delegates to addString, which can be overridden.
Value parameters
- end
-
the ending string.
- sep
-
the separator string.
- start
-
the starting string.
Attributes
- Returns
-
a string representation of this immutable set. The resulting string begins with the string
startand ends with the stringend. Inside, the string representations (w.r.t. the methodtoString) of all elements of this immutable set are separated by the stringsep. - Example
-
List(1, 2, 3).mkString("(", "; ", ")") = "(1; 2; 3)" - Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
Tests whether the immutable set is not empty.
Tests whether the immutable set is not empty.
Attributes
- Returns
-
trueif the immutable set contains at least one element,falseotherwise. - Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
A pair of, first, all elements that satisfy predicate p and, second, all elements that do not.
A pair of, first, all elements that satisfy predicate p and, second, all elements that do not.
The two immutable set correspond to the result of filter and filterNot, respectively.
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.
Value parameters
- p
-
the predicate used to test elements
Attributes
- Returns
-
a pair of immutable sets: the first containing all elements that satisfy
p, the second containing those that do not - Definition Classes
- Inherited from:
- StrictOptimizedIterableOps
- Source
- StrictOptimizedIterableOps.scala
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.
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 = $Coll(1, "one", 2, "two", 3, "three") partitionMap {
case i: Int => Left(i)
case s: String => Right(s)
}
// xs == ($Coll(1, 2, 3),
// $Coll(one, two, three))
Type parameters
- A1
-
the element type of the first resulting collection
- A2
-
the element type of the second resulting collection
Value parameters
- f
-
the 'split function' mapping the elements of this immutable set to an scala.util.Either
Attributes
- Returns
-
a pair of immutable sets: the first one made of those values returned by
fthat were wrapped in scala.util.Left, and the second one made of those wrapped in scala.util.Right. - Definition Classes
- Inherited from:
- StrictOptimizedIterableOps
- Source
- StrictOptimizedIterableOps.scala
Multiplies together the elements of this collection.
Multiplies together the elements of this collection.
The default implementation uses reduce for a known non-empty collection, foldLeft otherwise.
Note: will not terminate for infinite-sized collections.
Type parameters
- B
-
the result type of the
*operator.
Value parameters
- num
-
an implicit parameter defining a set of numeric operations which includes the
*operator to be used in forming the product.
Attributes
- Returns
-
the product of all elements of this immutable set with respect to the
*operator innum. - Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
Applies the given binary operator op to all elements of this immutable set.
Applies the given binary operator op to all elements of this immutable set.
For each application of the operator, each operand is either an element of this immutable set or another such application of the operator. The order of applications of the operator is unspecified and may be nondeterministic. Each element appears exactly once in the computation.
If this collection is ordered, then for any application of the operator, the element(s) appearing in the left operand will precede those in the right.
Note: might return different results for different runs, unless either
of the following conditions is met: (1) the operator is associative,
and the underlying collection type is ordered; or (2) the operator is
associative and commutative.
Note: will not terminate for infinite-sized collections.
Type parameters
- B
-
The type parameter for the binary operator, a supertype of
A.
Value parameters
- op
-
A binary operator; must be associative for the result to always be the same across runs.
Attributes
- Returns
-
The result of applying
opbetween all the elements if the immutable set is nonempty. - Throws
-
UnsupportedOperationException
if this immutable set is empty.
- Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
Applies the given binary operator op to all elements of this immutable set, going left to right.
Applies the given binary operator op to all elements of this immutable set, going left to right.
"Going left to right" only makes sense if this collection is ordered: then if x,,1,,, x,,2,,, ..., x,,n,, are the elements of this immutable set, the result is op( op( op( ... op(x,,1,,, x,,2,,) ... ), x,,n-1,,), x,,n,,).
If this collection is not ordered, then for each application of the operator, each right operand is an element. In addition, the leftmost operand is the first element of this immutable set and each other left operand is itself an application of the operator. Each element appears exactly once in the computation.
Note: might return different results for different runs, unless the
underlying collection type is ordered or the operator is associative
and commutative.
Note: will not terminate for infinite-sized collections.
Type parameters
- B
-
The result type of the binary operator, a supertype of
A.
Value parameters
- op
-
A binary operator.
Attributes
- Returns
-
The result of applying
opto all elements of this immutable set, going left to right. - Throws
-
UnsupportedOperationException
if this immutable set is empty.
- Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
If this immutable set is nonempty, reduces it with the given binary operator op, going left to right.
If this immutable set is nonempty, reduces it with the given binary operator op, going left to right.
The behavior is the same as reduceLeft except that the value is None if the immutable set is empty. Each element appears exactly once in the computation.
Note: might return different results for different runs, unless the
underlying collection type is ordered or the operator is associative
and commutative.
Note: will not terminate for infinite-sized collections.
Type parameters
- B
-
The result type of the binary operator, a supertype of
A.
Value parameters
- op
-
A binary operator.
Attributes
- Returns
-
The result of reducing this immutable set with
opgoing left to right if the immutable set is nonempty, inside aSome, andNoneotherwise. - Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
If this immutable set is nonempty, reduces it with the given binary operator op.
If this immutable set is nonempty, reduces it with the given binary operator op.
The behavior is the same as reduce except that the value is None if the immutable set is empty. The order of applications of the operator is unspecified and may be nondeterministic. Each element appears exactly once in the computation.
Note: might return different results for different runs, unless either
of the following conditions is met: (1) the operator is associative,
and the underlying collection type is ordered; or (2) the operator is
associative and commutative.
Note: will not terminate for infinite-sized collections.
Type parameters
- B
-
A type parameter for the binary operator, a supertype of
A.
Value parameters
- op
-
A binary operator; must be associative for the result to always be the same across runs.
Attributes
- Returns
-
The result of reducing this immutable set with
opif the immutable set is nonempty, inside aSome, andNoneotherwise. - Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
Applies the given binary operator op to all elements of this immutable set, going right to left.
Applies the given binary operator op to all elements of this immutable set, going right to left.
"Going right to left" only makes sense if this collection is ordered: then if x,,1,,, x,,2,,, ..., x,,n,, are the elements of this immutable set, the result is op(x,,1,,, op(x,,2,,, op( ... op(x,,n-1,,, x,,n,,) ... ))).
If this collection is not ordered, then for each application of the operator, each left operand is an element. In addition, the rightmost operand is the last element of this immutable set and each other right operand is itself an application of the operator. Each element appears exactly once in the computation.
Note: might return different results for different runs, unless the
underlying collection type is ordered or the operator is associative
and commutative.
Note: will not terminate for infinite-sized collections.
Type parameters
- B
-
The result type of the binary operator, a supertype of
A.
Value parameters
- op
-
A binary operator.
Attributes
- Returns
-
The result of applying
opto all elements of this immutable set, going right to left. - Throws
-
UnsupportedOperationException
if this immutable set is empty.
- Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
If this immutable set is nonempty, reduces it with the given binary operator op, going right to left.
If this immutable set is nonempty, reduces it with the given binary operator op, going right to left.
The behavior is the same as reduceRight except that the value is None if the immutable set is empty. Each element appears exactly once in the computation.
Note: might return different results for different runs, unless the
underlying collection type is ordered or the operator is associative
and commutative.
Note: will not terminate for infinite-sized collections.
Type parameters
- B
-
The result type of the binary operator, a supertype of
A.
Value parameters
- op
-
A binary operator.
Attributes
- Returns
-
The result of reducing this immutable set with
opgoing right to left if the immutable set is nonempty, inside aSome, andNoneotherwise. - Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
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.
Value parameters
- that
-
the collection containing the elements to remove.
Attributes
Attributes
- Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
Computes a prefix scan of the elements of the collection.
Computes a prefix scan of the elements of the collection.
Note: The neutral element z may be applied more than once.
Type parameters
- B
-
element type of the resulting collection
Value parameters
- op
-
the associative operator for the scan
- z
-
neutral element for the operator
op
Attributes
- Returns
-
a new immutable set containing the prefix scan of the elements in this immutable set
- Inherited from:
- IterableOps
- Source
- Iterable.scala
Produces a immutable set containing cumulative results of applying the operator going left to right, including the initial value.
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.
Type parameters
- B
-
the type of the elements in the resulting collection
Value parameters
- op
-
the binary operator applied to the intermediate result and the element
- z
-
the initial value
Attributes
- Returns
-
collection with intermediate results
- Definition Classes
- Inherited from:
- StrictOptimizedIterableOps
- Source
- StrictOptimizedIterableOps.scala
Produces a collection containing cumulative results of applying the operator going right to left. The head of the collection is the last cumulative result.
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)
Type parameters
- B
-
the type of the elements in the resulting collection
Value parameters
- op
-
the binary operator applied to the intermediate result and the element
- z
-
the initial value
Attributes
- Returns
-
collection with intermediate results
- Inherited from:
- IterableOps
- Source
- Iterable.scala
The size of this immutable set.
The size of this immutable set.
Note: will not terminate for infinite-sized collections.
Attributes
- Returns
-
the number of elements in this immutable set.
- Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
Compares the size of this immutable set to the size of another Iterable.
Compares the size of this immutable set to the size of another Iterable.
Value parameters
- that
-
the
Iterablewhose size is compared with this immutable set's size.
Attributes
- Returns
-
A value
xwherex < 0 if this.size < that.size x == 0 if this.size == that.size x > 0 if this.size > that.sizeThe method as implemented here does not call
sizedirectly; its running time isO(this.size min that.size)instead ofO(this.size + that.size). The method should be overridden if computingsizeis cheap andknownSizereturns-1. - Inherited from:
- IterableOps
- Source
- Iterable.scala
Compares the size of this immutable set to a test value.
Compares the size of this immutable set to a test value.
Value parameters
- otherSize
-
the test value that gets compared with the size.
Attributes
- Returns
-
A value
xwherex < 0 if this.size < otherSize x == 0 if this.size == otherSize x > 0 if this.size > otherSizeThe default implementation does not call
size, which may be arbitrarily expensive. It will useknownSizeif nonnegative. Otherwise, it will iterate to compute an element count, with complexityO(size min otherSize). This method should be overridden if computingsizeis cheap andknownSizereturns-1. In that case, the custom implementation should just comparesizeandotherSizedirectly. - See also
- Inherited from:
- IterableOps
- Source
- Iterable.scala
Returns a value class containing operations for comparing 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
Attributes
- Returns
-
a wrapper that allows size comparisons using operators such as
=, and> - Inherited from:
- IterableOps
- Source
- Iterable.scala
Selects an interval of elements. The returned immutable set is made up of all elements x which satisfy the invariant:
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.
Value parameters
- from
-
the lowest index to include from this immutable set.
- until
-
the lowest index to EXCLUDE from this immutable set.
Attributes
- Returns
-
a immutable set containing the elements greater than or equal to index
fromextending up to (but not including) indexuntilof this immutable set. - Example
-
List('a', 'b', 'c', 'd', 'e').slice(1, 3) == List('b', 'c') - Inherited from:
- IterableOps
- Source
- Iterable.scala
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).
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.
Value parameters
- size
-
the number of elements per group
- step
-
the distance between the first elements of successive groups
Attributes
- Returns
-
An iterator producing immutable sets of size
size, except the last element (which may be the only element) will be smaller if there are fewer thansizeelements remaining to be grouped. - See also
-
scala.collection.Iterator, method
sliding - Example
-
List(1, 2, 3, 4, 5).sliding(2, 2) = Iterator(List(1, 2), List(3, 4), List(5))List(1, 2, 3, 4, 5, 6).sliding(2, 3) = Iterator(List(1, 2), List(4, 5)) - Inherited from:
- IterableOps
- Source
- Iterable.scala
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).
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.
Value parameters
- size
-
the number of elements per group
Attributes
- Returns
-
An iterator producing immutable sets of size
size, except for a non-empty collection with less thansizeelements, which returns an iterator that produces the source collection itself as its only element. - See also
-
scala.collection.Iterator, method
sliding - Example
-
List().sliding(2) = empty iteratorList(1).sliding(2) = Iterator(List(1))List(1, 2).sliding(2) = Iterator(List(1, 2))List(1, 2, 3).sliding(2) = Iterator(List(1, 2), List(2, 3)) - Inherited from:
- IterableOps
- Source
- Iterable.scala
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.
Value parameters
- p
-
the test predicate
Attributes
- 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
- Inherited from:
- StrictOptimizedIterableOps
- Source
- StrictOptimizedIterableOps.scala
Splits this immutable set into a prefix/suffix pair at a given position.
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.
Value parameters
- n
-
the position at which to split.
Attributes
- Returns
-
a pair of immutable sets consisting of the first
nelements of this immutable set, and the other elements. - Definition Classes
- Inherited from:
- IterableOps
- Source
- Iterable.scala
Returns a scala.collection.Stepper for the elements of this collection.
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,ByteorChar, an scala.collection.IntStepper is returned - For collections of
DoubleorFloat, a scala.collection.DoubleStepper is returned - For collections of
Longa 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.
Type parameters
- S
-
the type of the returned
Stepper, determined by the implicitStepperShape
Value parameters
- shape
-
the
StepperShapethat determines the concreteSteppersubtype to return
Attributes
- Returns
-
a
Stepperover the elements of this immutable set, using a primitive-typedSteppersubclass forInt/Long/Double(and related) element types - Inherited from:
- IterableOnce
- Source
- IterableOnce.scala
Type parameters
- B
-
Type of elements of the resulting collection (e.g.
String) - C2
-
Type of the resulting collection (e.g.
List[String])
Value parameters
- b
-
Builder to use to build the resulting collection
- pf
-
Element transformation partial function
Attributes
- Returns
-
The resulting collection
- Inherited from:
- StrictOptimizedIterableOps
- Source
- StrictOptimizedIterableOps.scala
Type parameters
- B
-
Type of elements of the resulting collections (e.g.
Int) - C2
-
Type of the resulting collection (e.g.
List[Int])
Value parameters
- b
-
Builder to use to build the resulting collection
- that
-
Elements to concatenate to this collection
Attributes
- Returns
-
The resulting collection
- Inherited from:
- StrictOptimizedIterableOps
- Source
- StrictOptimizedIterableOps.scala
Type parameters
- B
-
Type of elements of the resulting collection (e.g.
String) - C2
-
Type of the resulting collection (e.g.
List[String])
Value parameters
- b
-
Builder to use to build the resulting collection
- f
-
Element transformation function
Attributes
- Returns
-
The resulting collection
- Inherited from:
- StrictOptimizedIterableOps
- Source
- StrictOptimizedIterableOps.scala
Type parameters
- B
-
Type of elements of the resulting collection (e.g.
Int) - C2
-
Type of the resulting collection (e.g.
List[Int])
Value parameters
- b
-
Builder to use to build the resulting collection
- toIterableOnce
-
Evidence that
Acan be seen as anIterableOnce[B]
Attributes
- Returns
-
The resulting collection
- Inherited from:
- StrictOptimizedIterableOps
- Source
- StrictOptimizedIterableOps.scala
Type parameters
- B
-
Type of elements of the resulting collection (e.g.
String) - C2
-
Type of the resulting collection (e.g.
List[String])
Value parameters
- b
-
Builder to use to build the resulting collection
- f
-
Element transformation function
Attributes
- Returns
-
The resulting collection
- Inherited from:
- StrictOptimizedIterableOps
- Source
- StrictOptimizedIterableOps.scala
Type parameters
- B
-
Type of elements of the second collection (e.g.
String) - C2
-
Type of the resulting collection (e.g.
List[(Int, String)])
Value parameters
- b
-
Builder to use to build the resulting collection
- that
-
Collection to zip with this collection
Attributes
- Returns
-
The resulting collection
- Inherited from:
- StrictOptimizedIterableOps
- Source
- StrictOptimizedIterableOps.scala
An iterator over all subsets of this set of the given size. If the requested size is impossible, an empty iterator is returned.
Sums the elements of this collection.
Sums the elements of this collection.
The default implementation uses reduce for a known non-empty collection, foldLeft otherwise.
Note: will not terminate for infinite-sized collections.
Type parameters
- B
-
the result type of the
+operator.
Value parameters
- num
-
an implicit parameter defining a set of numeric operations which includes the
+operator to be used in forming the sum.
Attributes
- Returns
-
the sum of all elements of this immutable set with respect to the
+operator innum. - Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
The rest of the collection without its first element.
The rest of the collection without its first element.
Attributes
- Inherited from:
- IterableOps
- Source
- Iterable.scala
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.
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.
Attributes
- Returns
-
an iterator over all the tails of this immutable set
- Example
-
List(1,2,3).tails = Iterator(List(1,2,3), List(2,3), List(3), Nil) - Inherited from:
- IterableOps
- Source
- Iterable.scala
Selects the first n elements.
Selects the first n elements.
Note: might return different results for different runs, unless the underlying collection type is ordered.
Value parameters
- n
-
the number of elements to take from this immutable set.
Attributes
- Returns
-
a immutable set consisting only of the first
nelements of this immutable set, or else the whole immutable set, if it has less thannelements. Ifnis negative, returns an empty immutable set. - Inherited from:
- IterableOps
- Source
- Iterable.scala
A collection containing the last n elements of this collection.
A collection containing the last n elements of this collection.
Note: Even when applied to a view or a lazy collection it will always force the elements.
Value parameters
- n
-
the number of elements to take from the end of this collection
Attributes
- Returns
-
a new collection containing the last
nelements of this collection, or all elements ifnis greater than the size, or an empty collection ifnis non-positive - Definition Classes
- Inherited from:
- StrictOptimizedIterableOps
- Source
- StrictOptimizedIterableOps.scala
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.
Value parameters
- p
-
The predicate used to test elements.
Attributes
- Returns
-
the longest prefix of this immutable set whose elements all satisfy the predicate
p. - Inherited from:
- IterableOps
- Source
- Iterable.scala
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.
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.
Type parameters
- U
-
the return type of f
Value parameters
- f
-
a function to apply to each element in this immutable set
Attributes
- Returns
-
The same logical collection as this
- Definition Classes
- Inherited from:
- StrictOptimizedIterableOps
- Source
- StrictOptimizedIterableOps.scala
Given a collection factory factory, converts this immutable set to the appropriate representation for the current element type A. Example uses:
Given a collection factory factory, converts this immutable set to the appropriate representation for the current element type A. Example uses:
import scala.collection.mutable.ArrayBuffer
import scala.collection.immutable.BitSet
val xs: Iterable[Int] = Seq(1, 2, 3, 4, 5)
xs.to(List)
xs.to(ArrayBuffer)
xs.to(BitSet) // for xs: Iterable[Int]
Type parameters
- C1
-
the target collection type
Value parameters
- factory
-
the factory for the target collection type
Attributes
- Returns
-
a new collection of type
C1containing all elements of this immutable set - Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
Converts this immutable set to an Array.
Converts this immutable set to an Array.
Implementation note: DO NOT call Array.from from this method.
Type parameters
- B
-
The type of elements of the result, a supertype of
A.
Attributes
- Returns
-
This immutable set as an
Array[B]. - Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
Converts this immutable set to a Buffer.
Converts this immutable set to a Buffer.
Type parameters
- B
-
The type of elements of the result, a supertype of
A.
Attributes
- Returns
-
This immutable set as a
Buffer[B]. - Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
Converts this immutable set to an IndexedSeq.
Converts this immutable set to an IndexedSeq.
Attributes
- Returns
-
This immutable set as an
IndexedSeq[A]. - Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
Converts this immutable set to a List.
Converts this immutable set to a List.
Attributes
- Returns
-
This immutable set as a
List[A]. - Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
Converts this immutable set to a Map, given an implicit coercion from the immutable set's type to a key-value tuple.
Converts this immutable set to a Map, given an implicit coercion from the immutable set's type to a key-value tuple.
Type parameters
- K
-
The key type for the resulting map.
- V
-
The value type for the resulting map.
Value parameters
- ev
-
an implicit evidence that
Ais a subtype of(K, V)
Attributes
- Returns
-
This immutable set as a
Map[K, V]. - Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
Attributes
- Returns
-
This immutable set as a
Seq[A]. This is equivalent toto(Seq)but might be faster. - Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
Converts this immutable set to a Set.
Converts this immutable set to a Set.
Type parameters
- B
-
The type of elements of the result, a supertype of
A.
Attributes
- Returns
-
This immutable set as a
Set[B]. - Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
Returns a string representation of the object.
Returns a string representation of the object.
The default representation is platform dependent.
Attributes
- Returns
-
a string representation of the object.
- Definition Classes
- Inherited from:
- Function1
- Source
- Function1.scala
Converts this immutable set to a Vector.
Converts this immutable set to a Vector.
Attributes
- Returns
-
This immutable set as a
Vector[A]. - Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
Transposes this immutable set of iterable collections into a immutable set of immutable sets.
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.
Type parameters
- B
-
the type of the elements of each iterable collection.
Value parameters
- asIterable
-
an implicit conversion which asserts that the element type of this immutable set is an
Iterable.
Attributes
- Returns
-
a two-dimensional immutable set of immutable sets which has as nth row the nth column of this immutable set.
- Throws
-
IllegalArgumentException
if all collections in this immutable set are not of the same size.
- Inherited from:
- IterableOps
- Source
- Iterable.scala
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.
val xs = $Coll(
(1, "one"),
(2, "two"),
(3, "three")).unzip
// xs == ($Coll(1, 2, 3),
// $Coll(one, two, three))
Type parameters
- A1
-
the type of the first half of the element pairs
- A2
-
the type of the second half of the element pairs
Value parameters
- asPair
-
an implicit conversion which asserts that the element type of this immutable set is a pair.
Attributes
- Returns
-
a pair of immutable sets, containing the first, respectively second half of each element pair of this immutable set.
- Definition Classes
- Inherited from:
- StrictOptimizedIterableOps
- Source
- StrictOptimizedIterableOps.scala
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.
val xs = $Coll(
(1, "one", '1'),
(2, "two", '2'),
(3, "three", '3')).unzip3
// xs == ($Coll(1, 2, 3),
// $Coll(one, two, three),
// $Coll(1, 2, 3))
Type parameters
- A1
-
the type of the first member of the element triples
- A2
-
the type of the second member of the element triples
- A3
-
the type of the third member of the element triples
Value parameters
- asTriple
-
an implicit conversion which asserts that the element type of this immutable set is a triple.
Attributes
- Returns
-
a triple of immutable sets, containing the first, second, respectively third member of each element triple of this immutable set.
- Definition Classes
- Inherited from:
- StrictOptimizedIterableOps
- Source
- StrictOptimizedIterableOps.scala
A view over the elements of this collection.
A view over the elements of this collection.
Attributes
- Inherited from:
- IterableOps
- Source
- Iterable.scala
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.
Value parameters
- p
-
the predicate used to test elements.
Attributes
- Returns
-
an object of class
WithFilter, which supportsmap,flatMap,foreach, andwithFilteroperations. All these operations apply to those elements of this immutable set which satisfy the predicatep. - Inherited from:
- IterableOps
- Source
- Iterable.scala
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 longer than the other, its remaining elements are ignored.
Type parameters
- B
-
the type of the second half of the returned pairs
Value parameters
- that
-
The iterable providing the second half of each result pair
Attributes
- 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 andthat. - Definition Classes
- Inherited from:
- StrictOptimizedIterableOps
- Source
- StrictOptimizedIterableOps.scala
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.
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.
Type parameters
- A1
-
the type of the first element in each result pair (supertype of
A) - B
-
the type of the second element in each result pair
Value parameters
- that
-
the iterable providing the second half of each result pair
- thatElem
-
the element to be used to fill up the result if
thatis shorter than this immutable set. - thisElem
-
the element to be used to fill up the result if this immutable set is shorter than
that.
Attributes
- 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 andthat. If this immutable set is shorter thanthat,thisElemvalues are used to pad the result. Ifthatis shorter than this immutable set,thatElemvalues are used to pad the result. - Inherited from:
- IterableOps
- Source
- Iterable.scala
Zips this immutable set with its indices.
Zips this immutable set with its indices.
Attributes
- 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)) - Definition Classes
- Inherited from:
- StrictOptimizedIterableOps
- Source
- StrictOptimizedIterableOps.scala
Inherited and Abstract methods
Creates a new set with a given element removed from this set.
Creates a new set with an additional element, unless the element is already present.
The companion object of this immutable set, providing various factory methods.
The companion object of this immutable set, providing various factory methods.
Attributes
- Returns
-
the companion factory object for this collection type
- Note
-
When implementing a custom collection type and refining
CCto the new type, this method needs to be overridden to return a factory for the new type (the compiler will issue an error otherwise). - Inherited from:
- IterableOps
- Source
- Iterable.scala
An scala.collection.Iterator over the elements of this immutable set.
An scala.collection.Iterator over the elements of this immutable set.
If an IterableOnce object is in fact an scala.collection.Iterator, this method always returns itself, in its current state, but if it is an scala.collection.Iterable, this method always returns a new scala.collection.Iterator.
Attributes
- Returns
-
an iterator over all elements of this immutable set
- Inherited from:
- IterableOnce
- Source
- IterableOnce.scala
Deprecated and Inherited methods
Attributes
- Deprecated
-
[Since version 2.13.0]Use ++ instead of ++: for collections of type Iterable - Inherited from:
- IterableOps
- Source
- Iterable.scala
Attributes
- Deprecated
-
[Since version 2.13.0]Use foldLeft instead of /: - Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
Attributes
- Deprecated
-
[Since version 2.13.0]Use foldRight instead of :\\ - Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
Aggregates the results of applying an operator to subsequent elements.
Aggregates the results of applying an operator to subsequent elements.
Since this method degenerates to foldLeft for sequential (non-parallel) collections, where the combining operation is ignored, it is advisable to prefer foldLeft for that case.
For parallel collections, use the aggregate method specified by scala.collection.parallel.ParIterableLike.
Type parameters
- B
-
the result type, produced by
seqop,combop, and by this function as a final result.
Value parameters
- combop
-
an associative operator for combining sequential results, unused for sequential collections.
- seqop
-
the binary operator used to accumulate the result.
- z
-
the start value, a neutral element for
seqop.
Attributes
- Deprecated
-
[Since version 2.13.0]For sequential collections, prefer `foldLeft(z)(seqop)`. For parallel collections, use `ParIterableLike#aggregate`. - Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
Attributes
- Deprecated
-
[Since version 2.13.0]Use iterableFactory instead - Inherited from:
- IterableOps
- Source
- Iterable.scala
Attributes
- Deprecated
-
[Since version 2.13.0]Use `dest ++= coll` instead - Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
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.
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.
Attributes
- Returns
-
**true**if this collection is known to have finite size,**false**otherwise. - See also
-
method
knownSizefor a more useful alternative - Deprecated
-
[Since version 2.13.0]Check .knownSize instead of .hasDefiniteSize for more actionable information (see scaladoc for details)This method is deprecated in 2.13 because it does not provide any actionable information. As noted above, even the collection library itself does not use it. When there is no guarantee that a collection is finite, it is generally best to attempt a computation anyway and document that it will not terminate for infinite collections rather than backing out because this would prevent performing the computation on collections that are in fact finite even though
hasDefiniteSizereturnsfalse. - Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
Attributes
- Deprecated
-
[Since version 2.13.0]Use coll instead of repr in a collection implementation, use the collection value itself from the outside - Inherited from:
- IterableOps
- Source
- Iterable.scala
Attributes
- Returns
-
This collection as an
Iterable[A]. No new collection will be built ifthisis already anIterable[A]. - Deprecated
-
[Since version 2.13.7]toIterable is internal and will be made protected; its name is similar to `toList` or `toSeq`, but it doesn\'t copy non-immutable collections - Inherited from:
- IterableOps
- Source
- Iterable.scala
Attributes
- Deprecated
-
[Since version 2.13.0]Use .iterator instead of .toIterator - Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
Attributes
- Deprecated
-
[Since version 2.13.0]Use .to(LazyList) instead of .toStream - Inherited from:
- IterableOnceOps
- Source
- IterableOnce.scala
Converts this immutable set to an unspecified Iterable. Will return the same collection if this instance is already Iterable.
Converts this immutable set to an unspecified Iterable. Will return the same collection if this instance is already Iterable.
Attributes
- Returns
-
An Iterable containing all elements of this immutable set.
- Deprecated
-
[Since version 2.13.0]toTraversable is internal and will be made protected; its name is similar to `toList` or `toSeq`, but it doesn\'t copy non-immutable collections - Inherited from:
- IterableOps
- Source
- Iterable.scala
A view over a slice of the elements of this collection.
A view over a slice of the elements of this collection.
Attributes
- Deprecated
-
[Since version 2.13.0]Use .view.slice(from, until) instead of .view(from, until) - Inherited from:
- IterableOps
- Source
- Iterable.scala