Scala 3
3.3.1
LearnInstallPlaygroundFind A LibraryCommunityBlog
LearnInstallPlaygroundFind A LibraryCommunityBlog
API
Generated with
Copyright (c) 2002-2023, LAMP/EPFL
Copyright (c) 2002-2023, LAMP/EPFL
Scala 3/scala/scala.collection/AbstractIterator

AbstractIterator

scala.collection.AbstractIterator
abstract class AbstractIterator[+A] extends Iterator[A]

Explicit instantiation of the Iterator trait to reduce class file size in subclasses.

Attributes

Source
Iterator.scala
Graph
Supertypes
trait Iterator[A]
trait IterableOnce[A]
class Object
trait Matchable
class Any
Show all
Known subtypes
class GroupedIterator[B]
class LineIterator

Members list

Type members

Inherited classlikes

class GroupedIterator[B >: A](self: Iterator[B], size: Int, step: Int) extends AbstractIterator[Seq[B]]

A flexible iterator for transforming an Iterator[A] into an Iterator[Seq[A]], with configurable sequence size, step, and strategy for dealing with remainder elements which don't fit evenly into the last group.

A flexible iterator for transforming an Iterator[A] into an Iterator[Seq[A]], with configurable sequence size, step, and strategy for dealing with remainder elements which don't fit evenly into the last group.

A GroupedIterator is yielded by grouped and by sliding, where the step may differ from the group size.

Attributes

Inherited from:
Iterator
Source
Iterator.scala
Supertypes
class AbstractIterator[Seq[B]]
trait Iterator[Seq[B]]
trait IterableOnce[Seq[B]]
class Object
trait Matchable
class Any
Show all

Value members

Inherited methods

final def ++[B >: A](xs: => IterableOnce[B]): Iterator[B]

Attributes

Inherited from:
Iterator
Source
Iterator.scala
final def addString(b: StringBuilder): b.type

Appends all elements of this collection to a string builder.

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

Value parameters

b

the string builder to which elements are appended.

Attributes

Returns

the string builder b to which elements were appended.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
final def addString(b: StringBuilder, sep: String): b.type

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

Appends all elements of this 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 collection, separated by the string sep.

Example:

scala> val a = List(1,2,3,4)
a: List[Int] = List(1, 2, 3, 4)

scala> val b = new StringBuilder()
b: StringBuilder =

scala> a.addString(b, ", ")
res0: StringBuilder = 1, 2, 3, 4

Value parameters

b

the string builder to which elements are appended.

sep

the separator string.

Attributes

Returns

the string builder b to which elements were appended.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def addString(b: StringBuilder, start: String, sep: String, end: String): b.type

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

Appends all elements of this collection to a string builder using start, end, and separator strings. The written text begins with the string start and ends with the string end. Inside, the string representations (w.r.t. the method toString) of all elements of this collection are separated by the string sep.

Example:

scala> val a = List(1,2,3,4)
a: List[Int] = List(1, 2, 3, 4)

scala> val b = new StringBuilder()
b: StringBuilder =

scala> a.addString(b , "List(" , ", " , ")")
res5: StringBuilder = List(1, 2, 3, 4)

Value parameters

b

the string builder to which elements are appended.

end

the ending string.

sep

the separator string.

start

the starting string.

Attributes

Returns

the string builder b to which elements were appended.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def buffered: BufferedIterator[A]

Creates a buffered iterator from this iterator.

Creates a buffered iterator from this iterator.

Attributes

Returns

a buffered iterator producing the same values as this iterator.

See also
Note

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

Inherited from:
Iterator
Source
Iterator.scala
def collect[B](pf: PartialFunction[A, B]): Iterator[B]

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

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

Type parameters

B

the element type of the returned iterator.

Value parameters

pf

the partial function which filters and maps the iterator.

Attributes

Returns

a new iterator 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.

Inherited from:
Iterator
Source
Iterator.scala
def collectFirst[B](pf: PartialFunction[A, B]): Option[B]

Finds the first element of the collection for which the given partial function is defined, and applies the partial function to it.

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

Value parameters

pf

the partial function

Attributes

Returns

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

Example

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

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def concat[B >: A](xs: => IterableOnce[B]): Iterator[B]

Attributes

Inherited from:
Iterator
Source
Iterator.scala
def contains(elem: Any): Boolean

Tests whether this iterator contains a given value as an element.

Tests whether this iterator contains a given value as an element.

Note: may not terminate for infinite iterators.

Value parameters

elem

the element to test.

Attributes

Returns

true if this iterator produces some value that is is equal (as determined by ==) to elem, false otherwise.

Note

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

Inherited from:
Iterator
Source
Iterator.scala
def copyToArray[B >: A](xs: Array[B], start: Int, len: Int): Int

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

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

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

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

Type parameters

B

the type of the elements of the array.

Value parameters

len

the maximal number of elements to copy.

start

the starting index of xs.

xs

the array to fill.

Attributes

Returns

the number of elements written to the array

Note

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

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
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 index start with values of this collection.

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

Type parameters

B

the type of the elements of the array.

Value parameters

start

the starting index of xs.

xs

the array to fill.

Attributes

Returns

the number of elements written to the array

Note

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

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
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 index start with values of this collection.

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

Type parameters

B

the type of the elements of the array.

Value parameters

xs

the array to fill.

Attributes

Returns

the number of elements written to the array

Note

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

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def corresponds[B](that: 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.

Type parameters

B

the type of the elements of that

Value parameters

p

the test predicate, which relates elements from both collections

that

the other collection

Attributes

Returns

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

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def count(p: A => Boolean): Int

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

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

Note: will not terminate for infinite-sized collections.

Value parameters

p

the predicate used to test elements.

Attributes

Returns

the number of elements satisfying the predicate p.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def distinct: Iterator[A]

Builds a new iterator from this one without any duplicated elements on it.

Builds a new iterator from this one without any duplicated elements on it.

Attributes

Returns

iterator with distinct elements

Note

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

Inherited from:
Iterator
Source
Iterator.scala
def distinctBy[B](f: A => B): Iterator[A]

Builds a new iterator from this one without any duplicated elements as determined by == after applying the transforming function f.

Builds a new iterator from this one without any duplicated elements as determined by == after applying the transforming function f.

Type parameters

B

the type of the elements after being transformed by f

Value parameters

f

The transforming function whose result is used to determine the uniqueness of each element

Attributes

Returns

iterator with distinct elements

Note

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

Inherited from:
Iterator
Source
Iterator.scala
def drop(n: Int): Iterator[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.

Value parameters

n

the number of elements to drop from this iterator.

Attributes

Returns

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

Inherited from:
Iterator
Source
Iterator.scala
def dropWhile(p: A => Boolean): Iterator[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.

Value parameters

p

The predicate used to test elements.

Attributes

Returns

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

Inherited from:
Iterator
Source
Iterator.scala
def duplicate: (Iterator[A], Iterator[A])

Creates two new iterators that both iterate over the same elements as this iterator (in the same order).

Creates two new iterators that both iterate over the same elements as this iterator (in the same order). The duplicate iterators are considered equal if they are positioned at the same element.

Given that most methods on iterators will make the original iterator unfit for further use, this methods provides a reliable way of calling multiple such methods on an iterator.

Attributes

Returns

a pair of iterators

Note

The implementation may allocate temporary storage for elements iterated by one iterator but not yet by the other.

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

Inherited from:
Iterator
Source
Iterator.scala
def exists(p: A => Boolean): Boolean

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

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

Note: may not terminate for infinite-sized collections.

Value parameters

p

the predicate used to test elements.

Attributes

Returns

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

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def filter(p: A => Boolean): Iterator[A]

Selects all elements of this iterator which satisfy a predicate.

Selects all elements of this iterator which satisfy a predicate.

Value parameters

p

the predicate used to test elements.

Attributes

Returns

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

Inherited from:
Iterator
Source
Iterator.scala
def filterNot(p: A => Boolean): Iterator[A]

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

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

Value parameters

pred

the predicate used to test elements.

Attributes

Returns

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

Inherited from:
Iterator
Source
Iterator.scala
def find(p: A => Boolean): Option[A]

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

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

Value parameters

p

the predicate used to test elements.

Attributes

Returns

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

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def flatMap[B](f: A => IterableOnce[B]): Iterator[B]

Builds a new iterator by applying a function to all elements of this iterator and using the elements of the resulting collections.

Builds a new iterator by applying a function to all elements of this iterator 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 iterator. 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)

Type parameters

B

the element type of the returned collection.

Value parameters

f

the function to apply to each element.

Attributes

Returns

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

Inherited from:
Iterator
Source
Iterator.scala
def flatten[B](implicit ev: A => IterableOnce[B]): Iterator[B]

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

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

The resulting collection's type will be guided by the type of iterator. For example:

val xs = List(
           Set(1, 2, 3),
           Set(1, 2, 3)
         ).flatten
// xs == List(1, 2, 3, 1, 2, 3)

val ys = Set(
           List(1, 2, 3),
           List(3, 2, 1)
         ).flatten
// ys == Set(1, 2, 3)

Type parameters

B

the type of the elements of each iterable collection.

Value parameters

asIterable

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

Attributes

Returns

a new iterator resulting from concatenating all element iterators.

Inherited from:
Iterator
Source
Iterator.scala
def fold[A1 >: A](z: A1)(op: (A1, A1) => A1): A1

Folds the elements of this collection using the specified associative binary operator.

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

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

Note: will not terminate for infinite-sized collections.

Type parameters

A1

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

Value parameters

op

a binary operator that must be associative.

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

Attributes

Returns

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

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def foldLeft[B](z: B)(op: (B, A) => B): B

Applies a binary operator to a start value and all elements of this collection, going left to right.

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

Type parameters

B

the result type of the binary operator.

Value parameters

op

the binary operator.

z

the start value.

Attributes

Returns

the result of inserting op between consecutive elements of this collection, going left to right with the start value z on the left: op(...op(z, x1), x2, ..., xn) where x1, ..., xn are the elements of this collection. Returns z if this collection is empty.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def foldRight[B](z: B)(op: (A, B) => B): B

Applies a binary operator to all elements of this collection and a start value, going right to left.

Applies a binary operator to all elements of this 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.

Type parameters

B

the result type of the binary operator.

Value parameters

op

the binary operator.

z

the start value.

Attributes

Returns

the result of inserting op between consecutive elements of this collection, going right to left with the start value z on the right: op(x1, op(x2, ... op(xn, z)...)) where x1, ..., xn are the elements of this collection. Returns z if this collection is empty.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def forall(p: A => Boolean): Boolean

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

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

Note: may not terminate for infinite-sized collections.

Value parameters

p

the predicate used to test elements.

Attributes

Returns

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

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
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.

Attributes

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def grouped[B >: A](size: Int): GroupedIterator[B]

Returns an iterator which groups this iterator into fixed size blocks.

Returns an iterator which groups this iterator into fixed size blocks. Example usages:

// Returns List(List(1, 2, 3), List(4, 5, 6), List(7)))
(1 to 7).iterator.grouped(3).toList
// Returns List(List(1, 2, 3), List(4, 5, 6))
(1 to 7).iterator.grouped(3).withPartial(false).toList
// Returns List(List(1, 2, 3), List(4, 5, 6), List(7, 20, 25)
// Illustrating that withPadding's argument is by-name.
val it2 = Iterator.iterate(20)(_ + 5)
(1 to 7).iterator.grouped(3).withPadding(it2.next).toList

Attributes

Note

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

Inherited from:
Iterator
Source
Iterator.scala
def hasNext: Boolean

Check if there is a next element available.

Check if there is a next element available.

Attributes

Returns

true if there is a next element, false otherwise

Note

Reuse: The iterator remains valid for further use whatever result is returned.

Inherited from:
Iterator
Source
Iterator.scala
def indexOf[B >: A](elem: B, from: Int): Int

Returns the index of the first occurrence of the specified object in this iterable object after or at some start index.

Returns the index of the first occurrence of the specified object in this iterable object after or at some start index.

Note: may not terminate for infinite iterators.

Value parameters

elem

element to search for.

from

the start index

Attributes

Returns

the index >= from of the first occurrence of elem in the values produced by this iterator, or -1 if such an element does not exist until the end of the iterator is reached.

Note

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

Inherited from:
Iterator
Source
Iterator.scala
def indexOf[B >: A](elem: B): Int

Returns the index of the first occurrence of the specified object in this iterable object.

Returns the index of the first occurrence of the specified object in this iterable object.

Note: may not terminate for infinite iterators.

Value parameters

elem

element to search for.

Attributes

Returns

the index of the first occurrence of elem in the values produced by this iterator, or -1 if such an element does not exist until the end of the iterator is reached.

Note

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

Inherited from:
Iterator
Source
Iterator.scala
def indexWhere(p: A => Boolean, from: Int): Int

Attributes

Inherited from:
Iterator
Source
Iterator.scala
override def isEmpty: Boolean

Tests whether the iterator is empty.

Tests whether the iterator is empty.

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

Attributes

Returns

true if the iterator contains no elements, false otherwise.

Definition Classes
Inherited from:
Iterator
Source
Iterator.scala
def isTraversableAgain: Boolean

Tests whether this collection can be repeatedly traversed.

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

Attributes

Returns

true if it is repeatedly traversable, false otherwise.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
final def iterator: Iterator[A]

Iterator can be used only once

Iterator can be used only once

Attributes

Inherited from:
Iterator
Source
Iterator.scala
def knownSize: Int

Attributes

Returns

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

Inherited from:
IterableOnce
Source
IterableOnce.scala
final def length: Int

Attributes

Inherited from:
Iterator
Source
Iterator.scala
def map[B](f: A => B): Iterator[B]

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

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

Type parameters

B

the element type of the returned iterator.

Value parameters

f

the function to apply to each element.

Attributes

Returns

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

Inherited from:
Iterator
Source
Iterator.scala
def max[B >: A](implicit ord: Ordering[B]): A

Finds the largest element.

Finds the largest element.

Note: will not terminate for infinite-sized collections.

Type parameters

B

The type over which the ordering is defined.

Value parameters

ord

An ordering to be used for comparing elements.

Attributes

Returns

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

Throws

UnsupportedOperationException if this collection is empty.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def maxBy[B](f: A => B)(implicit cmp: 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.

Type parameters

B

The result type of the function f.

Value parameters

cmp

An ordering to be used for comparing elements.

f

The measuring function.

Attributes

Returns

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

Throws

UnsupportedOperationException if this collection is empty.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def maxByOption[B](f: A => B)(implicit cmp: 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.

Type parameters

B

The result type of the function f.

Value parameters

cmp

An ordering to be used for comparing elements.

f

The measuring function.

Attributes

Returns

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

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def maxOption[B >: A](implicit ord: Ordering[B]): Option[A]

Finds the largest element.

Finds the largest element.

Note: will not terminate for infinite-sized collections.

Type parameters

B

The type over which the ordering is defined.

Value parameters

ord

An ordering to be used for comparing elements.

Attributes

Returns

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

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def min[B >: A](implicit ord: Ordering[B]): A

Finds the smallest element.

Finds the smallest element.

Note: will not terminate for infinite-sized collections.

Type parameters

B

The type over which the ordering is defined.

Value parameters

ord

An ordering to be used for comparing elements.

Attributes

Returns

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

Throws

UnsupportedOperationException if this collection is empty.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def minBy[B](f: A => B)(implicit cmp: 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.

Type parameters

B

The result type of the function f.

Value parameters

cmp

An ordering to be used for comparing elements.

f

The measuring function.

Attributes

Returns

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

Throws

UnsupportedOperationException if this collection is empty.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def minByOption[B](f: A => B)(implicit cmp: 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.

Type parameters

B

The result type of the function f.

Value parameters

cmp

An ordering to be used for comparing elements.

f

The measuring function.

Attributes

Returns

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

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def minOption[B >: A](implicit ord: Ordering[B]): Option[A]

Finds the smallest element.

Finds the smallest element.

Note: will not terminate for infinite-sized collections.

Type parameters

B

The type over which the ordering is defined.

Value parameters

ord

An ordering to be used for comparing elements.

Attributes

Returns

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

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
final def mkString: String

Displays all elements of this collection in a string.

Displays all elements of this collection in a string.

Delegates to addString, which can be overridden.

Attributes

Returns

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

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
final def mkString(sep: String): String

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

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

Delegates to addString, which can be overridden.

Value parameters

sep

the separator string.

Attributes

Returns

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

Example

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

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
final def mkString(start: String, sep: String, end: String): String

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

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

Delegates to addString, which can be overridden.

Value parameters

end

the ending string.

sep

the separator string.

start

the starting string.

Attributes

Returns

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

Example

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

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def next(): A

Return the next element and advance the iterator.

Return the next element and advance the iterator.

Attributes

Returns

the next element.

Throws

NoSuchElementException if there is no next element.

Note

Reuse: Advances the iterator, which may exhaust the elements. It is valid to make additional calls on the iterator.

Inherited from:
Iterator
Source
Iterator.scala
def nextOption(): Option[A]

Wraps the value of next() in an option.

Wraps the value of next() in an option.

Attributes

Returns

Some(next) if a next element exists, None otherwise.

Inherited from:
Iterator
Source
Iterator.scala
def nonEmpty: Boolean

Tests whether the collection is not empty.

Tests whether the collection is not empty.

Attributes

Returns

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

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def padTo[B >: A](len: Int, elem: B): Iterator[B]

A copy of this iterator with an element value appended until a given target length is reached.

A copy of this iterator with an element value appended until a given target length is reached.

Type parameters

B

the element type of the returned iterator.

Value parameters

elem

the padding value

len

the target length

Attributes

Returns

a new iterator consisting of all elements of this iterator followed by the minimal number of occurrences of elem so that the resulting collection has a length of at least len.

Inherited from:
Iterator
Source
Iterator.scala
def partition(p: A => Boolean): (Iterator[A], Iterator[A])

Partitions this iterator in two iterators according to a predicate.

Partitions this iterator in two iterators according to a predicate.

Value parameters

p

the predicate on which to partition

Attributes

Returns

a pair of iterators: the iterator that satisfies the predicate p and the iterator that does not. The relative order of the elements in the resulting iterators is the same as in the original iterator.

Note

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

Inherited from:
Iterator
Source
Iterator.scala
def patch[B >: A](from: Int, patchElems: Iterator[B], replaced: Int): Iterator[B]

Returns this iterator with patched values.

Returns this iterator with patched values. Patching at negative indices is the same as patching starting at 0. Patching at indices at or larger than the length of the original iterator appends the patch to the end. If more values are replaced than actually exist, the excess is ignored.

Value parameters

from

The start index from which to patch

patchElems

The iterator of patch values

replaced

The number of values in the original iterator that are replaced by the patch.

Attributes

Note

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

Inherited from:
Iterator
Source
Iterator.scala
def product[B >: A](implicit num: 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.

Type parameters

B

the result type of the * operator.

Value parameters

num

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

Attributes

Returns

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

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def reduce[B >: A](op: (B, B) => B): B

Reduces the elements of this collection using the specified associative binary operator.

Reduces the elements of this collection using the specified associative binary operator.

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

Type parameters

B

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

Value parameters

op

A binary operator that must be associative.

Attributes

Returns

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

Throws

UnsupportedOperationException if this collection is empty.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def reduceLeft[B >: A](op: (B, A) => B): B

Applies a binary operator to all elements of this collection, going left to right.

Applies a binary operator to all elements of this 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.

Type parameters

B

the result type of the binary operator.

Value parameters

op

the binary operator.

Attributes

Returns

the result of inserting op between consecutive elements of this collection, going left to right: op( op( ... op(x1, x2) ..., xn-1), xn) where x1, ..., xn are the elements of this collection.

Throws

UnsupportedOperationException if this collection is empty.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def reduceLeftOption[B >: A](op: (B, A) => B): Option[B]

Optionally applies a binary operator to all elements of this collection, going left to right.

Optionally applies a binary operator to all elements of this 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.

Type parameters

B

the result type of the binary operator.

Value parameters

op

the binary operator.

Attributes

Returns

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

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def reduceOption[B >: A](op: (B, B) => B): Option[B]

Reduces the elements of this collection, if any, using the specified associative binary operator.

Reduces the elements of this collection, if any, using the specified associative binary operator.

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

Type parameters

B

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

Value parameters

op

A binary operator that must be associative.

Attributes

Returns

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

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def reduceRight[B >: A](op: (A, B) => B): B

Applies a binary operator to all elements of this collection, going right to left.

Applies a binary operator to all elements of this 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.

Type parameters

B

the result type of the binary operator.

Value parameters

op

the binary operator.

Attributes

Returns

the result of inserting op between consecutive elements of this collection, going right to left: op(x1, op(x2, ..., op(xn-1, xn)...)) where x1, ..., xn are the elements of this collection.

Throws

UnsupportedOperationException if this collection is empty.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def reduceRightOption[B >: A](op: (A, B) => B): Option[B]

Optionally applies a binary operator to all elements of this collection, going right to left.

Optionally applies a binary operator to all elements of this 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.

Type parameters

B

the result type of the binary operator.

Value parameters

op

the binary operator.

Attributes

Returns

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

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
protected def reversed: Iterable[A]

Attributes

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def sameElements[B >: A](that: IterableOnce[B]): Boolean

Checks whether corresponding elements of the given iterable collection compare equal (with respect to ==) to elements of this iterator.

Checks whether corresponding elements of the given iterable collection compare equal (with respect to ==) to elements of this iterator.

Type parameters

B

the type of the elements of collection that.

Value parameters

that

the collection to compare

Attributes

Returns

true if both collections contain equal elements in the same order, false otherwise. <invalid inheritdoc annotation>

Inherited from:
Iterator
Source
Iterator.scala
def scanLeft[B](z: B)(op: (B, A) => B): Iterator[B]

Produces a iterator containing cumulative results of applying the operator going left to right, including the initial value.

Produces a iterator containing cumulative results of applying the operator going left to right, including the initial value.

Note: will not terminate for infinite-sized collections.

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

Type parameters

B

the type of the elements in the resulting collection

Value parameters

op

the binary operator applied to the intermediate result and the element

z

the initial value

Attributes

Returns

collection with intermediate results

Inherited from:
Iterator
Source
Iterator.scala
def size: Int

The size of this collection.

The size of this collection.

Note: will not terminate for infinite-sized collections.

Attributes

Returns

the number of elements in this collection.

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def slice(from: Int, until: Int): Iterator[A]

Selects an interval of elements.

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

from <= indexOf(x) < until

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

Value parameters

from

the lowest index to include from this iterator.

until

the lowest index to EXCLUDE from this iterator.

Attributes

Returns

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

Inherited from:
Iterator
Source
Iterator.scala
def sliding[B >: A](size: Int, step: Int): GroupedIterator[B]

Returns an iterator which presents a "sliding window" view of this iterator.

Returns an iterator which presents a "sliding window" view of this iterator. The first argument is the window size, and the second argument step is how far to advance the window on each iteration. The step defaults to 1.

The returned GroupedIterator can be configured to either pad a partial result to size size or suppress the partial result entirely.

Example usages:

// Returns List(ArraySeq(1, 2, 3), ArraySeq(2, 3, 4), ArraySeq(3, 4, 5))
(1 to 5).iterator.sliding(3).toList
// Returns List(ArraySeq(1, 2, 3, 4), ArraySeq(4, 5))
(1 to 5).iterator.sliding(4, 3).toList
// Returns List(ArraySeq(1, 2, 3, 4))
(1 to 5).iterator.sliding(4, 3).withPartial(false).toList
// Returns List(ArraySeq(1, 2, 3, 4), ArraySeq(4, 5, 20, 25))
// Illustrating that withPadding's argument is by-name.
val it2 = Iterator.iterate(20)(_ + 5)
(1 to 5).iterator.sliding(4, 3).withPadding(it2.next).toList

Value parameters

size

the number of elements per group

step

the distance between the first elements of successive groups

Attributes

Returns

A GroupedIterator producing Seq[B]s of size size, except the last element (which may be the only element) will be truncated if there are fewer than size elements remaining to be grouped. This behavior can be configured.

Note

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

Inherited from:
Iterator
Source
Iterator.scala
def span(p: A => Boolean): (Iterator[A], Iterator[A])

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

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

Note: c span p is equivalent to (but possibly more efficient than) (c takeWhile p, c dropWhile p), provided the evaluation of the predicate p does not cause any side-effects.

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

Attributes

Note

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

Inherited from:
Iterator
Source
Iterator.scala
def splitAt(n: Int): (Iterator[A], Iterator[A])

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

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

Value parameters

n

the position at which to split.

Attributes

Returns

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

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def stepper[S <: Stepper[_]](implicit shape: StepperShape[A, S]): S

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

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

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

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

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

Attributes

Inherited from:
IterableOnce
Source
IterableOnce.scala
def sum[B >: A](implicit num: 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.

Type parameters

B

the result type of the + operator.

Value parameters

num

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

Attributes

Returns

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

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def take(n: Int): Iterator[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.

Value parameters

n

the number of elements to take from this iterator.

Attributes

Returns

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

Inherited from:
Iterator
Source
Iterator.scala
def takeWhile(p: A => Boolean): Iterator[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.

Value parameters

p

The predicate used to test elements.

Attributes

Returns

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

Inherited from:
Iterator
Source
Iterator.scala
override def tapEach[U](f: A => U): Iterator[A]

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

Applies a side-effecting function to each element in this collection. Strict collections will apply f to their elements immediately, while lazy collections like Views and LazyLists will only apply f on each element if and when that element is evaluated, and each time that element is evaluated.

Type parameters

U

the return type of f

Value parameters

f

a function to apply to each element in this iterator

Attributes

Returns

The same logical collection as this

Definition Classes
Inherited from:
Iterator
Source
Iterator.scala
def to[C1](factory: Factory[A, C1]): C1

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

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

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

Attributes

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def toArray[B >: A : ClassTag]: Array[B]

Convert collection to array.

Convert collection to array.

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

Attributes

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
final def toBuffer[B >: A]: Buffer[B]

Attributes

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def toIndexedSeq: IndexedSeq[A]

Attributes

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def toList: List[A]

Attributes

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def toMap[K, V](implicit ev: A <:< (K, V)): Map[K, V]

Attributes

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def toSeq: Seq[A]

Attributes

Returns

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

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def toSet[B >: A]: Set[B]

Attributes

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
override def toString: String

Converts this iterator to a string.

Converts this iterator to a string.

Attributes

Returns

"<iterator>"

Note

Reuse: The iterator remains valid for further use whatever result is returned.

Definition Classes
Inherited from:
Iterator
Source
Iterator.scala
def toVector: Vector[A]

Attributes

Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def withFilter(p: A => Boolean): Iterator[A]

Creates an iterator over all the elements of this iterator that satisfy the predicate p.

Creates an iterator over all the elements of this iterator that satisfy the predicate p. The order of the elements is preserved.

Note: withFilter is the same as filter on iterators. It exists so that for-expressions with filters work over iterators.

Value parameters

p

the predicate used to test values.

Attributes

Returns

an iterator which produces those values of this iterator which satisfy the predicate p.

Note

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

Inherited from:
Iterator
Source
Iterator.scala
def zip[B](that: IterableOnce[B]): Iterator[(A, B)]

Attributes

Inherited from:
Iterator
Source
Iterator.scala
def zipAll[A1 >: A, B](that: IterableOnce[B], thisElem: A1, thatElem: B): Iterator[(A1, B)]

Attributes

Inherited from:
Iterator
Source
Iterator.scala
def zipWithIndex: Iterator[(A, Int)]

Zips this iterator with its indices.

Zips this iterator with its indices.

Attributes

Returns

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

Example

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

Inherited from:
Iterator
Source
Iterator.scala

Deprecated and Inherited methods

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

Attributes

Deprecated
true
Inherited from:
IterableOnceOps
Source
IterableOnce.scala
final def :\[B](z: B)(op: (A, B) => B): B

Attributes

Deprecated
true
Inherited from:
IterableOnceOps
Source
IterableOnce.scala
def aggregate[B](z: => B)(seqop: (B, A) => B, combop: (B, B) => B): B

Attributes

Deprecated
true
Inherited from:
IterableOnceOps
Source
IterableOnce.scala
final def copyToBuffer[B >: A](dest: Buffer[B]): Unit

Attributes

Deprecated
true
Inherited from:
IterableOnceOps
Source
IterableOnce.scala
final override def hasDefiniteSize: Boolean

Tests whether this iterator is known to have a finite size.

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

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

Attributes

Returns

true if this collection is known to have finite size, false otherwise.

See also

method knownSize for a more useful alternative

Deprecated

This method is deprecated in 2.13 because it does not provide any actionable information. As noted above, even the collection library itself does not use it. When there is no guarantee that a collection is finite, it is generally best to attempt a computation anyway and document that it will not terminate for infinite collections rather than backing out because this would prevent performing the computation on collections that are in fact finite even though hasDefiniteSize returns false.

Definition Classes
Inherited from:
Iterator
Source
Iterator.scala
def scanRight[B](z: B)(op: (A, B) => B): Iterator[B]

Attributes

Deprecated
true
Inherited from:
Iterator
Source
Iterator.scala
def seq: Iterator.this.type

Attributes

Deprecated
true
Inherited from:
Iterator
Source
Iterator.scala
final def toIterator: Iterator[A]

Attributes

Deprecated
true
Inherited from:
IterableOnceOps
Source
IterableOnce.scala
final def toStream: Stream[A]

Attributes

Deprecated
true
Inherited from:
IterableOnceOps
Source
IterableOnce.scala
Generated with
Copyright (c) 2002-2023, LAMP/EPFL
Copyright (c) 2002-2023, LAMP/EPFL