scala.collection

Iterator

object Iterator extends AnyRef

The Iterator object provides various functions for creating specialized iterators.

go to: companion
source: Iterator.scala
    version
  1. 2.8

    since
  1. 2.8

    authors:
  1. Matthias Zenger

  2. ,
  3. Martin Odersky

Inherited
  1. Hide All
  2. Show all
  1. AnyRef
  2. Any
Visibility
  1. Public
  2. All

Type Members

  1. class IteratorCanBuildFrom[A] extends CanBuildFrom[Iterator[A], A, Iterator[A]]

    With the advent of TraversableOnce, it can be useful to have a builder for Iterators so they can be treated uniformly along with the collections.

  2. 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 !=(arg0: AnyRef): Boolean

    attributes: final
    definition classes: AnyRef
  2. def !=(arg0: Any): Boolean

    o != arg0 is the same as !(o == (arg0)).

    o != arg0 is the same as !(o == (arg0)).

    arg0

    the object to compare against this object for dis-equality.

    returns

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

    attributes: final
    definition classes: Any
  3. def ##(): Int

    attributes: final
    definition classes: AnyRef → Any
  4. def $asInstanceOf[T0](): T0

    attributes: final
    definition classes: AnyRef
  5. def $isInstanceOf[T0](): Boolean

    attributes: final
    definition classes: AnyRef
  6. def ==(arg0: AnyRef): Boolean

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

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

    attributes: final
    definition classes: AnyRef
  7. def ==(arg0: Any): Boolean

    o == arg0 is the same as o.equals(arg0).

    o == arg0 is the same as o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

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

    attributes: final
    definition classes: Any
  8. 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.

  9. def asInstanceOf[T0]: T0

    This method is used to cast the receiver object to be of type T0.

    This method is used to 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 expression1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expressionList(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    the receiver object.

    attributes: final
    definition classes: Any
  10. def clone(): AnyRef

    This method creates and returns a copy of the receiver object.

    This method creates and returns 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
    definition classes: AnyRef
  11. 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.

  12. val empty: Iterator[Nothing]

    The iterator which produces no values

    The iterator which produces no values

  13. def eq(arg0: AnyRef): Boolean

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    The eq method implements an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation] on non-null instances of AnyRef: * It is reflexive: for any non-null instance x of type AnyRef, x.eq(x) returns true. * It is symmetric: for any non-null instances x and y of type AnyRef, x.eq(y) returns true if and only if y.eq(x) returns true. * It is transitive: for any non-null instances x, y, and z of type AnyRef if x.eq(y) returns true and y.eq(z) returns true, then x.eq(z) returns true.

    Additionally, the eq method has three other 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).

    arg0

    the object to compare against this object for reference equality.

    returns

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

    attributes: final
    definition classes: AnyRef
  14. 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 [http://en.wikipedia.org/wiki/Equivalence_relation 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 scala.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
  15. 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.

  16. def finalize(): Unit

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

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

    attributes: protected
    definition classes: AnyRef
  17. 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.

      deprecated:
    1. use its.flatten instead

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

    Create an iterator with elements e<sub>n+1</sub> = step(e<sub>n</sub>) where e<sub>0</sub> = start.

    Create an iterator with elements e<sub>n+1</sub> = step(e<sub>n</sub>) where e<sub>0</sub> = start.

    start

    the start value of the iterator

    step

    the increment function of the iterator

    returns

    the iterator starting at value start.

      deprecated:
    1. use iterate(start)(step) instead

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

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

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

    no summary matey

    xs

    the array of elements

    start

    the start index

    length

    the length

      deprecated:
    1. use xs.slice(start, start + length).iterator' instead

      see also:
    1. also: IndexedSeq.iterator and slice

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

    no summary matey

    xs

    the array of elements

      deprecated:
    1. use xs.iterator' instead

      see also:
    1. also: IndexedSeq.iterator and slice

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

    no summary matey

    n

    the product arity

    returns

    the iterator on Product&lt;n&gt;.

      deprecated:
    1. use product.productIterator instead

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

      deprecated:
    1. use xs.iterator' or Iterator(xs)' instead

  25. def getClass(): java.lang.Class[_ <: java.lang.Object]

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

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

    attributes: final
    definition classes: AnyRef
  26. 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.

    returns

    the hash code value for the object.

    definition classes: AnyRef → Any
  27. def isInstanceOf[T0]: Boolean

    This method is used to test whether the dynamic type of the receiver object is T0.

    This method is used to test whether the dynamic type of the receiver object is T0.

    Note that the test result of the test is modulo Scala's erasure semantics. Therefore the expression1.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 requested typed.

    returns

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

    attributes: final
    definition classes: Any
  28. 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)), ...

  29. implicit def iteratorCanBuildFrom[T]: IteratorCanBuildFrom[T]

    attributes: implicit
  30. implicit 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
  31. def ne(arg0: AnyRef): Boolean

    o.ne(arg0) is the same as !(o.eq(arg0)).

    o.ne(arg0) is the same as !(o.eq(arg0)).

    arg0

    the object to compare against this object for reference dis-equality.

    returns

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

    attributes: final
    definition classes: AnyRef
  32. 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.

    attributes: final
    definition classes: AnyRef
  33. 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.

    attributes: final
    definition classes: AnyRef
  34. def range(start: Int, end: Int, step: (Int) ⇒ Int): Iterator[Int]

    Create an iterator with elements e<sub>n+1</sub> = step(e<sub>n</sub>) where e<sub>0</sub> = start and elements are in the range between start (inclusive) and end (exclusive)

    Create an iterator with elements e<sub>n+1</sub> = step(e<sub>n</sub>) where e<sub>0</sub> = 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).

      deprecated:
    1. use Iterator.iterate(start, end - start)(step) instead

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

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

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

  38. def synchronized[T0](arg0: T0): T0

    attributes: final
    definition classes: AnyRef
  39. 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).

  40. def toString(): String

    Returns a string representation of the object.

    Returns a string representation of the object.

    The default representation is platform dependent.

    returns

    a string representation of the object.

    definition classes: AnyRef → Any
  41. def wait(): Unit

    attributes: final
    definition classes: AnyRef
  42. def wait(arg0: Long, arg1: Int): Unit

    attributes: final
    definition classes: AnyRef
  43. def wait(arg0: Long): Unit

    attributes: final
    definition classes: AnyRef