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.

Returns the option's value.

This is equivalent to:

option match {
  case Some(x) => x
  case None    => throw new Exception
}

Returns true if the option is None, false otherwise.

This is equivalent to:

option match {
  case Some(_) => false
  case None    => true
}

The size of this product.

The n^th element of this product, 0-based. In other words, for a product A(x1, ..., xk), returns x(n+1) where 0 <= n < k.

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.

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

As with ++, returns a new collection containing the elements from the left operand followed by the elements from the right operand.

It differs from ++ in that the right operand determines the type of the resulting collection rather than the left one. Mnemonic: the COLon is on the side of the new COLlection type.

Example:

scala> val x = List(1)
x: List[Int] = List(1)

scala> val y = LinkedList(2)
y: scala.collection.mutable.LinkedList[Int] = LinkedList(2)

scala> val z = x ++: y
z: scala.collection.mutable.LinkedList[Int] = LinkedList(1, 2)

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

Since TraversableOnce has no ++ method, we have to implement that directly, but Traversable and down can use the overload.

As with ++, returns a new collection containing the elements from the left operand followed by the elements from the right operand.

It differs from ++ in that the right operand determines the type of the resulting collection rather than the left one. Mnemonic: the COLon is on the side of the new COLlection type.

Example:

scala> val x = List(1)
x: List[Int] = List(1)

scala> val y = LinkedList(2)
y: scala.collection.mutable.LinkedList[Int] = LinkedList(2)

scala> val z = x ++: y
z: scala.collection.mutable.LinkedList[Int] = LinkedList(1, 2)

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

Appends all elements of this iterable collection to a string builder. The written text consists of the string representations (w.r.t. the method toString) of all elements of this iterable collection 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 iterable collection 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 iterable collection, 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 iterable collection 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 iterable collection 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)

Aggregates the results of applying an operator to subsequent elements.

This is a more general form of fold and reduce. It is similar to foldLeft in that it doesn't require the result to be a supertype of the element type. In addition, it allows parallel collections to be processed in chunks, and then combines the intermediate results.

aggregate splits the iterable collection into partitions and processes each partition by sequentially applying seqop, starting with z (like foldLeft). Those intermediate results are then combined by using combop (like fold). The implementation of this operation may operate on an arbitrary number of collection partitions (even 1), so combop may be invoked an arbitrary number of times (even 0).

As an example, consider summing up the integer values of a list of chars. The initial value for the sum is 0. First, seqop transforms each input character to an Int and adds it to the sum (of the partition). Then, combop just needs to sum up the intermediate results of the partitions:

List('a', 'b', 'c').aggregate(0)({ (sum, ch) => sum + ch.toInt }, { (p1, p2) => p1 + p2 })

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.

Create a copy of the receiver object.

The default implementation of the clone method is platform dependent.

Returns a scala.Some containing the result of applying pf to this scala.Option's contained value, if this option is nonempty and pf is defined for that value. Returns None otherwise.

Finds the first element of the iterable collection 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.

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

Tests whether the option contains a given value as an element.

This is equivalent to:

option match {
  case Some(x) => x == elem
  case None    => false
}

Copies the elements of this option to an array. Fills the given array xs with at most len elements of this option, starting at position start. Copying will stop once either the end of the current option is reached, or the end of the target array is reached, or len elements have been copied.

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

Copies the elements of this option to an array. Fills the given array xs with values of this option, beginning at index start. Copying will stop once either the end of the current option is reached, or the end of the target array is reached.

Copies all elements of this iterable collection to a buffer.

Note: will not terminate for infinite-sized collections.

Counts the number of elements in the iterable collection which satisfy a predicate.

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.

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

The equality method for reference types. Default implementation delegates to eq.

See also equals in scala.Any.

Returns true if this option is nonempty and the predicate p returns true when applied to this scala.Option's value. Otherwise, returns false.

This is equivalent to:

option match {
  case Some(x) => p(x)
  case None    => false
}

Returns this scala.Option if it is nonempty and applying the predicate p to this scala.Option's value returns true. Otherwise, return None.

This is equivalent to:

option match {
  case Some(x) if p(x) => Some(x)
  case _               => None
}

Returns this scala.Option if it is nonempty and applying the predicate p to this scala.Option's value returns false. Otherwise, return None.

This is equivalent to:

option match {
  case Some(x) if !p(x) => Some(x)
  case _                => None
}

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

Returns the result of applying f to this scala.Option's value if this scala.Option is nonempty. Returns None if this scala.Option is empty. Slightly different from map in that f is expected to return an scala.Option (which could be None).

This is equivalent to:

option match {
  case Some(x) => f(x)
  case None    => None
}

Returns the result of applying f to this scala.Option's value if the scala.Option is nonempty. Otherwise, evaluates expression ifEmpty.

This is equivalent to:

option match {
  case Some(x) => f(x)
  case None    => ifEmpty
}

This is also equivalent to:

option map f getOrElse ifEmpty

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

Returns true if this option is empty or the predicate p returns true when applied to this scala.Option's value.

This is equivalent to:

option match {
  case Some(x) => p(x)
  case None    => true
}

Apply the given procedure f to the option's value, if it is nonempty. Otherwise, do nothing.

This is equivalent to:

option match {
  case Some(x) => f(x)
  case None    => ()
}

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

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

Returns the runtime class representation of the object.

Returns the option's value if the option is nonempty, otherwise return the result of evaluating default.

This is equivalent to:

option match {
  case Some(x) => x
  case None    => default
}

Partitions this iterable collection into a map of iterable collections according to some discriminator function.

Note: this method is not re-implemented by views. This means when applied to a view it will always force the view and return a new iterable collection.

Partitions elements in fixed size iterable collections.

Tests whether this iterable collection 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.

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

Selects the first element of this iterable collection.

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.

Selects all elements except the last.

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

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

Returns true if the option is an instance of scala.Some, false otherwise.

This is equivalent to:

option match {
  case Some(_) => true
  case None    => false
}

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

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

Tests whether this iterable collection can be repeatedly traversed.

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.

Returns a scala.Some containing the result of applying f to this scala.Option's value if this scala.Option is nonempty. Otherwise return None.

This is equivalent to:

option match {
  case Some(x) => Some(f(x))
  case None    => None
}

Finds the largest element.

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

Finds the smallest element.

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

Displays all elements of this iterable collection in a string.

Displays all elements of this iterable collection in a string using a separator string.

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

Equivalent to !(this eq that).

Returns false if the option is None, true otherwise.

This is equivalent to:

option match {
  case Some(_) => true
  case None    => false
}

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.

Returns this scala.Option if it is nonempty, otherwise return the result of evaluating alternative.

This is equivalent to:

option match {
  case Some(x) => Some(x)
  case None    => alternative
}

Returns the option's value if it is nonempty, or null if it is empty.

Although the use of null is discouraged, code written to use scala.Option must often interface with code that expects and returns nulls.

This is equivalent to:

option match {
  case Some(x) => x
  case None    => null
}

Returns a parallel implementation of this collection.

For most collection types, this method creates a new parallel collection by copying all the elements. For these collection, par takes linear time. Mutable collections in this category do not produce a mutable parallel collection that has the same underlying dataset, so changes in one collection will not be reflected in the other one.

Specific collections (e.g. ParArray or mutable.ParHashMap) override this default behaviour by creating a parallel collection which shares the same underlying dataset. For these collections, par takes constant or sublinear time.

All parallel collections return a reference to themselves.

Partitions this iterable collection in two iterable collections according to a predicate.

Multiplies up the elements of this collection.

An iterator over all the elements of this product.

A string used in the toString methods of derived classes. Implementations may override this method to prepend a string prefix to the result of toString methods.

Reduces the elements of this iterable collection 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 iterable collection, 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 iterable collection, 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 iterable collection, 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 iterable collection, 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 iterable collection, 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.

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

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

Computes a prefix scan of the elements of the collection.

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

Produces a collection containing cumulative results of applying the operator 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.

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.

Example:

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

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

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

The size of this iterable collection.

Note: will not terminate for infinite-sized collections.

Selects an interval of elements. The returned collection is made up of all elements x which satisfy the invariant:

from <= indexOf(x) < until

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

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 "sliding window" step is set to one.

Splits this iterable collection 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 iterable collection into two at a given position. Note: c splitAt n is equivalent to (but possibly more efficient than) (c take n, c drop n).

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

Defines the prefix of this object's toString representation.

Sums up the elements of this collection.

Selects all elements except the first.

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

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

Selects first n elements.

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

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

Converts this option into another by copying all elements.

Converts this option to an array.

Uses the contents of this iterable collection to create a new mutable buffer.

Note: will not terminate for infinite-sized collections.

Converts this iterable collection to an indexed sequence.

Note: will not terminate for infinite-sized collections.

Returns this iterable collection as an iterable collection.

A new collection will not be built; lazy collections will stay lazy.

Note: will not terminate for infinite-sized collections.

Returns an Iterator over the elements in this iterable collection. Produces the same result as iterator.

Note: will not terminate for infinite-sized collections.

Returns a scala.util.Right containing the given argument right if this is empty, or a scala.util.Left containing this scala.Option's value if this scala.Option is nonempty.

This is equivalent to:

option match {
  case Some(x) => Left(x)
  case None    => Right(right)
}

Returns a singleton list containing the scala.Option's value if it is nonempty, or the empty list if the scala.Option is empty.

This is equivalent to:

option match {
  case Some(x) => List(x)
  case None    => Nil
}

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

Returns a scala.util.Left containing the given argument left if this scala.Option is empty, or a scala.util.Right containing this scala.Option's value if this is nonempty.

This is equivalent to:

option match {
  case Some(x) => Right(x)
  case None    => Left(left)
}

Converts this iterable collection to a sequence. As with toIterable, it's lazy in this default implementation, as this TraversableOnce may be lazy and unevaluated.

Note: will not terminate for infinite-sized collections.

Converts this iterable collection to a set.

Note: will not terminate for infinite-sized collections.

Converts this iterable collection to a stream.

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.

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

Note: will not terminate for infinite-sized collections.

Converts this iterable collection to a Vector.

Note: will not terminate for infinite-sized collections.

Transposes this iterable collection of traversable collections into a iterable collection of iterable collections.

The resulting collection's type will be guided by the static type of iterable collection. 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))

Converts this iterable collection of pairs into two collections of the first and second half of each pair.

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

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

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

Creates a non-strict view of a slice of this iterable collection.

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

Note: view(from, to) is equivalent to view.slice(from, to)

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

Creates a non-strict view of this iterable collection.

Necessary to keep scala.Option from being implicitly converted to scala.collection.Iterable in for comprehensions.

Returns a option formed from this option 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 option formed from this option 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.