scala.collection.immutable

# Stream

#### object Stream extends SeqFactory[Stream] with Serializable

The object `Stream` provides helper functions to manipulate streams.

Source
  Stream.scala
Version

  1.1 08/08/03

Since

  2.8

Linear Supertypes
Serializable, java.io.Serializable, SeqFactory[Stream], TraversableFactory[Stream], GenericSeqCompanion[Stream], GenSeqFactory[Stream], GenTraversableFactory[Stream], GenericCompanion[Stream], AnyRef, Any
Content Hierarchy Learn more about scaladoc diagrams
Ordering

1. Alphabetic
2. By inheritance

Inherited

1. Stream
2. Serializable
3. Serializable
4. SeqFactory
5. TraversableFactory
6. GenericSeqCompanion
7. GenSeqFactory
8. GenTraversableFactory
9. GenericCompanion
10. AnyRef
11. Any

1. Hide All
2. Show all

Learn more about member selection
Visibility

1. Public
2. All

### Type Members

1. #### type Coll = Stream[_]

   The underlying collection type with unknown element type

   The underlying collection type with unknown element type

   Attributes
     protected[this]
   Definition Classes
     GenericCompanion

2. #### final class Cons[+A] extends Stream[A]

   A lazy cons cell, from which streams are built.

   A lazy cons cell, from which streams are built.

   Annotations
     @SerialVersionUID()

3. #### class ConsWrapper[A] extends AnyRef

   A wrapper class that adds `#::` for cons and `#:::` for concat as operations to streams.

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

   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.

   Definition Classes
     GenTraversableFactory

5. #### class StreamBuilder[A] extends LazyBuilder[A, Stream[A]]

   A builder for streams

   A builder for streams

   Note

     This builder is lazy only in the sense that it does not go downs the spine of traversables that are added as a whole. If more laziness can be achieved, this builder should be bypassed.

6. #### class StreamCanBuildFrom[A] extends GenericCanBuildFrom[A]

   The factory for streams.

   The factory for streams.

   Note

     Methods such as map/flatMap will not invoke the `Builder` factory, but will return a new stream directly, to preserve laziness. The new stream is then cast to the factory's result type. This means that every CanBuildFrom that takes a Stream as its From type parameter must yield a stream as its result parameter. If that assumption is broken, cast errors might result.

### Value Members

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

   Definition Classes
     AnyRef → Any

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

   Definition Classes
     AnyRef → Any

3. #### object #::

   An extractor that allows to pattern match streams with `#::`.

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

   Definition Classes
     AnyRef → Any

5. #### object Empty extends Stream[Nothing]

6. #### def ReusableCBF: GenericCanBuildFrom[Nothing]

   Definition Classes
     GenTraversableFactory

7. #### def apply[A](xs: A*): Stream[A]

   A stream consisting of given elements

   A stream consisting of given elements

   A

     the type of the collection's elements

   returns

     a new collection with elements `elems`

   Definition Classes
     Stream → GenericCompanion

8. #### final def asInstanceOf[T0]: T0

   Definition Classes
     Any

9. #### implicit def canBuildFrom[A]: CanBuildFrom[Coll, A, Stream[A]]

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

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

11. #### def concat[A](xss: collection.Traversable[A]*): Stream[A]

    Concatenates all argument collections into a single collection.

    Concatenates all argument collections into a single collection.

    xss

      the collections that are to be concatenated.

    returns

      the concatenation of all the collections.

    Definition Classes
      GenTraversableFactory

12. #### object cons

    An alternative way of building and matching Streams using Stream.cons(hd, tl).

13. #### implicit def consWrapper[A](stream: ⇒ Stream[A]): ConsWrapper[A]

    A wrapper method that adds `#::` for cons and `#::: for concat as operations to streams.`

14. #### def continually[A](elem: ⇒ A): Stream[A]

    Create an infinite stream containing the given element expression (which is computed for each occurrence).

    Create an infinite stream containing the given element expression (which is computed for each occurrence).

    elem

      the element composing the resulting stream

    returns

      the stream containing an infinite number of elem

15. #### def empty[A]: Stream[A]

    The empty stream

    The empty stream

    A

      the type of the collection's elements

    Definition Classes
      Stream → GenericCompanion

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

    Definition Classes
      AnyRef

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

    Definition Classes
      AnyRef → Any

18. #### def fill[A](n: Int)(elem: ⇒ A): Stream[A]

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

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

    n

      the number of elements contained in the collection.

    elem

      the element computation

    returns

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

    Definition Classes
      Stream → GenTraversableFactory

19. #### def fill[A](n1: Int, n2: Int, n3: Int, n4: Int, n5: Int)(elem: ⇒ A): Stream[Stream[Stream[Stream[Stream[A]]]]]

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

    Produces a five-dimensional 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 collection that contains the results of `n1 x n2 x n3 x n4 x n5` evaluations of `elem`.

    Definition Classes
      GenTraversableFactory

20. #### def fill[A](n1: Int, n2: Int, n3: Int, n4: Int)(elem: ⇒ A): Stream[Stream[Stream[Stream[A]]]]

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

    Produces a four-dimensional 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 collection that contains the results of `n1 x n2 x n3 x n4` evaluations of `elem`.

    Definition Classes
      GenTraversableFactory

21. #### def fill[A](n1: Int, n2: Int, n3: Int)(elem: ⇒ A): Stream[Stream[Stream[A]]]

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

    Produces a three-dimensional 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 collection that contains the results of `n1 x n2 x n3` evaluations of `elem`.

    Definition Classes
      GenTraversableFactory

22. #### def fill[A](n1: Int, n2: Int)(elem: ⇒ A): Stream[Stream[A]]

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

    Produces a two-dimensional 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 collection that contains the results of `n1 x n2` evaluations of `elem`.

    Definition Classes
      GenTraversableFactory

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

    Attributes
      protected[java.lang]
    Definition Classes
      AnyRef
    Annotations
      @throws( classOf[java.lang.Throwable] )

24. #### def from(start: Int): Stream[Int]

    Create an infinite stream starting at `start` and incrementing by `1`.

    Create an infinite stream starting at `start` and incrementing by `1`.

    start

      the start value of the stream

    returns

      the stream starting at value `start`.

25. #### def from(start: Int, step: Int): Stream[Int]

    Create an infinite stream starting at `start` and incrementing by step `step`.

    Create an infinite stream starting at `start` and incrementing by step `step`.

    start

      the start value of the stream

    step

      the increment value of the stream

    returns

      the stream starting at value `start`.

26. #### final def getClass(): Class[_]

    Definition Classes
      AnyRef → Any

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

    Definition Classes
      AnyRef → Any

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

    Definition Classes
      Any

29. #### def iterate[A](start: A, len: Int)(f: (A) ⇒ A): Stream[A]

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

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

    start

      the start value of the collection

    len

      the number of elements contained inthe collection

    f

      the function that's repeatedly applied

    returns

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

    Definition Classes
      Stream → GenTraversableFactory

30. #### def iterate[A](start: A)(f: (A) ⇒ A): Stream[A]

    An infinite stream that repeatedly applies a given function to a start value.

    An infinite stream that repeatedly applies a given function to a start value.

    start

      the start value of the stream

    f

      the function that's repeatedly applied

    returns

      the stream returning the infinite sequence of values `start, f(start), f(f(start)), ...`

31. #### final def ne(arg0: AnyRef): Boolean

    Definition Classes
      AnyRef

32. #### def newBuilder[A]: Builder[A, Stream[A]]

    Creates a new builder for a stream

    Creates a new builder for a stream

    A

      the type of the collection's elements

    Definition Classes
      Stream → GenericCompanion

33. #### final def notify(): Unit

    Definition Classes
      AnyRef

34. #### final def notifyAll(): Unit

    Definition Classes
      AnyRef

35. #### def range[T](start: T, end: T, step: T)(implicit arg0: Integral[T]): Stream[T]

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

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

    start

      the start value of the collection

    end

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

    step

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

    returns

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

    Definition Classes
      Stream → GenTraversableFactory

36. #### def range[T](start: T, end: T)(implicit arg0: Integral[T]): Stream[T]

    Produces a collection containing a sequence of increasing of integers.

    Produces a collection containing a sequence of increasing of integers.

    start

      the first element of the collection

    end

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

    returns

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

    Definition Classes
      GenTraversableFactory

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

    Definition Classes
      AnyRef

38. #### def tabulate[A](n: Int)(f: (Int) ⇒ A): Stream[A]

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

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

    n

      The number of elements in the collection

    f

      The function computing element values

    returns

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

    Definition Classes
      Stream → GenTraversableFactory

39. #### def tabulate[A](n1: Int, n2: Int, n3: Int, n4: Int, n5: Int)(f: (Int, Int, Int, Int, Int) ⇒ A): Stream[Stream[Stream[Stream[Stream[A]]]]]

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

    Produces a five-dimensional 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 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
      GenTraversableFactory

40. #### def tabulate[A](n1: Int, n2: Int, n3: Int, n4: Int)(f: (Int, Int, Int, Int) ⇒ A): Stream[Stream[Stream[Stream[A]]]]

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

    Produces a four-dimensional 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 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
      GenTraversableFactory

41. #### def tabulate[A](n1: Int, n2: Int, n3: Int)(f: (Int, Int, Int) ⇒ A): Stream[Stream[Stream[A]]]

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

    Produces a three-dimensional 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 collection consisting of elements `f(i1, i2, i3)` for `0 <= i1 < n1`, `0 <= i2 < n2`, and `0 <= i3 < n3`.

    Definition Classes
      GenTraversableFactory

42. #### def tabulate[A](n1: Int, n2: Int)(f: (Int, Int) ⇒ A): Stream[Stream[A]]

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

    Produces a two-dimensional 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 collection consisting of elements `f(i1, i2)` for `0 <= i1 < n1` and `0 <= i2 < n2`.

    Definition Classes
      GenTraversableFactory

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

    Definition Classes
      AnyRef → Any

44. #### def unapplySeq[A](x: Stream[A]): Some[Stream[A]]

    This method is called in a pattern match { case Seq(...) => }.

    This method is called in a pattern match { case Seq(...) => }.

    x

      the selector value

    returns

      sequence wrapped in an option, if this is a Seq, otherwise none

    Definition Classes
      SeqFactory

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

    Definition Classes
      AnyRef
    Annotations
      @throws( ... )

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

    Definition Classes
      AnyRef
    Annotations
      @throws( ... )

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

    Definition Classes
      AnyRef
    Annotations
      @throws( ... )

### Inherited from Serializable

### Inherited from java.io.Serializable

### Inherited from SeqFactory[Stream]

### Inherited from TraversableFactory[Stream]

### Inherited from GenericSeqCompanion[Stream]

### Inherited from GenSeqFactory[Stream]

### Inherited from GenTraversableFactory[Stream]

### Inherited from GenericCompanion[Stream]

### Inherited from AnyRef

### Inherited from Any

### Ungrouped