final case class Some[+A](value: A) extends Option[A] with Product with Serializable
Class Some[A]
represents existing values of type
A
.
- Annotations
- @SerialVersionUID()
- Source
- Option.scala
- Alphabetic
- By Inheritance
- Some
- Option
- Serializable
- Product
- Equals
- IterableOnce
- AnyRef
- Any
- by option2Iterable
- by iterableOnceExtensionMethods
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new Some(value: A)
Type Members
- 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.
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.
- Definition Classes
- Option
Value Members
- 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
- final def ##: Int
Equivalent to
x.hashCode
except for boxed numeric types andnull
.Equivalent to
x.hashCode
except for boxed numeric types andnull
. 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. Fornull
returns a hashcode wherenull.hashCode
throws aNullPointerException
.- returns
a hash value consistent with ==
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- Implicit
- This member is added by an implicit conversion from Some[A] toany2stringadd[Some[A]] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- final def ++[B >: A](suffix: collection.IterableOnce[B]): collection.Iterable[B]
Alias for
concat
Alias for
concat
- Implicit
- This member is added by an implicit conversion from Some[A] toIterable[A] performed by method option2Iterable in scala.Option.
- Definition Classes
- IterableOps
- Annotations
- @inline()
- def ->[B](y: B): (Some[A], B)
- Implicit
- This member is added by an implicit conversion from Some[A] toArrowAssoc[Some[A]] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
The expression
x == that
is equivalent toif (x eq null) that eq null else x.equals(that)
.The expression
x == that
is equivalent toif (x eq null) that eq null else x.equals(that)
.- returns
true
if the receiver object is equivalent to the argument;false
otherwise.
- Definition Classes
- AnyRef → Any
- final def addString(b: collection.mutable.StringBuilder): collection.mutable.StringBuilder
Appends all elements of this iterable collection to a string builder.
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 Some[A] toIterable[A] performed by method option2Iterable in scala.Option.
- Definition Classes
- IterableOnceOps
- Annotations
- @inline()
- final def addString(b: collection.mutable.StringBuilder, sep: String): collection.mutable.StringBuilder
Appends all elements of this iterable collection to a string builder using a separator string.
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 stringsep
.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 Some[A] toIterable[A] performed by method option2Iterable in scala.Option.
- Definition Classes
- IterableOnceOps
- Annotations
- @inline()
- def addString(b: collection.mutable.StringBuilder, start: String, sep: String, end: String): collection.mutable.StringBuilder
Appends all elements of this iterable collection to a string builder using start, end, and separator strings.
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 stringend
. Inside, the string representations (w.r.t. the methodtoString
) of all elements of this iterable collection are separated by the stringsep
.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 Some[A] toIterable[A] performed by method option2Iterable in scala.Option.
- Definition Classes
- IterableOnceOps
- final def asInstanceOf[T0]: T0
Cast the receiver object to be of type
T0
.Cast the receiver object to be of type
T0
.Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression
1.asInstanceOf[String]
will throw aClassCastException
at runtime, while the expressionList(1).asInstanceOf[List[String]]
will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested type.- returns
the receiver object.
- Definition Classes
- Any
- Exceptions thrown
ClassCastException
if the receiver object is not an instance of the erasure of typeT0
.
- 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.
- 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 andpf
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 andpf
is defined for that value. ReturnsNone
otherwise.- pf
the partial function.
- returns
the result of applying
pf
to this scala.Option's value (if possible), orNone
.
- Definition Classes
- Option
- Annotations
- @inline()
// 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}
Example: - 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 Some[A] toIterable[A] performed by method option2Iterable in scala.Option.
- Definition Classes
- IterableOnceOps
Seq("a", 1, 5L).collectFirst({ case x: Int => x*10 }) = Some(10)
Example: - 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 traversable to append.
- returns
a new iterable collection which contains all elements of this iterable collection followed by all elements of
suffix
.
- Implicit
- This member is added by an implicit conversion from Some[A] toIterable[A] performed by method option2Iterable in scala.Option.
- Definition Classes
- IterableOps
- final def contains[A1 >: A](elem: A1): Boolean
Tests whether the option contains a given value as an element.
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==
) toelem
,false
otherwise.
- Definition Classes
- Option
// 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"
Example: - 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 indexstart
with at mostlen
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 Some[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.
- def copyToArray[B >: A](xs: Array[B], start: 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 indexstart
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 Some[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.
- def copyToArray[B >: A](xs: Array[B]): 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 indexstart
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 Some[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.
- 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 andp(x, y)
istrue
for all corresponding elementsx
of this iterator andy
ofthat
, otherwisefalse
- Implicit
- This member is added by an implicit conversion from Some[A] toIterable[A] performed by method option2Iterable in scala.Option.
- Definition Classes
- IterableOnceOps
- def drop(n: Int): collection.Iterable[A]
Selects all elements except first n ones.
Selects all elements except first n ones.
Note: might return different results for different runs, unless the underlying collection type is ordered.
- n
the number of elements to drop from this iterable collection.
- returns
a iterable collection consisting of all elements of this iterable collection except the first
n
ones, or else the empty iterable collection, if this iterable collection has less thann
elements. Ifn
is negative, don't drop any elements.
- Implicit
- This member is added by an implicit conversion from Some[A] toIterable[A] performed by method option2Iterable in scala.Option.
- Definition Classes
- IterableOps → IterableOnceOps
- 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 thann
elements. Ifn
is negative, don't drop any elements.
- Implicit
- This member is added by an implicit conversion from Some[A] toIterable[A] performed by method option2Iterable in scala.Option.
- Definition Classes
- IterableOps
- def dropWhile(p: (A) => Boolean): collection.Iterable[A]
Drops longest prefix of elements that satisfy a predicate.
Drops longest prefix of elements that satisfy a predicate.
Note: might return different results for different runs, unless the underlying collection type is ordered.
- p
The predicate used to test elements.
- returns
the longest suffix of this iterable collection whose first element does not satisfy the predicate
p
.
- Implicit
- This member is added by an implicit conversion from Some[A] toIterable[A] performed by method option2Iterable in scala.Option.
- Definition Classes
- IterableOps → IterableOnceOps
- 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 Some[A] toIterable[A] performed by method option2Iterable in scala.Option.
- Definition Classes
- IterableFactoryDefaults → IterableOps
- def ensuring(cond: (Some[A]) => Boolean, msg: => Any): Some[A]
- Implicit
- This member is added by an implicit conversion from Some[A] toEnsuring[Some[A]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (Some[A]) => Boolean): Some[A]
- Implicit
- This member is added by an implicit conversion from Some[A] toEnsuring[Some[A]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): Some[A]
- Implicit
- This member is added by an implicit conversion from Some[A] toEnsuring[Some[A]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): Some[A]
- Implicit
- This member is added by an implicit conversion from Some[A] toEnsuring[Some[A]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- final def eq(arg0: AnyRef): Boolean
Tests whether the argument (
that
) is a reference to the receiver object (this
).Tests whether the argument (
that
) is a reference to the receiver object (this
).The
eq
method implements an equivalence relation on non-null instances ofAnyRef
, and has three additional properties:- It is consistent: for any non-null instances
x
andy
of typeAnyRef
, multiple invocations ofx.eq(y)
consistently returnstrue
or consistently returnsfalse
. - For any non-null instance
x
of typeAnyRef
,x.eq(null)
andnull.eq(x)
returnsfalse
. null.eq(null)
returnstrue
.
When overriding the
equals
orhashCode
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
- It is consistent: for any non-null instances
- 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
- 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, returnNone
.This is equivalent to:
option match { case Some(x) if p(x) => Some(x) case _ => None }
- p
the predicate used for testing.
- 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, returnNone
.This is equivalent to:
option match { case Some(x) if !p(x) => Some(x) case _ => None }
- p
the predicate used for testing.
- 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 betweenfinalize
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
- 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. ReturnsNone
if this scala.Option is empty. Slightly different frommap
in thatf
is expected to return an scala.Option (which could beNone
).This is equivalent to:
option match { case Some(x) => f(x) case None => None }
- f
the function to apply
- 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.
- Definition Classes
- Option
Some(Some("something")).flatten
- See also
flatMap
Example: - 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 expressionifEmpty
.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.
- def foldLeft[B](z: B)(op: (B, A) => B): B
Applies a binary operator to a start value and all elements of this iterable collection, going left to right.
Applies a binary operator to a start value and all elements of this iterable collection, going left to right.
Note: will not terminate for infinite-sized collections.
Note: might return different results for different runs, unless the underlying collection type is ordered or the operator is associative and commutative.
- B
the result type of the binary operator.
- z
the start value.
- op
the binary operator.
- returns
the result of inserting
op
between consecutive elements of this iterable collection, going left to right with the start valuez
on the left:op(...op(z, x1), x2, ..., xn)
wherex1, ..., xn
are the elements of this iterable collection. Returnsz
if this iterable collection is empty.
- Implicit
- This member is added by an implicit conversion from Some[A] toIterable[A] performed by method option2Iterable in scala.Option.
- Definition Classes
- IterableOnceOps
- def foldRight[B](z: B)(op: (A, B) => B): B
Applies a binary operator to all elements of this iterable collection and a start value, going right to left.
Applies a binary operator to all elements of this iterable collection and a start value, going right to left.
Note: will not terminate for infinite-sized collections.
Note: might return different results for different runs, unless the underlying collection type is ordered or the operator is associative and commutative.
- B
the result type of the binary operator.
- z
the start value.
- op
the binary operator.
- returns
the result of inserting
op
between consecutive elements of this iterable collection, going right to left with the start valuez
on the right:op(x1, op(x2, ... op(xn, z)...))
wherex1, ..., xn
are the elements of this iterable collection. Returnsz
if this iterable collection is empty.
- Implicit
- This member is added by an implicit conversion from Some[A] toIterable[A] performed by method option2Iterable in scala.Option.
- Definition Classes
- IterableOnceOps
- final def forall(p: (A) => Boolean): Boolean
Returns true if this option is empty or the predicate
p
returns true when applied to this scala.Option's value.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
- final def foreach[U](f: (A) => U): Unit
Apply the given procedure
f
to the option's value, if it is nonempty. - 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 }
- Definition Classes
- Some → Option
- Exceptions thrown
NoSuchElementException
if the option is empty.- Note
The option must be nonempty.
- final def getClass(): Class[_ <: AnyRef]
Returns the runtime class representation of the object.
- 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
. - 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 elementsx
for whichf(x)
equalsk
.
- Implicit
- This member is added by an implicit conversion from Some[A] toIterable[A] performed by method option2Iterable in scala.Option.
- Definition Classes
- IterableOps
- def groupMap[K, B](key: (A) => K)(f: (A) => B): Map[K, collection.Iterable[B]]
Partitions this iterable collection into a map of iterable collections according to a discriminator function
key
.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 typeB
using thevalue
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 Some[A] toIterable[A] performed by method option2Iterable in scala.Option.
- Definition Classes
- IterableOps
- def groupMapReduce[K, B](key: (A) => K)(f: (A) => B)(reduce: (B, B) => B): Map[K, B]
Partitions this iterable collection into a map according to a discriminator function
key
.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 thef
function and then reduced into a single value with thereduce
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 Some[A] toIterable[A] performed by method option2Iterable in scala.Option.
- Definition Classes
- IterableOps
- def grouped(size: Int): collection.Iterator[collection.Iterable[A]]
Partitions elements in fixed size iterable collections.
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 sizesize
if the elements don't divide evenly.
- Implicit
- This member is added by an implicit conversion from Some[A] toIterable[A] performed by method option2Iterable in scala.Option.
- Definition Classes
- IterableOps
- See also
scala.collection.Iterator, method
grouped
- 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 Some[A] toIterable[A] performed by method option2Iterable in scala.Option.
- Definition Classes
- IterableOps
- Exceptions thrown
NoSuchElementException
if the iterable collection is empty.
- def headOption: Option[A]
Optionally selects the first element.
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 Some[A] toIterable[A] performed by method option2Iterable in scala.Option.
- Definition Classes
- IterableOps
- def init: collection.Iterable[A]
The initial part of the collection without its last element.
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 Some[A] toIterable[A] performed by method option2Iterable in scala.Option.
- Definition Classes
- IterableOps
- def inits: collection.Iterator[collection.Iterable[A]]
Iterates over the inits of this iterable collection.
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 Some[A] toIterable[A] performed by method option2Iterable in scala.Option.
- Definition Classes
- IterableOps
List(1,2,3).inits = Iterator(List(1,2,3), List(1,2), List(1), Nil)
Example: - 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 }
- Definition Classes
- Option
- 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 }
- Definition Classes
- Option
- 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 returnstrue
if the value of the receiver object is aBigDecimal
or a subtype ofBigDecimal
.T0
is a parameterized class type, e.g.List[Int]
: this method returnstrue
if the value of the receiver object is someList[X]
for anyX
. For example,List(1, 2, 3).isInstanceOf[List[String]]
will return true.T0
is some singleton typex.type
or literalx
: this method returnsthis.eq(x)
. For example,x.isInstanceOf[1]
is equivalent tox.eq(1)
T0
is an intersectionX with Y
orX & Y: this method is equivalent to
x.isInstanceOf[X] && x.isInstanceOf[Y]T0
is a unionX | Y
: this method is equivalent tox.isInstanceOf[X] || x.isInstanceOf[Y]
T0
is a type parameter or an abstract type member: this method is equivalent toisInstanceOf[U]
whereU
isT0
's upper bound,Any
ifT0
is unbounded. For example,x.isInstanceOf[A]
whereA
is an unbounded type parameter will return true for any value ofx
.
This is exactly equivalent to the type pattern
_: T0
- returns
true
if the receiver object is an instance of erasure of typeT0
;false
otherwise.
- Definition Classes
- Any
- Note
due to the unexpectedness of
List(1, 2, 3).isInstanceOf[List[String]]
returning true andx.isInstanceOf[A]
whereA
is a type parameter or abstract member returning true, these forms issue a warning.
- 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 Some[A] toIterable[A] performed by method option2Iterable in scala.Option.
- Definition Classes
- IterableOps → IterableOnceOps
- 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 Some[A] toIterable[A] performed by method option2Iterable in scala.Option.
- Definition Classes
- Iterable → IterableOps
- Note
When implementing a custom collection type and refining
CC
to the new type, this method needs to be overridden to return a factory for the new type (the compiler will issue an error otherwise).
- def iterator: Iterator[A]
Returns a singleton iterator returning the scala.Option's value if it is nonempty, or an empty iterator if the option is empty.
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
- Option → IterableOnce
- final def knownSize: Int
- returns
The number of elements in this option, if it can be cheaply computed, -1 otherwise. Cheaply usually means: Not requiring a collection traversal.
- Definition Classes
- Option → IterableOnce
- 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 Some[A] toIterable[A] performed by method option2Iterable in scala.Option.
- Definition Classes
- IterableOps
- Exceptions thrown
NoSuchElementException
If the iterable collection is empty.
- def lastOption: Option[A]
Optionally selects the last element.
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 Some[A] toIterable[A] performed by method option2Iterable in scala.Option.
- Definition Classes
- IterableOps
- def lazyZip[B]: ([B](that: Iterable[B]): scala.collection.LazyZip2[A,B,_1.type]) forSome {val _1: collection.Iterable[A]}
Analogous to
zip
except that the elements in each collection are not consumed until a strict operation is invoked on the returnedLazyZip2
decorator.Analogous to
zip
except that the elements in each collection are not consumed until a strict operation is invoked on the returnedLazyZip2
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 tolazyZip
. Implicit conversion toIterable[(A, B)]
is also supported.
- Implicit
- This member is added by an implicit conversion from Some[A] toIterable[A] performed by method option2Iterable in scala.Option.
- Definition Classes
- Iterable
- final def map[B](f: (A) => B): Option[B]
Returns a scala.Some containing the result of applying
f
to this scala.Option's value if this scala.Option is nonempty.Returns a scala.Some containing the result of applying
f
to this scala.Option's value if this scala.Option is nonempty. Otherwise returnNone
.This is equivalent to:
option match { case Some(x) => Some(f(x)) case None => None }
- f
the function to apply
- Definition Classes
- Option
- Annotations
- @inline()
- Note
This is similar to
flatMap
except here,f
does not need to wrap its result in an scala.Option.- See also
flatMap
foreach
- def max[B >: A](implicit ord: math.Ordering[B]): A
Finds the largest element.
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 Some[A] toIterable[A] performed by method option2Iterable in scala.Option.
- Definition Classes
- IterableOnceOps
- Exceptions thrown
UnsupportedOperationException
if this iterable collection is empty.
- def maxBy[B](f: (A) => B)(implicit cmp: math.Ordering[B]): A
Finds the first element which yields the largest value measured by function f.
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.
- cmp
An ordering to be used for comparing elements.
- returns
the first element of this iterable collection with the largest value measured by function f with respect to the ordering
cmp
.
- Implicit
- This member is added by an implicit conversion from Some[A] toIterable[A] performed by method option2Iterable in scala.Option.
- Definition Classes
- IterableOnceOps
- Exceptions thrown
UnsupportedOperationException
if this iterable collection is empty.
- def maxByOption[B](f: (A) => B)(implicit cmp: math.Ordering[B]): Option[A]
Finds the first element which yields the largest value measured by function f.
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.
- cmp
An ordering to be used for comparing elements.
- returns
an option value containing the first element of this iterable collection with the largest value measured by function f with respect to the ordering
cmp
.
- Implicit
- This member is added by an implicit conversion from Some[A] toIterable[A] performed by method option2Iterable in scala.Option.
- Definition Classes
- IterableOnceOps
- def maxOption[B >: A](implicit ord: math.Ordering[B]): Option[A]
Finds the largest element.
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 Some[A] toIterable[A] performed by method option2Iterable in scala.Option.
- Definition Classes
- IterableOnceOps
- def min[B >: A](implicit ord: math.Ordering[B]): A
Finds the smallest element.
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 Some[A] toIterable[A] performed by method option2Iterable in scala.Option.
- Definition Classes
- IterableOnceOps
- Exceptions thrown
UnsupportedOperationException
if this iterable collection is empty.
- def minBy[B](f: (A) => B)(implicit cmp: math.Ordering[B]): A
Finds the first element which yields the smallest value measured by function f.
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.
- cmp
An ordering to be used for comparing elements.
- returns
the first element of this iterable collection with the smallest value measured by function f with respect to the ordering
cmp
.
- Implicit
- This member is added by an implicit conversion from Some[A] toIterable[A] performed by method option2Iterable in scala.Option.
- Definition Classes
- IterableOnceOps
- Exceptions thrown
UnsupportedOperationException
if this iterable collection is empty.
- def minByOption[B](f: (A) => B)(implicit cmp: math.Ordering[B]): Option[A]
Finds the first element which yields the smallest value measured by function f.
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.
- cmp
An ordering to be used for comparing elements.
- returns
an option value containing the first element of this iterable collection with the smallest value measured by function f with respect to the ordering
cmp
.
- Implicit
- This member is added by an implicit conversion from Some[A] toIterable[A] performed by method option2Iterable in scala.Option.
- Definition Classes
- IterableOnceOps
- def minOption[B >: A](implicit ord: math.Ordering[B]): Option[A]
Finds the smallest element.
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 Some[A] toIterable[A] performed by method option2Iterable in scala.Option.
- Definition Classes
- IterableOnceOps
- 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
- 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 }
- Definition Classes
- Option
- Note
Implemented here to avoid the implicit conversion to Iterable.
- final def notify(): Unit
Wakes up a single thread that is waiting on the receiver object's monitor.
Wakes up a single thread that is waiting on the receiver object's monitor.
- Definition Classes
- AnyRef
- Annotations
- @native()
- Note
not specified by SLS as a member of AnyRef
- final def notifyAll(): Unit
Wakes up all threads that are waiting on the receiver object's monitor.
Wakes up all threads that are waiting on the receiver object's monitor.
- Definition Classes
- AnyRef
- Annotations
- @native()
- Note
not specified by SLS as a member of AnyRef
- final def orElse[B >: A](alternative: => Option[B]): Option[B]
Returns this scala.Option if it is nonempty, otherwise return the result of evaluating
alternative
.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.
- 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 }
- 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. Interesting because it splits a collection in two.The default implementation provided here needs to traverse the collection twice. Strict collections have an overridden version of
partition
inStrictOptimizedIterableOps
, which requires only a single traversal.- Implicit
- This member is added by an implicit conversion from Some[A] toIterable[A] performed by method option2Iterable in scala.Option.
- Definition Classes
- IterableOps
- def partitionMap[A1, A2](f: (A) => Either[A1, A2]): (collection.Iterable[A1], collection.Iterable[A2])
Applies a function
f
to each element of the iterable collection and returns a pair of iterable collections: the first one made of those values returned byf
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 byf
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 Some[A] toIterable[A] performed by method option2Iterable in scala.Option.
- Definition Classes
- IterableOps
- def product[B >: A](implicit num: math.Numeric[B]): B
Multiplies up the elements of this collection.
Multiplies up the elements of this collection.
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 innum
.
- Implicit
- This member is added by an implicit conversion from Some[A] toIterable[A] performed by method option2Iterable in scala.Option.
- Definition Classes
- IterableOnceOps
- 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
- def reduce[B >: A](op: (B, B) => B): B
Reduces the elements of this iterable collection using the specified associative binary operator.
Reduces the elements of this iterable collection using the specified associative binary operator.
The order in which operations are performed on elements is unspecified and may be nondeterministic.
- B
A type parameter for the binary operator, a supertype of
A
.- op
A binary operator that must be associative.
- returns
The result of applying reduce operator
op
between all the elements if the iterable collection is nonempty.
- Implicit
- This member is added by an implicit conversion from Some[A] toIterable[A] performed by method option2Iterable in scala.Option.
- Definition Classes
- IterableOnceOps
- Exceptions thrown
UnsupportedOperationException
if this iterable collection is empty.
- def reduceLeft[B >: A](op: (B, A) => B): B
Applies a binary operator to all elements of this iterable collection, going left to right.
Applies a binary operator to all elements of this iterable collection, going left to right.
Note: will not terminate for infinite-sized collections.
Note: might return different results for different runs, unless the underlying collection type is ordered or the operator is associative and commutative.
- B
the result type of the binary operator.
- op
the binary operator.
- returns
the result of inserting
op
between consecutive elements of this iterable collection, going left to right:op( op( ... op(x1, x2) ..., xn-1), xn)
wherex1, ..., xn
are the elements of this iterable collection.
- Implicit
- This member is added by an implicit conversion from Some[A] toIterable[A] performed by method option2Iterable in scala.Option.
- Definition Classes
- IterableOnceOps
- Exceptions thrown
UnsupportedOperationException
if this iterable collection is empty.
- def reduceLeftOption[B >: A](op: (B, A) => B): Option[B]
Optionally applies a binary operator to all elements of this iterable collection, going left to right.
Optionally applies a binary operator to all elements of this iterable collection, going left to right.
Note: will not terminate for infinite-sized collections.
Note: might return different results for different runs, unless the underlying collection type is ordered or the operator is associative and commutative.
- B
the result type of the binary operator.
- op
the binary operator.
- returns
an option value containing the result of
reduceLeft(op)
if this iterable collection is nonempty,None
otherwise.
- Implicit
- This member is added by an implicit conversion from Some[A] toIterable[A] performed by method option2Iterable in scala.Option.
- Definition Classes
- IterableOnceOps
- def reduceOption[B >: A](op: (B, B) => B): Option[B]
Reduces the elements of this iterable collection, if any, using the specified associative binary operator.
Reduces the elements of this iterable collection, if any, using the specified associative binary operator.
The order in which operations are performed on elements is unspecified and may be nondeterministic.
- B
A type parameter for the binary operator, a supertype of
A
.- op
A binary operator that must be associative.
- returns
An option value containing result of applying reduce operator
op
between all the elements if the collection is nonempty, andNone
otherwise.
- Implicit
- This member is added by an implicit conversion from Some[A] toIterable[A] performed by method option2Iterable in scala.Option.
- Definition Classes
- IterableOnceOps
- def reduceRight[B >: A](op: (A, B) => B): B
Applies a binary operator to all elements of this iterable collection, going right to left.
Applies a binary operator to all elements of this iterable collection, going right to left.
Note: will not terminate for infinite-sized collections.
Note: might return different results for different runs, unless the underlying collection type is ordered or the operator is associative and commutative.
- B
the result type of the binary operator.
- op
the binary operator.
- returns
the result of inserting
op
between consecutive elements of this iterable collection, going right to left:op(x1, op(x2, ..., op(xn-1, xn)...))
wherex1, ..., xn
are the elements of this iterable collection.
- Implicit
- This member is added by an implicit conversion from Some[A] toIterable[A] performed by method option2Iterable in scala.Option.
- Definition Classes
- IterableOnceOps
- Exceptions thrown
UnsupportedOperationException
if this iterable collection is empty.
- def reduceRightOption[B >: A](op: (A, B) => B): Option[B]
Optionally applies a binary operator to all elements of this iterable collection, going right to left.
Optionally applies a binary operator to all elements of this iterable collection, going right to left.
Note: will not terminate for infinite-sized collections.
Note: might return different results for different runs, unless the underlying collection type is ordered or the operator is associative and commutative.
- B
the result type of the binary operator.
- op
the binary operator.
- returns
an option value containing the result of
reduceRight(op)
if this iterable collection is nonempty,None
otherwise.
- Implicit
- This member is added by an implicit conversion from Some[A] toIterable[A] performed by method option2Iterable in scala.Option.
- Definition Classes
- IterableOnceOps
- def scan[B >: A](z: B)(op: (B, B) => B): collection.Iterable[B]
Computes a prefix scan of the elements of the collection.
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 Some[A] toIterable[A] performed by method option2Iterable in scala.Option.
- Definition Classes
- IterableOps
- def scanLeft[B](z: B)(op: (B, A) => B): collection.Iterable[B]
Produces a iterable collection containing cumulative results of applying the operator going left to right, including the initial value.
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 Some[A] toIterable[A] performed by method option2Iterable in scala.Option.
- Definition Classes
- IterableOps → IterableOnceOps
- 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 Some[A] toIterable[A] performed by method option2Iterable in scala.Option.
- Definition Classes
- IterableOps
- def sizeCompare(that: collection.Iterable[_]): Int
Compares the size of this iterable collection to the size of another
Iterable
.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
wherex < 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 isO(this.size min that.size)
instead ofO(this.size + that.size)
. The method should be overridden if computingsize
is cheap andknownSize
returns-1
.
- Implicit
- This member is added by an implicit conversion from Some[A] toIterable[A] performed by method option2Iterable in scala.Option.
- Definition Classes
- IterableOps
- def sizeCompare(otherSize: Int): Int
Compares the size of this iterable collection to a test value.
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
wherex < 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 isO(size min otherSize)
instead ofO(size)
. The method should be overridden if computingsize
is cheap andknownSize
returns-1
.
- Implicit
- This member is added by an implicit conversion from Some[A] toIterable[A] performed by method option2Iterable in scala.Option.
- Definition Classes
- IterableOps
- See also
- 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 Some[A] toIterable[A] performed by method option2Iterable in scala.Option.
- Definition Classes
- IterableOps
- Annotations
- @inline()
- def slice(from: Int, until: Int): collection.Iterable[A]
Selects an interval of elements.
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) indexuntil
of this iterable collection.
- Implicit
- This member is added by an implicit conversion from Some[A] toIterable[A] performed by method option2Iterable in scala.Option.
- Definition Classes
- IterableOps → IterableOnceOps
- 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 thansize
elements remaining to be grouped.
- Implicit
- This member is added by an implicit conversion from Some[A] toIterable[A] performed by method option2Iterable in scala.Option.
- Definition Classes
- IterableOps
List(1, 2, 3, 4, 5).sliding(2, 2) = Iterator(List(1, 2), List(3, 4), List(5))
, List(1, 2, 3, 4, 5, 6).sliding(2, 3) = Iterator(List(1, 2), List(4, 5))
- See also
scala.collection.Iterator, method
sliding
Examples: - 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 thansize
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 Some[A] toIterable[A] performed by method option2Iterable in scala.Option.
- Definition Classes
- IterableOps
List().sliding(2) = empty iterator
, List(1).sliding(2) = Iterator(List(1))
, List(1, 2).sliding(2) = Iterator(List(1, 2))
, List(1, 2, 3).sliding(2) = Iterator(List(1, 2), List(2, 3))
- See also
scala.collection.Iterator, method
sliding
Examples: - 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 predicatep
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 Some[A] toIterable[A] performed by method option2Iterable in scala.Option.
- Definition Classes
- IterableOps → IterableOnceOps
- 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 Some[A] toIterable[A] performed by method option2Iterable in scala.Option.
- Definition Classes
- IterableOps → IterableOnceOps
- 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.
- For collections of
Int
,Short
,Byte
orChar
, an scala.collection.IntStepper is returned - For collections of
Double
orFloat
, a scala.collection.DoubleStepper is returned - For collections of
Long
a scala.collection.LongStepper is returned - For any other element type, an scala.collection.AnyStepper is returned
Note that this method is overridden in subclasses and the return type is refined to
S with EfficientSplit
, for example scala.collection.IndexedSeqOps.stepper. For Steppers marked with scala.collection.Stepper.EfficientSplit, the converters in scala.jdk.StreamConverters allow creating parallel streams, whereas bare Steppers can be converted only to sequential streams.- Definition Classes
- IterableOnce
- For collections of
- def sum[B >: A](implicit num: math.Numeric[B]): B
Sums up the elements of this collection.
Sums up the elements of this collection.
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 innum
.
- Implicit
- This member is added by an implicit conversion from Some[A] toIterable[A] performed by method option2Iterable in scala.Option.
- Definition Classes
- IterableOnceOps
- final def synchronized[T0](arg0: => T0): T0
Executes the code in
body
with an exclusive lock onthis
.Executes the code in
body
with an exclusive lock onthis
.- returns
the result of
body
- Definition Classes
- AnyRef
- 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 Some[A] toIterable[A] performed by method option2Iterable in scala.Option.
- Definition Classes
- IterableOps
- def tails: collection.Iterator[collection.Iterable[A]]
Iterates over the tails of this iterable collection.
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 Some[A] toIterable[A] performed by method option2Iterable in scala.Option.
- Definition Classes
- IterableOps
List(1,2,3).tails = Iterator(List(1,2,3), List(2,3), List(3), Nil)
Example: - 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 thann
elements. Ifn
is negative, returns an empty iterable collection.
- Implicit
- This member is added by an implicit conversion from Some[A] toIterable[A] performed by method option2Iterable in scala.Option.
- Definition Classes
- IterableOps → IterableOnceOps
- 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 thann
elements. Ifn
is negative, returns an empty iterable collection.
- Implicit
- This member is added by an implicit conversion from Some[A] toIterable[A] performed by method option2Iterable in scala.Option.
- Definition Classes
- IterableOps
- def takeWhile(p: (A) => Boolean): collection.Iterable[A]
Takes longest prefix of elements that satisfy a predicate.
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 Some[A] toIterable[A] performed by method option2Iterable in scala.Option.
- Definition Classes
- IterableOps → IterableOnceOps
- 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 applyf
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 Some[A] toIterable[A] performed by method option2Iterable in scala.Option.
- Definition Classes
- IterableOps → IterableOnceOps
- def to[C1](factory: Factory[A, C1]): C1
Given a collection factory
factory
, convert this collection to the appropriate representation for the current element typeA
.Given a collection factory
factory
, convert this collection to the appropriate representation for the current element typeA
. 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 Some[A] toIterable[A] performed by method option2Iterable in scala.Option.
- Definition Classes
- IterableOnceOps
- def toArray[B >: A](implicit arg0: ClassTag[B]): Array[B]
Convert collection to array.
Convert collection to array.
Implementation note: DO NOT call Array.from from this method.
- Implicit
- This member is added by an implicit conversion from Some[A] toIterable[A] performed by method option2Iterable in scala.Option.
- Definition Classes
- IterableOnceOps
- final def toLeft[X](right: => X): Either[A, X]
Returns a scala.util.Right containing the given argument
right
if this is empty, or a scala.util.Left containing this scala.Option's value if this scala.Option is nonempty.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
- 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 }
- Definition Classes
- Option
- def toMap[K, V](implicit ev: <:<[A, (K, V)]): Map[K, V]
- Implicit
- This member is added by an implicit conversion from Some[A] toIterable[A] performed by method option2Iterable in scala.Option.
- Definition Classes
- IterableOnceOps
- final def toRight[X](left: => X): Either[X, A]
Returns a scala.util.Left containing the given argument
left
if this scala.Option is empty, or a scala.util.Right containing this scala.Option's value if this is nonempty.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
- 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 Some[A] toIterable[A] performed by method option2Iterable in scala.Option.
- Definition Classes
- Iterable → AnyRef → Any
- def transpose[B](implicit asIterable: (A) => collection.Iterable[B]): collection.Iterable[collection.Iterable[B]]
Transposes this iterable collection of iterable collections into a iterable collection of iterable collections.
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 Some[A] toIterable[A] performed by method option2Iterable in scala.Option.
- Definition Classes
- IterableOps
- Exceptions thrown
IllegalArgumentException
if all collections in this iterable collection are not of the same size.
- final def unzip[A1, A2](implicit asPair: <:<[A, (A1, A2)]): (Option[A1], Option[A2])
Converts an Option of a pair into an Option of the first element and an Option of the second element.
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.
- Definition Classes
- Option
- final def unzip3[A1, A2, A3](implicit asTriple: <:<[A, (A1, A2, A3)]): (Option[A1], Option[A2], Option[A3])
Converts an Option of a triple into three Options, one containing the element from each position of the triple.
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.
- Definition Classes
- Option
- val value: A
- 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 Some[A] toIterable[A] performed by method option2Iterable in scala.Option.
- Definition Classes
- IterableOps
- 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
- 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
- final def wait(arg0: Long): Unit
See https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-.
- 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. - 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
- Definition Classes
- Option
// 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")
Example: - 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 andthat
. The length of the returned collection is the maximum of the lengths of this iterable collection andthat
. If this iterable collection is shorter thanthat
,thisElem
values are used to pad the result. Ifthat
is shorter than this iterable collection,thatElem
values are used to pad the result.
- Implicit
- This member is added by an implicit conversion from Some[A] toIterable[A] performed by method option2Iterable in scala.Option.
- Definition Classes
- IterableOps
- def zipWithIndex: collection.Iterable[(A, Int)]
Zips this iterable collection with its indices.
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 Some[A] toIterable[A] performed by method option2Iterable in scala.Option.
- Definition Classes
- IterableOps → IterableOnceOps
List("a", "b", "c").zipWithIndex == List(("a", 0), ("b", 1), ("c", 2))
Example:
Shadowed Implicit Value Members
- def collect[B](pf: PartialFunction[A, B]): collection.Iterable[B]
Builds a new iterable collection by applying a partial function to all elements of this iterable collection on which the function is defined.
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 Some[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:(some: Iterable[A]).collect(pf)
- Definition Classes
- IterableOps → IterableOnceOps
- 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 Some[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:(some: Iterable[A]).count(p)
- Definition Classes
- IterableOnceOps
- def exists(p: (A) => Boolean): Boolean
Tests whether a predicate holds for at least one element of this iterable collection.
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 predicatep
is satisfied by at least one element of this iterable collection, otherwisefalse
- Implicit
- This member is added by an implicit conversion from Some[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:(some: Iterable[A]).exists(p)
- Definition Classes
- IterableOnceOps
- def filter(pred: (A) => Boolean): collection.Iterable[A]
Selects all elements of this iterable collection which satisfy a predicate.
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 Some[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:(some: Iterable[A]).filter(pred)
- Definition Classes
- IterableOps → IterableOnceOps
- 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 Some[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:(some: Iterable[A]).filterNot(pred)
- Definition Classes
- IterableOps → IterableOnceOps
- 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
, orNone
if none exists.
- Implicit
- This member is added by an implicit conversion from Some[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:(some: Iterable[A]).find(p)
- Definition Classes
- IterableOnceOps
- def flatMap[B](f: (A) => collection.IterableOnce[B]): collection.Iterable[B]
Builds a new iterable collection by applying a function to all elements of this iterable collection and using the elements of the resulting collections.
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 Some[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:(some: Iterable[A]).flatMap(f)
- Definition Classes
- IterableOps → IterableOnceOps
- def flatten[B](implicit asIterable: (A) => collection.IterableOnce[B]): collection.Iterable[B]
Converts this iterable collection of traversable collections into a iterable collection formed by the elements of these traversable collections.
Converts this iterable collection of traversable collections into a iterable collection formed by the elements of these traversable collections.
The resulting collection's type will be guided by the type of iterable collection. For example:
val xs = List( Set(1, 2, 3), Set(1, 2, 3) ).flatten // xs == List(1, 2, 3, 1, 2, 3) val ys = Set( List(1, 2, 3), List(3, 2, 1) ).flatten // ys == Set(1, 2, 3)
- B
the type of the elements of each traversable collection.
- asIterable
an implicit conversion which asserts that the element type of this iterable collection is a
GenTraversable
.- returns
a new iterable collection resulting from concatenating all element iterable collections.
- Implicit
- This member is added by an implicit conversion from Some[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:(some: Iterable[A]).flatten(asIterable)
- Definition Classes
- IterableOps → IterableOnceOps
- def fold[A1 >: A](z: A1)(op: (A1, A1) => A1): A1
Folds the elements of this iterable collection using the specified associative binary operator.
Folds the elements of this iterable collection using the specified associative binary operator. The default implementation in
IterableOnce
is equivalent tofoldLeft
but may be overridden for more efficient traversal orders.The order in which operations are performed on elements is unspecified and may be nondeterministic.
Note: will not terminate for infinite-sized collections.
- A1
a type parameter for the binary operator, a supertype of
A
.- z
a neutral element for the fold operation; may be added to the result an arbitrary number of times, and must not change the result (e.g.,
Nil
for list concatenation, 0 for addition, or 1 for multiplication).- op
a binary operator that must be associative.
- returns
the result of applying the fold operator
op
between all the elements andz
, orz
if this iterable collection is empty.
- Implicit
- This member is added by an implicit conversion from Some[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:(some: Iterable[A]).fold(z)(op)
- Definition Classes
- IterableOnceOps
- def forall(p: (A) => Boolean): Boolean
Tests whether a predicate holds for all elements of this iterable collection.
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 predicatep
holds for all elements of this iterable collection, otherwisefalse
.
- Implicit
- This member is added by an implicit conversion from Some[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:(some: Iterable[A]).forall(p)
- Definition Classes
- IterableOnceOps
- def foreach[U](f: (A) => U): Unit
Apply
f
to each element for its side effects Note: [U] parameter needed to help scalac's type inference.Apply
f
to each element for its side effects Note: [U] parameter needed to help scalac's type inference.- Implicit
- This member is added by an implicit conversion from Some[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:(some: Iterable[A]).foreach(f)
- Definition Classes
- IterableOnceOps
- def isEmpty: Boolean
Tests whether the iterable collection is empty.
Tests whether the iterable collection is empty.
Note: Implementations in subclasses that are not repeatedly traversable must take care not to consume any elements when
isEmpty
is called.- returns
true
if the iterable collection contains no elements,false
otherwise.
- Implicit
- This member is added by an implicit conversion from Some[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:(some: Iterable[A]).isEmpty
- Definition Classes
- IterableOnceOps
- def iterator: collection.Iterator[A]
Iterator can be used only once
Iterator can be used only once
- Implicit
- This member is added by an implicit conversion from Some[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:(some: Iterable[A]).iterator
- Definition Classes
- IterableOnce
- def knownSize: Int
- returns
The number of elements in this iterable collection, if it can be cheaply computed, -1 otherwise. Cheaply usually means: Not requiring a collection traversal.
- Implicit
- This member is added by an implicit conversion from Some[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:(some: Iterable[A]).knownSize
- Definition Classes
- IterableOnce
- def map[B](f: (A) => B): collection.Iterable[B]
Builds a new iterable collection by applying a function to all elements of this iterable collection.
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 Some[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:(some: Iterable[A]).map(f)
- Definition Classes
- IterableOps → IterableOnceOps
- 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 Some[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:(some: Iterable[A]).mkString
- Definition Classes
- IterableOnceOps
- Annotations
- @inline()
- final def mkString(sep: String): String
Displays all elements of this iterable collection in a string using a separator string.
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 stringsep
.
- Implicit
- This member is added by an implicit conversion from Some[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:(some: Iterable[A]).mkString(sep)
- Definition Classes
- IterableOnceOps
- Annotations
- @inline()
List(1, 2, 3).mkString("|") = "1|2|3"
Example: - 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 stringend
. Inside, the string representations (w.r.t. the methodtoString
) of all elements of this iterable collection are separated by the stringsep
.
- Implicit
- This member is added by an implicit conversion from Some[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:(some: Iterable[A]).mkString(start, sep, end)
- Definition Classes
- IterableOnceOps
List(1, 2, 3).mkString("(", "; ", ")") = "(1; 2; 3)"
Example: - 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 Some[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:(some: Iterable[A]).nonEmpty
- Definition Classes
- IterableOnceOps
- Annotations
- @deprecatedOverriding()
- 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 Some[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:(some: Iterable[A]).size
- Definition Classes
- IterableOnceOps
- 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.
- For collections of
Int
,Short
,Byte
orChar
, an scala.collection.IntStepper is returned - For collections of
Double
orFloat
, a scala.collection.DoubleStepper is returned - For collections of
Long
a scala.collection.LongStepper is returned - For any other element type, an scala.collection.AnyStepper is returned
Note that this method is overridden in subclasses and the return type is refined to
S with EfficientSplit
, for example scala.collection.IndexedSeqOps.stepper. For Steppers marked with scala.collection.Stepper.EfficientSplit, the converters in scala.jdk.StreamConverters allow creating parallel streams, whereas bare Steppers can be converted only to sequential streams.- Implicit
- This member is added by an implicit conversion from Some[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:(some: Iterable[A]).stepper(shape)
- Definition Classes
- IterableOnce
- For collections of
- final def toBuffer[B >: A]: Buffer[B]
- Implicit
- This member is added by an implicit conversion from Some[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:(some: Iterable[A]).toBuffer
- Definition Classes
- IterableOnceOps
- Annotations
- @inline()
- def toIndexedSeq: collection.immutable.IndexedSeq[A]
- Implicit
- This member is added by an implicit conversion from Some[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:(some: Iterable[A]).toIndexedSeq
- Definition Classes
- IterableOnceOps
- def toList: collection.immutable.List[A]
- Implicit
- This member is added by an implicit conversion from Some[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:(some: Iterable[A]).toList
- Definition Classes
- IterableOnceOps
- def toSeq: collection.immutable.Seq[A]
- returns
This collection as a
Seq[A]
. This is equivalent toto(Seq)
but might be faster.
- Implicit
- This member is added by an implicit conversion from Some[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:(some: Iterable[A]).toSeq
- Definition Classes
- IterableOnceOps
- def toSet[B >: A]: Set[B]
- Implicit
- This member is added by an implicit conversion from Some[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:(some: Iterable[A]).toSet
- Definition Classes
- IterableOnceOps
- def toVector: collection.immutable.Vector[A]
- Implicit
- This member is added by an implicit conversion from Some[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:(some: Iterable[A]).toVector
- Definition Classes
- IterableOnceOps
- def unzip[A1, A2](implicit asPair: (A) => (A1, A2)): (collection.Iterable[A1], collection.Iterable[A2])
Converts this iterable collection of pairs into two collections of the first and second half of each pair.
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 Some[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:(some: Iterable[A]).unzip(asPair)
- Definition Classes
- IterableOps
- def unzip3[A1, A2, A3](implicit asTriple: (A) => (A1, A2, A3)): (collection.Iterable[A1], collection.Iterable[A2], collection.Iterable[A3])
Converts this iterable collection of triples into three collections of the first, second, and third element of each triple.
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 Some[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:(some: Iterable[A]).unzip3(asTriple)
- Definition Classes
- IterableOps
- def withFilter(p: (A) => Boolean): collection.WithFilter[A, collection.Iterable]
Creates a non-strict filter of this iterable collection.
Creates a non-strict filter of this iterable collection.
Note: the difference between
c filter p
andc withFilter p
is that the former creates a new collection, whereas the latter only restricts the domain of subsequentmap
,flatMap
,foreach
, andwithFilter
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 supportsmap
,flatMap
,foreach
, andwithFilter
operations. All these operations apply to those elements of this iterable collection which satisfy the predicatep
.
- Implicit
- This member is added by an implicit conversion from Some[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:(some: Iterable[A]).withFilter(p)
- Definition Classes
- IterableOps
- def zip[B](that: collection.IterableOnce[B]): collection.Iterable[(A, B)]
Returns a iterable collection formed from this iterable collection and another iterable collection by combining corresponding elements in pairs.
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 andthat
.
- Implicit
- This member is added by an implicit conversion from Some[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:(some: Iterable[A]).zip(that)
- Definition Classes
- IterableOps
Deprecated Value Members
- def ++:[B >: A](that: collection.IterableOnce[B]): collection.Iterable[B]
- Implicit
- This member is added by an implicit conversion from Some[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
- final def /:[B](z: B)(op: (B, A) => B): B
- Implicit
- This member is added by an implicit conversion from Some[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 /:
- def /:[B](z: B)(op: (B, A) => B): B
- Implicit
- This member is added by an implicit conversion from Some[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
- final def :\[B](z: B)(op: (A, B) => B): B
- Implicit
- This member is added by an implicit conversion from Some[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 :\
- def :\[B](z: B)(op: (A, B) => B): B
- Implicit
- This member is added by an implicit conversion from Some[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
- def aggregate[B](z: => B)(seqop: (B, A) => B, combop: (B, B) => B): B
- Implicit
- This member is added by an implicit conversion from Some[A] toIterable[A] performed by method option2Iterable in scala.Option.
- Definition Classes
- IterableOnceOps
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0)
aggregate
is not relevant for sequential collections. UsefoldLeft(z)(seqop)
instead.
- def collectFirst[B](f: PartialFunction[A, B]): Option[B]
- Implicit
- This member is added by an implicit conversion from Some[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
- def companion: IterableFactory[collection.Iterable]
- Implicit
- This member is added by an implicit conversion from Some[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
- final def copyToBuffer[B >: A](dest: Buffer[B]): Unit
- Implicit
- This member is added by an implicit conversion from Some[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
- def copyToBuffer(dest: Buffer[A]): Unit
- Implicit
- This member is added by an implicit conversion from Some[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
- def count(f: (A) => Boolean): Int
- Implicit
- This member is added by an implicit conversion from Some[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:(some: IterableOnceExtensionMethods[A]).count(f)
- Definition Classes
- IterableOnceExtensionMethods
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use .iterator.count(...) instead
- def exists(f: (A) => Boolean): Boolean
- Implicit
- This member is added by an implicit conversion from Some[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:(some: IterableOnceExtensionMethods[A]).exists(f)
- Definition Classes
- IterableOnceExtensionMethods
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use .iterator.exists(...) instead
- def filter(f: (A) => Boolean): collection.Iterator[A]
- Implicit
- This member is added by an implicit conversion from Some[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:(some: IterableOnceExtensionMethods[A]).filter(f)
- Definition Classes
- IterableOnceExtensionMethods
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use .iterator.filter(...) instead
- def find(p: (A) => Boolean): Option[A]
- Implicit
- This member is added by an implicit conversion from Some[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:(some: IterableOnceExtensionMethods[A]).find(p)
- Definition Classes
- IterableOnceExtensionMethods
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use .iterator.find instead
- def flatMap[B](f: (A) => collection.IterableOnce[B]): collection.IterableOnce[B]
- Implicit
- This member is added by an implicit conversion from Some[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:(some: IterableOnceExtensionMethods[A]).flatMap(f)
- Definition Classes
- IterableOnceExtensionMethods
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use .iterator.flatMap instead or consider requiring an Iterable
- def fold[A1 >: A](z: A1)(op: (A1, A1) => A1): A1
- Implicit
- This member is added by an implicit conversion from Some[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:(some: IterableOnceExtensionMethods[A]).fold(z)(op)
- Definition Classes
- IterableOnceExtensionMethods
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use .iterator.fold instead
- def foldLeft[B](z: B)(op: (B, A) => B): B
- Implicit
- This member is added by an implicit conversion from Some[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
- def foldRight[B](z: B)(op: (A, B) => B): B
- Implicit
- This member is added by an implicit conversion from Some[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
- def forall(f: (A) => Boolean): Boolean
- Implicit
- This member is added by an implicit conversion from Some[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:(some: IterableOnceExtensionMethods[A]).forall(f)
- Definition Classes
- IterableOnceExtensionMethods
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use .iterator.forall(...) instead
- def foreach[U](f: (A) => U): Unit
- Implicit
- This member is added by an implicit conversion from Some[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:(some: IterableOnceExtensionMethods[A]).foreach(f)
- Definition Classes
- IterableOnceExtensionMethods
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.13.0) Use .iterator.foreach(...) instead
- 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 forString.format
(@see java.lang.String.format).- Implicit
- This member is added by an implicit conversion from Some[A] toStringFormat[Some[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 ofvalue.formatted(formatString)
, or use thef""
string interpolator. In Java 15 and later,formatted
resolves to the new method in String which has reversed parameters.
- 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 returnstrue
if all elements have been computed. It returnsfalse
if the stream is not yet evaluated to the end. Non-empty Iterators usually returnfalse
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
returnstrue
. However, checkinghasDefiniteSize
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 Some[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
- def isEmpty: Boolean
- Implicit
- This member is added by an implicit conversion from Some[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:(some: IterableOnceExtensionMethods[A]).isEmpty
- Definition Classes
- IterableOnceExtensionMethods
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use .iterator.isEmpty instead
- def map[B](f: (A) => B): collection.IterableOnce[B]
- Implicit
- This member is added by an implicit conversion from Some[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:(some: IterableOnceExtensionMethods[A]).map(f)
- Definition Classes
- IterableOnceExtensionMethods
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use .iterator.map instead or consider requiring an Iterable
- def max(implicit ord: math.Ordering[A]): A
- Implicit
- This member is added by an implicit conversion from Some[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
- def maxBy[B](f: (A) => B)(implicit cmp: math.Ordering[B]): A
- Implicit
- This member is added by an implicit conversion from Some[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
- def min(implicit ord: math.Ordering[A]): A
- Implicit
- This member is added by an implicit conversion from Some[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
- def minBy[B](f: (A) => B)(implicit cmp: math.Ordering[B]): A
- Implicit
- This member is added by an implicit conversion from Some[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
- def mkString: String
- Implicit
- This member is added by an implicit conversion from Some[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:(some: IterableOnceExtensionMethods[A]).mkString
- Definition Classes
- IterableOnceExtensionMethods
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use .iterator.mkString instead
- def mkString(sep: String): String
- Implicit
- This member is added by an implicit conversion from Some[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:(some: IterableOnceExtensionMethods[A]).mkString(sep)
- Definition Classes
- IterableOnceExtensionMethods
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use .iterator.mkString instead
- def mkString(start: String, sep: String, end: String): String
- Implicit
- This member is added by an implicit conversion from Some[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:(some: IterableOnceExtensionMethods[A]).mkString(start, sep, end)
- Definition Classes
- IterableOnceExtensionMethods
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use .iterator.mkString instead
- def nonEmpty: Boolean
- Implicit
- This member is added by an implicit conversion from Some[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:(some: IterableOnceExtensionMethods[A]).nonEmpty
- Definition Classes
- IterableOnceExtensionMethods
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use .iterator.nonEmpty instead
- def product(implicit num: math.Numeric[A]): A
- Implicit
- This member is added by an implicit conversion from Some[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
- def reduce(f: (A, A) => A): A
- Implicit
- This member is added by an implicit conversion from Some[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
- def reduceLeft(f: (A, A) => A): A
- Implicit
- This member is added by an implicit conversion from Some[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
- def reduceLeftOption(f: (A, A) => A): Option[A]
- Implicit
- This member is added by an implicit conversion from Some[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
- def reduceOption(f: (A, A) => A): Option[A]
- Implicit
- This member is added by an implicit conversion from Some[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
- def reduceRight(f: (A, A) => A): A
- Implicit
- This member is added by an implicit conversion from Some[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
- def reduceRightOption(f: (A, A) => A): Option[A]
- Implicit
- This member is added by an implicit conversion from Some[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
- final def repr: collection.Iterable[A]
- Implicit
- This member is added by an implicit conversion from Some[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
- def sameElements[B >: A](that: collection.IterableOnce[B]): Boolean
- Implicit
- This member is added by an implicit conversion from Some[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
- def seq: collection.Iterable[A]
- Implicit
- This member is added by an implicit conversion from Some[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
- def size: Int
- Implicit
- This member is added by an implicit conversion from Some[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:(some: IterableOnceExtensionMethods[A]).size
- Definition Classes
- IterableOnceExtensionMethods
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use .iterator.size instead
- def sum(implicit num: math.Numeric[A]): A
- Implicit
- This member is added by an implicit conversion from Some[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
- def to[C1](factory: Factory[A, C1]): C1
- Implicit
- This member is added by an implicit conversion from Some[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
- def toArray[B >: A](implicit arg0: ClassTag[B]): Array[B]
- Implicit
- This member is added by an implicit conversion from Some[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
- def toBuffer[B >: A]: Buffer[B]
- Implicit
- This member is added by an implicit conversion from Some[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:(some: IterableOnceExtensionMethods[A]).toBuffer
- Definition Classes
- IterableOnceExtensionMethods
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use .iterator.to(ArrayBuffer) instead
- def toIndexedSeq: collection.IndexedSeq[A]
- Implicit
- This member is added by an implicit conversion from Some[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:(some: IterableOnceExtensionMethods[A]).toIndexedSeq
- Definition Classes
- IterableOnceExtensionMethods
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use .iterator.toIndexedSeq instead
- final def toIterable: collection.Iterable[A]
- returns
This collection as an
Iterable[A]
. No new collection will be built ifthis
is already anIterable[A]
.
- Implicit
- This member is added by an implicit conversion from Some[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:(some: Iterable[A]).toIterable
- Definition Classes
- Iterable → IterableOps
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.7) toIterable is internal and will be made protected; its name is similar to
toList
ortoSeq
, but it doesn't copy non-immutable collections
- final def toIterable: collection.Iterable[A]
- Implicit
- This member is added by an implicit conversion from Some[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:(some: IterableOnceExtensionMethods[A]).toIterable
- Definition Classes
- IterableOnceExtensionMethods
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.13.0) Use .iterator.to(Iterable) instead
- final def toIterator: collection.Iterator[A]
- Implicit
- This member is added by an implicit conversion from Some[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:(some: Iterable[A]).toIterator
- Definition Classes
- IterableOnceOps
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.13.0) Use .iterator instead of .toIterator
- def toIterator: collection.Iterator[A]
- Implicit
- This member is added by an implicit conversion from Some[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:(some: IterableOnceExtensionMethods[A]).toIterator
- Definition Classes
- IterableOnceExtensionMethods
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.13.0) Use .iterator instead
- def toList: collection.immutable.List[A]
- Implicit
- This member is added by an implicit conversion from Some[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:(some: IterableOnceExtensionMethods[A]).toList
- Definition Classes
- IterableOnceExtensionMethods
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use .iterator.to(List) instead
- def toMap[K, V](implicit ev: <:<[A, (K, V)]): Map[K, V]
- Implicit
- This member is added by an implicit conversion from Some[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
- def toSeq: collection.immutable.Seq[A]
- Implicit
- This member is added by an implicit conversion from Some[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:(some: IterableOnceExtensionMethods[A]).toSeq
- Definition Classes
- IterableOnceExtensionMethods
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.13.0) Use .iterator.to(Seq) instead
- def toSet[B >: A]: Set[B]
- Implicit
- This member is added by an implicit conversion from Some[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:(some: IterableOnceExtensionMethods[A]).toSet
- Definition Classes
- IterableOnceExtensionMethods
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.13.0) Use .iterator.to(Set) instead
- final def toStream: collection.immutable.Stream[A]
- Implicit
- This member is added by an implicit conversion from Some[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:(some: Iterable[A]).toStream
- Definition Classes
- IterableOnceOps
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.13.0) Use .to(LazyList) instead of .toStream
- def toStream: collection.immutable.Stream[A]
- Implicit
- This member is added by an implicit conversion from Some[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:(some: IterableOnceExtensionMethods[A]).toStream
- Definition Classes
- IterableOnceExtensionMethods
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.13.0) Use .iterator.to(LazyList) instead
- 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 Some[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:(some: 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
ortoSeq
, but it doesn't copy non-immutable collections
- final def toTraversable: collection.Traversable[A]
- Implicit
- This member is added by an implicit conversion from Some[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:(some: IterableOnceExtensionMethods[A]).toTraversable
- Definition Classes
- IterableOnceExtensionMethods
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.13.0) Use .iterator.to(Iterable) instead
- def toVector: collection.immutable.Vector[A]
- Implicit
- This member is added by an implicit conversion from Some[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:(some: IterableOnceExtensionMethods[A]).toVector
- Definition Classes
- IterableOnceExtensionMethods
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.13.0) Use .iterator.to(Vector) instead
- 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 Some[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)
- def withFilter(f: (A) => Boolean): collection.Iterator[A]
- Implicit
- This member is added by an implicit conversion from Some[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:(some: IterableOnceExtensionMethods[A]).withFilter(f)
- Definition Classes
- IterableOnceExtensionMethods
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use .iterator.withFilter(...) instead
- def →[B](y: B): (Some[A], B)
- Implicit
- This member is added by an implicit conversion from Some[A] toArrowAssoc[Some[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.
This is the documentation for the Scala standard library.
Package structure
The scala package contains core types like
Int
,Float
,Array
orOption
which are accessible in all Scala compilation units without explicit qualification or imports.Notable packages include:
scala.collection
and its sub-packages contain Scala's collections frameworkscala.collection.immutable
- Immutable, sequential data-structures such asVector
,List
,Range
,HashMap
orHashSet
scala.collection.mutable
- Mutable, sequential data-structures such asArrayBuffer
,StringBuilder
,HashMap
orHashSet
scala.collection.concurrent
- Mutable, concurrent data-structures such asTrieMap
scala.concurrent
- Primitives for concurrent programming such asFutures
andPromises
scala.io
- Input and output operationsscala.math
- Basic math functions and additional numeric types likeBigInt
andBigDecimal
scala.sys
- Interaction with other processes and the operating systemscala.util.matching
- Regular expressionsOther packages exist. See the complete list on the right.
Additional parts of the standard library are shipped as separate libraries. These include:
scala.reflect
- Scala's reflection API (scala-reflect.jar)scala.xml
- XML parsing, manipulation, and serialization (scala-xml.jar)scala.collection.parallel
- Parallel collections (scala-parallel-collections.jar)scala.util.parsing
- Parser combinators (scala-parser-combinators.jar)scala.swing
- A convenient wrapper around Java's GUI framework called Swing (scala-swing.jar)Automatic imports
Identifiers in the scala package and the
scala.Predef
object are always in scope by default.Some of these identifiers are type aliases provided as shortcuts to commonly used classes. For example,
List
is an alias forscala.collection.immutable.List
.Other aliases refer to classes provided by the underlying platform. For example, on the JVM,
String
is an alias forjava.lang.String
.