Packages

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
Note

Many of the methods in here are duplicative with those in the Iterable 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.

Known Subclasses
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Option
  2. Serializable
  3. Product
  4. Equals
  5. IterableOnce
  6. AnyRef
  7. Any
Implicitly
  1. by option2Iterable
  2. by iterableOnceExtensionMethods
  3. by any2stringadd
  4. by StringFormat
  5. by Ensuring
  6. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. class WithFilter extends AnyRef

    We need a whole WithFilter class to honor the "doesn't create a new collection" contract even though it seems unlikely to matter much in a collection with max size 1.

Abstract Value Members

  1. abstract def canEqual(that: Any): Boolean

    Checks whether this instance can possibly equal that.

    Checks whether this instance can possibly equal that.

    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
  2. abstract def get: A

    Returns the option's value.

    Returns the option's value.

    This is equivalent to:

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

    NoSuchElementException if the option is empty.

    Note

    The option must be nonempty.

  3. abstract def productArity: Int

    The size of this product.

    The size of this product.

    returns

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

    Definition Classes
    Product
  4. abstract def productElement(n: Int): Any

    The nth element of this product, 0-based.

    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

  1. final def !=(arg0: Any): Boolean

    Test two objects for inequality.

    Test two objects for inequality.

    returns

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

    Definition Classes
    AnyRef → Any
  2. final def ##: Int

    Equivalent to x.hashCode except for boxed numeric types and null.

    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
  3. 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
  4. final def ++[B >: A](suffix: collection.IterableOnce[B]): collection.Iterable[B]

    Alias for concat

    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()
  5. 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()
  6. final def ==(arg0: Any): Boolean

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

    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
  7. final def addString(b: collection.mutable.StringBuilder): b.type

    Appends all elements of this iterable collection to a string builder.

    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()
  8. final def addString(b: collection.mutable.StringBuilder, sep: String): b.type

    Appends all elements of this iterable collection to a string builder using a separator string.

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

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

    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
  10. final def asInstanceOf[T0]: T0

    Forces the compiler to treat the receiver object as having type T0, even though doing so may violate type safety.

    Forces the compiler to treat the receiver object as having type T0, even though doing so may violate type safety.

    This method is useful when you believe you have type information the compiler doesn't, and it also isn't possible to check the type at runtime. In such situations, skipping type safety is the only option.

    It is platform dependent whether asInstanceOf has any effect at runtime. It might do a runtime type test on the erasure of T0, insert a conversion (such as boxing/unboxing), fill in a default value, or do nothing at all.

    In particular, asInstanceOf is not a type test. It does **not** mean:

    this match {
     case x: T0 => x
     case _     => throw ClassCastException("...")

    Use pattern matching or isInstanceOf for type testing instead.

    Situations where asInstanceOf is useful:

    • when flow analysis fails to deduce T0 automatically
    • when down-casting a type parameter or an abstract type member (which cannot be checked at runtime due to type erasure) If there is any doubt and you are able to type test instead, you should do so.

    Be careful of using asInstanceOf when T0 is a primitive type. When T0 is primitive, asInstanceOf may insert a conversion instead of a type test. If your intent is to convert, use a toT method (x.toChar, x.toByte, etc.).

    returns

    the receiver object.

    Definition Classes
    Any
    Exceptions thrown

    ClassCastException if the receiver is not an instance of the erasure of T0, if that can be checked on this platform

  11. def clone(): AnyRef

    Create a copy of the receiver object.

    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[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
    Note

    not specified by SLS as a member of AnyRef

  12. 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 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:
    1. // 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}
  13. 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.

    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:
    1. Seq("a", 1, 5L).collectFirst({ case x: Int => x*10 }) = Some(10)

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

    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 iterable 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
  15. final def contains[A1 >: A](elem: A1): Boolean

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

    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:
    1. // 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"
  16. def copyToArray[B >: A](xs: Array[B], start: Int, len: Int): Int

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

    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.

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

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

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

    Fills the given array 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

    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
    @deprecatedOverriding()
    Note

    Reuse: After calling this method, one should discard the iterator it was called on. Using it is undefined and subject to change.

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

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

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

    Fills the given array 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

    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
    @deprecatedOverriding()
    Note

    Reuse: After calling this method, one should discard the iterator it was called on. Using it is undefined and subject to change.

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

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

    Note: will not terminate for infinite-sized collections.

    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
  20. def drop(n: Int): collection.Iterable[A]

    Selects all elements except the first n ones.

    Selects all elements except the first n ones.

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

    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
  21. def dropRight(n: Int): collection.Iterable[A]

    Selects all elements except last n ones.

    Selects all elements except last n ones.

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

    n

    the number of elements to 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
  22. def dropWhile(p: (A) => Boolean): collection.Iterable[A]

    Selects all elements except the longest prefix that satisfies a predicate.

    Selects all elements except the longest prefix that satisfies a predicate.

    The matching prefix starts with the first element of this iterable collection, and the element following the prefix is the first element that does not satisfy the predicate. The matching prefix may be empty, so that this method returns the entire iterable collection.

    Example:

    scala> List(1, 2, 3, 100, 4).dropWhile(n => n < 10)
    val res0: List[Int] = List(100, 4)
    
    scala> List(1, 2, 3, 100, 4).dropWhile(n => n == 0)
    val res1: List[Int] = List(1, 2, 3, 100, 4)

    Use span to obtain both the prefix and suffix. Use filterNot to drop all elements that satisfy the predicate.

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

    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
  23. def empty: collection.Iterable[A]

    The empty iterable of the same type as this iterable.

    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
  24. 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
  25. 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
  26. 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
  27. 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
  28. final def eq(arg0: AnyRef): Boolean

    Tests whether the argument (that) is a reference to the receiver object (this).

    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
  29. def equals(arg0: AnyRef): Boolean

    The equality method for reference types.

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

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

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

    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()
  33. def finalize(): Unit

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

    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[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
    Note

    not specified by SLS as a member of AnyRef

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

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

    Returns the nested scala.Option value if it is nonempty.

    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:
    1. Some(Some("something")).flatten
    See also

    flatMap

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

    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()
  37. def foldLeft[B](z: B)(op: (B, A) => B): B

    Applies the given binary operator op to the given initial value z and all elements of this iterable collection, going left to right.

    Applies the given binary operator op to the given initial value z and all elements of this iterable collection, going left to right. Returns the initial value if this iterable collection is empty.

    "Going left to right" only makes sense if this collection is ordered: then if x1, x2, ..., xn are the elements of this iterable collection, the result is op( op( ... op( op(z, x1), x2) ... ), xn).

    If this collection is not ordered, then for each application of the operator, each right operand is an element. In addition, the leftmost operand is the initial value, and each other left operand is itself an application of the operator. The elements of this iterable collection and the initial value all appear exactly once in the computation.

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

    Note: will not terminate for infinite-sized collections.

    B

    The result type of the binary operator.

    z

    An initial value.

    op

    A binary operator.

    returns

    The result of applying op to z and all elements of this iterable collection, going left to right. 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
  38. def foldRight[B](z: B)(op: (A, B) => B): B

    Applies the given binary operator op to all elements of this iterable collection and the given initial value z, going right to left.

    Applies the given binary operator op to all elements of this iterable collection and the given initial value z, going right to left. Returns the initial value if this iterable collection is empty.

    "Going right to left" only makes sense if this collection is ordered: then if x1, x2, ..., xn are the elements of this iterable collection, the result is op(x1, op(x2, op( ... op(xn, z) ... ))).

    If this collection is not ordered, then for each application of the operator, each left operand is an element. In addition, the rightmost operand is the initial value, and each other right operand is itself an application of the operator. The elements of this iterable collection and the initial value all appear exactly once in the computation.

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

    Note: will not terminate for infinite-sized collections.

    B

    The result type of the binary operator.

    z

    An initial value.

    op

    A binary operator.

    returns

    The result of applying op to all elements of this iterable collection and z, going right to left. 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
  39. 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.

    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()
  40. final def foreach[U](f: (A) => U): Unit

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

    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

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

    Returns the runtime class representation of the object.

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

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

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

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

    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 f function and then reduced into a single value with the reduce function.

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

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

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

    Implicit
    This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
    Definition Classes
    IterableOps
  46. def grouped(size: Int): collection.Iterator[collection.Iterable[A]]

    Partitions elements in fixed size iterable collections.

    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

  47. def hashCode(): Int

    The hashCode method for reference types.

    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()
  48. def head: A

    Selects the first element of this iterable collection.

    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.

  49. def headOption: Option[A]

    Optionally selects the first element.

    Optionally selects the first element.

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

    returns

    the first element of this 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
  50. def init: collection.Iterable[A]

    The initial part of the collection without its last element.

    The initial part of the collection without its last element.

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

    Implicit
    This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
    Definition Classes
    IterableOps
  51. def inits: collection.Iterator[collection.Iterable[A]]

    Iterates over the inits of this iterable collection.

    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:
    1. List(1,2,3).inits = Iterator(List(1,2,3), List(1,2), List(1), Nil)

  52. final def isDefined: Boolean

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

    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
    }
  53. final def isEmpty: Boolean

    Returns true if the option is None, false otherwise.

    Returns true if the option is None, false otherwise.

    This is equivalent to:

    option match {
      case Some(_) => false
      case None    => true
    }
  54. final def isInstanceOf[T0]: Boolean

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

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

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

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

    This is exactly equivalent to the type pattern _: T0

    returns

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

    Definition Classes
    Any
    Note

    due to the unexpectedness of List(1, 2, 3).isInstanceOf[List[String]] returning true and x.isInstanceOf[A] where A is a type parameter or abstract member returning true, these forms issue a warning.

  55. def isTraversableAgain: Boolean

    Tests whether this iterable collection can be repeatedly traversed.

    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
  56. def iterableFactory: IterableFactory[collection.Iterable]

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

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

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

    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
  58. final def knownSize: Int

    The number of elements in this option, if it can be cheaply computed, -1 otherwise.

    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
  59. def last: A

    Selects the last element.

    Selects the last element.

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

    returns

    The last element of this 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.

  60. def lastOption: Option[A]

    Optionally selects the last element.

    Optionally selects the last element.

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

    returns

    the last element of this 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
  61. 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.

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

    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

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

    Finds the largest element.

    Finds the largest element.

    Note: will not terminate for infinite-sized collections.

    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.

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

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

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

    Note: will not terminate for infinite-sized collections.

    B

    The result type of the function f.

    f

    The measuring function.

    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.

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

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

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

    Note: will not terminate for infinite-sized collections.

    B

    The result type of the function f.

    f

    The measuring function.

    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
  66. def maxOption[B >: A](implicit ord: math.Ordering[B]): Option[A]

    Finds the largest element.

    Finds the largest element.

    Note: will not terminate for infinite-sized collections.

    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
  67. def min[B >: A](implicit ord: math.Ordering[B]): A

    Finds the smallest element.

    Finds the smallest element.

    Note: will not terminate for infinite-sized collections.

    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.

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

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

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

    Note: will not terminate for infinite-sized collections.

    B

    The result type of the function f.

    f

    The measuring function.

    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.

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

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

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

    Note: will not terminate for infinite-sized collections.

    B

    The result type of the function f.

    f

    The measuring function.

    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
  70. def minOption[B >: A](implicit ord: math.Ordering[B]): Option[A]

    Finds the smallest element.

    Finds the smallest element.

    Note: will not terminate for infinite-sized collections.

    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
  71. final def ne(arg0: AnyRef): Boolean

    Equivalent to !(this eq that).

    Equivalent to !(this eq that).

    returns

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

    Definition Classes
    AnyRef
  72. final def nonEmpty: Boolean

    Returns false if the option is None, true otherwise.

    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.

  73. final def notify(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @native()
    Note

    not specified by SLS as a member of AnyRef

  74. final def notifyAll(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @native()
    Note

    not specified by SLS as a member of AnyRef

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

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

    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:
    1. val initialText: Option[String] = getInitialText
      val textField = new JComponent(initialText.orNull,20)
  77. 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.

    A pair of, first, all elements that satisfy predicate p and, second, all elements that do not.

    The two iterable collection correspond to the result of filter and filterNot, respectively.

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

    Implicit
    This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
    Definition Classes
    IterableOps
  78. 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.

    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
  79. def product[B >: A](implicit num: math.Numeric[B]): B

    Multiplies together the elements of this collection.

    Multiplies together the elements of this collection.

    The default implementation uses reduce for a known non-empty collection, foldLeft otherwise.

    Note: will not terminate for infinite-sized collections.

    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
  80. def productElementName(n: Int): String

    The name of the nth element of this product, 0-based.

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

  81. def productElementNames: Iterator[String]

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

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

    Definition Classes
    Product
  82. def productIterator: Iterator[Any]

    An iterator over all the elements of this product.

    An iterator over all the elements of this product.

    returns

    in the default implementation, an Iterator[Any]

    Definition Classes
    Product
  83. def productPrefix: String

    A string used in the toString methods of derived classes.

    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
  84. def reduce[B >: A](op: (B, B) => B): B

    Applies the given binary operator op to all elements of this iterable collection.

    Applies the given binary operator op to all elements of this iterable collection.

    For each application of the operator, each operand is either an element of this iterable collection or another such application of the operator. The order of applications of the operator is unspecified and may be nondeterministic. Each element appears exactly once in the computation.

    If this collection is ordered, then for any application of the operator, the element(s) appearing in the left operand will precede those in the right.

    Note: might return different results for different runs, unless either of the following conditions is met: (1) the operator is associative, and the underlying collection type is ordered; or (2) the operator is associative and commutative.

    Note: will not terminate for infinite-sized collections.

    B

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

    op

    A binary operator; must be associative for the result to always be the same across runs.

    returns

    The result of applying 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.

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

    Applies the given binary operator op to all elements of this iterable collection, going left to right.

    Applies the given binary operator op to all elements of this iterable collection, going left to right.

    "Going left to right" only makes sense if this collection is ordered: then if x1, x2, ..., xn are the elements of this iterable collection, the result is op( op( op( ... op(x1, x2) ... ), xn-1), xn).

    If this collection is not ordered, then for each application of the operator, each right operand is an element. In addition, the leftmost operand is the first element of this iterable collection and each other left operand is itself an application of the operator. Each element appears exactly once in the computation.

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

    Note: will not terminate for infinite-sized collections.

    B

    The result type of the binary operator, a supertype of A.

    op

    A binary operator.

    returns

    The result of applying op to all elements of this iterable collection, going left to right.

    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.

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

    If this iterable collection is nonempty, reduces it with the given binary operator op, going left to right.

    If this iterable collection is nonempty, reduces it with the given binary operator op, going left to right.

    The behavior is the same as reduceLeft except that the value is None if the iterable collection is empty. Each element appears exactly once in the computation.

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

    Note: will not terminate for infinite-sized collections.

    B

    The result type of the binary operator, a supertype of A.

    op

    A binary operator.

    returns

    The result of reducing this iterable collection with op going left to right if the iterable collection is nonempty, inside a Some, 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
  87. def reduceOption[B >: A](op: (B, B) => B): Option[B]

    If this iterable collection is nonempty, reduces it with the given binary operator op.

    If this iterable collection is nonempty, reduces it with the given binary operator op.

    The behavior is the same as reduce except that the value is None if the iterable collection is empty. The order of applications of the operator is unspecified and may be nondeterministic. Each element appears exactly once in the computation.

    Note: might return different results for different runs, unless either of the following conditions is met: (1) the operator is associative, and the underlying collection type is ordered; or (2) the operator is associative and commutative.

    Note: will not terminate for infinite-sized collections.

    B

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

    op

    A binary operator; must be associative for the result to always be the same across runs.

    returns

    The result of reducing this iterable collection with op if the iterable collection is nonempty, inside a Some, 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
  88. def reduceRight[B >: A](op: (A, B) => B): B

    Applies the given binary operator op to all elements of this iterable collection, going right to left.

    Applies the given binary operator op to all elements of this iterable collection, going right to left.

    "Going right to left" only makes sense if this collection is ordered: then if x1, x2, ..., xn are the elements of this iterable collection, the result is op(x1, op(x2, op( ... op(xn-1, xn) ... ))).

    If this collection is not ordered, then for each application of the operator, each left operand is an element. In addition, the rightmost operand is the last element of this iterable collection and each other right operand is itself an application of the operator. Each element appears exactly once in the computation.

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

    Note: will not terminate for infinite-sized collections.

    B

    The result type of the binary operator, a supertype of A.

    op

    A binary operator.

    returns

    The result of applying op to all elements of this iterable collection, going right to left.

    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.

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

    If this iterable collection is nonempty, reduces it with the given binary operator op, going right to left.

    If this iterable collection is nonempty, reduces it with the given binary operator op, going right to left.

    The behavior is the same as reduceRight except that the value is None if the iterable collection is empty. Each element appears exactly once in the computation.

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

    Note: will not terminate for infinite-sized collections.

    B

    The result type of the binary operator, a supertype of A.

    op

    A binary operator.

    returns

    The result of reducing this iterable collection with op going right to left if the iterable collection is nonempty, inside a Some, 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
  90. def scan[B >: A](z: B)(op: (B, B) => B): collection.Iterable[B]

    Computes a prefix scan of the elements of the collection.

    Computes a prefix scan of the elements of the collection.

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

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

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

    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
  93. def sizeCompare(that: collection.Iterable[_]): Int

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

    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
  94. def sizeCompare(otherSize: Int): Int

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

    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

  95. final def sizeIs: SizeCompareOps

    Returns a value class containing operations for comparing the size of this iterable collection to a test value.

    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()
  96. def slice(from: Int, until: Int): collection.Iterable[A]

    Selects an interval of elements.

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

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

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

    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 smaller 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
    Examples:
    1. List(1, 2, 3, 4, 5).sliding(2, 2) = Iterator(List(1, 2), List(3, 4), List(5))

    2. ,
    3. List(1, 2, 3, 4, 5, 6).sliding(2, 3) = Iterator(List(1, 2), List(4, 5))

    See also

    scala.collection.Iterator, method sliding

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

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

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

    size

    the number of elements per group

    returns

    An iterator producing iterable collections of size size, except for a non-empty collection with less than size elements, which returns an iterator that produces the source collection itself as its only 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
    Examples:
    1. List().sliding(2) = empty iterator

    2. ,
    3. List(1).sliding(2) = Iterator(List(1))

    4. ,
    5. List(1, 2).sliding(2) = Iterator(List(1, 2))

    6. ,
    7. List(1, 2, 3).sliding(2) = Iterator(List(1, 2), List(2, 3))

    See also

    scala.collection.Iterator, method sliding

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

    Splits this iterable collection into a prefix/suffix pair according to a predicate.

    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
  100. def splitAt(n: Int): (collection.Iterable[A], collection.Iterable[A])

    Splits this iterable collection into a prefix/suffix pair at a given position.

    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
  101. def stepper[S <: Stepper[_]](implicit shape: StepperShape[A, S]): S

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

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

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

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

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

    Definition Classes
    IterableOnce
  102. def sum[B >: A](implicit num: math.Numeric[B]): B

    Sums the elements of this collection.

    Sums the elements of this collection.

    The default implementation uses reduce for a known non-empty collection, foldLeft otherwise.

    Note: will not terminate for infinite-sized collections.

    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
  103. final def synchronized[T0](arg0: => T0): T0

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

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

    returns

    the result of body

    Definition Classes
    AnyRef
  104. def tail: collection.Iterable[A]

    The rest of the collection without its first element.

    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
  105. def tails: collection.Iterator[collection.Iterable[A]]

    Iterates over the tails of this iterable collection.

    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:
    1. List(1,2,3).tails = Iterator(List(1,2,3), List(2,3), List(3), Nil)

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

    Selects the first n elements.

    Selects the first n elements.

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

    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
  107. def takeRight(n: Int): collection.Iterable[A]

    Selects the last n elements.

    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
  108. def takeWhile(p: (A) => Boolean): collection.Iterable[A]

    Takes longest prefix of elements that satisfy a predicate.

    Takes longest prefix of elements that satisfy a predicate.

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

    p

    The predicate used to test elements.

    returns

    the longest prefix of this 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
  109. def tapEach[U](f: (A) => U): collection.Iterable[A]

    Applies a side-effecting function to each element in this collection.

    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
  110. def to[C1](factory: Factory[A, C1]): C1

    Given a collection factory factory, converts this iterable collection to the appropriate representation for the current element type A.

    Given a collection factory factory, converts this iterable 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
  111. def toArray[B >: A](implicit arg0: ClassTag[B]): Array[B]

    Converts this iterable collection to an Array.

    Converts this iterable collection to an Array.

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

    B

    The type of elements of the result, a supertype of A.

    returns

    This iterable collection as an Array[B].

    Implicit
    This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
    Definition Classes
    IterableOnceOps
  112. 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.

    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

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

    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
    }
  114. def toMap[K, V](implicit ev: <:<[A, (K, V)]): Map[K, V]

    Converts this iterable collection to a Map, given an implicit coercion from the iterable collection's type to a key-value tuple.

    Converts this iterable collection to a Map, given an implicit coercion from the iterable collection's type to a key-value tuple.

    K

    The key type for the resulting map.

    V

    The value type for the resulting map.

    ev

    An implicit coercion from A to [K, V].

    returns

    This iterable collection as a 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
  115. 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.

    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

  116. def toString(): String

    Creates a String representation of this object.

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

    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.

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

    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.

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

    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.

  120. def view: View[A]

    A view over the elements of this collection.

    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
  121. final def wait(): Unit

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

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

    not specified by SLS as a member of AnyRef

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

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

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

    not specified by SLS as a member of AnyRef

  123. final def wait(arg0: Long): Unit

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

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

    not specified by SLS as a member of AnyRef

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

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

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

    Annotations
    @inline()
  125. 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.

    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:
    1. // 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")
  126. 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.

    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
  127. def zipWithIndex: collection.Iterable[(A, Int)]

    Zips this iterable collection with its indices.

    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:
    1. List("a", "b", "c").zipWithIndex == List(("a", 0), ("b", 1), ("c", 2))

Shadowed Implicit Value Members

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

    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
  2. def count(p: (A) => Boolean): Int

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

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

    Note: will not terminate for infinite-sized collections.

    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
  3. def exists(p: (A) => Boolean): Boolean

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

    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
  4. def filter(pred: (A) => Boolean): collection.Iterable[A]

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

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

    returns

    a new iterable collection 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
  5. def filterNot(pred: (A) => Boolean): collection.Iterable[A]

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

    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
  6. def find(p: (A) => Boolean): Option[A]

    Finds the first element of the iterable collection satisfying a predicate, if any.

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

    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
  8. def flatten[B](implicit asIterable: (A) => collection.IterableOnce[B]): collection.Iterable[B]

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

    Converts this iterable collection of iterable collections into a iterable collection formed by the elements of these iterable 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 iterable collection.

    asIterable

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

    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
  9. def fold[A1 >: A](z: A1)(op: (A1, A1) => A1): A1

    Applies the given binary operator op to the given initial value z and all elements of this iterable collection.

    Applies the given binary operator op to the given initial value z and all elements of this iterable collection.

    For each application of the operator, each operand is either an element of this iterable collection, the initial value, or another such application of the operator.

    The order of applications of the operator is unspecified and may be nondeterministic. Each element appears exactly once in the computation. The initial value may be used an arbitrary number of times, but at least once.

    If this collection is ordered, then for any application of the operator, the element(s) appearing in the left operand will precede those in the right.

    Note: might return different results for different runs, unless either of the following conditions is met: (1) the operator is associative, and the underlying collection type is ordered; or (2) the operator is associative and commutative. In either case, it is also necessary that the initial value be a neutral value for the operator, e.g. Nil for List concatenation or 1 for multiplication.

    The default implementation in IterableOnce is equivalent to foldLeft but may be overridden for more efficient traversal orders.

    Note: will not terminate for infinite-sized collections.

    A1

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

    z

    An initial value; may be used an arbitrary number of times in the computation of the result; must be a neutral value for op for the result to always be the same across runs.

    op

    A binary operator; must be associative for the result to always be the same across runs.

    returns

    The result of applying 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
  10. def forall(p: (A) => Boolean): Boolean

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

    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
  11. def foreach[U](f: (A) => U): Unit

    Applies f to each element for its side effects.

    Applies 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
  12. def isEmpty: Boolean

    Tests whether the iterable collection is empty.

    Tests whether the iterable collection is empty.

    Note: The default implementation creates and discards an iterator.

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

    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
  13. def iterator: collection.Iterator[A]

    An scala.collection.Iterator over the elements of this iterable collection.

    An scala.collection.Iterator over the elements of this iterable collection.

    If an IterableOnce object is in fact an scala.collection.Iterator, this method always returns itself, in its current state, but if it is an scala.collection.Iterable, this method always returns a new scala.collection.Iterator.

    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
  14. def knownSize: Int

    The number of elements in this iterable collection, if it can be cheaply computed, -1 otherwise.

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

    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
  16. final def mkString: String

    Displays all elements of this iterable collection in a 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()
  17. final def mkString(sep: String): String

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

    Displays all elements of this iterable collection in a string using 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:
    1. List(1, 2, 3).mkString("|") = "1|2|3"

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

    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:
    1. List(1, 2, 3).mkString("(", "; ", ")") = "(1; 2; 3)"

  19. def nonEmpty: Boolean

    Tests whether the iterable collection is not empty.

    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()
  20. def size: Int

    The size of this iterable collection.

    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
  21. def stepper[S <: Stepper[_]](implicit shape: StepperShape[A, S]): S

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

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

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

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

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

    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
  22. final def toBuffer[B >: A]: Buffer[B]

    Converts this iterable collection to a Buffer.

    Converts this iterable collection to a Buffer.

    B

    The type of elements of the result, a supertype of A.

    returns

    This iterable collection as 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()
  23. def toIndexedSeq: collection.immutable.IndexedSeq[A]

    Converts this iterable collection to an IndexedSeq.

    Converts this iterable collection to an IndexedSeq.

    returns

    This iterable collection as an 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
  24. def toList: collection.immutable.List[A]

    Converts this iterable collection to a List.

    Converts this iterable collection to a List.

    returns

    This iterable collection as a 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
  25. def toSeq: collection.immutable.Seq[A]

    returns

    This iterable 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
  26. def toSet[B >: A]: Set[B]

    Converts this iterable collection to a Set.

    Converts this iterable collection to a Set.

    B

    The type of elements of the result, a supertype of A.

    returns

    This iterable collection as 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
  27. def toString(): String

    Converts this iterable collection to a 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
  28. def toVector: collection.immutable.Vector[A]

    Converts this iterable collection to a Vector.

    Converts this iterable collection to a Vector.

    returns

    This iterable collection as a 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
  29. 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.

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

    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
  31. def withFilter(p: (A) => Boolean): collection.WithFilter[A, collection.Iterable]

    Creates a non-strict filter of this iterable collection.

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

    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

Deprecated Value Members

  1. def ++:[B >: A](that: collection.IterableOnce[B]): collection.Iterable[B]
    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
    @deprecated
    Deprecated

    (Since version 2.13.0) Use ++ instead of ++: for collections of type Iterable

  2. final def /:[B](z: B)(op: (B, A) => B): B
    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
    @deprecated @inline()
    Deprecated

    (Since version 2.13.0) Use foldLeft instead of /:

  3. def /:[B](z: B)(op: (B, A) => B): B
    Implicit
    This member is added by an implicit conversion from Option[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.13.0) Use .iterator.foldLeft instead

  4. final def :\[B](z: B)(op: (A, B) => B): B
    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
    @deprecated @inline()
    Deprecated

    (Since version 2.13.0) Use foldRight instead of :\

  5. def :\[B](z: B)(op: (A, B) => B): B
    Implicit
    This member is added by an implicit conversion from Option[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.13.0) Use .iterator.foldRight instead

  6. def aggregate[B](z: => B)(seqop: (B, A) => B, combop: (B, B) => B): B

    Aggregates the results of applying an operator to subsequent elements.

    Aggregates the results of applying an operator to subsequent elements.

    Since this method degenerates to foldLeft for sequential (non-parallel) collections, where the combining operation is ignored, it is advisable to prefer foldLeft for that case.

    For parallel collections, use the aggregate method specified by scala.collection.parallel.ParIterableLike.

    B

    the result type, produced by seqop, combop, and by this function as a final result.

    z

    the start value, a neutral element for seqop.

    seqop

    the binary operator used to accumulate the result.

    combop

    an associative operator for combining sequential results, unused for sequential 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
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) For sequential collections, prefer foldLeft(z)(seqop). For parallel collections, use ParIterableLike#aggregate.

  7. def collectFirst[B](f: PartialFunction[A, B]): Option[B]
    Implicit
    This member is added by an implicit conversion from Option[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .iterator.collectFirst(...) instead

  8. def companion: IterableFactory[collection.Iterable]
    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
    @deprecated @deprecatedOverriding() @inline()
    Deprecated

    (Since version 2.13.0) Use iterableFactory instead

  9. final def copyToBuffer[B >: A](dest: Buffer[B]): Unit
    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
    @deprecated @inline()
    Deprecated

    (Since version 2.13.0) Use dest ++= coll instead

  10. def copyToBuffer(dest: Buffer[A]): Unit
    Implicit
    This member is added by an implicit conversion from Option[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .iterator.copyToBuffer(...) instead

  11. def count(f: (A) => Boolean): Int
    Implicit
    This member is added by an implicit conversion from Option[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    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: IterableOnceExtensionMethods[A]).count(f)
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .iterator.count(...) instead

  12. def exists(f: (A) => Boolean): Boolean
    Implicit
    This member is added by an implicit conversion from Option[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    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: IterableOnceExtensionMethods[A]).exists(f)
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .iterator.exists(...) instead

  13. def filter(f: (A) => Boolean): collection.Iterator[A]
    Implicit
    This member is added by an implicit conversion from Option[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    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: IterableOnceExtensionMethods[A]).filter(f)
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .iterator.filter(...) instead

  14. def find(p: (A) => Boolean): Option[A]
    Implicit
    This member is added by an implicit conversion from Option[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    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: IterableOnceExtensionMethods[A]).find(p)
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .iterator.find instead

  15. def flatMap[B](f: (A) => collection.IterableOnce[B]): collection.IterableOnce[B]
    Implicit
    This member is added by an implicit conversion from Option[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    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: IterableOnceExtensionMethods[A]).flatMap(f)
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .iterator.flatMap instead or consider requiring an Iterable

  16. def fold[A1 >: A](z: A1)(op: (A1, A1) => A1): A1
    Implicit
    This member is added by an implicit conversion from Option[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    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: IterableOnceExtensionMethods[A]).fold(z)(op)
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .iterator.fold instead

  17. def foldLeft[B](z: B)(op: (B, A) => B): B
    Implicit
    This member is added by an implicit conversion from Option[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.13.0) Use .iterator.foldLeft instead

  18. def foldRight[B](z: B)(op: (A, B) => B): B
    Implicit
    This member is added by an implicit conversion from Option[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.13.0) Use .iterator.foldRight instead

  19. def forall(f: (A) => Boolean): Boolean
    Implicit
    This member is added by an implicit conversion from Option[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    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: IterableOnceExtensionMethods[A]).forall(f)
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .iterator.forall(...) instead

  20. def foreach[U](f: (A) => U): Unit
    Implicit
    This member is added by an implicit conversion from Option[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    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: IterableOnceExtensionMethods[A]).foreach(f)
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.13.0) Use .iterator.foreach(...) instead

  21. def formatted(fmtstr: String): String

    Returns string formatted according to given format 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
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  22. def hasDefiniteSize: Boolean

    Tests whether this iterable collection is known to have a finite size.

    Tests whether this iterable collection is known to have a finite size. All strict collections are known to have finite size. For a non-strict collection such as Stream, the predicate returns true if all elements have been computed. It returns false if the stream is not yet evaluated to the end. Non-empty Iterators usually return false even if they were created from a collection with a known finite size.

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

    returns

    true if this collection is known to have finite size, 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
    IterableOnceOps
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Check .knownSize instead of .hasDefiniteSize for more actionable information (see scaladoc for details)

    See also

    method knownSize for a more useful alternative

  23. def isEmpty: Boolean
    Implicit
    This member is added by an implicit conversion from Option[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    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: IterableOnceExtensionMethods[A]).isEmpty
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .iterator.isEmpty instead

  24. def map[B](f: (A) => B): collection.IterableOnce[B]
    Implicit
    This member is added by an implicit conversion from Option[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    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: IterableOnceExtensionMethods[A]).map(f)
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .iterator.map instead or consider requiring an Iterable

  25. def max(implicit ord: math.Ordering[A]): A
    Implicit
    This member is added by an implicit conversion from Option[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .iterator.max instead

  26. def maxBy[B](f: (A) => B)(implicit cmp: math.Ordering[B]): A
    Implicit
    This member is added by an implicit conversion from Option[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .iterator.maxBy(...) instead

  27. def min(implicit ord: math.Ordering[A]): A
    Implicit
    This member is added by an implicit conversion from Option[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .iterator.min instead

  28. def minBy[B](f: (A) => B)(implicit cmp: math.Ordering[B]): A
    Implicit
    This member is added by an implicit conversion from Option[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .iterator.minBy(...) instead

  29. def mkString: String
    Implicit
    This member is added by an implicit conversion from Option[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    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: IterableOnceExtensionMethods[A]).mkString
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .iterator.mkString instead

  30. def mkString(sep: String): String
    Implicit
    This member is added by an implicit conversion from Option[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    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: IterableOnceExtensionMethods[A]).mkString(sep)
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .iterator.mkString instead

  31. def mkString(start: String, sep: String, end: String): String
    Implicit
    This member is added by an implicit conversion from Option[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    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: IterableOnceExtensionMethods[A]).mkString(start, sep, end)
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .iterator.mkString instead

  32. def nonEmpty: Boolean
    Implicit
    This member is added by an implicit conversion from Option[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    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: IterableOnceExtensionMethods[A]).nonEmpty
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .iterator.nonEmpty instead

  33. def product(implicit num: math.Numeric[A]): A
    Implicit
    This member is added by an implicit conversion from Option[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .iterator.product instead

  34. def reduce(f: (A, A) => A): A
    Implicit
    This member is added by an implicit conversion from Option[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .iterator.reduce(...) instead

  35. def reduceLeft(f: (A, A) => A): A
    Implicit
    This member is added by an implicit conversion from Option[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .iterator.reduceLeft(...) instead

  36. def reduceLeftOption(f: (A, A) => A): Option[A]
    Implicit
    This member is added by an implicit conversion from Option[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .iterator.reduceLeftOption(...) instead

  37. def reduceOption(f: (A, A) => A): Option[A]
    Implicit
    This member is added by an implicit conversion from Option[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .iterator.reduceOption(...) instead

  38. def reduceRight(f: (A, A) => A): A
    Implicit
    This member is added by an implicit conversion from Option[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .iterator.reduceRight(...) instead

  39. def reduceRightOption(f: (A, A) => A): Option[A]
    Implicit
    This member is added by an implicit conversion from Option[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .iterator.reduceRightOption(...) instead

  40. final def repr: collection.Iterable[A]
    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
    @deprecated
    Deprecated

    (Since version 2.13.0) Use coll instead of repr in a collection implementation, use the collection value itself from the outside

  41. def sameElements[B >: A](that: collection.IterableOnce[B]): Boolean
    Implicit
    This member is added by an implicit conversion from Option[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .iterator.sameElements instead

  42. def seq: collection.Iterable[A]
    Implicit
    This member is added by an implicit conversion from Option[A] toIterable[A] performed by method option2Iterable in scala.Option.
    Definition Classes
    Iterable
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Iterable.seq always returns the iterable itself

  43. def size: Int
    Implicit
    This member is added by an implicit conversion from Option[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    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: IterableOnceExtensionMethods[A]).size
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .iterator.size instead

  44. def sum(implicit num: math.Numeric[A]): A
    Implicit
    This member is added by an implicit conversion from Option[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .iterator.sum instead

  45. def to[C1](factory: Factory[A, C1]): C1
    Implicit
    This member is added by an implicit conversion from Option[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .iterator.to(factory) instead

  46. def toArray[B >: A](implicit arg0: ClassTag[B]): Array[B]
    Implicit
    This member is added by an implicit conversion from Option[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .iterator.toArray

  47. def toBuffer[B >: A]: Buffer[B]
    Implicit
    This member is added by an implicit conversion from Option[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    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: IterableOnceExtensionMethods[A]).toBuffer
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .iterator.to(ArrayBuffer) instead

  48. def toIndexedSeq: collection.IndexedSeq[A]
    Implicit
    This member is added by an implicit conversion from Option[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    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: IterableOnceExtensionMethods[A]).toIndexedSeq
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .iterator.toIndexedSeq instead

  49. 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
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.7) toIterable is internal and will be made protected; its name is similar to toList or toSeq, but it doesn't copy non-immutable collections

  50. final def toIterable: collection.Iterable[A]
    Implicit
    This member is added by an implicit conversion from Option[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    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: IterableOnceExtensionMethods[A]).toIterable
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.13.0) Use .iterator.to(Iterable) instead

  51. final def toIterator: collection.Iterator[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]).toIterator
    Definition Classes
    IterableOnceOps
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.13.0) Use .iterator instead of .toIterator

  52. def toIterator: collection.Iterator[A]
    Implicit
    This member is added by an implicit conversion from Option[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    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: IterableOnceExtensionMethods[A]).toIterator
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.13.0) Use .iterator instead

  53. def toList: collection.immutable.List[A]
    Implicit
    This member is added by an implicit conversion from Option[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    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: IterableOnceExtensionMethods[A]).toList
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .iterator.to(List) instead

  54. def toMap[K, V](implicit ev: <:<[A, (K, V)]): Map[K, V]
    Implicit
    This member is added by an implicit conversion from Option[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .iterator.to(Map) instead

  55. def toSeq: collection.immutable.Seq[A]
    Implicit
    This member is added by an implicit conversion from Option[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    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: IterableOnceExtensionMethods[A]).toSeq
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.13.0) Use .iterator.to(Seq) instead

  56. def toSet[B >: A]: Set[B]
    Implicit
    This member is added by an implicit conversion from Option[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    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: IterableOnceExtensionMethods[A]).toSet
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.13.0) Use .iterator.to(Set) instead

  57. final def toStream: collection.immutable.Stream[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]).toStream
    Definition Classes
    IterableOnceOps
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.13.0) Use .to(LazyList) instead of .toStream

  58. def toStream: collection.immutable.Stream[A]
    Implicit
    This member is added by an implicit conversion from Option[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    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: IterableOnceExtensionMethods[A]).toStream
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.13.0) Use .iterator.to(LazyList) instead

  59. final def toTraversable: collection.Traversable[A]

    Converts this iterable collection to an unspecified Iterable.

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

    returns

    An Iterable containing all 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.
    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]).toTraversable
    Definition Classes
    IterableOps
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) toTraversable is internal and will be made protected; its name is similar to toList or toSeq, but it doesn't copy non-immutable collections

  60. final def toTraversable: collection.Traversable[A]
    Implicit
    This member is added by an implicit conversion from Option[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    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: IterableOnceExtensionMethods[A]).toTraversable
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.13.0) Use .iterator.to(Iterable) instead

  61. def toVector: collection.immutable.Vector[A]
    Implicit
    This member is added by an implicit conversion from Option[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    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: IterableOnceExtensionMethods[A]).toVector
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.13.0) Use .iterator.to(Vector) instead

  62. def view(from: Int, until: Int): View[A]

    A view over a slice of the elements of this collection.

    A view over a slice of 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
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .view.slice(from, until) instead of .view(from, until)

  63. def withFilter(f: (A) => Boolean): collection.Iterator[A]
    Implicit
    This member is added by an implicit conversion from Option[A] toIterableOnceExtensionMethods[A] performed by method iterableOnceExtensionMethods in scala.collection.IterableOnce.
    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: IterableOnceExtensionMethods[A]).withFilter(f)
    Definition Classes
    IterableOnceExtensionMethods
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use .iterator.withFilter(...) instead

  64. 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
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from java.io.Serializable

Inherited from Product

Inherited from Equals

Inherited from collection.IterableOnce[A]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion option2Iterable fromOption[A] to Iterable[A]

Inherited by implicit conversion iterableOnceExtensionMethods fromOption[A] to IterableOnceExtensionMethods[A]

Inherited by implicit conversion any2stringadd fromOption[A] to any2stringadd[Option[A]]

Inherited by implicit conversion StringFormat fromOption[A] to StringFormat[Option[A]]

Inherited by implicit conversion Ensuring fromOption[A] to Ensuring[Option[A]]

Inherited by implicit conversion ArrowAssoc fromOption[A] to ArrowAssoc[Option[A]]

Ungrouped