Stream

Companion class Stream

object Stream extends SeqFactory[Stream]

Annotations: @deprecated @SerialVersionUID()
Deprecated: (Since version 2.13.0) Use LazyList (which is fully lazy) instead of Stream (which has a lazy tail only)
Source: Stream.scala

Linear Supertypes

SeqFactory[Stream], IterableFactory[Stream], java.io.Serializable, AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

Stream
SeqFactory
IterableFactory
Serializable
AnyRef
Any

Hide All
Show All

Visibility

Public
Protected

Type Members

final class Cons[A] extends Stream[A]
Annotations
@SerialVersionUID()
final class Deferrer[A] extends AnyVal
class SerializationProxy[A] extends Serializable
This serialization proxy is used for Streams which start with a sequence of evaluated cons cells.
This serialization proxy is used for Streams which start with a sequence of evaluated cons cells. The forced sequence is serialized in a compact, sequential format, followed by the unevaluated tail, which uses standard Java serialization to store the complete structure of unevaluated thunks. This allows the serialization of long evaluated streams without exhausting the stack through recursive serialization of cons cells.
Annotations
@SerialVersionUID()

Value Members

final def !=(arg0: Any): Boolean
Test two objects for inequality.
Test two objects for inequality.
returns
true if !(this == that), false otherwise.
Definition Classes
AnyRef → Any
final def ##: Int
Equivalent to x.hashCode except for boxed numeric types and null.
Equivalent to x.hashCode except for boxed numeric types and null. For numerics, it returns a hash value which is consistent with value equality: if two value type instances compare as true, then ## will produce the same hash value for each of them. For null returns a hashcode where null.hashCode throws a NullPointerException.
returns
a hash value consistent with ==
Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean
The expression x == that is equivalent to if (x eq null) that eq null else x.equals(that).
The expression x == that is equivalent to if (x eq null) that eq null else x.equals(that).
returns
true if the receiver object is equivalent to the argument; false otherwise.
Definition Classes
AnyRef → Any
def apply[A](elems: A*): Stream[A]
Creates a collection with the specified elements.
Creates a collection with the specified elements.
A
the type of the collection's elements
elems
the elements of the created collection
returns
a new collection with elements elems
Definition Classes
IterableFactory
final def asInstanceOf[T0]: T0
Forces the compiler to treat the receiver object as having type T0, even though doing so may violate type safety.
Forces the compiler to treat the receiver object as having type T0, even though doing so may violate type safety.
This method is useful when you believe you have type information the compiler doesn't, and it also isn't possible to check the type at runtime. In such situations, skipping type safety is the only option.
It is platform dependent whether asInstanceOf has any effect at runtime. It might do a runtime type test on the erasure of T0, insert a conversion (such as boxing/unboxing), fill in a default value, or do nothing at all.
In particular, asInstanceOf is not a type test. It does **not** mean:
```
this match {
 case x: T0 => x
 case _     => throw ClassCastException("...")
```
Use pattern matching or isInstanceOf for type testing instead.
Situations where asInstanceOf is useful:
- when flow analysis fails to deduce T0 automatically
- when down-casting a type parameter or an abstract type member (which cannot be checked at runtime due to type erasure) If there is any doubt and you are able to type test instead, you should do so.
Be careful of using asInstanceOf when T0 is a primitive type. When T0 is primitive, asInstanceOf may insert a conversion instead of a type test. If your intent is to convert, use a toT method (x.toChar, x.toByte, etc.).
returns
the receiver object.
Definition Classes
Any
Exceptions thrown
ClassCastException if the receiver is not an instance of the erasure of T0, if that can be checked on this platform
def clone(): AnyRef
Create a copy of the receiver object.
Create 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[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @native()
Note
not specified by SLS as a member of AnyRef
def concat[A](xss: collection.Iterable[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
IterableFactory
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
def empty[A]: Stream[A]
An empty collection
An empty collection
A
the type of the collection's elements
Definition Classes
Stream → IterableFactory
final def eq(arg0: AnyRef): Boolean
Tests whether the argument (that) is a reference to the receiver object (this).
Tests whether the argument (that) is a reference to the receiver object (this).
The eq method implements an equivalence relation on non-null instances of AnyRef, and has three additional 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).
returns
true if the argument is a reference to the receiver object; false otherwise.
Definition Classes
AnyRef
def equals(arg0: AnyRef): Boolean
The equality method for reference types.
The equality method for reference types. Default implementation delegates to eq.
See also equals in scala.Any.
returns
true if the receiver object is equivalent to the argument; false otherwise.
Definition Classes
AnyRef → Any
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 3rd 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
IterableFactory
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 3rd 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
IterableFactory
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 3rd dimension
elem
the element computation
returns
A collection that contains the results of n1 x n2 x n3 evaluations of elem.
Definition Classes
IterableFactory
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
IterableFactory
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
IterableFactory
def finalize(): Unit
Called by the garbage collector on the receiver object when there are no more references to the object.
Called by the garbage collector on the receiver object when there are no more references to the object.
The details of when and if the finalize method is invoked, as well as the interaction between finalize and non-local returns and exceptions, are all platform dependent.
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.Throwable])
Note
not specified by SLS as a member of AnyRef
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.
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.
def from[A](coll: IterableOnce[A]): Stream[A]
Creates a target collection from an existing source collection
Creates a target collection from an existing source collection
A
the type of the collection’s elements
returns
a new collection with the elements of source
Definition Classes
Stream → IterableFactory
def fromIterator[A](it: Iterator[A]): Stream[A]
A
type of elements
it
Source iterator
returns
A Stream[A] that gets its elements from the given Iterator.
final def getClass(): Class[_ <: AnyRef]
Returns the runtime class representation of the object.
Returns the runtime class representation of the object.
returns
a class object corresponding to the runtime type of the receiver.
Definition Classes
AnyRef → Any
Annotations
@native()
def hashCode(): Int
The hashCode method for reference types.
The hashCode method for reference types. See hashCode in scala.Any.
returns
the hash code value for this object.
Definition Classes
AnyRef → Any
Annotations
@native()
final def isInstanceOf[T0]: Boolean
Test whether the dynamic type of the receiver object has the same erasure as T0.
Test whether the dynamic type of the receiver object has the same erasure as T0.
Depending on what T0 is, the test is done in one of the below ways:
- T0 is a non-parameterized class type, e.g. BigDecimal: this method returns true if the value of the receiver object is a BigDecimal or a subtype of BigDecimal.
- T0 is a parameterized class type, e.g. List[Int]: this method returns true if the value of the receiver object is some List[X] for any X. For example, List(1, 2, 3).isInstanceOf[List[String]] will return true.
- T0 is some singleton type x.type or literal x: this method returns this.eq(x). For example, x.isInstanceOf[1] is equivalent to x.eq(1)
- T0 is an intersection X with Y or X & Y: this method is equivalent to x.isInstanceOf[X] && x.isInstanceOf[Y]
- T0 is a union X | Y: this method is equivalent to x.isInstanceOf[X] || x.isInstanceOf[Y]
- T0 is a type parameter or an abstract type member: this method is equivalent to isInstanceOf[U] where U is T0's upper bound, Any if T0 is unbounded. For example, x.isInstanceOf[A] where A is an unbounded type parameter will return true for any value of x.
This is exactly equivalent to the type pattern _: T0
returns
true if the receiver object is an instance of erasure of type T0; false otherwise.
Definition Classes
Any
Note
due to the unexpectedness of List(1, 2, 3).isInstanceOf[List[String]] returning true and x.isInstanceOf[A] where A is a type parameter or abstract member returning true, these forms issue a warning.
implicit def iterableFactory[A]: Factory[A, Stream[A]]
Definition Classes
IterableFactory
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)), ...
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 in the 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
IterableFactory
final def ne(arg0: AnyRef): Boolean
Equivalent to !(this eq that).
Equivalent to !(this eq that).
returns
true if the argument is not a reference to the receiver object; false otherwise.
Definition Classes
AnyRef
def newBuilder[A]: Builder[A, Stream[A]]
A
the type of the collection’s elements
returns
A builder for Iterable objects.
Definition Classes
Stream → IterableFactory
final 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.
Definition Classes
AnyRef
Annotations
@native()
Note
not specified by SLS as a member of AnyRef
final 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.
Definition Classes
AnyRef
Annotations
@native()
Note
not specified by SLS as a member of AnyRef
def range[A](start: A, end: A, step: A)(implicit arg0: Integral[A]): Stream[A]
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
IterableFactory
def range[A](start: A, end: A)(implicit arg0: Integral[A]): Stream[A]
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
IterableFactory
final def synchronized[T0](arg0: => T0): T0
Executes the code in body with an exclusive lock on this.
Executes the code in body with an exclusive lock on this.
returns
the result of body
Definition Classes
AnyRef
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 3rd 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
IterableFactory
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 3rd 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
IterableFactory
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 3rd 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
IterableFactory
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
IterableFactory
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
IterableFactory
implicit def toDeferrer[A](l: => Stream[A]): Deferrer[A]
def toString(): String
Creates a String representation of this object.
Creates a String representation of this object. The default representation is platform dependent. On the java platform it is the concatenation of the class name, "@", and the object's hashcode in hexadecimal.
returns
a String representation of the object.
Definition Classes
AnyRef → Any
final def unapplySeq[A](x: Stream[A]): UnapplySeqWrapper[A]
Definition Classes
SeqFactory
def unfold[A, S](init: S)(f: (S) => Option[(A, S)]): Stream[A]
Produces a collection that uses a function f to produce elements of type A and update an internal state of type S.
Produces a collection that uses a function f to produce elements of type A and update an internal state of type S.
A
Type of the elements
S
Type of the internal state
init
State initial value
f
Computes the next element (or returns None to signal the end of the collection)
returns
a collection that produces elements using f until f returns None
Definition Classes
IterableFactory
final def wait(): Unit
See https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--.
See https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--.
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
Note
not specified by SLS as a member of AnyRef
final def wait(arg0: Long, arg1: Int): Unit
See https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-
See https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
Note
not specified by SLS as a member of AnyRef
final def wait(arg0: Long): Unit
See https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-.
See https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-.
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException]) @native()
Note
not specified by SLS as a member of AnyRef
object #::
object Empty extends Stream[Nothing]
object cons
An alternative way of building and matching Streams using Stream.cons(hd, tl).

Packages

Package structure

Automatic imports

Stream

Companion class Stream

object Stream extends SeqFactory[Stream]

Type Members

Value Members

Inherited from SeqFactory[Stream]

Inherited from IterableFactory[Stream]

Inherited from java.io.Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

Package structure

Automatic imports

Stream

Companion class Stream

object Stream extends SeqFactory[Stream]

Type Members

Value Members

Inherited from SeqFactory[Stream]

Inherited from IterableFactory[Stream]

Inherited from java.io.Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped

Stream