Scala 3/API/scala.collection/Iterator

Iterator

@SerialVersionUID(3L) object Iterator extends IterableFactory[[A] =>> Iterator[A]]
Companion
class
trait IterableFactory[[A] =>> Iterator[A]]
class Object
trait Matchable
class Any

Value members

Concrete methods

override def apply[A](xs: A*): Iterator[A]
Definition Classes
def continually[A](elem: => A): Iterator[A]

Creates an infinite-length iterator returning the results of evaluating an expression.

Creates an infinite-length iterator returning the results of evaluating an expression. The expression is recomputed for every element.

Value Params
elem

the element computation.

Returns

the iterator containing an infinite number of results of evaluating elem.

final def empty[T]: Iterator[T]

The iterator which produces no values.

The iterator which produces no values.

override def fill[A](len: Int)(elem: => A): Iterator[A]

Creates iterator that produces the results of some element computation a number of times.

Creates iterator that produces the results of some element computation a number of times.

Value Params
elem

the element computation

len

the number of elements returned by the iterator.

Returns

An iterator that produces the results of n evaluations of elem.

Definition Classes
override def from[A](source: IterableOnce[A]): Iterator[A]

Creates a target collection from an existing source collection

Creates a target collection from an existing source collection

Type Params
A

the type of the collection’s elements

Value Params
source

Source collection

Returns

a new collection with the elements of source

Definition Classes
def from(start: Int): Iterator[Int]

Creates an infinite-length iterator which returns successive values from some start value.

Creates an infinite-length iterator which returns successive values from some start value.

Value Params
start

the start value of the iterator

Returns

the iterator producing the infinite sequence of values start, start + 1, start + 2, ...

def from(start: Int, step: Int): Iterator[Int]

Creates an infinite-length iterator returning values equally spaced apart.

Creates an infinite-length iterator returning values equally spaced apart.

Value Params
start

the start value of the iterator

step

the increment between successive values

Returns

the iterator producing the infinite sequence of values start, start + 1 * step, start + 2 * step, ...

def iterate[T](start: T)(f: T => T): Iterator[T]

Creates an infinite iterator that repeatedly applies a given function to the previous result.

Creates an infinite iterator that repeatedly applies a given function to the previous result.

Value Params
f

the function that's repeatedly applied

start

the start value of the iterator

Returns

the iterator producing the infinite sequence of values start, f(start), f(f(start)), ...

def newBuilder[A]: Builder[A, Iterator[A]]
Type Params
A

the type of the collection’s elements

Returns

A builder for Iterable objects.

def range(start: Int, end: Int): Iterator[Int]

Creates nn iterator returning successive values in some integer interval.

Creates nn iterator returning successive values in some integer interval.

Value Params
end

the end value of the iterator (the first value NOT returned)

start

the start value of the iterator

Returns

the iterator producing values start, start + 1, ..., end - 1

def range(start: Int, end: Int, step: Int): Iterator[Int]

An iterator producing equally spaced values in some integer interval.

An iterator producing equally spaced values in some integer interval.

Value Params
end

the end value of the iterator (the first value NOT returned)

start

the start value of the iterator

step

the increment value of the iterator (must be positive or negative)

Returns

the iterator producing values start, start + step, ... up to, but excluding end

def single[A](a: A): Iterator[A]
override def tabulate[A](end: Int)(f: Int => A): Iterator[A]

Creates an iterator producing the values of a given function over a range of integer values starting from 0.

Creates an iterator producing the values of a given function over a range of integer values starting from 0.

Value Params
end

The number of elements returned by the iterator

f

The function computing element values

Returns

An iterator that produces the values f(0), ..., f(n -1).

Definition Classes
override def unfold[A, S](init: S)(f: S => Option[(A, S)]): Iterator[A]

Creates an Iterator that uses a function f to produce elements of type A and update an internal state of type S.

Creates an Iterator that uses a function f to produce elements of type A and update an internal state of type S.

Type Params
A

Type of the elements

S

Type of the internal state

Value Params
f

Computes the next element (or returns None to signal the end of the collection)

init

State initial value

Returns

an Iterator that produces elements using f until f returns None

Definition Classes

Inherited methods

def concat[A](xss: Iterable[A]*): Iterator[A]

Concatenates all argument collections into a single collection.

Concatenates all argument collections into a single collection.

Value Params
xss

the collections that are to be concatenated.

Returns

the concatenation of all the collections.

Inherited from
IterableFactory
def fill[A](n1: Int, n2: Int, n3: Int, n4: Int, n5: Int)(elem: => A): Iterator[Iterator[Iterator[Iterator[Iterator[A]]]]]

Produces a five-dimensional collection containing the results of some element computation a number of times.

Produces a five-dimensional collection containing the results of some element computation a number of times.

Value Params
elem

the element computation

n1

the number of elements in the 1st dimension

n2

the number of elements in the 2nd dimension

n3

the number of elements in the 3rd dimension

n4

the number of elements in the 4th dimension

n5

the number of elements in the 5th dimension

Returns

A collection that contains the results of n1 x n2 x n3 x n4 x n5 evaluations of elem.

Inherited from
IterableFactory
def fill[A](n1: Int, n2: Int, n3: Int, n4: Int)(elem: => A): Iterator[Iterator[Iterator[Iterator[A]]]]

Produces a four-dimensional collection containing the results of some element computation a number of times.

Produces a four-dimensional collection containing the results of some element computation a number of times.

Value Params
elem

the element computation

n1

the number of elements in the 1st dimension

n2

the number of elements in the 2nd dimension

n3

the number of elements in the 3rd dimension

n4

the number of elements in the 4th dimension

Returns

A collection that contains the results of n1 x n2 x n3 x n4 evaluations of elem.

Inherited from
IterableFactory
def fill[A](n1: Int, n2: Int, n3: Int)(elem: => A): Iterator[Iterator[Iterator[A]]]

Produces a three-dimensional collection containing the results of some element computation a number of times.

Produces a three-dimensional collection containing the results of some element computation a number of times.

Value Params
elem

the element computation

n1

the number of elements in the 1st dimension

n2

the number of elements in the 2nd dimension

n3

the number of elements in the 3rd dimension

Returns

A collection that contains the results of n1 x n2 x n3 evaluations of elem.

Inherited from
IterableFactory
def fill[A](n1: Int, n2: Int)(elem: => A): Iterator[Iterator[A]]

Produces a two-dimensional collection containing the results of some element computation a number of times.

Produces a two-dimensional collection containing the results of some element computation a number of times.

Value Params
elem

the element computation

n1

the number of elements in the 1st dimension

n2

the number of elements in the 2nd dimension

Returns

A collection that contains the results of n1 x n2 evaluations of elem.

Inherited from
IterableFactory
def iterate[A](start: A, len: Int)(f: A => A): Iterator[A]

Produces a collection containing repeated applications of a function to a start value.

Produces a collection containing repeated applications of a function to a start value.

Value Params
f

the function that's repeatedly applied

len

the number of elements contained in the collection

start

the start value of the collection

Returns

a collection with len values in the sequence start, f(start), f(f(start)), ...

Inherited from
IterableFactory
def range[A](start: A, end: A, step: A)(`evidence$25`: Integral[A]): Iterator[A]

Produces a collection containing equally spaced values in some integer interval.

Produces a collection containing equally spaced values in some integer interval.

Value Params
end

the end value of the collection (the first value NOT contained)

start

the start value of the collection

step

the difference between successive elements of the collection (must be positive or negative)

Returns

a collection with values start, start + step, ... up to, but excluding end

Inherited from
IterableFactory
def range[A](start: A, end: A)(`evidence$24`: Integral[A]): Iterator[A]

Produces a collection containing a sequence of increasing of integers.

Produces a collection containing a sequence of increasing of integers.

Value Params
end

the end value of the collection (the first value NOT contained)

start

the first element of the collection

Returns

a collection with values start, start + 1, ..., end - 1

Inherited from
IterableFactory
def tabulate[A](n1: Int, n2: Int, n3: Int, n4: Int, n5: Int)(f: (Int, Int, Int, Int, Int) => A): Iterator[Iterator[Iterator[Iterator[Iterator[A]]]]]

Produces a five-dimensional collection containing values of a given function over ranges of integer values starting from 0.

Produces a five-dimensional collection containing values of a given function over ranges of integer values starting from 0.

Value Params
f

The function computing element values

n1

the number of elements in the 1st dimension

n2

the number of elements in the 2nd dimension

n3

the number of elements in the 3rd dimension

n4

the number of elements in the 4th dimension

n5

the number of elements in the 5th dimension

Returns

A collection consisting of elements f(i1, i2, i3, i4, i5) for 0 <= i1 < n1, 0 <= i2 < n2, 0 <= i3 < n3, 0 <= i4 < n4, and 0 <= i5 < n5.

Inherited from
IterableFactory
def tabulate[A](n1: Int, n2: Int, n3: Int, n4: Int)(f: (Int, Int, Int, Int) => A): Iterator[Iterator[Iterator[Iterator[A]]]]

Produces a four-dimensional collection containing values of a given function over ranges of integer values starting from 0.

Produces a four-dimensional collection containing values of a given function over ranges of integer values starting from 0.

Value Params
f

The function computing element values

n1

the number of elements in the 1st dimension

n2

the number of elements in the 2nd dimension

n3

the number of elements in the 3rd dimension

n4

the number of elements in the 4th dimension

Returns

A collection consisting of elements f(i1, i2, i3, i4) for 0 <= i1 < n1, 0 <= i2 < n2, 0 <= i3 < n3, and 0 <= i4 < n4.

Inherited from
IterableFactory
def tabulate[A](n1: Int, n2: Int, n3: Int)(f: (Int, Int, Int) => A): Iterator[Iterator[Iterator[A]]]

Produces a three-dimensional collection containing values of a given function over ranges of integer values starting from 0.

Produces a three-dimensional collection containing values of a given function over ranges of integer values starting from 0.

Value Params
f

The function computing element values

n1

the number of elements in the 1st dimension

n2

the number of elements in the 2nd dimension

n3

the number of elements in the 3rd dimension

Returns

A collection consisting of elements f(i1, i2, i3) for 0 <= i1 < n1, 0 <= i2 < n2, and 0 <= i3 < n3.

Inherited from
IterableFactory
def tabulate[A](n1: Int, n2: Int)(f: (Int, Int) => A): Iterator[Iterator[A]]

Produces a two-dimensional collection containing values of a given function over ranges of integer values starting from 0.

Produces a two-dimensional collection containing values of a given function over ranges of integer values starting from 0.

Value Params
f

The function computing element values

n1

the number of elements in the 1st dimension

n2

the number of elements in the 2nd dimension

Returns

A collection consisting of elements f(i1, i2) for 0 <= i1 < n1 and 0 <= i2 < n2.

Inherited from
IterableFactory

Implicits

Inherited implicits

implicit def iterableFactory[A]: Factory[A, Iterator[A]]
Inherited from
IterableFactory