scala.collection

Iterator

object Iterator extends AnyRef

The Iterator object provides various functions for creating specialized iterators.

Inherits

  1. AnyRef
  2. Any

Type Members

  1. class IteratorIteratorOps[A] extends AnyRef

    A wrapper class for the flatten method that is added to class Iterator with implicit conversion

Value Members

  1. def apply[A](elems: A*): Iterator[A]

    Creates an iterator with given elements

    Creates an iterator with given elements

    elems

    The elements returned one-by-one from the iterator

    returns

    An iterator which produces the given elements on the first calls to next, and which has no further elements.

  2. 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 epxression is recomputed for every element.

    elem

    the element computation.

    returns

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

  3. val empty: Iterator[Nothing]

    The iterator which produces no values

    The iterator which produces no values

  4. def equals(arg0: Any): Boolean

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    The default implementations of this method is an equivalence relation:

    • It is reflexive: for any instance x of type Any, x.equals(x) should return true.
    • It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true.
    • It is transitive: for any instances x, y, and z of type AnyRef if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

    If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is often necessary to override hashCode to ensure that objects that are "equal" (o1.equals(o2) returns true) hash to the same Int (o1.hashCode.equals(o2.hashCode)).

    arg0

    the object to compare against this object for equality.

    returns

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

    definition classes: AnyRef ⇐ Any

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

    elem

    the element computation

    returns

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

  6. def flatten[T](its: Iterator[Iterator[T]]): Iterator[T]

    Create an iterator that is the concantenation of all iterators returned by a given iterator of iterators

    Create an iterator that is the concantenation of all iterators returned by a given iterator of iterators.

    its

    The iterator which returns on each call to next a new iterator whose elements are to be concatenated to the result.

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

    Create an iterator with elements en+1 = step(en) where e0 = start

    Create an iterator with elements en+1 = step(en) where e0 = start.

    start

    the start value of the iterator

    step

    the increment function of the iterator

    returns

    the iterator starting at value start.

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

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

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

    start

    the start value of the iterator

    returns

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

  10. def fromArray[a](xs: Array[a], start: Int, length: Int): Iterator[a]

    xs

    the array of elements

    start

    the start index

    length

    the length

  11. def fromArray[a](xs: Array[a]): Iterator[a]

    xs

    the array of elements

  12. def fromProduct(n: Product): Iterator[Any]

    n

    the product arity

    returns

    the iterator on Product<n>.

  13. def fromValues[a](xs: a*): Iterator[a]

  14. def hashCode(): Int

    Returns a hash code value for the object

    Returns a hash code value for the object.

    The default hashing algorithm is platform dependent.

    Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

    definition classes: AnyRef ⇐ Any

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

    start

    the start value of the iterator

    f

    the function that's repeatedly applied

    returns

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

  16. def iteratorIteratorWrapper[A](its: Iterator[Iterator[A]]): IteratorIteratorOps[A]

    An implicit conversion which adds the flatten method to class Iterator

    An implicit conversion which adds the flatten method to class Iterator

    attributes: implicit

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

    Create an iterator with elements en+1 = step(en) where e0 = start and elements are in the range between start (inclusive) and end (exclusive)

    Create an iterator with elements en+1 = step(en) where e0 = start and elements are in the range between start (inclusive) and end (exclusive)

    start

    the start value of the iterator

    end

    the end value of the iterator

    step

    the increment function of the iterator, must be monotonically increasing or decreasing

    returns

    the iterator with values in range [start;end).

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

    start

    the start value of the iterator

    end

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

    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

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

    start

    the start value of the iterator

    end

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

    returns

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

  20. def single[A](elem: A): Iterator[A]

    Creates an iterator which produces a single element

    Creates an iterator which produces a single element.

    elem

    the element

    returns

    An iterator which produces elem on the first call to next, and which has no further elements.

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

    f

    The function computing element values

    returns

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

  22. def toString(): String

    Returns a string representation of the object

    Returns a string representation of the object.

    The default representation is platform dependent.

    definition classes: AnyRef ⇐ Any