Search code examples
scalastreamiteratorscala-collectionslazy-evaluation

Why does method "combinations" return Iterator rather than Stream in Scala?

I noticed that method combinations (from here) returns Iterator. It looks reasonable that the method should be "lazy" to avoid generating all combinations in advance. Now I wonder, why it returns Iterator instead of Stream (which is a lazy list in Scala).

So, why does combinations return Iterator rather than Stream ?

Solution

  • With Stream it is more likely that all generated values will be held in memory. 

    scala> val s = Stream.iterate(0)(_ + 1)
s: scala.collection.immutable.Stream[Int] = Stream(0, ?)

scala> s.drop(3).head
res1: Int = 3

scala> s
res2: scala.collection.immutable.Stream[Int] = Stream(0, 1, 2, 3, ?)

    When you retain a reference to your Stream, all generated elements will remain in memory. With an Iterator this is less likely to happen.

    Of course this does not have to be the reason why the Scala library is designed the way it is...