scala.collection

# Iterator

#### object Iterator extends AnyRef

The `Iterator` object provides various functions for creating specialized iterators.

Source
  Iterator.scala
Version

  2.8

Since

  2.8

Linear Supertypes
AnyRef, Any
Ordering

1. Alphabetic
2. By inheritance

Inherited

1. Hide All
2. Show all

1. Iterator
2. AnyRef
3. Any

Visibility

1. Public
2. All

### Value Members

1. #### final def !=(arg0: AnyRef): Boolean

   Definition Classes
     AnyRef

2. #### final def !=(arg0: Any): Boolean

   Test two objects for inequality.

   Test two objects for inequality.

   returns

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

   Definition Classes
     Any

3. #### final def ##(): Int

   Equivalent to `x.hashCode` except for boxed numeric types.

   Equivalent to `x.hashCode` except for boxed numeric types. 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.

   returns

     a hash value consistent with ==

   Definition Classes
     AnyRef → Any

4. #### final def ==(arg0: AnyRef): Boolean

   Definition Classes
     AnyRef

5. #### final def ==(arg0: Any): Boolean

   Test two objects for equality.

   Test two objects for equality.

   returns

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

   Definition Classes
     Any

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

7. #### 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 a `ClassCastException` at runtime, while the expression `List(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 type `T0`.

8. #### def clone(): AnyRef

   Create a copy of the receiver object.

   Create a copy of the receiver object.

   The default implementation of the `clone` method is platform dependent.

   returns

     a copy of the receiver object.

   Attributes
     protected[lang]
   Definition Classes
     AnyRef
   Annotations
     @throws()
   Note

     not specified by SLS as a member of AnyRef

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

   elem

     the element computation.

   returns

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

10. #### val empty: Iterator[Nothing]

    The iterator which produces no values.

11. #### final def eq(arg0: AnyRef): Boolean

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

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

    The `eq` method implements an equivalence relation on non-null instances of `AnyRef`, and has three additional properties:

    - It is consistent: for any non-null instances `x` and `y` of type `AnyRef`, multiple invocations of `x.eq(y)` consistently returns `true` or consistently returns `false`.
    - For any non-null instance `x` of type `AnyRef`, `x.eq(null)` and `null.eq(x)` returns `false`.
    - `null.eq(null)` returns `true`.

    When overriding the `equals` or `hashCode` methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (`o1 eq o2`), they should be equal to each other (`o1 == o2`) and they should hash to the same value (`o1.hashCode == o2.hashCode`).

    returns

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

    Definition Classes
      AnyRef

12. #### def equals(arg0: Any): Boolean

    The equality method for reference types.

    The equality method for reference types. See equals in Any.

    returns

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

    Definition Classes
      AnyRef → Any

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

    len

      the number of elements returned by the iterator.

    elem

      the element computation

    returns

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

14. #### def finalize(): Unit

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

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

    The details of when and if the `finalize` method is invoked, as well as the interaction between `finalize` and non-local returns and exceptions, are all platform dependent.

    Attributes
      protected[lang]
    Definition Classes
      AnyRef
    Annotations
      @throws()
    Note

      not specified by SLS as a member of AnyRef

15. #### 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, ...`

16. #### 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, ...`

17. #### final def getClass(): java.lang.Class[_]

    A representation that corresponds to the dynamic class of the receiver object.

    A representation that corresponds to the dynamic class of the receiver object.

    The nature of the representation is platform dependent.

    returns

      a representation that corresponds to the dynamic class of the receiver object.

    Definition Classes
      AnyRef → Any
    Note

      not specified by SLS as a member of AnyRef

18. #### def hashCode(): Int

    The hashCode method for reference types.

    The hashCode method for reference types. See hashCode in Any.

    returns

      the hash code value for this object.

    Definition Classes
      AnyRef → Any

19. #### final def isInstanceOf[T0]: Boolean

    Test whether the dynamic type of the receiver object is `T0`.

    Test whether the dynamic type of the receiver object is `T0`.

    Note that the result of the test is modulo Scala's erasure semantics. Therefore the expression `1.isInstanceOf[String]` will return `false`, while the expression `List(1).isInstanceOf[List[String]]` will return `true`. 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 specified type.

    returns

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

    Definition Classes
      Any

20. #### 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)), ...`

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

22. #### 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
    Note

      not specified by SLS as a member of AnyRef

23. #### 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
    Note

      not specified by SLS as a member of AnyRef

24. #### 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`

25. #### 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`

26. #### def single[A](elem: A): Iterator[A]

    Creates an iterator which produces a single element.

    Creates an iterator which produces a single element. Note: Equivalent, but more efficient than Iterator(elem)

    elem

      the element

    returns

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

27. #### final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
      AnyRef

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

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

29. #### def toString(): String

    Creates a String representation of this object.

    Creates a String representation of this object. The default representation is platform dependent. On the java platform it is the concatenation of the class name, "@", and the object's hashcode in hexadecimal.

    returns

      a String representation of the object.

    Definition Classes
      AnyRef → Any

30. #### final def wait(): Unit

    Definition Classes
      AnyRef
    Annotations
      @throws()

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

    Definition Classes
      AnyRef
    Annotations
      @throws()

32. #### final def wait(arg0: Long): Unit

    Definition Classes
      AnyRef
    Annotations
      @throws()

### Deprecated Value Members

1. #### def flatten[T](its: Iterator[Iterator[T]]): Iterator[T]

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

   Create an iterator that is the concatenation 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.

   Annotations
     @deprecated
   Deprecated

     (Since version 2.8.0) use its.flatten instead

2. #### 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`.

   Annotations
     @deprecated
   Deprecated

     (Since version 2.8.0) use iterate(start)(step) instead

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

   xs

     the array of elements

   start

     the start index

   length

     the length

   Annotations
     @deprecated
   Deprecated

     (Since version 2.8.0) use `xs.slice(start, start + length).iterator' instead`

   See also

     also: IndexedSeq.iterator and slice

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

   xs

     the array of elements

   Annotations
     @deprecated
   Deprecated

     (Since version 2.8.0) use `xs.iterator' instead`

   See also

     also: IndexedSeq.iterator and slice

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

   n

     the product arity

   returns

     the iterator on `Product<n>`.

   Annotations
     @deprecated
   Deprecated

     (Since version 2.8.0) use product.productIterator instead

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

   Annotations
     @deprecated
   Deprecated

     (Since version 2.8.0) use `xs.iterator' or` Iterator(xs)' instead

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

   Annotations
     @deprecated
   Deprecated

     (Since version 2.8.0) use Iterator.iterate(start, end - start)(step) instead

### Inherited from AnyRef

### Inherited from Any