W3cubDocs

/Scala 2.13 Library

Class scala.Option

Companion object Option

sealed abstract class Option[+A] extends IterableOnce[A] with Product with Serializable

Represents optional values. Instances of Option are either an instance of scala.Some or the object None.

The most idiomatic way to use an scala.Option instance is to treat it as a collection or monad and use map,flatMap, filter, or foreach:

val name: Option[String] = request getParameter "name"
val upper = name map { _.trim } filter { _.length != 0 } map { _.toUpperCase }
println(upper getOrElse "")

Note that this is equivalent to

val upper = for {
  name <- request getParameter "name"
  trimmed <- Some(name.trim)
  upper <- Some(trimmed.toUpperCase) if trimmed.length != 0
} yield upper
println(upper getOrElse "")

Because of how for comprehension works, if None is returned from request.getParameter, the entire expression results in None

This allows for sophisticated chaining of scala.Option values without having to check for the existence of a value.

These are useful methods that exist for both scala.Some and None.

  • isDefined — True if not empty
  • isEmpty — True if empty
  • nonEmpty — True if not empty
  • orElse — Evaluate and return alternate optional value if empty
  • getOrElse — Evaluate and return alternate value if empty
  • get — Return value, throw exception if empty
  • fold — Apply function on optional value, return default if empty
  • map — Apply a function on the optional value
  • flatMap — Same as map but function must return an optional value
  • foreach — Apply a procedure on option value
  • collect — Apply partial pattern match on optional value
  • filter — An optional value satisfies predicate
  • filterNot — An optional value doesn't satisfy predicate
  • exists — Apply predicate on optional value, or false if empty
  • forall — Apply predicate on optional value, or true if empty
  • contains — Checks if value equals optional value, or false if empty
  • zip — Combine two optional values to make a paired optional value
  • unzip — Split an optional pair to two optional values
  • unzip3 — Split an optional triple to three optional values
  • toList — Unary list of optional value, otherwise the empty list

A less-idiomatic way to use scala.Option values is via pattern matching:

val nameMaybe = request getParameter "name"
nameMaybe match {
  case Some(name) =>
    println(name.trim.toUppercase)
  case None =>
    println("No name value")
}

Interacting with code that can occasionally return null can be safely wrapped in scala.Option to become None and scala.Some otherwise.

val abc = new java.util.HashMap[Int, String]
abc.put(1, "A")
bMaybe = Option(abc.get(2))
bMaybe match {
  case Some(b) =>
    println(s"Found $b")
  case None =>
    println("Not found")
}
Self Type
Option[A]
Annotations
@SerialVersionUID()
Source
Option.scala
Since

1.1

Note

Many of the methods in here are duplicative with those in the Traversable hierarchy, but they are duplicated for a reason: the implicit conversion tends to leave one with an Iterable in situations where one could have retained an Option.

Linear Supertypes
java.io.Serializable, Product, Equals, collection.IterableOnce[A], AnyRef, Any
Known Subclasses
None, Some

Type Members

class WithFilter extends AnyRef

Abstract Value Members

abstract def canEqual(that: Any): Boolean

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.

that

the value being probed for possible equality

returns

true if this instance can possibly equal that, otherwise false

Definition Classes
Equals

abstract def get: A

Returns the option's value.

This is equivalent to:

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

java.util.NoSuchElementException if the option is empty.

Note

The option must be nonempty.

abstract def productArity: Int

The size of this product.

returns

for a product A(x1, ..., xk), returns k

Definition Classes
Product

abstract def productElement(n: Int): Any

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

n

the index of the element to return

returns

the element n elements after the first element

Definition Classes
Product
Exceptions thrown

IndexOutOfBoundsException if the n is out of range(n < 0 || n >= productArity).

Concrete Value Members

final def !=(arg0: Any): Boolean

Test two objects for inequality.

returns

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

Definition Classes
AnyRef → Any

final def ##(): Int

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 hash value consistent with ==

Definition Classes
AnyRef → Any

def +(other: String): String

Implicit
This member is added by an implicit conversion from Option[A] toany2stringadd[Option[A]] performed by method any2stringadd in scala.Predef.
Definition Classes
any2stringadd

final def ++[B >: A](suffix: collection.IterableOnce[B]): collection.Iterable[B]

Alias for concat

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Definition Classes
IterableOps
Annotations
@inline()

def ->[B](y: B): (Option[A], B)

Implicit
This member is added by an implicit conversion from Option[A] toArrowAssoc[Option[A]] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@inline()

final def ==(arg0: Any): Boolean

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

returns

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

Definition Classes
AnyRef → Any

final def addString(b: collection.mutable.StringBuilder): collection.mutable.StringBuilder

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
b

the string builder to which elements are appended.

returns

the string builder b to which elements were appended.

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Definition Classes
IterableOnceOps
Annotations
@inline()

final def addString(b: collection.mutable.StringBuilder, sep: String): collection.mutable.StringBuilder

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
b

the string builder to which elements are appended.

sep

the separator string.

returns

the string builder b to which elements were appended.

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Definition Classes
IterableOnceOps
Annotations
@inline()

def addString(b: collection.mutable.StringBuilder, start: String, sep: String, end: String): collection.mutable.StringBuilder

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

the string builder to which elements are appended.

start

the starting string.

sep

the separator string.

end

the ending string.

returns

the string builder b to which elements were appended.

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Definition Classes
IterableOnceOps

final def asInstanceOf[T0]: T0

Cast the receiver object to be of type T0.

Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression 1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expression List(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested type.

returns

the receiver object.

Definition Classes
Any
Exceptions thrown

ClassCastException if the receiver object is not an instance of the erasure of type T0.

def clone(): AnyRef

Create a copy of the receiver object.

The default implementation of the clone method is platform dependent.

returns

a copy of the receiver object.

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @native()
Note

not specified by SLS as a member of AnyRef

final def collect[B](pf: PartialFunction[A, B]): Option[B]

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.

pf

the partial function.

returns

the result of applying pf to this scala.Option's value (if possible), or None.

Annotations
@inline()
Example:
    // Returns Some(HTTP) because the partial function covers the case.
    Some("http") collect {case "http" => "HTTP"}
    
    // Returns None because the partial function doesn't cover the case.
    Some("ftp") collect {case "http" => "HTTP"}
    
    // Returns None because the option is empty. There is no value to pass to the partial function.
    None collect {case value => value}

def collectFirst[B](pf: PartialFunction[A, B]): Option[B]

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.

pf

the partial function

returns

an option value containing pf applied to the first value for which it is defined, or None if none exists.

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Definition Classes
IterableOnceOps
Example:

    Seq("a", 1, 5L).collectFirst({ case x: Int => x*10 }) = Some(10)

def concat[B >: A](suffix: collection.IterableOnce[B]): collection.Iterable[B]

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.

B

the element type of the returned collection.

suffix

the traversable to append.

returns

a new iterable collection which contains all elements of this iterable collection followed by all elements of suffix.

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Definition Classes
IterableOps

final def contains[A1 >: A](elem: A1): Boolean

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
}
elem

the element to test.

returns

true if the option has an element that is equal (as determined by ==) to elem, false otherwise.

Example:
    // Returns true because Some instance contains string "something" which equals "something".
    Some("something") contains "something"
    
    // Returns false because "something" != "anything".
    Some("something") contains "anything"
    
    // Returns false when method called on None.
    None contains "anything"

def copyToArray[B >: A](xs: Array[B], start: Int, len: Int): Int

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

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

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

B

the type of the elements of the array.

xs

the array to fill.

start

the starting index of xs.

len

the maximal number of elements to copy.

returns

the number of elements written to the array

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Definition Classes
IterableOnceOps
Note

Reuse: After calling this method, one should discard the iterator it was called on. Using it is undefined and subject to change. Note: will not terminate for infinite-sized collections.

def copyToArray[B >: A](xs: Array[B], start: Int): Int

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

Fills the given array xs starting at index start with values of this iterable collection.

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

B

the type of the elements of the array.

xs

the array to fill.

start

the starting index of xs.

returns

the number of elements written to the array Note: will not terminate for infinite-sized collections.

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Definition Classes
IterableOnceOps

def copyToArray[B >: A](xs: Array[B]): Int

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

Fills the given array xs starting at index start with values of this iterable collection.

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

B

the type of the elements of the array.

xs

the array to fill.

returns

the number of elements written to the array Note: will not terminate for infinite-sized collections.

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Definition Classes
IterableOnceOps

def corresponds[B](that: collection.IterableOnce[B])(p: (A, B) => Boolean): Boolean

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

B

the type of the elements of that

that

the other collection

p

the test predicate, which relates elements from both collections

returns

true if both collections have the same length and p(x, y) is true for all corresponding elements x of this iterator and y of that, otherwise false

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Definition Classes
IterableOnceOps

def drop(n: Int): collection.Iterable[A]

Selects all elements except first n ones.

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

n

the number of elements to drop from this iterable collection.

returns

a iterable collection consisting of all elements of this iterable collection except the first n ones, or else the empty iterable collection, if this iterable collection has less than n elements. If n is negative, don't drop any elements.

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Definition Classes
IterableOpsIterableOnceOps
Note

Reuse: After calling this method, one should discard the iterator it was called on, and use only the iterator that was returned. Using the old iterator is undefined, subject to change, and may result in changes to the new iterator as well.

def dropRight(n: Int): collection.Iterable[A]

Selects all elements except last n ones.

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

n

the number of elements to drop from this iterable collection.

returns

a iterable collection consisting of all elements of this iterable collection except the last n ones, or else the empty iterable collection, if this iterable collection has less than n elements. If n is negative, don't drop any elements.

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Definition Classes
IterableOps

def dropWhile(p: (A) => Boolean): collection.Iterable[A]

Drops longest prefix of elements that satisfy a predicate.

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

p

The predicate used to test elements.

returns

the longest suffix of this iterable collection whose first element does not satisfy the predicate p.

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Definition Classes
IterableOpsIterableOnceOps
Note

Reuse: After calling this method, one should discard the iterator it was called on, and use only the iterator that was returned. Using the old iterator is undefined, subject to change, and may result in changes to the new iterator as well.

def empty: collection.Iterable[A]

The empty iterable of the same type as this iterable

returns

an empty iterable of type C.

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Definition Classes
IterableFactoryDefaultsIterableOps

def ensuring(cond: (Option[A]) => Boolean, msg: => Any): Option[A]

Implicit
This member is added by an implicit conversion from Option[A] toEnsuring[Option[A]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring

def ensuring(cond: (Option[A]) => Boolean): Option[A]

Implicit
This member is added by an implicit conversion from Option[A] toEnsuring[Option[A]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring

def ensuring(cond: Boolean, msg: => Any): Option[A]

Implicit
This member is added by an implicit conversion from Option[A] toEnsuring[Option[A]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring

def ensuring(cond: Boolean): Option[A]

Implicit
This member is added by an implicit conversion from Option[A] toEnsuring[Option[A]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring

final def eq(arg0: AnyRef): Boolean

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

returns

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

Definition Classes
AnyRef

def equals(arg0: AnyRef): Boolean

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

See also equals in scala.Any.

returns

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

Definition Classes
AnyRef → Any

final def exists(p: (A) => Boolean): Boolean

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
}
p

the predicate to test

Annotations
@inline()

final def filter(p: (A) => Boolean): Option[A]

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
}
p

the predicate used for testing.

Annotations
@inline()

final def filterNot(p: (A) => Boolean): Option[A]

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
}
p

the predicate used for testing.

Annotations
@inline()

def finalize(): Unit

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

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

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.Throwable])
Note

not specified by SLS as a member of AnyRef

final def flatMap[B](f: (A) => Option[B]): Option[B]

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
}
f

the function to apply

Annotations
@inline()
See also

map

foreach

def flatten[B](implicit ev: <:<[A, Option[B]]): Option[B]

Returns the nested scala.Option value if it is nonempty. Otherwise, return None.

This is equivalent to:

option match {
  case Some(Some(b)) => Some(b)
  case _             => None
}
ev

an implicit conversion that asserts that the value is also an scala.Option.

Example:
    Some(Some("something")).flatten
See also

flatMap

final def fold[B](ifEmpty: => B)(f: (A) => B): B

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
ifEmpty

the expression to evaluate if empty.

f

the function to apply if nonempty.

Annotations
@inline()

def foldLeft[B](z: B)(op: (B, A) => B): B

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.

B

the result type of the binary operator.

z

the start value.

op

the binary operator.

returns

the result of inserting op between consecutive elements of this iterable collection, going left to right with the start value z on the left:

op(...op(z, x_1), x_2, ..., x_n)

where x1, ..., xn are the elements of this iterable collection. Returns z if this iterable collection is empty.

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Definition Classes
IterableOnceOps

def foldRight[B](z: B)(op: (A, B) => B): B

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.

B

the result type of the binary operator.

z

the start value.

op

the binary operator.

returns

the result of inserting op between consecutive elements of this iterable collection, going right to left with the start value z on the right:

op(x_1, op(x_2, ... op(x_n, z)...))

where x1, ..., xn are the elements of this iterable collection. Returns z if this iterable collection is empty.

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Definition Classes
IterableOnceOps

final def forall(p: (A) => Boolean): Boolean

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
}
p

the predicate to test

Annotations
@inline()

final def foreach[U](f: (A) => U): Unit

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    => ()
}
f

the procedure to apply.

Annotations
@inline()
See also

map

flatMap

def formatted(fmtstr: String): String

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

Implicit
This member is added by an implicit conversion from Option[A] toStringFormat[Option[A]] performed by method StringFormat in scala.Predef.
Definition Classes
StringFormat
Annotations
@inline()

final def getClass(): Class[_ <: AnyRef]

Returns the runtime class representation of the object.

returns

a class object corresponding to the runtime type of the receiver.

Definition Classes
AnyRef → Any
Annotations
@native()

final def getOrElse[B >: A](default: => B): B

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
}
default

the default expression.

Annotations
@inline()

def groupBy[K](f: (A) => K): Map[K, collection.Iterable[A]]

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

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

K

the type of keys returned by the discriminator function.

f

the discriminator function.

returns

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

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Definition Classes
IterableOps

def groupMap[K, B](key: (A) => K)(f: (A) => B): Map[K, collection.Iterable[B]]

Partitions this iterable collection into a map of iterable collections 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.

K

the type of keys returned by the discriminator function

B

the type of values returned by the transformation function

key

the discriminator function

f

the element transformation function

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Definition Classes
IterableOps

def groupMapReduce[K, B](key: (A) => K)(f: (A) => B)(reduce: (B, B) => B): Map[K, B]

Partitions this iterable collection into a map according to a discriminator function key. All the values that have the same discriminator are then transformed by the value 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.

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Definition Classes
IterableOps

def grouped(size: Int): collection.Iterator[collection.Iterable[A]]

Partitions elements in fixed size iterable collections.

size

the number of elements per group

returns

An iterator producing iterable collections of size size, except the last will be less than size size if the elements don't divide evenly.

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Definition Classes
IterableOps
See also

scala.collection.Iterator, method grouped

def hashCode(): Int

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

returns

the hash code value for this object.

Definition Classes
AnyRef → Any
Annotations
@native()

Selects the first element of this iterable collection.

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

returns

the first element of this iterable collection.

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Definition Classes
IterableOps
Exceptions thrown

NoSuchElementException if the iterable collection is empty.

def headOption: Option[A]

Optionally selects the first element.

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

returns

the first element of this iterable collection if it is nonempty, None if it is empty.

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Definition Classes
IterableOps

def init: collection.Iterable[A]

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.

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Definition Classes
IterableOps

def inits: collection.Iterator[collection.Iterable[A]]

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.

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

returns

an iterator over all the inits of this iterable collection

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Definition Classes
IterableOps
Example:

    List(1,2,3).inits = Iterator(List(1,2,3), List(1,2), List(1), Nil)

final def isDefined: Boolean

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
}

final def isEmpty: Boolean

Returns true if the option is None, false otherwise.

This is equivalent to:

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

final def isInstanceOf[T0]: Boolean

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

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

returns

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

Definition Classes
Any

def isTraversableAgain: Boolean

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

returns

true if it is repeatedly traversable, false otherwise.

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Definition Classes
IterableOpsIterableOnceOps

def iterableFactory: IterableFactory[collection.Iterable]

The companion object of this iterable collection, providing various factory methods.

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Definition Classes
IterableIterableOps
Note

When implementing a custom collection type and refining CC to the new type, this method needs to be overridden to return a factory for the new type (the compiler will issue an error otherwise).

def iterator: Iterator[A]

Returns a singleton iterator returning the scala.Option's value if it is nonempty, or an empty iterator if the option is empty.

Definition Classes
OptionIterableOnce

final def knownSize: Int

returns

The number of elements in this option, if it can be cheaply computed, -1 otherwise. Cheaply usually means: Not requiring a collection traversal.

Definition Classes
OptionIterableOnce

def last: A

Selects the last element.

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

returns

The last element of this iterable collection.

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Definition Classes
IterableOps
Exceptions thrown

NoSuchElementException If the iterable collection is empty.

def lastOption: Option[A]

Optionally selects the last element.

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

returns

the last element of this iterable collection$ if it is nonempty, None if it is empty.

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Definition Classes
IterableOps

def lazyZip[B]: ([B](that: Iterable[B])scala.collection.LazyZip2[A,B,_1.type]) forSome {val _1: collection.Iterable[A]}

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

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

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

the type of the second element in each eventual pair

returns

a decorator LazyZip2 that allows strict operations to be performed on the lazily evaluated pairs or chained calls to lazyZip. Implicit conversion to Iterable[(A, B)] is also supported.

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Definition Classes
Iterable

final def map[B](f: (A) => B): Option[B]

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
}
f

the function to apply

Annotations
@inline()
Note

This is similar to flatMap except here, f does not need to wrap its result in an scala.Option.

See also

flatMap

foreach

def max[B >: A](implicit ord: math.Ordering[B]): A

Finds the largest element.

B

The type over which the ordering is defined.

ord

An ordering to be used for comparing elements.

returns

the largest element of this iterable collection with respect to the ordering ord.

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Definition Classes
IterableOnceOps
Exceptions thrown

UnsupportedOperationException if this iterable collection is empty.

def maxBy[B](f: (A) => B)(implicit cmp: math.Ordering[B]): A

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

B

The result type of the function f.

f

The measuring function.

cmp

An ordering to be used for comparing elements.

returns

the first element of this iterable collection with the largest value measured by function f with respect to the ordering cmp.

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Definition Classes
IterableOnceOps
Exceptions thrown

UnsupportedOperationException if this iterable collection is empty.

def maxByOption[B](f: (A) => B)(implicit cmp: math.Ordering[B]): Option[A]

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

B

The result type of the function f.

f

The measuring function.

cmp

An ordering to be used for comparing elements.

returns

an option value containing the first element of this iterable collection with the largest value measured by function f with respect to the ordering cmp.

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Definition Classes
IterableOnceOps

def maxOption[B >: A](implicit ord: math.Ordering[B]): Option[A]

Finds the largest element.

B

The type over which the ordering is defined.

ord

An ordering to be used for comparing elements.

returns

an option value containing the largest element of this iterable collection with respect to the ordering ord.

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Definition Classes
IterableOnceOps

def min[B >: A](implicit ord: math.Ordering[B]): A

Finds the smallest element.

B

The type over which the ordering is defined.

ord

An ordering to be used for comparing elements.

returns

the smallest element of this iterable collection with respect to the ordering ord.

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Definition Classes
IterableOnceOps
Exceptions thrown

UnsupportedOperationException if this iterable collection is empty.

def minBy[B](f: (A) => B)(implicit cmp: math.Ordering[B]): A

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

B

The result type of the function f.

f

The measuring function.

cmp

An ordering to be used for comparing elements.

returns

the first element of this iterable collection with the smallest value measured by function f with respect to the ordering cmp.

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Definition Classes
IterableOnceOps
Exceptions thrown

UnsupportedOperationException if this iterable collection is empty.

def minByOption[B](f: (A) => B)(implicit cmp: math.Ordering[B]): Option[A]

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

B

The result type of the function f.

f

The measuring function.

cmp

An ordering to be used for comparing elements.

returns

an option value containing the first element of this iterable collection with the smallest value measured by function f with respect to the ordering cmp.

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Definition Classes
IterableOnceOps

def minOption[B >: A](implicit ord: math.Ordering[B]): Option[A]

Finds the smallest element.

B

The type over which the ordering is defined.

ord

An ordering to be used for comparing elements.

returns

an option value containing the smallest element of this iterable collection with respect to the ordering ord.

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Definition Classes
IterableOnceOps

final def ne(arg0: AnyRef): Boolean

Equivalent to !(this eq that).

returns

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

Definition Classes
AnyRef

final def nonEmpty: Boolean

Returns false if the option is None, true otherwise.

This is equivalent to:

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

Implemented here to avoid the implicit conversion to Iterable.

final def notify(): Unit

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

Definition Classes
AnyRef
Annotations
@native()
Note

not specified by SLS as a member of AnyRef

final def notifyAll(): Unit

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

Definition Classes
AnyRef
Annotations
@native()
Note

not specified by SLS as a member of AnyRef

final def orElse[B >: A](alternative: => Option[B]): Option[B]

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
}
alternative

the alternative expression.

Annotations
@inline()

final def orNull[A1 >: A](implicit ev: <:<[Null, A1]): A1

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
}
Annotations
@inline()
Example:
    val initialText: Option[String] = getInitialText
    val textField = new JComponent(initialText.orNull,20)

def partition(p: (A) => Boolean): (collection.Iterable[A], collection.Iterable[A])

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

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

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Definition Classes
IterableOps

def partitionMap[A1, A2](f: (A) => Either[A1, A2]): (collection.Iterable[A1], collection.Iterable[A2])

Applies a function f to each element of the iterable collection and returns a pair of iterable collections: 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 = `Iterable`(1, "one", 2, "two", 3, "three") partitionMap {
 case i: Int => Left(i)
 case s: String => Right(s)
}
// xs == (`Iterable`(1, 2, 3),
//        `Iterable`(one, two, three))
A1

the element type of the first resulting collection

A2

the element type of the second resulting collection

f

the 'split function' mapping the elements of this iterable collection to an scala.util.Either

returns

a pair of iterable collections: 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.

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Definition Classes
IterableOps

def product[B >: A](implicit num: math.Numeric[B]): B

Multiplies up the elements of this collection.

B

the result type of the * operator.

num

an implicit parameter defining a set of numeric operations which includes the * operator to be used in forming the product.

returns

the product of all elements of this iterable collection with respect to the * operator in num.

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Definition Classes
IterableOnceOps

def productElementName(n: Int): String

The name of the nth element of this product, 0-based. In the default implementation, an empty string.

n

the index of the element name to return

returns

the name of the specified element

Definition Classes
Product
Exceptions thrown

IndexOutOfBoundsException if the n is out of range(n < 0 || n >= productArity).

def productElementNames: Iterator[String]

An iterator over the names of all the elements of this product.

Definition Classes
Product

def productIterator: Iterator[Any]

An iterator over all the elements of this product.

returns

in the default implementation, an Iterator[Any]

Definition Classes
Product

def productPrefix: String

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.

returns

in the default implementation, the empty string

Definition Classes
Product

def reduce[B >: A](op: (B, B) => B): B

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.

B

A type parameter for the binary operator, a supertype of A.

op

A binary operator that must be associative.

returns

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

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Definition Classes
IterableOnceOps
Exceptions thrown

UnsupportedOperationException if this iterable collection is empty.

def reduceLeft[B >: A](op: (B, A) => B): B

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.

B

the result type of the binary operator.

op

the binary operator.

returns

the result of inserting op between consecutive elements of this iterable collection, going left to right:

op( op( ... op(x_1, x_2) ..., x_{n-1}), x_n)

where x1, ..., xn are the elements of this iterable collection.

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Definition Classes
IterableOnceOps
Exceptions thrown

UnsupportedOperationException if this iterable collection is empty.

def reduceLeftOption[B >: A](op: (B, A) => B): Option[B]

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.

B

the result type of the binary operator.

op

the binary operator.

returns

an option value containing the result of reduceLeft(op) if this iterable collection is nonempty, None otherwise.

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Definition Classes
IterableOnceOps

def reduceOption[B >: A](op: (B, B) => B): Option[B]

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.

B

A type parameter for the binary operator, a supertype of A.

op

A binary operator that must be associative.

returns

An option value containing result of applying reduce operator op between all the elements if the collection is nonempty, and None otherwise.

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Definition Classes
IterableOnceOps

def reduceRight[B >: A](op: (A, B) => B): B

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.

B

the result type of the binary operator.

op

the binary operator.

returns

the result of inserting op between consecutive elements of this iterable collection, going right to left:

op(x_1, op(x_2, ..., op(x_{n-1}, x_n)...))

where x1, ..., xn are the elements of this iterable collection.

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Definition Classes
IterableOnceOps
Exceptions thrown

UnsupportedOperationException if this iterable collection is empty.

def reduceRightOption[B >: A](op: (A, B) => B): Option[B]

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.

B

the result type of the binary operator.

op

the binary operator.

returns

an option value containing the result of reduceRight(op) if this iterable collection is nonempty, None otherwise.

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Definition Classes
IterableOnceOps

def scan[B >: A](z: B)(op: (B, B) => B): collection.Iterable[B]

Computes a prefix scan of the elements of the collection.

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

B

element type of the resulting collection

z

neutral element for the operator op

op

the associative operator for the scan

returns

a new iterable collection containing the prefix scan of the elements in this iterable collection

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Definition Classes
IterableOps

def scanLeft[B](z: B)(op: (B, A) => B): collection.Iterable[B]

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

B

the type of the elements in the resulting collection

z

the initial value

op

the binary operator applied to the intermediate result and the element

returns

collection with intermediate results

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Definition Classes
IterableOpsIterableOnceOps
Note

Reuse: After calling this method, one should discard the iterator it was called on, and use only the iterator that was returned. Using the old iterator is undefined, subject to change, and may result in changes to the new iterator as well.

def scanRight[B](z: B)(op: (A, B) => B): collection.Iterable[B]

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

the type of the elements in the resulting collection

z

the initial value

op

the binary operator applied to the intermediate result and the element

returns

collection with intermediate results

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Definition Classes
IterableOps

def sizeCompare(that: collection.Iterable[_]): Int

Compares the size of this iterable collection to the size of another Iterable.

that

the Iterable whose size is compared with this iterable collection's size.

returns

A value x where

x <  0       if this.size <  that.size
x == 0       if this.size == that.size
x >  0       if this.size >  that.size

The method as implemented here does not call size directly; its running time is O(this.size min that.size) instead of O(this.size + that.size). The method should be overridden if computing size is cheap and knownSize returns -1.

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Definition Classes
IterableOps

def sizeCompare(otherSize: Int): Int

Compares the size of this iterable collection to a test value.

otherSize

the test value that gets compared with the size.

returns

A value x where

x <  0       if this.size <  otherSize
x == 0       if this.size == otherSize
x >  0       if this.size >  otherSize

The method as implemented here does not call size directly; its running time is O(size min otherSize) instead of O(size). The method should be overridden if computing size is cheap and knownSize returns -1.

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Definition Classes
IterableOps
See also

sizeIs

final def sizeIs: SizeCompareOps

Returns a value class containing operations for comparing the size of this iterable collection 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
Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Definition Classes
IterableOps
Annotations
@inline()

def slice(from: Int, until: Int): collection.Iterable[A]

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

from <= indexOf(x) < until

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

from

the lowest index to include from this iterable collection.

until

the lowest index to EXCLUDE from this iterable collection.

returns

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

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Definition Classes
IterableOpsIterableOnceOps
Note

Reuse: After calling this method, one should discard the iterator it was called on, and use only the iterator that was returned. Using the old iterator is undefined, subject to change, and may result in changes to the new iterator as well.

def sliding(size: Int, step: Int): collection.Iterator[collection.Iterable[A]]

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

size

the number of elements per group

step

the distance between the first elements of successive groups

returns

An iterator producing iterable collections of size size, except the last element (which may be the only element) will be truncated if there are fewer than size elements remaining to be grouped.

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Definition Classes
IterableOps
See also

scala.collection.Iterator, method sliding

def sliding(size: Int): collection.Iterator[collection.Iterable[A]]

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.

size

the number of elements per group

returns

An iterator producing iterable collections of size size, except the last element (which may be the only element) will be truncated if there are fewer than size elements remaining to be grouped.

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Definition Classes
IterableOps
See also

scala.collection.Iterator, method sliding

def span(p: (A) => Boolean): (collection.Iterable[A], collection.Iterable[A])

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.

p

the test predicate

returns

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

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Definition Classes
IterableOpsIterableOnceOps
Note

Reuse: After calling this method, one should discard the iterator it was called on, and use only the iterators that were returned. Using the old iterator is undefined, subject to change, and may result in changes to the new iterators as well.

def splitAt(n: Int): (collection.Iterable[A], collection.Iterable[A])

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

n

the position at which to split.

returns

a pair of iterable collections consisting of the first n elements of this iterable collection, and the other elements.

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Definition Classes
IterableOpsIterableOnceOps
Note

Reuse: After calling this method, one should discard the iterator it was called on, and use only the iterators that were returned. Using the old iterator is undefined, subject to change, and may result in changes to the new iterators as well.

def stepper[S <: Stepper[_]](implicit shape: StepperShape[A, S]): S

Returns a 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 StepperShape parameter defines the resulting Stepper type according to the element type of this collection.

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

Note that this method is overridden in subclasses and the return type is refined to S with EfficientSplit, for example 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.

Definition Classes
IterableOnce

def sum[B >: A](implicit num: math.Numeric[B]): B

Sums up the elements of this collection.

B

the result type of the + operator.

num

an implicit parameter defining a set of numeric operations which includes the + operator to be used in forming the sum.

returns

the sum of all elements of this iterable collection with respect to the + operator in num.

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Definition Classes
IterableOnceOps

final def synchronized[T0](arg0: => T0): T0

Definition Classes
AnyRef

def tail: collection.Iterable[A]

The rest of the collection without its first element.

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Definition Classes
IterableOps

def tails: collection.Iterator[collection.Iterable[A]]

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.

returns

an iterator over all the tails of this iterable collection

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Definition Classes
IterableOps
Example:

    List(1,2,3).tails = Iterator(List(1,2,3), List(2,3), List(3), Nil)

def take(n: Int): collection.Iterable[A]

Selects the first n elements.

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

n

the number of elements to take from this iterable collection.

returns

a iterable collection consisting only of the first n elements of this iterable collection, or else the whole iterable collection, if it has less than n elements. If n is negative, returns an empty iterable collection.

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Definition Classes
IterableOpsIterableOnceOps
Note

Reuse: After calling this method, one should discard the iterator it was called on, and use only the iterator that was returned. Using the old iterator is undefined, subject to change, and may result in changes to the new iterator as well.

def takeRight(n: Int): collection.Iterable[A]

Selects the last n elements.

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

n

the number of elements to take from this iterable collection.

returns

a iterable collection consisting only of the last n elements of this iterable collection, or else the whole iterable collection, if it has less than n elements. If n is negative, returns an empty iterable collection.

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Definition Classes
IterableOps

def takeWhile(p: (A) => Boolean): collection.Iterable[A]

Takes longest prefix of elements that satisfy a predicate.

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

p

The predicate used to test elements.

returns

the longest prefix of this iterable collection whose elements all satisfy the predicate p.

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Definition Classes
IterableOpsIterableOnceOps

def tapEach[U](f: (A) => U): collection.Iterable[A]

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.

U

the return type of f

f

a function to apply to each element in this iterable collection

returns

The same logical collection as this

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Definition Classes
IterableOpsIterableOnceOps

def to[C1](factory: Factory[A, C1]): C1

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

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

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Definition Classes
IterableOnceOps

def toArray[B >: A](implicit arg0: ClassTag[B]): Array[B]

Convert collection to array.

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Definition Classes
IterableOnceOps

final def toLeft[X](right: => X): Either[A, X]

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)
}
right

the expression to evaluate and return if this is empty

Annotations
@inline()
See also

toRight

def toList: List[A]

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
}

def toMap[K, V](implicit ev: <:<[A, (K, V)]): Map[K, V]

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Definition Classes
IterableOnceOps

final def toRight[X](left: => X): Either[X, A]

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)
}
left

the expression to evaluate and return if this is empty

Annotations
@inline()
See also

toLeft

def toString(): String

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

returns

a String representation of the object.

Definition Classes
AnyRef → Any

def transpose[B](implicit asIterable: (A) => collection.Iterable[B]): collection.Iterable[collection.Iterable[B]]

Transposes this iterable collection of iterable 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))

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

B

the type of the elements of each iterable collection.

asIterable

an implicit conversion which asserts that the element type of this iterable collection is an Iterable.

returns

a two-dimensional iterable collection of iterable collections which has as nth row the nth column of this iterable collection.

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Definition Classes
IterableOps
Exceptions thrown

IllegalArgumentException if all collections in this iterable collection are not of the same size.

final def unzip[A1, A2](implicit asPair: <:<[A, (A1, A2)]): (Option[A1], Option[A2])

Converts an Option of a pair into an Option of the first element and an Option of the second element.

This is equivalent to:

option match {
  case Some((x, y)) => (Some(x), Some(y))
  case _            => (None,    None)
}
A1

the type of the first half of the element pair

A2

the type of the second half of the element pair

asPair

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

returns

a pair of Options, containing, respectively, the first and second half of the element pair of this Option.

final def unzip3[A1, A2, A3](implicit asTriple: <:<[A, (A1, A2, A3)]): (Option[A1], Option[A2], Option[A3])

Converts an Option of a triple into three Options, one containing the element from each position of the triple.

This is equivalent to:

option match {
  case Some((x, y, z)) => (Some(x), Some(y), Some(z))
  case _               => (None,    None,    None)
}
A1

the type of the first of three elements in the triple

A2

the type of the second of three elements in the triple

A3

the type of the third of three elements in the triple

asTriple

an implicit conversion which asserts that the element type of this Option is a triple.

returns

a triple of Options, containing, respectively, the first, second, and third elements from the element triple of this Option.

def view: View[A]

A view over the elements of this collection.

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Definition Classes
IterableOps

final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])

final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])

final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException]) @native()

final def withFilter(p: (A) => Boolean): WithFilter

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

Annotations
@inline()

final def zip[A1 >: A, B](that: Option[B]): Option[(A1, B)]

Returns a scala.Some formed from this option and another option by combining the corresponding elements in a pair. If either of the two options is empty, None is returned.

This is equivalent to:

(option1, option2) match {
  case (Some(x), Some(y)) => Some((x, y))
  case _                  => None
}
that

the options which is going to be zipped

Example:
    // Returns Some(("foo", "bar")) because both options are nonempty.
    Some("foo") zip Some("bar")
    
    // Returns None because `that` option is empty.
    Some("foo") zip None
    
    // Returns None because `this` option is empty.
    None zip Some("bar")

def zipAll[A1 >: A, B](that: collection.Iterable[B], thisElem: A1, thatElem: B): collection.Iterable[(A1, B)]

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

that

the iterable providing the second half of each result pair

thisElem

the element to be used to fill up the result if this iterable collection is shorter than that.

thatElem

the element to be used to fill up the result if that is shorter than this iterable collection.

returns

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

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Definition Classes
IterableOps

def zipWithIndex: collection.Iterable[(A, Int)]

Zips this iterable collection with its indices.

returns

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

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Definition Classes
IterableOpsIterableOnceOps
Example:

    List("a", "b", "c").zipWithIndex == List(("a", 0), ("b", 1), ("c", 2))

Note

Reuse: After calling this method, one should discard the iterator it was called on, and use only the iterator that was returned. Using the old iterator is undefined, subject to change, and may result in changes to the new iterator as well.

Shadowed Implicit Value Members

def collect[B](pf: PartialFunction[A, B]): collection.Iterable[B]

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

B

the element type of the returned iterable collection.

pf

the partial function which filters and maps the iterable collection.

returns

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

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(option: Iterable[A]).collect(pf)
Definition Classes
IterableOpsIterableOnceOps
Note

Reuse: After calling this method, one should discard the iterator it was called on, and use only the iterator that was returned. Using the old iterator is undefined, subject to change, and may result in changes to the new iterator as well.

def count(p: (A) => Boolean): Int

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

p

the predicate used to test elements.

returns

the number of elements satisfying the predicate p.

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Shadowing
This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
To access this member you can use a type ascription:
(option: Iterable[A]).count(p)
Definition Classes
IterableOnceOps

def exists(p: (A) => Boolean): Boolean

Tests whether a predicate holds for at least one element of this iterable collection.

Note: may not terminate for infinite-sized collections.

p

the predicate used to test elements.

returns

true if the given predicate p is satisfied by at least one element of this iterable collection, otherwise false

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(option: Iterable[A]).exists(p)
Definition Classes
IterableOnceOps

def filter(pred: (A) => Boolean): collection.Iterable[A]

Selects all elements of this iterable collection which satisfy a predicate.

returns

a new iterator consisting of all elements of this iterable collection that satisfy the given predicate p. The order of the elements is preserved.

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(option: Iterable[A]).filter(pred)
Definition Classes
IterableOpsIterableOnceOps

def filterNot(pred: (A) => Boolean): collection.Iterable[A]

Selects all elements of this iterable collection which do not satisfy a predicate.

pred

the predicate used to test elements.

returns

a new iterable collection consisting of all elements of this iterable collection that do not satisfy the given predicate pred. Their order may not be preserved.

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(option: Iterable[A]).filterNot(pred)
Definition Classes
IterableOpsIterableOnceOps

def find(p: (A) => Boolean): Option[A]

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.

p

the predicate used to test elements.

returns

an option value containing the first element in the iterable collection that satisfies p, or None if none exists.

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Shadowing
This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
To access this member you can use a type ascription:
(option: Iterable[A]).find(p)
Definition Classes
IterableOnceOps

def flatMap[B](f: (A) => collection.IterableOnce[B]): collection.Iterable[B]

Builds a new iterable collection by applying a function to all elements of this iterable collection 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 iterable collection. This might cause unexpected results sometimes. For example:

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

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

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

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

the element type of the returned collection.

f

the function to apply to each element.

returns

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

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(option: Iterable[A]).flatMap(f)
Definition Classes
IterableOpsIterableOnceOps
Note

Reuse: After calling this method, one should discard the iterator it was called on, and use only the iterator that was returned. Using the old iterator is undefined, subject to change, and may result in changes to the new iterator as well.

def flatten[B](implicit asIterable: (A) => collection.IterableOnce[B]): collection.Iterable[B]

Converts this iterable collection of traversable collections into a iterable collection formed by the elements of these traversable collections.

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

the type of the elements of each traversable collection.

asIterable

an implicit conversion which asserts that the element type of this iterable collection is a GenTraversable.

returns

a new iterable collection resulting from concatenating all element iterable collections.

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(option: Iterable[A]).flatten(asIterable)
Definition Classes
IterableOpsIterableOnceOps
Note

Reuse: After calling this method, one should discard the iterator it was called on, and use only the iterator that was returned. Using the old iterator is undefined, subject to change, and may result in changes to the new iterator as well.

def fold[A1 >: A](z: A1)(op: (A1, A1) => A1): A1

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

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

Note: will not terminate for infinite-sized collections.

A1

a type parameter for the binary operator, a supertype of A.

z

a neutral element for the fold operation; may be added to the result an arbitrary number of times, and must not change the result (e.g., Nil for list concatenation, 0 for addition, or 1 for multiplication).

op

a binary operator that must be associative.

returns

the result of applying the fold operator op between all the elements and z, or z if this iterable collection is empty.

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(option: Iterable[A]).fold(z)(op)
Definition Classes
IterableOnceOps

def forall(p: (A) => Boolean): Boolean

Tests whether a predicate holds for all elements of this iterable collection.

Note: may not terminate for infinite-sized collections.

p

the predicate used to test elements.

returns

true if this iterable collection is empty or the given predicate p holds for all elements of this iterable collection, otherwise false.

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(option: Iterable[A]).forall(p)
Definition Classes
IterableOnceOps

def foreach[U](f: (A) => U): Unit

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

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(option: Iterable[A]).foreach(f)
Definition Classes
IterableOnceOps

def isEmpty: Boolean

Tests whether the iterable collection is empty.

Note: Implementations in subclasses that are not repeatedly traversable must take care not to consume any elements when isEmpty is called.

returns

true if the iterable collection contains no elements, false otherwise.

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(option: Iterable[A]).isEmpty
Definition Classes
IterableOnceOps

def iterator: collection.Iterator[A]

Iterator can be used only once

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(option: Iterable[A]).iterator
Definition Classes
IterableOnce

def knownSize: Int

returns

The number of elements in this iterable collection, if it can be cheaply computed, -1 otherwise. Cheaply usually means: Not requiring a collection traversal.

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(option: Iterable[A]).knownSize
Definition Classes
IterableOnce

def map[B](f: (A) => B): collection.Iterable[B]

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

B

the element type of the returned iterable collection.

f

the function to apply to each element.

returns

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

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(option: Iterable[A]).map(f)
Definition Classes
IterableOpsIterableOnceOps
Note

Reuse: After calling this method, one should discard the iterator it was called on, and use only the iterator that was returned. Using the old iterator is undefined, subject to change, and may result in changes to the new iterator as well.

final def mkString: String

Displays all elements of this iterable collection in a string.

Delegates to addString, which can be overridden.

returns

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

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Shadowing
This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
To access this member you can use a type ascription:
(option: Iterable[A]).mkString
Definition Classes
IterableOnceOps
Annotations
@inline()

final def mkString(sep: String): String

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

Delegates to addString, which can be overridden.

sep

the separator string.

returns

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

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Shadowing
This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
To access this member you can use a type ascription:
(option: Iterable[A]).mkString(sep)
Definition Classes
IterableOnceOps
Annotations
@inline()
Example:

    List(1, 2, 3).mkString("|") = "1|2|3"

final def mkString(start: String, sep: String, end: String): String

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

Delegates to addString, which can be overridden.

start

the starting string.

sep

the separator string.

end

the ending string.

returns

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

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Shadowing
This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
To access this member you can use a type ascription:
(option: Iterable[A]).mkString(start, sep, end)
Definition Classes
IterableOnceOps
Example:

    List(1, 2, 3).mkString("(", "; ", ")") = "(1; 2; 3)"

def nonEmpty: Boolean

Tests whether the iterable collection is not empty.

returns

true if the iterable collection contains at least one element, false otherwise.

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(option: Iterable[A]).nonEmpty
Definition Classes
IterableOnceOps
Annotations
@deprecatedOverriding("nonEmpty is defined as !isEmpty; override isEmpty instead", "2.13.0")

def size: Int

The size of this iterable collection.

Note: will not terminate for infinite-sized collections.

returns

the number of elements in this iterable collection.

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Shadowing
This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
To access this member you can use a type ascription:
(option: Iterable[A]).size
Definition Classes
IterableOnceOps

def stepper[S <: Stepper[_]](implicit shape: StepperShape[A, S]): S

Returns a 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 StepperShape parameter defines the resulting Stepper type according to the element type of this collection.

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

Note that this method is overridden in subclasses and the return type is refined to S with EfficientSplit, for example 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.

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(option: Iterable[A]).stepper(shape)
Definition Classes
IterableOnce

final def toBuffer[B >: A]: Buffer[B]

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Shadowing
This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
To access this member you can use a type ascription:
(option: Iterable[A]).toBuffer
Definition Classes
IterableOnceOps
Annotations
@inline()

def toIndexedSeq: collection.immutable.IndexedSeq[A]

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Shadowing
This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
To access this member you can use a type ascription:
(option: Iterable[A]).toIndexedSeq
Definition Classes
IterableOnceOps

final def toIterable: collection.Iterable[A]

returns

This collection as an Iterable[A]. No new collection will be built if this is already an Iterable[A].

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Shadowing
This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
To access this member you can use a type ascription:
(option: Iterable[A]).toIterable
Definition Classes
IterableIterableOps

def toList: collection.immutable.List[A]

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(option: Iterable[A]).toList
Definition Classes
IterableOnceOps

def toSeq: collection.immutable.Seq[A]

returns

This collection as a Seq[A]. This is equivalent to to(Seq) but might be faster.

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Shadowing
This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
To access this member you can use a type ascription:
(option: Iterable[A]).toSeq
Definition Classes
IterableOnceOps

def toSet[B >: A]: Set[B]

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Shadowing
This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
To access this member you can use a type ascription:
(option: Iterable[A]).toSet
Definition Classes
IterableOnceOps

def toString(): String

Converts this iterable collection to a string.

returns

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

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(option: Iterable[A]).toString()
Definition Classes
Iterable → AnyRef → Any

def toVector: collection.immutable.Vector[A]

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Shadowing
This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
To access this member you can use a type ascription:
(option: Iterable[A]).toVector
Definition Classes
IterableOnceOps

def unzip[A1, A2](implicit asPair: (A) => (A1, A2)): (collection.Iterable[A1], collection.Iterable[A2])

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

the type of the first half of the element pairs

A2

the type of the second half of the element pairs

asPair

an implicit conversion which asserts that the element type of this iterable collection is a pair.

returns

a pair of iterable collections, containing the first, respectively second half of each element pair of this iterable collection.

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(option: Iterable[A]).unzip(asPair)
Definition Classes
IterableOps

def unzip3[A1, A2, A3](implicit asTriple: (A) => (A1, A2, A3)): (collection.Iterable[A1], collection.Iterable[A2], collection.Iterable[A3])

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

asTriple

an implicit conversion which asserts that the element type of this iterable collection is a triple.

returns

a triple of iterable collections, containing the first, second, respectively third member of each element triple of this iterable collection.

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(option: Iterable[A]).unzip3(asTriple)
Definition Classes
IterableOps

def withFilter(p: (A) => Boolean): collection.WithFilter[A, collection.Iterable]

Creates a non-strict filter of this iterable collection.

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

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

p

the predicate used to test elements.

returns

an object of class WithFilter, which supports map, flatMap, foreach, and withFilter operations. All these operations apply to those elements of this iterable collection which satisfy the predicate p.

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(option: Iterable[A]).withFilter(p)
Definition Classes
IterableOps

def zip[B](that: collection.IterableOnce[B]): collection.Iterable[(A, B)]

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

B

the type of the second half of the returned pairs

that

The iterable providing the second half of each result pair

returns

a new iterable collection containing pairs consisting of corresponding elements of this iterable collection and that. The length of the returned collection is the minimum of the lengths of this iterable collection and that.

Implicit
This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
Shadowing
This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:
(option: Iterable[A]).zip(that)
Definition Classes
IterableOps

© 2002-2019 EPFL, with contributions from Lightbend.
Licensed under the Apache License, Version 2.0.
https://www.scala-lang.org/api/2.13.0/scala/Option.html