summaryrefslogtreecommitdiff
path: root/src/library/scala/collection/Iterable.scala
blob: 826248bf2a195b4cabcbe18445e3d552fe5ceb2b (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
/*                     __                                               *\
**     ________ ___   / /  ___     Scala API                            **
**    / __/ __// _ | / /  / _ |    (c) 2003-2009, LAMP/EPFL             **
**  __\ \/ /__/ __ |/ /__/ __ |    http://scala-lang.org/               **
** /____/\___/_/ |_/____/_/ | |                                         **
**                          |/                                          **
\*                                                                      */

// $Id: Iterable.scala 15188 2008-05-24 15:01:02Z stepancheg $

package scala.collection

import util.control.Breaks._
// import immutable.Stream
import generic._

/** A template trait for iterable collections.
 *
 *  Collection classes mixing in this trait provide a method
 *  <code>iterator</code> which returns an iterator over all the
 *  elements contained in the collection. They also provide a method `newBuilder`
 *  which creates a builder for collections of the same kind.
 *
 *  This trait implements Traversable's `foreach` method by stepping through
 *  all elements. Subclasses of `Iterable` should re-implement `foreach` with
 *  something more efficient, if possible.
 *
 *  This trait adds methods `elements`, `zip`, `zipAll`, `zipWithIndex`, `sameElements`,
 *  `takeRight`, `dropRight` to the methods inherited from trait `Traversable`.
 *
 *  @author Martin Odersky
 *  @version 2.8
 */
trait Iterable[+A] extends Traversable[A]
                      with TraversableClass[A, Iterable]
                      with IterableTemplate[A, Iterable[A]] {
   override def companion: Companion[Iterable] = Iterable

  /* The following methods are inherited from trait IterableTemplate
   *
  override def iterator: Iterator[A]
  override def takeRight(n: Int): Iterable[A]
  override def dropRight(n: Int): Iterable[A]
  override def sameElements[B >: A](that: Iterable[B]): Boolean
  override def view
  override def view(from: Int, until: Int)
  */

}

/** Factory methods and utilities for instances of type Traversable */
object Iterable extends TraversableFactory[Iterable] {

  implicit def builderFactory[A]: BuilderFactory[A, Iterable[A], Coll] = new VirtualBuilderFactory[A]
  def newBuilder[A]: Builder[A, Iterable[A]] = immutable.Iterable.newBuilder[A]

  /** The minimum element of a non-empty sequence of ordered elements */
  @deprecated("use seq.min instead")
  def min[A <% Ordered[A]](seq: Iterable[A]): A = {
    val xs = seq.iterator
    if (!xs.hasNext) throw new IllegalArgumentException("min(<empty>)")
    var min = xs.next
    while (xs.hasNext) {
      val x = xs.next
      if (x < min) min = x
    }
    min
  }

  /** The maximum element of a non-empty sequence of ordered elements */
  @deprecated("use seq.max iConstead")
  def max[A <% Ordered[A]](seq: Iterable[A]): A = {
    val xs = seq.iterator
    if (!xs.hasNext) throw new IllegalArgumentException("max(<empty>)")
    var max = xs.next
    while (xs.hasNext) {
      val x = xs.next
      if (max < x) max = x
    }
    max
  }

  @deprecated("use View instead") type Projection[A] = IterableView[A, Coll]
}