scala.collection

Iterable

object Iterable extends TraversableFactory[Iterable]

This object provides a set of operations to create Iterable values.

go to: companion
linear super types: TraversableFactory[Iterable], GenericCompanion[Iterable], AnyRef, Any
source: Iterable.scala
    version
  1. 2.8 The current default implementation of a Iterable is a Vector.

Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. Iterable
  2. TraversableFactory
  3. GenericCompanion
  4. AnyRef
  5. Any
Visibility
  1. Public
  2. All
Impl.
  1. Concrete
  2. Abstract

Type Members

  1. type Coll = Iterable[_]

    The underlying collection type with unknown element type

    The underlying collection type with unknown element type

    definition classes: GenericCompanion
  2. class GenericCanBuildFrom [A] extends CanBuildFrom[CC[_], A, CC[A]]

    A generic implementation of the CanBuildFrom trait, which forwards all calls to apply(from) to the genericBuilder method of collection from, and which forwards all calls of apply() to the newBuilder method of this factory.

  3. type Projection [A] = IterableView[A, Coll]

      deprecated:
    1. use View instead

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*) : Iterable[A]

    Creates a iterable collection with the specified elements.

    Creates a iterable collection with the specified elements.

    A

    the type of the iterable collection's elements

    elems

    the elements of the created iterable collection

    returns

    a new iterable collection with elements elems

    definition classes: GenericCompanion
  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. implicit def canBuildFrom [A] : CanBuildFrom[Coll, A, Iterable[A]]

    The standard CanBuildFrom instance for Iterable objects.

    The standard CanBuildFrom instance for Iterable objects. The created value is an instance of class GenericCanBuildFrom, which forwards calls to create a new builder to the genericBuilder method of the requesting collection.

    attributes: implicit
      see also:
    1. GenericCanBuildFrom

    2. ,
    3. CanBuildFrom

  11. 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
  12. def concat [A] (xss: Traversable[A]*) : Iterable[A]

    Concatenates all argument collections into a single iterable collection.

    Concatenates all argument collections into a single iterable collection.

    xss

    the collections that are to be concatenated.

    returns

    the concatenation of all the collections.

    definition classes: TraversableFactory
  13. def empty [A] : Iterable[A]

    An empty collection of type Iterable[A]

    An empty collection of type Iterable[A]

    A

    the type of the iterable collection's elements

    definition classes: GenericCompanion
  14. 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
  15. 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
  16. def fill [A] (n1: Int, n2: Int, n3: Int, n4: Int, n5: Int)(elem: ⇒ A) : Iterable[Iterable[Iterable[Iterable[Iterable[A]]]]]

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

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

    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 3nd dimension

    n4

    the number of elements in the 4th dimension

    n5

    the number of elements in the 5th dimension

    elem

    the element computation

    returns

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

    definition classes: TraversableFactory
  17. def fill [A] (n1: Int, n2: Int, n3: Int, n4: Int)(elem: ⇒ A) : Iterable[Iterable[Iterable[Iterable[A]]]]

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

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

    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 3nd dimension

    n4

    the number of elements in the 4th dimension

    elem

    the element computation

    returns

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

    definition classes: TraversableFactory
  18. def fill [A] (n1: Int, n2: Int, n3: Int)(elem: ⇒ A) : Iterable[Iterable[Iterable[A]]]

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

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

    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 3nd dimension

    elem

    the element computation

    returns

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

    definition classes: TraversableFactory
  19. def fill [A] (n1: Int, n2: Int)(elem: ⇒ A) : Iterable[Iterable[A]]

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

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

    n1

    the number of elements in the 1st dimension

    n2

    the number of elements in the 2nd dimension

    elem

    the element computation

    returns

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

    definition classes: TraversableFactory
  20. def fill [A] (n: Int)(elem: ⇒ A) : Iterable[A]

    Produces a iterable collection containing the results of some element computation a number of times.

    Produces a iterable collection containing the results of some element computation a number of times.

    n

    the number of elements contained in the iterable collection.

    elem

    the element computation

    returns

    A iterable collection that contains the results of n evaluations of elem.

    definition classes: TraversableFactory
  21. 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
  22. 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
  23. 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
  24. 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
  25. def iterate [A] (start: A, len: Int)(f: (A) ⇒ A) : Iterable[A]

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

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

    start

    the start value of the iterable collection

    len

    the number of elements contained inthe iterable collection

    f

    the function that's repeatedly applied

    returns

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

    definition classes: TraversableFactory
  26. def max [A] (seq: Iterable[A])(implicit ord: Ordering[A]) : A

    The maximum element of a non-empty sequence of ordered elements

    The maximum element of a non-empty sequence of ordered elements

      deprecated:
    1. use <seq>.max instead, where <seq> is the sequence for which you want to compute the maximum

  27. def min [A] (seq: Iterable[A])(implicit ord: Ordering[A]) : A

    The minimum element of a non-empty sequence of ordered elements

    The minimum element of a non-empty sequence of ordered elements

      deprecated:
    1. use <seq>.min instead, where <seq> is the sequence for which you want to compute the minimum

  28. 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
  29. def newBuilder [A] : Builder[A, Iterable[A]]

    The default builder for Iterable objects.

    The default builder for Iterable objects.

    A

    the type of the iterable collection's elements

    definition classes: IterableGenericCompanion
  30. 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
  31. 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
  32. def range (start: Int, end: Int, step: Int) : Iterable[Int]

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

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

    start

    the start value of the iterable collection

    end

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

    step

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

    returns

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

    definition classes: TraversableFactory
  33. def range (start: Int, end: Int) : Iterable[Int]

    Produces a iterable collection containing a sequence of increasing of integers.

    Produces a iterable collection containing a sequence of increasing of integers.

    end

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

    returns

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

    definition classes: TraversableFactory
  34. def synchronized [T0] (arg0: T0) : T0

    attributes: final
    definition classes: AnyRef
  35. def tabulate [A] (n1: Int, n2: Int, n3: Int, n4: Int, n5: Int)(f: (Int, Int, Int, Int, Int) ⇒ A) : Iterable[Iterable[Iterable[Iterable[Iterable[A]]]]]

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

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

    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 3nd dimension

    n4

    the number of elements in the 4th dimension

    n5

    the number of elements in the 5th dimension

    f

    The function computing element values

    returns

    A iterable 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.

    definition classes: TraversableFactory
  36. def tabulate [A] (n1: Int, n2: Int, n3: Int, n4: Int)(f: (Int, Int, Int, Int) ⇒ A) : Iterable[Iterable[Iterable[Iterable[A]]]]

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

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

    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 3nd dimension

    n4

    the number of elements in the 4th dimension

    f

    The function computing element values

    returns

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

    definition classes: TraversableFactory
  37. def tabulate [A] (n1: Int, n2: Int, n3: Int)(f: (Int, Int, Int) ⇒ A) : Iterable[Iterable[Iterable[A]]]

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

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

    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 3nd dimension

    f

    The function computing element values

    returns

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

    definition classes: TraversableFactory
  38. def tabulate [A] (n1: Int, n2: Int)(f: (Int, Int) ⇒ A) : Iterable[Iterable[A]]

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

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

    n1

    the number of elements in the 1st dimension

    n2

    the number of elements in the 2nd dimension

    f

    The function computing element values

    returns

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

    definition classes: TraversableFactory
  39. def tabulate [A] (n: Int)(f: (Int) ⇒ A) : Iterable[A]

    Produces a iterable collection containing values of a given function over a range of integer values starting from 0.

    Produces a iterable collection containing values of a given function over a range of integer values starting from 0.

    n

    The number of elements in the iterable collection

    f

    The function computing element values

    returns

    A iterable collection consisting of elements f(0), ..., f(n -1)

    definition classes: TraversableFactory
  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

Inherited from TraversableFactory[Iterable]

Inherited from GenericCompanion[Iterable]

Inherited from AnyRef

Inherited from Any