Scala Library: scala.collection.immutable.Stream
scala.collection.immutable.Stream
The class Stream
implements lazy lists where elements are only evaluated when
they are needed. Here is an example:
The Stream
class also employs memoization such that previously computed values
are converted from Stream
elements to concrete values of type A
. To
illustrate, we will alter body of the fibs
value above and take some more
values:
There are a number of subtle points to the above example.
- The definition of
fibs
is aval
not a method. The memoization of theStream
requires us to have somewhere to store the information and aval
allows us to do that. - While the
Stream
is actually being modified during access, this does not change the notion of its immutability. Once the values are memoized they do not change and values that have yet to be memoized still “exist”, they simply haven’t been realized yet. - One must be cautious of memoization; you can very quickly eat up large amounts
of memory if you’re not careful. The reason for this is that the memoization
of the
Stream
creates a structure much like scala.collection.immutable.List. So long as something is holding on to the head, the head holds on to the tail, and so it continues recursively. If, on the other hand, there is nothing holding on to the head (e.g. we useddef
to define theStream
) then once it is no longer being used directly, it disappears. - Note that some operations, including drop, dropWhile, flatMap or collect may
process a large number of intermediate elements before returning. These
necessarily hold onto the head, since they are methods on
Stream
, and a stream holds its own head. For computations of this sort where memoization is not desired, useIterator
when possible.
- The fact that
tail
works at all is of interest. In the definition offibs
we have an initial(0, 1, Stream(...))
sotail
is deterministic. If we definedfibs
such that only0
were concretely known then the act of determiningtail
would require the evaluation oftail
which would cause an infinite recursion and stack overflow. If we define a definition where the tail is not initially computable then we’re going to have an infinite recursion:
The definition of fibs
above creates a larger number of objects than necessary
depending on how you might want to implement it. The following implementation
provides a more “cost effective” implementation due to the fact that it has a
more direct route to the numbers themselves:
Note that mkString
forces evaluation of a Stream
, but addString
does not.
In both cases, a Stream
that is or ends in a cycle (e.g.
lazy val s: Stream[Int] = 0 #:: s
) will convert additional trips through the
cycle to ...
. Additionally, addString
will display an un-memoized tail as
?
.
- A
- the type of the elements contained in this stream.
- Self Type
- Stream [A]
- Annotations
- @ deprecatedInheritance (message = “This class will be sealed.”, since = “2.11.0”)
- Source
- Version
- 1.1 08/08/03
- Since
- 2.8
- See also
- “Scala’s Collection Library overview”
section on
Streams
for more information.
- “Scala’s Collection Library overview”
section on
Type Members
type Self = Stream[A]
The type implementing this traversable
- Attributes
- protected[this]
- Definition Classes
- TraversableLike
class WithFilter extends FilterMonadic[A, Repr]
A class supporting filtered operations. Instances of this class are returned by
method withFilter
.
- Definition Classes
- TraversableLike
Concrete Value Members From scala.Function1
def compose[A](g: (A) ⇒ Int): (A) ⇒ A
Composes two instances of Function1 in a new Function1, with this function applied last.
- A
- the type to which function
g
can be applied
- the type to which function
- g
- a function A => T1
- returns
- a new function
f
such thatf(x) == apply(g(x))
- a new function
- Definition Classes
- Function1
- Annotations
- @ unspecialized ()
(defined at scala.Function1)
Concrete Value Members From scala.PartialFunction
def andThen[C](k: (A) ⇒ C): PartialFunction[Int, C]
Composes this partial function with a transformation function that gets applied to results of this partial function.
- C
- the result type of the transformation function.
- k
- the transformation function
- returns
- a partial function with the same domain as this partial function, which maps
arguments
x
tok(this(x))
.
- a partial function with the same domain as this partial function, which maps
arguments
- Definition Classes
- PartialFunction → Function1
(defined at scala.PartialFunction)
def applyOrElse[A1 <: Int, B1 >: A](x: A1, default: (A1) ⇒ B1): B1
Applies this partial function to the given argument when it is contained in the function domain. Applies fallback function where this partial function is not defined.
Note that expression pf.applyOrElse(x, default)
is equivalent to
except that applyOrElse
method can be implemented more efficiently. For all
partial function literals the compiler generates an applyOrElse
implementation
which avoids double evaluation of pattern matchers and guards. This makes
applyOrElse
the basis for the efficient implementation for many operations
and scenarios, such as:
- combining partial functions into
orElse
/andThen
chains does not lead to excessiveapply
/isDefinedAt
evaluation lift
andunlift
do not evaluate source functions twice on each invocationrunWith
allows efficient imperative-style combining of partial functions with conditionally applied actions
For non-literal partial function classes with nontrivial isDefinedAt
method it
is recommended to override applyOrElse
with custom implementation that avoids
double isDefinedAt
evaluation. This may result in better performance and more
predictable behavior w.r.t. side effects.
- x
- the function argument
- default
- the fallback function
- returns
- the result of this function or fallback function application.
- Definition Classes
- PartialFunction
- Since
- 2.10
(defined at scala.PartialFunction)
def lift: (Int) ⇒ Option[A]
Turns this partial function into a plain function returning an Option
result.
- returns
- a function that takes an argument
x
toSome(this(x))
ifthis
is defined forx
, and toNone
otherwise.
- a function that takes an argument
- Definition Classes
- PartialFunction
- See also
- Function.unlift
(defined at scala.PartialFunction)
def orElse[A1 <: Int, B1 >: A](that: PartialFunction[A1, B1]): PartialFunction[A1, B1]
Composes this partial function with a fallback partial function which gets applied where this partial function is not defined.
- A1
- the argument type of the fallback function
- B1
- the result type of the fallback function
- that
- the fallback function
- returns
- a partial function which has as domain the union of the domains of this
partial function and
that
. The resulting partial function takesx
tothis(x)
wherethis
is defined, and tothat(x)
where it is not.
- a partial function which has as domain the union of the domains of this
partial function and
- Definition Classes
- PartialFunction
(defined at scala.PartialFunction)
def runWith[U](action: (A) ⇒ U): (Int) ⇒ Boolean
Composes this partial function with an action function which gets applied to results of this partial function. The action function is invoked only for its side effects; its result is ignored.
Note that expression pf.runWith(action)(x)
is equivalent to
except that runWith
is implemented via applyOrElse
and thus potentially more
efficient. Using runWith
avoids double evaluation of pattern matchers and
guards for partial function literals.
- action
- the action function
- returns
- a function which maps arguments
x
toisDefinedAt(x)
. The resulting function runsaction(this(x))
wherethis
is defined.
- a function which maps arguments
- Definition Classes
- PartialFunction
- Since
- 2.10
- See also
applyOrElse
.
(defined at scala.PartialFunction)
Concrete Value Members From scala.collection.GenSeqLike
def equals(that: Any): Boolean
The equals method for arbitrary sequences. Compares this sequence to some other object.
- that
- The object to compare the sequence to
- returns
true
ifthat
is a sequence that has the same elements as this sequence in the same order,false
otherwise
- Definition Classes
- GenSeqLike → Equals → Any
(defined at scala.collection.GenSeqLike)
def indexOf[B >: A](elem: B): Int
[use case]
Finds index of first occurrence of some value in this stream.
Note: may not terminate for infinite-sized collections.
- elem
- the element value to search for.
- returns
- the index of the first element of this stream that is equal (as determined
by
==
) toelem
, or-1
, if none exists.
- the index of the first element of this stream that is equal (as determined
by
- Definition Classes
- GenSeqLike
(defined at scala.collection.GenSeqLike)
def indexOf[B >: A](elem: B, from: Int): Int
[use case]
Finds index of first occurrence of some value in this stream after or at some start index.
Note: may not terminate for infinite-sized collections.
- elem
- the element value to search for.
- from
- the start index
- returns
- the index
>= from
of the first element of this stream that is equal (as determined by==
) toelem
, or-1
, if none exists.
- the index
- Definition Classes
- GenSeqLike
(defined at scala.collection.GenSeqLike)
def indexWhere(p: (A) ⇒ Boolean): Int
Finds index of first element satisfying some predicate.
Note: may not terminate for infinite-sized collections.
- p
- the predicate used to test elements.
- returns
- the index of the first element of this general sequence that satisfies the
predicate
p
, or-1
, if none exists.
- the index of the first element of this general sequence that satisfies the
predicate
- Definition Classes
- GenSeqLike
(defined at scala.collection.GenSeqLike)
def lastIndexOf[B >: A](elem: B): Int
[use case]
Finds index of last occurrence of some value in this stream.
Note: will not terminate for infinite-sized collections.
- elem
- the element value to search for.
- returns
- the index of the last element of this stream that is equal (as determined by
==
) toelem
, or-1
, if none exists.
- the index of the last element of this stream that is equal (as determined by
- Definition Classes
- GenSeqLike
(defined at scala.collection.GenSeqLike)
def lastIndexOf[B >: A](elem: B, end: Int): Int
[use case]
Finds index of last occurrence of some value in this stream before or at a given end index.
- elem
- the element value to search for.
- end
- the end index.
- returns
- the index
<= end
of the last element of this stream that is equal (as determined by==
) toelem
, or-1
, if none exists.
- the index
- Definition Classes
- GenSeqLike
(defined at scala.collection.GenSeqLike)
def lastIndexWhere(p: (A) ⇒ Boolean): Int
Finds index of last element satisfying some predicate.
Note: will not terminate for infinite-sized collections.
- p
- the predicate used to test elements.
- returns
- the index of the last element of this general sequence that satisfies the
predicate
p
, or-1
, if none exists.
- the index of the last element of this general sequence that satisfies the
predicate
- Definition Classes
- GenSeqLike
(defined at scala.collection.GenSeqLike)
def prefixLength(p: (A) ⇒ Boolean): Int
Returns the length of the longest prefix whose elements all satisfy some predicate.
Note: may not terminate for infinite-sized collections.
- p
- the predicate used to test elements.
- returns
- the length of the longest prefix of this general sequence such that every
element of the segment satisfies the predicate
p
.
- the length of the longest prefix of this general sequence such that every
element of the segment satisfies the predicate
- Definition Classes
- GenSeqLike
(defined at scala.collection.GenSeqLike)
def startsWith[B](that: GenSeq[B]): Boolean
Tests whether this general sequence starts with the given sequence.
- that
- the sequence to test
- returns
true
if this collection hasthat
as a prefix,false
otherwise.
- Definition Classes
- GenSeqLike
(defined at scala.collection.GenSeqLike)
Concrete Value Members From scala.collection.IterableLike
def canEqual(that: Any): Boolean
Method called from equality methods, so that user-defined subclasses can refuse to be equal to other collections of the same kind.
- that
- The object with which this iterable collection should be compared
- returns
true
, if this iterable collection can possibly equalthat
,false
otherwise. The test takes into consideration only the run-time types of objects but ignores their elements.
- Definition Classes
- IterableLike → Equals
(defined at scala.collection.IterableLike)
def copyToArray[B >: A](xs: Array[B], start: Int, len: Int): Unit
[use case]
Copies the elements of this stream to an array. Fills the given array xs
with
at most len
elements of this stream, starting at position start
. Copying
will stop once either the end of the current stream is reached, or the end of
the target array is reached, or len
elements have been copied.
Note: will not terminate for infinite-sized collections.
- xs
- the array to fill.
- start
- the starting index.
- len
- the maximal number of elements to copy.
- Definition Classes
- IterableLike → TraversableLike → TraversableOnce → GenTraversableOnce
(defined at scala.collection.IterableLike)
def grouped(size: Int): Iterator[Stream[A]]
Partitions elements in fixed size iterable collections.
- size
- the number of elements per group
- returns
- An iterator producing iterable collections of size
size
, except the last will be less than sizesize
if the elements don’t divide evenly.
- An iterator producing iterable collections of size
- Definition Classes
- IterableLike
- See also
- scala.collection.Iterator, method
grouped
- scala.collection.Iterator, method
(defined at scala.collection.IterableLike)
def sliding(size: Int): Iterator[Stream[A]]
Groups elements in fixed size blocks by passing a “sliding window” over them (as opposed to partitioning them, as is done in grouped.) “Sliding window” step is 1 by default.
- size
- the number of elements per group
- returns
- An iterator producing iterable collections of size
size
, except the last and the only element will be truncated if there are fewer elements than size.
- An iterator producing iterable collections of size
- Definition Classes
- IterableLike
- See also
- scala.collection.Iterator, method
sliding
- scala.collection.Iterator, method
(defined at scala.collection.IterableLike)
def sliding(size: Int, step: Int): Iterator[Stream[A]]
Groups elements in fixed size blocks by passing a “sliding window” over them (as opposed to partitioning them, as is done in grouped.)
- size
- the number of elements per group
- step
- the distance between the first elements of successive groups
- returns
- An iterator producing iterable collections of size
size
, except the last and the only element will be truncated if there are fewer elements than size.
- An iterator producing iterable collections of size
- Definition Classes
- IterableLike
- See also
- scala.collection.Iterator, method
sliding
- scala.collection.Iterator, method
(defined at scala.collection.IterableLike)
def toIterable: collection.Iterable[A]
Returns this iterable collection as an iterable collection.
A new collection will not be built; lazy collections will stay lazy.
Note: will not terminate for infinite-sized collections.
- returns
- an
Iterable
containing all elements of this iterable collection.
- an
- Definition Classes
- IterableLike → TraversableOnce → GenTraversableOnce
(defined at scala.collection.IterableLike)
def zipAll[B, A1 >: A, That](that: GenIterable[B], thisElem: A1, thatElem: B)(implicit bf: CanBuildFrom[Stream[A], (A1, B), That]): That
[use case]
Returns a stream formed from this stream and another iterable collection by combining corresponding elements in pairs. If one of the two collections is shorter than the other, placeholder elements are used to extend the shorter collection to the length of the longer.
- B
- the type of the second half of the returned pairs
- that
- The iterable providing the second half of each result pair
- thisElem
- the element to be used to fill up the result if this stream is shorter than
that
.
- the element to be used to fill up the result if this stream is shorter than
- thatElem
- the element to be used to fill up the result if
that
is shorter than this stream.
- the element to be used to fill up the result if
- returns
- a new stream containing pairs consisting of corresponding elements of this
stream and
that
. The length of the returned collection is the maximum of the lengths of this stream andthat
. If this stream is shorter thanthat
,thisElem
values are used to pad the result. Ifthat
is shorter than this stream,thatElem
values are used to pad the result.
- a new stream containing pairs consisting of corresponding elements of this
stream and
- Definition Classes
- IterableLike → GenIterableLike
(defined at scala.collection.IterableLike)
Concrete Value Members From scala.collection.LinearSeqLike
final def corresponds[B](that: GenSeq[B])(p: (A, B) ⇒ Boolean): Boolean
Tests whether every element of this sequence relates to the corresponding element of another sequence by satisfying a test predicate.
- B
- the type of the elements of
that
- the type of the elements of
- that
- the other sequence
- p
- the test predicate, which relates elements from both sequences
- returns
true
if both sequences have the same length andp(x, y)
istrue
for all corresponding elementsx
of this sequence andy
ofthat
, otherwisefalse
.
- Definition Classes
- LinearSeqLike → SeqLike → GenSeqLike
- Annotations
- @ tailrec ()
(defined at scala.collection.LinearSeqLike)
def thisCollection: collection.LinearSeq[A]
The underlying collection seen as an instance of Seq
. By default this is
implemented as the current collection object itself, but this can be overridden.
- Attributes
- protected[this]
- Definition Classes
- LinearSeqLike → SeqLike → IterableLike → TraversableLike
(defined at scala.collection.LinearSeqLike)
def toCollection(repr: Stream[A]): collection.LinearSeq[A]
A conversion from collections of type Repr
to Seq
objects. By default this
is implemented as just a cast, but this can be overridden.
- Attributes
- protected[this]
- Definition Classes
- LinearSeqLike → SeqLike → IterableLike → TraversableLike
(defined at scala.collection.LinearSeqLike)
Concrete Value Members From scala.collection.LinearSeqOptimized
def apply(n: Int): A
Selects an element by its index in the sequence. Note: the execution of apply
may take time proportional to the index value.
- returns
- the element of this sequence at index
idx
, where0
indicates the first element.
- the element of this sequence at index
- Definition Classes
- LinearSeqOptimized → SeqLike → GenSeqLike
- Exceptions thrown
- IndexOutOfBoundsException if
idx
does not satisfy0 <= idx < length
.
- IndexOutOfBoundsException if
(defined at scala.collection.LinearSeqOptimized)
def contains[A1 >: A](elem: A1): Boolean
Tests whether this sequence contains a given value as an element.
Note: may not terminate for infinite-sized collections.
- elem
- the element to test.
- returns
true
if this sequence has an element that is equal (as determined by==
) toelem
,false
otherwise.
- Definition Classes
- LinearSeqOptimized → SeqLike
(defined at scala.collection.LinearSeqOptimized)
def exists(p: (A) ⇒ Boolean): Boolean
Tests whether a predicate holds for at least one element of this sequence.
Note: may not terminate for infinite-sized collections.
- p
- the predicate used to test elements.
- returns
false
if this sequence is empty, otherwisetrue
if the given predicatep
holds for some of the elements of this sequence, otherwisefalse
- Definition Classes
- LinearSeqOptimized → IterableLike → TraversableLike → TraversableOnce → GenTraversableOnce
(defined at scala.collection.LinearSeqOptimized)
def find(p: (A) ⇒ Boolean): Option[A]
Finds the first element of the sequence satisfying a predicate, if any.
Note: may not terminate for infinite-sized collections.
- p
- the predicate used to test elements.
- returns
- an option value containing the first element in the sequence that satisfies
p
, orNone
if none exists.
- an option value containing the first element in the sequence that satisfies
- Definition Classes
- LinearSeqOptimized → IterableLike → TraversableLike → TraversableOnce → GenTraversableOnce
(defined at scala.collection.LinearSeqOptimized)
def foldRight[B](z: B)(op: (A, B) ⇒ B): B
Applies a binary operator to all elements of this sequence and a start value, going right to left.
Note: will not terminate for infinite-sized collections.
- B
- the result type of the binary operator.
- z
- the start value.
- op
- the binary operator.
- returns
- the result of inserting
op
between consecutive elements of this sequence, going right to left with the start valuez
on the right:
- the result of inserting
where `x1, ..., xn` are the elements of this sequence. Returns `z` if this
sequence is empty.
- Definition Classes
- LinearSeqOptimized → IterableLike → TraversableOnce → GenTraversableOnce
(defined at scala.collection.LinearSeqOptimized)
def forall(p: (A) ⇒ Boolean): Boolean
Tests whether a predicate holds for all elements of this sequence.
Note: may not terminate for infinite-sized collections.
- p
- the predicate used to test elements.
- returns
true
if this sequence is empty or the given predicatep
holds for all elements of this sequence, otherwisefalse
.
- Definition Classes
- LinearSeqOptimized → IterableLike → TraversableLike → TraversableOnce → GenTraversableOnce
(defined at scala.collection.LinearSeqOptimized)
def indexWhere(p: (A) ⇒ Boolean, from: Int): Int
Finds index of the first element satisfying some predicate after or at some start index.
Note: may not terminate for infinite-sized collections.
- p
- the predicate used to test elements.
- from
- the start index
- returns
- the index
>= from
of the first element of this sequence that satisfies the predicatep
, or-1
, if none exists.
- the index
- Definition Classes
- LinearSeqOptimized → SeqLike → GenSeqLike
(defined at scala.collection.LinearSeqOptimized)
def isDefinedAt(x: Int): Boolean
Tests whether this sequence contains given index.
The implementations of methods apply
and isDefinedAt
turn a Seq[A]
into a
PartialFunction[Int, A]
.
- returns
true
if this sequence contains an element at positionidx
,false
otherwise.
- Definition Classes
- LinearSeqOptimized → GenSeqLike
(defined at scala.collection.LinearSeqOptimized)
def lastIndexWhere(p: (A) ⇒ Boolean, end: Int): Int
Finds index of last element satisfying some predicate before or at given end index.
- p
- the predicate used to test elements.
- returns
- the index
<= end
of the last element of this sequence that satisfies the predicatep
, or-1
, if none exists.
- the index
- Definition Classes
- LinearSeqOptimized → SeqLike → GenSeqLike
(defined at scala.collection.LinearSeqOptimized)
def lengthCompare(len: Int): Int
Compares the length of this sequence to a test value.
- len
- the test value that gets compared with the length.
- returns
- A value
x
where
- A value
The method as implemented here does not call `length` directly; its running
time is `O(length min len)` instead of `O(length)` . The method should be
overwritten if computing `length` is cheap.
- Definition Classes
- LinearSeqOptimized → SeqLike
(defined at scala.collection.LinearSeqOptimized)
def reduceRight[B >: A](op: (A, B) ⇒ B): B
Applies a binary operator to all elements of this sequence, going right to left.
Note: will not terminate for infinite-sized collections.
- B
- the result type of the binary operator.
- op
- the binary operator.
- returns
- the result of inserting
op
between consecutive elements of this sequence, going right to left:
- the result of inserting
where `x1, ..., xn` are the elements of this sequence.
- Definition Classes
- LinearSeqOptimized → IterableLike → TraversableOnce → GenTraversableOnce
- Exceptions thrown
- UnsupportedOperationException if this sequence is empty.
(defined at scala.collection.LinearSeqOptimized)
def sameElements[B >: A](that: GenIterable[B]): Boolean
[use case]
Checks if the other iterable collection contains the same elements in the same order as this stream.
Note: will not terminate for infinite-sized collections.
- that
- the collection to compare with.
- returns
true
, if both collections contain the same elements in the same order,false
otherwise.
- Definition Classes
- LinearSeqOptimized → IterableLike → GenIterableLike
(defined at scala.collection.LinearSeqOptimized)
def segmentLength(p: (A) ⇒ Boolean, from: Int): Int
Computes length of longest segment whose elements all satisfy some predicate.
Note: may not terminate for infinite-sized collections.
- p
- the predicate used to test elements.
- from
- the index where the search starts.
- returns
- the length of the longest segment of this sequence starting from index
from
such that every element of the segment satisfies the predicatep
.
- the length of the longest segment of this sequence starting from index
- Definition Classes
- LinearSeqOptimized → SeqLike → GenSeqLike
(defined at scala.collection.LinearSeqOptimized)
def span(p: (A) ⇒ Boolean): (Stream[A], Stream[A])
Splits this sequence into a prefix/suffix pair according to a predicate.
Note: c span p
is equivalent to (but possibly more efficient than)
(c takeWhile p, c dropWhile p)
, provided the evaluation of the predicate
p
does not cause any side-effects.
- returns
- a pair consisting of the longest prefix of this sequence whose elements all
satisfy
p
, and the rest of this sequence.
- a pair consisting of the longest prefix of this sequence whose elements all
satisfy
- Definition Classes
- LinearSeqOptimized → TraversableLike → GenTraversableLike
(defined at scala.collection.LinearSeqOptimized)
Concrete Value Members From scala.collection.Parallelizable
def par: ParSeq[A]
Returns a parallel implementation of this collection.
For most collection types, this method creates a new parallel collection by
copying all the elements. For these collection, par
takes linear time. Mutable
collections in this category do not produce a mutable parallel collection that
has the same underlying dataset, so changes in one collection will not be
reflected in the other one.
Specific collections (e.g. ParArray
or mutable.ParHashMap
) override this
default behaviour by creating a parallel collection which shares the same
underlying dataset. For these collections, par
takes constant or sublinear
time.
All parallel collections return a reference to themselves.
- returns
- a parallel implementation of this collection
- Definition Classes
- Parallelizable
(defined at scala.collection.Parallelizable)
Concrete Value Members From scala.collection.SeqLike
def :+[B >: A, That](elem: B)(implicit bf: CanBuildFrom[Stream[A], B, That]): That
[use case]
A copy of this stream with an element appended.
A mnemonic for +:
vs. :+
is: the COLon goes on the COLlection side.
Note: will not terminate for infinite-sized collections.
Example:
- elem
- the appended element
- returns
- a new stream consisting of all elements of this stream followed by
elem
.
- a new stream consisting of all elements of this stream followed by
- Definition Classes
- SeqLike → GenSeqLike
(defined at scala.collection.SeqLike)
def combinations(n: Int): Iterator[Stream[A]]
Iterates over combinations. A combination of length n
is a subsequence of
the original sequence, with the elements taken in order. Thus, "xy"
and
"yy"
are both length-2 combinations of "xyy"
, but "yx"
is not. If there
is more than one way to generate the same subsequence, only one will be
returned.
For example, "xyyy"
has three different ways to generate "xy"
depending on
whether the first, second, or third "y"
is selected. However, since all are
identical, only one will be chosen. Which of the three will be taken is an
implementation detail that is not defined.
- returns
- An Iterator which traverses the possible n-element combinations of this sequence.
- Definition Classes
- SeqLike
Example:
(defined at scala.collection.SeqLike)
def containsSlice[B](that: GenSeq[B]): Boolean
Tests whether this sequence contains a given sequence as a slice.
Note: may not terminate for infinite-sized collections.
- that
- the sequence to test
- returns
true
if this sequence contains a slice with the same elements asthat
, otherwisefalse
.
- Definition Classes
- SeqLike
(defined at scala.collection.SeqLike)
def diff[B >: A](that: GenSeq[B]): Stream[A]
[use case]
Computes the multiset difference between this stream and another sequence.
Note: will not terminate for infinite-sized collections.
- that
- the sequence of elements to remove
- returns
- a new stream which contains all elements of this stream except some of
occurrences of elements that also appear in
that
. If an element valuex
appears n times inthat
, then the first n occurrences ofx
will not form part of the result, but any following occurrences will.
- a new stream which contains all elements of this stream except some of
occurrences of elements that also appear in
- Definition Classes
- SeqLike → GenSeqLike
(defined at scala.collection.SeqLike)
def endsWith[B](that: GenSeq[B]): Boolean
Tests whether this sequence ends with the given sequence.
Note: will not terminate for infinite-sized collections.
- that
- the sequence to test
- returns
true
if this sequence hasthat
as a suffix,false
otherwise.
- Definition Classes
- SeqLike → GenSeqLike
(defined at scala.collection.SeqLike)
def indexOfSlice[B >: A](that: GenSeq[B]): Int
Finds first index where this sequence contains a given sequence as a slice.
Note: may not terminate for infinite-sized collections.
- that
- the sequence to test
- returns
- the first index such that the elements of this sequence starting at this
index match the elements of sequence
that
, or-1
of no such subsequence exists.
- the first index such that the elements of this sequence starting at this
index match the elements of sequence
- Definition Classes
- SeqLike
(defined at scala.collection.SeqLike)
def indexOfSlice[B >: A](that: GenSeq[B], from: Int): Int
Finds first index after or at a start index where this sequence contains a given sequence as a slice.
Note: may not terminate for infinite-sized collections.
- that
- the sequence to test
- from
- the start index
- returns
- the first index
>= from
such that the elements of this sequence starting at this index match the elements of sequencethat
, or-1
of no such subsequence exists.
- the first index
- Definition Classes
- SeqLike
(defined at scala.collection.SeqLike)
def indices: Range
Produces the range of all indices of this sequence.
- returns
- a
Range
value from0
to one less than the length of this sequence.
- a
- Definition Classes
- SeqLike
(defined at scala.collection.SeqLike)
def intersect[B >: A](that: GenSeq[B]): Stream[A]
[use case]
Computes the multiset intersection between this stream and another sequence.
Note: may not terminate for infinite-sized collections.
- that
- the sequence of elements to intersect with.
- returns
- a new stream which contains all elements of this stream which also appear in
that
. If an element valuex
appears n times inthat
, then the first n occurrences ofx
will be retained in the result, but any following occurrences will be omitted.
- a new stream which contains all elements of this stream which also appear in
- Definition Classes
- SeqLike → GenSeqLike
(defined at scala.collection.SeqLike)
def lastIndexOfSlice[B >: A](that: GenSeq[B]): Int
Finds last index where this sequence contains a given sequence as a slice.
Note: will not terminate for infinite-sized collections.
- that
- the sequence to test
- returns
- the last index such that the elements of this sequence starting a this index
match the elements of sequence
that
, or-1
of no such subsequence exists.
- the last index such that the elements of this sequence starting a this index
match the elements of sequence
- Definition Classes
- SeqLike
(defined at scala.collection.SeqLike)
def lastIndexOfSlice[B >: A](that: GenSeq[B], end: Int): Int
Finds last index before or at a given end index where this sequence contains a given sequence as a slice.
- that
- the sequence to test
- end
- the end index
- returns
- the last index
<= end
such that the elements of this sequence starting at this index match the elements of sequencethat
, or-1
of no such subsequence exists.
- the last index
- Definition Classes
- SeqLike
(defined at scala.collection.SeqLike)
def patch[B >: A, That](from: Int, patch: GenSeq[B], replaced: Int)(implicit bf: CanBuildFrom[Stream[A], B, That]): That
[use case]
Produces a new stream where a slice of elements in this stream is replaced by another sequence.
- from
- the index of the first replaced element
- replaced
- the number of elements to drop in the original stream
- returns
- a new stream consisting of all elements of this stream except that
replaced
elements starting fromfrom
are replaced bypatch
.
- a new stream consisting of all elements of this stream except that
- Definition Classes
- SeqLike → GenSeqLike
(defined at scala.collection.SeqLike)
def permutations: Iterator[Stream[A]]
Iterates over distinct permutations.
- returns
- An Iterator which traverses the distinct permutations of this sequence.
- Definition Classes
- SeqLike
Example:
(defined at scala.collection.SeqLike)
def reverseMap[B, That](f: (A) ⇒ B)(implicit bf: CanBuildFrom[Stream[A], B, That]): That
[use case]
Builds a new collection by applying a function to all elements of this stream and collecting the results in reversed order.
Note: will not terminate for infinite-sized collections.
Note: xs.reverseMap(f)
is the same as xs.reverse.map(f)
but might be more
efficient.
- B
- the element type of the returned collection.
- f
- the function to apply to each element.
- returns
- a new stream resulting from applying the given function
f
to each element of this stream and collecting the results in reversed order.
- a new stream resulting from applying the given function
- Definition Classes
- SeqLike → GenSeqLike
(defined at scala.collection.SeqLike)
def sortBy[B](f: (A) ⇒ B)(implicit ord: math.Ordering[B]): Stream[A]
Sorts this Seq
according to the Ordering which results from transforming an
implicitly given Ordering with a transformation function.
- B
- the target type of the transformation
f
, and the type where the orderingord
is defined.
- the target type of the transformation
- f
- the transformation function mapping elements to some other domain
B
.
- the transformation function mapping elements to some other domain
- ord
- the ordering assumed on domain
B
.
- the ordering assumed on domain
- returns
- a sequence consisting of the elements of this sequence sorted according to
the ordering where
x < y
iford.lt(f(x), f(y))
.
- a sequence consisting of the elements of this sequence sorted according to
the ordering where
- Definition Classes
- SeqLike
- See also
- scala.math.Ordering Note: will not terminate for infinite-sized collections.
Example:
(defined at scala.collection.SeqLike)
def sortWith(lt: (A, A) ⇒ Boolean): Stream[A]
Sorts this sequence according to a comparison function.
Note: will not terminate for infinite-sized collections.
The sort is stable. That is, elements that are equal (as determined by lt
)
appear in the same order in the sorted sequence as in the original.
- lt
- the comparison function which tests whether its first argument precedes its second argument in the desired ordering.
- returns
- a sequence consisting of the elements of this sequence sorted according to
the comparison function
lt
.
- a sequence consisting of the elements of this sequence sorted according to
the comparison function
- Definition Classes
- SeqLike
Example:
(defined at scala.collection.SeqLike)
def sorted[B >: A](implicit ord: math.Ordering[B]): Stream[A]
Sorts this sequence according to an Ordering.
The sort is stable. That is, elements that are equal (as determined by lt
)
appear in the same order in the sorted sequence as in the original.
- ord
- the ordering to be used to compare elements.
- returns
- a sequence consisting of the elements of this sequence sorted according to
the ordering
ord
.
- a sequence consisting of the elements of this sequence sorted according to
the ordering
- Definition Classes
- SeqLike
- See also
- scala.math.Ordering
(defined at scala.collection.SeqLike)
def startsWith[B](that: GenSeq[B], offset: Int): Boolean
Tests whether this sequence contains the given sequence at a given index.
Note : If the both the receiver object this
and the argument that
are
infinite sequences this method may not terminate.
- that
- the sequence to test
- offset
- the index where the sequence is searched.
- returns
true
if the sequencethat
is contained in this sequence at indexoffset
, otherwisefalse
.
- Definition Classes
- SeqLike → GenSeqLike
(defined at scala.collection.SeqLike)
def union[B >: A, That](that: GenSeq[B])(implicit bf: CanBuildFrom[Stream[A], B, That]): That
[use case]
Produces a new sequence which contains all elements of this stream and also all
elements of a given sequence. xs union ys
is equivalent to xs ++ ys
.
Another way to express this is that xs union ys
computes the order-preserving
multi-set union of xs
and ys
. union
is hence a counter-part of diff
and
intersect
which also work on multi-sets.
Note: will not terminate for infinite-sized collections.
- that
- the sequence to add.
- returns
- a new stream which contains all elements of this stream followed by all
elements of
that
.
- a new stream which contains all elements of this stream followed by all
elements of
- Definition Classes
- SeqLike → GenSeqLike
(defined at scala.collection.SeqLike)
def updated[B >: A, That](index: Int, elem: B)(implicit bf: CanBuildFrom[Stream[A], B, That]): That
[use case]
A copy of this stream with one single replaced element.
- index
- the position of the replacement
- elem
- the replacing element
- returns
- a copy of this stream with the element at position
index
replaced byelem
.
- a copy of this stream with the element at position
- Definition Classes
- SeqLike → GenSeqLike
(defined at scala.collection.SeqLike)
def view(from: Int, until: Int): SeqView[A, Stream[A]]
Creates a non-strict view of a slice of this sequence.
Note: the difference between view
and slice
is that view
produces a view
of the current sequence, whereas slice
produces a new sequence.
Note: view(from, to)
is equivalent to view.slice(from, to)
- from
- the index of the first element of the view
- until
- the index of the element following the view
- returns
- a non-strict view of a slice of this sequence, starting at index
from
and extending up to (but not including) indexuntil
.
- a non-strict view of a slice of this sequence, starting at index
- Definition Classes
- SeqLike → IterableLike → TraversableLike
(defined at scala.collection.SeqLike)
Concrete Value Members From scala.collection.TraversableLike
def ++:[B >: A, That](that: collection.Traversable[B])(implicit bf: CanBuildFrom[Stream[A], B, That]): That
As with ++
, returns a new collection containing the elements from the left
operand followed by the elements from the right operand.
It differs from ++
in that the right operand determines the type of the
resulting collection rather than the left one. Mnemonic: the COLon is on the
side of the new COLlection type.
Example:
This overload exists because: for the implementation of ++:
we should reuse
that of ++
because many collections override it with more efficient versions.
Since TraversableOnce
has no ++
method, we have to implement that directly,
but Traversable
and down can use the overload.
- B
- the element type of the returned collection.
- That
- the class of the returned collection. Where possible,
That
is the same class as the current collection classRepr
, but this depends on the element typeB
being admissible for that class, which means that an implicit instance of typeCanBuildFrom[Repr, B, That]
is found.
- the class of the returned collection. Where possible,
- that
- the traversable to append.
- bf
- an implicit value of class
CanBuildFrom
which determines the result classThat
from the current representation typeRepr
and and the new element typeB
.
- an implicit value of class
- returns
- a new collection of type
That
which contains all elements of this traversable collection followed by all elements ofthat
.
- a new collection of type
- Definition Classes
- TraversableLike
(defined at scala.collection.TraversableLike)
def ++:[B >: A, That](that: TraversableOnce[B])(implicit bf: CanBuildFrom[Stream[A], B, That]): That
[use case]
As with ++
, returns a new collection containing the elements from the left
operand followed by the elements from the right operand.
It differs from ++
in that the right operand determines the type of the
resulting collection rather than the left one. Mnemonic: the COLon is on the
side of the new COLlection type.
Example:
- B
- the element type of the returned collection.
- that
- the traversable to append.
- returns
- a new stream which contains all elements of this stream followed by all
elements of
that
.
- a new stream which contains all elements of this stream followed by all
elements of
- Definition Classes
- TraversableLike
(defined at scala.collection.TraversableLike)
def filter(p: (A) ⇒ Boolean): Stream[A]
Selects all elements of this traversable collection which satisfy a predicate.
- p
- the predicate used to test elements.
- returns
- a new traversable collection consisting of all elements of this traversable
collection that satisfy the given predicate
p
. The order of the elements is preserved.
- a new traversable collection consisting of all elements of this traversable
collection that satisfy the given predicate
- Definition Classes
- TraversableLike → GenTraversableLike
(defined at scala.collection.TraversableLike)
def filterNot(p: (A) ⇒ Boolean): Stream[A]
Selects all elements of this traversable collection which do not satisfy a predicate.
- p
- the predicate used to test elements.
- returns
- a new traversable collection consisting of all elements of this traversable
collection that do not satisfy the given predicate
p
. The order of the elements is preserved.
- a new traversable collection consisting of all elements of this traversable
collection that do not satisfy the given predicate
- Definition Classes
- TraversableLike → GenTraversableLike
(defined at scala.collection.TraversableLike)
def groupBy[K](f: (A) ⇒ K): Map[K, Stream[A]]
Partitions this traversable collection into a map of traversable collections according to some discriminator function.
Note: this method is not re-implemented by views. This means when applied to a view it will always force the view and return a new traversable collection.
- K
- the type of keys returned by the discriminator function.
- f
- the discriminator function.
- returns
- A map from keys to traversable collections such that the following invariant holds:
That is, every key `k` is bound to a traversable collection of those
elements `x` for which `f(x)` equals `k` .
- Definition Classes
- TraversableLike → GenTraversableLike
(defined at scala.collection.TraversableLike)
def inits: Iterator[Stream[A]]
Iterates over the inits of this traversable collection. The first value will be
this traversable collection and the final one will be an empty traversable
collection, with the intervening values the results of successive applications
of init
.
- returns
- an iterator over all the inits of this traversable collection
- Definition Classes
- TraversableLike
Example:
(defined at scala.collection.TraversableLike)
def repr: Stream[A]
The collection of type traversable collection underlying this TraversableLike
object. By default this is implemented as the TraversableLike
object itself,
but this can be overridden.
- Definition Classes
- TraversableLike → GenTraversableLike
(defined at scala.collection.TraversableLike)
def scanRight[B, That](z: B)(op: (A, B) ⇒ B)(implicit bf: CanBuildFrom[Stream[A], B, That]): That
Produces a collection containing cumulative results of applying the operator going right to left. The head of the collection is the last cumulative result.
Note: will not terminate for infinite-sized collections.
Note: might return different results for different runs, unless the underlying collection type is ordered.
Example:
- B
- the type of the elements in the resulting collection
- That
- the actual type of the resulting collection
- z
- the initial value
- op
- the binary operator applied to the intermediate result and the element
- bf
- an implicit value of class
CanBuildFrom
which determines the result classThat
from the current representation typeRepr
and and the new element typeB
.
- an implicit value of class
- returns
- collection with intermediate results
- Definition Classes
- TraversableLike → GenTraversableLike
- Annotations
- @migration
- Migration
- (Changed in version 2.9.0) The behavior of
scanRight
has changed. The previous behavior can be reproduced with scanRight.reverse.
- (Changed in version 2.9.0) The behavior of
(defined at scala.collection.TraversableLike)
def scan[B >: A, That](z: B)(op: (B, B) ⇒ B)(implicit cbf: CanBuildFrom[Stream[A], B, That]): That
Computes a prefix scan of the elements of the collection.
Note: The neutral element z
may be applied more than once.
- B
- element type of the resulting collection
- That
- type of the resulting collection
- z
- neutral element for the operator
op
- neutral element for the operator
- op
- the associative operator for the scan
- cbf
- combiner factory which provides a combiner
- returns
- a new traversable collection containing the prefix scan of the elements in this traversable collection
- Definition Classes
- TraversableLike → GenTraversableLike
(defined at scala.collection.TraversableLike)
def tail: Stream[A]
Selects all elements except the first.
Note: might return different results for different runs, unless the underlying collection type is ordered.
- returns
- a traversable collection consisting of all elements of this traversable collection except the first one.
- Definition Classes
- TraversableLike → GenTraversableLike
- Exceptions thrown
UnsupportedOperationException
if the traversable collection is empty.
(defined at scala.collection.TraversableLike)
def tails: Iterator[Stream[A]]
Iterates over the tails of this traversable collection. The first value will be
this traversable collection and the final one will be an empty traversable
collection, with the intervening values the results of successive applications
of tail
.
- returns
- an iterator over all the tails of this traversable collection
- Definition Classes
- TraversableLike
Example:
(defined at scala.collection.TraversableLike)
def toTraversable: collection.Traversable[A]
Converts this traversable collection to an unspecified Traversable. Will return the same collection if this instance is already Traversable.
Note: will not terminate for infinite-sized collections.
- returns
- a Traversable containing all elements of this traversable collection.
- Definition Classes
- TraversableLike → TraversableOnce → GenTraversableOnce
- Annotations
- @ deprecatedOverriding (message =…, since = “2.11.0”)
(defined at scala.collection.TraversableLike)
Concrete Value Members From scala.collection.TraversableOnce
def /:[B](z: B)(op: (B, A) ⇒ B): B
Applies a binary operator to a start value and all elements of this traversable or iterator, going left to right.
Note: /:
is alternate syntax for foldLeft
; z /: xs
is the same as
xs foldLeft z
.
Examples:
Note that the folding function used to compute b is equivalent to that used to compute c.
Note: will not terminate for infinite-sized collections.
Note: might return different results for different runs, unless the underlying collection type is ordered or the operator is associative and commutative.
- B
- the result type of the binary operator.
- z
- the start value.
- op
- the binary operator.
- returns
- the result of inserting
op
between consecutive elements of this traversable or iterator, going left to right with the start valuez
on the left:
- the result of inserting
where `x1, ..., xn` are the elements of this traversable or iterator.
- Definition Classes
- TraversableOnce → GenTraversableOnce
(defined at scala.collection.TraversableOnce)
def :\[B](z: B)(op: (A, B) ⇒ B): B
Applies a binary operator to all elements of this traversable or iterator and a start value, going right to left.
Note: :\
is alternate syntax for foldRight
; xs :\ z
is the same as
xs foldRight z
.
Note: will not terminate for infinite-sized collections.
Note: might return different results for different runs, unless the underlying collection type is ordered or the operator is associative and commutative.
Examples:
Note that the folding function used to compute b is equivalent to that used to compute c.
- B
- the result type of the binary operator.
- z
- the start value
- op
- the binary operator
- returns
- the result of inserting
op
between consecutive elements of this traversable or iterator, going right to left with the start valuez
on the right:
- the result of inserting
where `x1, ..., xn` are the elements of this traversable or iterator.
- Definition Classes
- TraversableOnce → GenTraversableOnce
(defined at scala.collection.TraversableOnce)
def addString(b: StringBuilder): StringBuilder
Appends all elements of this traversable or iterator to a string builder. The
written text consists of the string representations (w.r.t. the method
toString
) of all elements of this traversable or iterator without any
separator string.
Example:
- b
- the string builder to which elements are appended.
- returns
- the string builder
b
to which elements were appended.
- the string builder
- Definition Classes
- TraversableOnce
(defined at scala.collection.TraversableOnce)
def addString(b: StringBuilder, sep: String): StringBuilder
Appends all elements of this traversable or iterator to a string builder using a
separator string. The written text consists of the string representations
(w.r.t. the method toString
) of all elements of this traversable or iterator,
separated by the string sep
.
Example:
- b
- the string builder to which elements are appended.
- sep
- the separator string.
- returns
- the string builder
b
to which elements were appended.
- the string builder
- Definition Classes
- TraversableOnce
(defined at scala.collection.TraversableOnce)
def aggregate[B](z: ⇒ B)(seqop: (B, A) ⇒ B, combop: (B, B) ⇒ B): B
Aggregates the results of applying an operator to subsequent elements.
This is a more general form of fold
and reduce
. It is similar to
foldLeft
in that it doesn’t require the result to be a supertype of the
element type. In addition, it allows parallel collections to be processed in
chunks, and then combines the intermediate results.
aggregate
splits the traversable or iterator into partitions and processes
each partition by sequentially applying seqop
, starting with z
(like
foldLeft
). Those intermediate results are then combined by using combop
(like fold
). The implementation of this operation may operate on an arbitrary
number of collection partitions (even 1), so combop
may be invoked an
arbitrary number of times (even 0).
As an example, consider summing up the integer values of a list of chars. The
initial value for the sum is 0. First, seqop
transforms each input character
to an Int and adds it to the sum (of the partition). Then, combop
just needs
to sum up the intermediate results of the partitions:
- B
- the type of accumulated results
- z
- the initial value for the accumulated result of the partition - this will
typically be the neutral element for the
seqop
operator (e.g.Nil
for list concatenation or0
for summation) and may be evaluated more than once
- the initial value for the accumulated result of the partition - this will
typically be the neutral element for the
- seqop
- an operator used to accumulate results within a partition
- combop
- an associative operator used to combine results from different partitions
- Definition Classes
- TraversableOnce → GenTraversableOnce
(defined at scala.collection.TraversableOnce)
def collectFirst[B](pf: PartialFunction[A, B]): Option[B]
Finds the first element of the traversable or iterator for which the given partial function is defined, and applies the partial function to it.
Note: may not terminate for infinite-sized collections.
Note: might return different results for different runs, unless the underlying collection type is ordered.
- pf
- the partial function
- returns
- an option value containing pf applied to the first value for which it is
defined, or
None
if none exists.
- an option value containing pf applied to the first value for which it is
defined, or
- Definition Classes
- TraversableOnce
Example:
(defined at scala.collection.TraversableOnce)
def copyToArray[B >: A](xs: Array[B]): Unit
[use case]
Copies the elements of this stream to an array. Fills the given array xs
with
values of this stream. Copying will stop once either the end of the current
stream is reached, or the end of the target array is reached.
Note: will not terminate for infinite-sized collections.
- xs
- the array to fill.
- Definition Classes
- TraversableOnce → GenTraversableOnce
(defined at scala.collection.TraversableOnce)
def copyToArray[B >: A](xs: Array[B], start: Int): Unit
[use case]
Copies the elements of this stream to an array. Fills the given array xs
with
values of this stream, beginning at index start
. Copying will stop once
either the end of the current stream is reached, or the end of the target array
is reached.
Note: will not terminate for infinite-sized collections.
- xs
- the array to fill.
- start
- the starting index.
- Definition Classes
- TraversableOnce → GenTraversableOnce
(defined at scala.collection.TraversableOnce)
def copyToBuffer[B >: A](dest: Buffer[B]): Unit
Copies all elements of this traversable or iterator to a buffer.
Note: will not terminate for infinite-sized collections.
- dest
- The buffer to which elements are copied.
- Definition Classes
- TraversableOnce
(defined at scala.collection.TraversableOnce)
def count(p: (A) ⇒ Boolean): Int
Counts the number of elements in the traversable or iterator which satisfy a predicate.
- p
- the predicate used to test elements.
- returns
- the number of elements satisfying the predicate
p
.
- the number of elements satisfying the predicate
- Definition Classes
- TraversableOnce → GenTraversableOnce
(defined at scala.collection.TraversableOnce)
def fold[A1 >: A](z: A1)(op: (A1, A1) ⇒ A1): A1
Folds the elements of this traversable or iterator using the specified associative binary operator.
The order in which operations are performed on elements is unspecified and may be nondeterministic.
Note: will not terminate for infinite-sized collections.
- A1
- a type parameter for the binary operator, a supertype of
A
.
- a type parameter for the binary operator, a supertype of
- z
- a neutral element for the fold operation; may be added to the result an
arbitrary number of times, and must not change the result (e.g.,
Nil
for list concatenation, 0 for addition, or 1 for multiplication).
- a neutral element for the fold operation; may be added to the result an
arbitrary number of times, and must not change the result (e.g.,
- op
- a binary operator that must be associative.
- returns
- the result of applying the fold operator
op
between all the elements andz
, orz
if this traversable or iterator is empty.
- the result of applying the fold operator
- Definition Classes
- TraversableOnce → GenTraversableOnce
(defined at scala.collection.TraversableOnce)
def maxBy[B](f: (A) ⇒ B)(implicit cmp: Ordering[B]): A
[use case]
Finds the first element which yields the largest value measured by function f.
- B
- The result type of the function f.
- f
- The measuring function.
- returns
- the first element of this stream with the largest value measured by function f.
- Definition Classes
- TraversableOnce → GenTraversableOnce
(defined at scala.collection.TraversableOnce)
def minBy[B](f: (A) ⇒ B)(implicit cmp: Ordering[B]): A
[use case]
Finds the first element which yields the smallest value measured by function f.
- B
- The result type of the function f.
- f
- The measuring function.
- returns
- the first element of this stream with the smallest value measured by function f.
- Definition Classes
- TraversableOnce → GenTraversableOnce
(defined at scala.collection.TraversableOnce)
def reduceLeftOption[B >: A](op: (B, A) ⇒ B): Option[B]
Optionally applies a binary operator to all elements of this traversable or iterator, going left to right.
Note: will not terminate for infinite-sized collections.
Note: might return different results for different runs, unless the underlying collection type is ordered or the operator is associative and commutative.
- B
- the result type of the binary operator.
- op
- the binary operator.
- returns
- an option value containing the result of
reduceLeft(op)
if this traversable or iterator is nonempty,None
otherwise.
- an option value containing the result of
- Definition Classes
- TraversableOnce → GenTraversableOnce
(defined at scala.collection.TraversableOnce)
def reduceOption[A1 >: A](op: (A1, A1) ⇒ A1): Option[A1]
Reduces the elements of this traversable or iterator, if any, using the specified associative binary operator.
The order in which operations are performed on elements is unspecified and may be nondeterministic.
- A1
- A type parameter for the binary operator, a supertype of
A
.
- A type parameter for the binary operator, a supertype of
- op
- A binary operator that must be associative.
- returns
- An option value containing result of applying reduce operator
op
between all the elements if the collection is nonempty, andNone
otherwise.
- An option value containing result of applying reduce operator
- Definition Classes
- TraversableOnce → GenTraversableOnce
(defined at scala.collection.TraversableOnce)
def reduceRightOption[B >: A](op: (A, B) ⇒ B): Option[B]
Optionally applies a binary operator to all elements of this traversable or iterator, going right to left.
Note: will not terminate for infinite-sized collections.
Note: might return different results for different runs, unless the underlying collection type is ordered or the operator is associative and commutative.
- B
- the result type of the binary operator.
- op
- the binary operator.
- returns
- an option value containing the result of
reduceRight(op)
if this traversable or iterator is nonempty,None
otherwise.
- an option value containing the result of
- Definition Classes
- TraversableOnce → GenTraversableOnce
(defined at scala.collection.TraversableOnce)
def reduce[A1 >: A](op: (A1, A1) ⇒ A1): A1
Reduces the elements of this traversable or iterator using the specified associative binary operator.
The order in which operations are performed on elements is unspecified and may be nondeterministic.
- A1
- A type parameter for the binary operator, a supertype of
A
.
- A type parameter for the binary operator, a supertype of
- op
- A binary operator that must be associative.
- returns
- The result of applying reduce operator
op
between all the elements if the traversable or iterator is nonempty.
- The result of applying reduce operator
- Definition Classes
- TraversableOnce → GenTraversableOnce
- Exceptions thrown
- UnsupportedOperationException if this traversable or iterator is empty.
(defined at scala.collection.TraversableOnce)
def reversed: scala.List[A]
- Attributes
- protected[this]
- Definition Classes
- TraversableOnce
(defined at scala.collection.TraversableOnce)
def toBuffer[B >: A]: Buffer[B]
Uses the contents of this traversable or iterator to create a new mutable buffer.
Note: will not terminate for infinite-sized collections.
- returns
- a buffer containing all elements of this traversable or iterator.
- Definition Classes
- TraversableOnce → GenTraversableOnce
(defined at scala.collection.TraversableOnce)
def toIndexedSeq: IndexedSeq[A]
Converts this traversable or iterator to an indexed sequence.
Note: will not terminate for infinite-sized collections.
- returns
- an indexed sequence containing all elements of this traversable or iterator.
- Definition Classes
- TraversableOnce → GenTraversableOnce
(defined at scala.collection.TraversableOnce)
def toList: scala.List[A]
Converts this traversable or iterator to a list.
Note: will not terminate for infinite-sized collections.
- returns
- a list containing all elements of this traversable or iterator.
- Definition Classes
- TraversableOnce → GenTraversableOnce
(defined at scala.collection.TraversableOnce)
def toMap[T, U](implicit ev: <:<[A, (T, U)]): Map[T, U]
[use case]
Converts this stream to a map. This method is unavailable unless the elements are members of Tuple2, each ((T, U)) becoming a key-value pair in the map. Duplicate keys will be overwritten by later keys: if this is an unordered collection, which key is in the resulting map is undefined.
Note: will not terminate for infinite-sized collections.
- returns
- a map of type
immutable.Map[T, U]
containing all key/value pairs of type(T, U)
of this stream.
- a map of type
- Definition Classes
- TraversableOnce → GenTraversableOnce
(defined at scala.collection.TraversableOnce)
def toSet[B >: A]: Set[B]
Converts this traversable or iterator to a set.
Note: will not terminate for infinite-sized collections.
- returns
- a set containing all elements of this traversable or iterator.
- Definition Classes
- TraversableOnce → GenTraversableOnce
(defined at scala.collection.TraversableOnce)
def toVector: scala.Vector[A]
Converts this traversable or iterator to a Vector.
Note: will not terminate for infinite-sized collections.
- returns
- a vector containing all elements of this traversable or iterator.
- Definition Classes
- TraversableOnce → GenTraversableOnce
(defined at scala.collection.TraversableOnce)
Concrete Value Members From scala.collection.generic.GenericTraversableTemplate ——————————————————————————–
def genericBuilder[B]: Builder[B, Stream[B]]
The generic builder that builds instances of Traversable at arbitrary element types.
- Definition Classes
- GenericTraversableTemplate
(defined at scala.collection.generic.GenericTraversableTemplate)
def newBuilder: Builder[A, Stream[A]]
The builder that builds instances of type Traversable[A]
- Attributes
- protected[this]
- Definition Classes
- GenericTraversableTemplate → HasNewBuilder
(defined at scala.collection.generic.GenericTraversableTemplate)
def transpose[B](implicit asTraversable: (A) ⇒ GenTraversableOnce[B]): Stream[Stream[B]]
Transposes this collection of traversable collections into a collection of collections.
The resulting collection’s type will be guided by the static type of collection. For example:
- B
- the type of the elements of each traversable collection.
- asTraversable
- an implicit conversion which asserts that the element type of this
collection is a
Traversable
.
- an implicit conversion which asserts that the element type of this
collection is a
- returns
- a two-dimensional collection of collections which has as n th row the n th column of this collection.
- Definition Classes
- GenericTraversableTemplate
- Annotations
- @migration
- Migration
- (Changed in version 2.9.0)
transpose
throws anIllegalArgumentException
if collections are not uniformly sized.
- (Changed in version 2.9.0)
- Exceptions thrown
- IllegalArgumentException if all collections in this collection are not of the same size.
(defined at scala.collection.generic.GenericTraversableTemplate)
def unzip3[A1, A2, A3](implicit asTriple: (A) ⇒ (A1, A2, A3)): (Stream[A1], Stream[A2], Stream[A3])
Converts this collection of triples into three collections of the first, second, and third element of each triple.
- A1
- the type of the first member of the element triples
- A2
- the type of the second member of the element triples
- A3
- the type of the third member of the element triples
- asTriple
- an implicit conversion which asserts that the element type of this collection is a triple.
- returns
- a triple of collections, containing the first, second, respectively third member of each element triple of this collection.
- Definition Classes
- GenericTraversableTemplate
(defined at scala.collection.generic.GenericTraversableTemplate)
def unzip[A1, A2](implicit asPair: (A) ⇒ (A1, A2)): (Stream[A1], Stream[A2])
Converts this collection of pairs into two collections of the first and second half of each pair.
- A1
- the type of the first half of the element pairs
- A2
- the type of the second half of the element pairs
- asPair
- an implicit conversion which asserts that the element type of this collection is a pair.
- returns
- a pair of collections, containing the first, respectively second half of each element pair of this collection.
- Definition Classes
- GenericTraversableTemplate
(defined at scala.collection.generic.GenericTraversableTemplate)
Concrete Value Members From scala.collection.immutable.LinearSeq
def seq: LinearSeq[A]
A version of this collection with all of the operations implemented sequentially (i.e., in a single-threaded manner).
This method returns a reference to this collection. In parallel collections, it is redefined to return a sequential implementation of this collection. In both cases, it has O(1) complexity.
- returns
- a sequential view of the collection.
- Definition Classes
- LinearSeq → LinearSeq → LinearSeqLike → Seq → Seq → GenSeq → GenSeqLike → Iterable → Iterable → GenIterable → Traversable → Traversable → GenTraversable → Parallelizable → TraversableOnce → GenTraversableOnce
(defined at scala.collection.immutable.LinearSeq)
Concrete Value Members From scala.collection.immutable.Seq
def parCombiner: Combiner[A, ParSeq[A]]
The default par
implementation uses the combiner provided by this method to
create a new parallel collection.
- returns
- a combiner for the parallel collection of type
ParRepr
- a combiner for the parallel collection of type
- Attributes
- protected[this]
- Definition Classes
- Seq → SeqLike → Iterable → TraversableLike → Parallelizable
(defined at scala.collection.immutable.Seq)
def toSeq: Seq[A]
Converts this immutable sequence to a sequence.
Note: will not terminate for infinite-sized collections.
A new collection will not be built; in particular, lazy sequences will stay lazy.
- returns
- a sequence containing all elements of this immutable sequence.
- Definition Classes
- Seq → SeqLike → GenSeqLike → TraversableOnce → GenTraversableOnce
(defined at scala.collection.immutable.Seq)
Concrete Value Members From scala.collection.immutable.Stream
abstract def tailDefined: Boolean
Is the tail of this stream defined?
- Attributes
- protected
(defined at scala.collection.immutable.Stream)
def ++[B >: A, That](that: GenTraversableOnce[B])(implicit bf: CanBuildFrom[Stream[A], B, That]): That
Create a new stream which contains all elements of this stream followed by all
elements of Traversable that
.
- B
- The element type of the returned collection. That
- That
- the class of the returned collection. Where possible,
That
is the same class as the current collection classRepr
, but this depends on the element typeB
being admissible for that class, which means that an implicit instance of typeCanBuildFrom[Repr, B, That]
is found.
- the class of the returned collection. Where possible,
- that
- The scala.collection.GenTraversableOnce the be concatenated to this
Stream
.
- The scala.collection.GenTraversableOnce the be concatenated to this
- bf
- an implicit value of class
CanBuildFrom
which determines the result classThat
from the current representation typeRepr
and the new element typeB
.
- an implicit value of class
- returns
- A new collection containing the result of concatenating
this
withthat
.
- A new collection containing the result of concatenating
- Definition Classes
- Stream → TraversableLike → GenTraversableLike
- Note
- This method doesn’t cause the
Stream
to be fully realized but it should be noted that using the++
operator from another collection type could cause infinite realization of aStream
. For example, referring to the definition offibs
in the preamble, the following would never return:List(BigInt(12)) ++ fibs
., It’s subtle why this works. We know that if the target type of the scala.collection.mutable.BuilderThat
is either aStream
, or one of its supertypes, or undefined, thenStreamBuilder
will be chosen for the implicit. We recognize that fact and optimize to get more laziness.
- This method doesn’t cause the
(defined at scala.collection.immutable.Stream)
def +:[B >: A, That](elem: B)(implicit bf: CanBuildFrom[Stream[A], B, That]): That
[use case]
A copy of the stream with an element prepended.
Note that :-ending operators are right associative (see example). A mnemonic for
+:
vs. :+
is: the COLon goes on the COLlection side.
Also, the original stream is not modified, so you will want to capture the result.
Example:
- elem
- the prepended element
- returns
- a new stream consisting of
elem
followed by all elements of this stream.
- a new stream consisting of
- Definition Classes
- Stream → SeqLike → GenSeqLike
(defined at scala.collection.immutable.Stream)
def addString(b: mutable.StringBuilder, start: String, sep: String, end: String): mutable.StringBuilder
Write all defined elements of this iterable into given string builder. The
written text begins with the string start
and is finished by the string end
.
Inside, the string representations of defined elements (w.r.t. the method
toString()
) are separated by the string sep
. The method will not force
evaluation of undefined elements. A tail of such elements will be represented by
a "?"
instead. A cyclic stream is represented by a "..."
at the point where
the cycle repeats.
- b
- The collection.mutable.StringBuilder factory to which we need to add the string elements.
- start
- The prefix of the resulting string (e.g. “Stream(“)
- sep
- The separator between elements of the resulting string (e.g. “,”)
- end
- The end of the resulting string (e.g. “)”)
- returns
- The original collection.mutable.StringBuilder containing the resulting string.
- Definition Classes
- Stream → TraversableOnce
(defined at scala.collection.immutable.Stream)
def append[B >: A](rest: ⇒ TraversableOnce[B]): Stream[B]
The stream resulting from the concatenation of this stream with the argument stream.
- rest
- The stream that gets appended to this stream
- returns
- The stream containing elements of this stream and the traversable object.
(defined at scala.collection.immutable.Stream)
final def collect[B, That](pf: PartialFunction[A, B])(implicit bf: CanBuildFrom[Stream[A], B, That]): That
[use case]
Builds a new collection by applying a partial function to all elements of this stream on which the function is defined.
- B
- the element type of the returned collection.
- pf
- the partial function which filters and maps the stream.
- returns
- a new stream resulting from applying the given partial function
pf
to each element on which it is defined and collecting the results. The order of the elements is preserved.
- a new stream resulting from applying the given partial function
- Definition Classes
- Stream → TraversableLike → GenTraversableLike
(defined at scala.collection.immutable.Stream)
def companion: GenericCompanion[Stream]
The factory companion object that builds instances of class Stream
. (or its
Iterable
superclass where class Stream
is not a Seq
.)
- Definition Classes
- Stream → LinearSeq → LinearSeq → Seq → Iterable → Traversable → Seq → GenSeq → Iterable → GenIterable → Traversable → GenTraversable → GenericTraversableTemplate
(defined at scala.collection.immutable.Stream)
def distinct: Stream[A]
Builds a new stream from this stream in which any duplicates (as determined by
==
) have been removed. Among duplicate elements, only the first one is
retained in the resulting Stream
.
- returns
- A new
Stream
representing the result of applying distinctness to the originalStream
.
- A new
- Definition Classes
- Stream → SeqLike → GenSeqLike
Example:
(defined at scala.collection.immutable.Stream)
final def drop(n: Int): Stream[A]
Selects all elements except first n ones.
- n
- the number of elements to drop from this stream.
- returns
- a stream consisting of all elements of this stream except the first
n
ones, or else the empty stream, if this stream has less thann
elements.
- a stream consisting of all elements of this stream except the first
- Definition Classes
- Stream → LinearSeqOptimized → IterableLike → TraversableLike → GenTraversableLike
- Annotations
- @ tailrec ()
(defined at scala.collection.immutable.Stream)
def dropRight(n: Int): Stream[A]
Selects all elements except last n ones.
Note: lazily evaluated; will terminate for infinite-sized collections.
- n
- The number of elements to take
- returns
- a stream consisting of all elements of this stream except the last
n
ones, or else the empty stream, if this stream has less thann
elements.
- a stream consisting of all elements of this stream except the last
- Definition Classes
- Stream → LinearSeqOptimized → IterableLike
(defined at scala.collection.immutable.Stream)
def dropWhile(p: (A) ⇒ Boolean): Stream[A]
Returns the a Stream
representing the longest suffix of this iterable whose
first element does not satisfy the predicate p
.
- p
- the test predicate.
- returns
- A new
Stream
representing the results of applyingp
to the originalStream
.
- A new
- Definition Classes
- Stream → TraversableLike → GenTraversableLike
- Note
- This method realizes the entire
Stream
beyond the truth value of the predicatep
.
- This method realizes the entire
Example:
(defined at scala.collection.immutable.Stream)
final def flatMap[B, That](f: (A) ⇒ GenTraversableOnce[B])(implicit bf: CanBuildFrom[Stream[A], B, That]): That
Applies the given function f
to each element of this stream, then concatenates
the results. As with map
this function does not need to realize the entire
Stream
but continues to keep it as a lazy Stream
.
- B
- The element type of the returned collection That .
- That
- the class of the returned collection. Where possible,
That
is the same class as the current collection classRepr
, but this depends on the element typeB
being admissible for that class, which means that an implicit instance of typeCanBuildFrom[Repr, B, That]
is found.
- the class of the returned collection. Where possible,
- f
- the function to apply on each element.
- bf
- an implicit value of class
CanBuildFrom
which determines the result classThat
from the current representation typeRepr
and the new element typeB
.
- an implicit value of class
- returns
f(a0) ::: ... ::: f(an)
if this stream is[a0, ..., an]
.
- Definition Classes
- Stream → TraversableLike → GenTraversableLike → FilterMonadic
Example:
(defined at scala.collection.immutable.Stream)
def flatten[B](implicit asTraversable: (A) ⇒ GenTraversableOnce[B]): Stream[B]
Evaluates and concatenates all elements within the Stream
into a new flattened
Stream
.
- B
- The type of the elements of the resulting
Stream
.
- The type of the elements of the resulting
- asTraversable
- an implicit conversion which asserts that the element type of this stream is
a
GenTraversable
.
- an implicit conversion which asserts that the element type of this stream is
a
- returns
- A new
Stream
of typeB
of the flattened elements ofthis
Stream
.
- A new
- Definition Classes
- Stream → GenericTraversableTemplate
Example:
(defined at scala.collection.immutable.Stream)
final def foldLeft[B](z: B)(op: (B, A) ⇒ B): B
Stream specialization of foldLeft which allows GC to collect along the way.
- B
- The type of value being accumulated.
- z
- The initial value seeded into the function
op
.
- The initial value seeded into the function
- op
- The operation to perform on successive elements of the
Stream
.
- The operation to perform on successive elements of the
- returns
- The accumulated value from successive applications of
op
.
- The accumulated value from successive applications of
- Definition Classes
- Stream → LinearSeqOptimized → TraversableOnce → GenTraversableOnce
- Annotations
- @ tailrec ()
(defined at scala.collection.immutable.Stream)
def force: Stream[A]
Forces evaluation of the whole stream and returns it.
- returns
- The fully realized
Stream
.
- The fully realized
- Note
- Often we use
Stream
s to represent an infinite set or series. If that’s the case for your particularStream
then this function will never return and will probably crash the VM with anOutOfMemory
exception. This function will not hang on a finite cycle, however.
- Often we use
(defined at scala.collection.immutable.Stream)
final def foreach[U](f: (A) ⇒ U): Unit
Apply the given function f
to each element of this linear sequence (while
respecting the order of the elements).
- U
- the type parameter describing the result of function
f
. This result will always be ignored. TypicallyU
isUnit
, but this is not necessary.
- the type parameter describing the result of function
- f
- The treatment to apply to each element.
- Definition Classes
- Stream → LinearSeqOptimized → IterableLike → GenericTraversableTemplate → TraversableLike → GenTraversableLike → TraversableOnce → GenTraversableOnce → FilterMonadic
- Annotations
- @ tailrec ()
- Note
- This function will force the realization of the entire stream unless the
f
throws an exception., Overridden here as final to trigger tail-call optimization, which replaces ‘this’ with ‘tail’ at each iteration. This is absolutely necessary for allowing the GC to collect the underlying stream as elements are consumed.
- This function will force the realization of the entire stream unless the
(defined at scala.collection.immutable.Stream)
def init: Stream[A]
The stream without its last element.
- returns
- A new
Stream
containing everything but the last element. If yourStream
represents an infinite series, this method will not return.
- A new
- Definition Classes
- Stream → TraversableLike → GenTraversableLike
- Exceptions thrown
- UnsupportedOperationException if the stream is empty.
(defined at scala.collection.immutable.Stream)
final def map[B, That](f: (A) ⇒ B)(implicit bf: CanBuildFrom[Stream[A], B, That]): That
Returns the stream resulting from applying the given function f
to each
element of this stream. This returns a lazy Stream
such that it does not need
to be fully realized.
- B
- The element type of the returned collection That .
- That
- the class of the returned collection. Where possible,
That
is the same class as the current collection classRepr
, but this depends on the element typeB
being admissible for that class, which means that an implicit instance of typeCanBuildFrom[Repr, B, That]
is found.
- the class of the returned collection. Where possible,
- f
- function to apply to each element.
- bf
- an implicit value of class
CanBuildFrom
which determines the result classThat
from the current representation typeRepr
and the new element typeB
.
- an implicit value of class
- returns
f(a0), ..., f(an)
if this sequence isa0, ..., an
.
- Definition Classes
- Stream → TraversableLike → GenTraversableLike → FilterMonadic
Example:
(defined at scala.collection.immutable.Stream)
def mkString(sep: String): String
Displays all elements of this stream in a string using a separator string.
- sep
- the separator string.
- returns
- a string representation of this stream. In the resulting string the string
representations (w.r.t. the method
toString
) of all elements of this stream are separated by the stringsep
.
- a string representation of this stream. In the resulting string the string
representations (w.r.t. the method
- Definition Classes
- Stream → TraversableOnce → GenTraversableOnce
Example:
(defined at scala.collection.immutable.Stream)
def mkString(start: String, sep: String, end: String): String
Displays all elements of this stream in a string using start, end, and separator strings.
- start
- the starting string.
- sep
- the separator string.
- end
- the ending string.
- returns
- a string representation of this stream. The resulting string begins with the
string
start
and ends with the stringend
. Inside, the string representations (w.r.t. the methodtoString
) of all elements of this stream are separated by the stringsep
.
- a string representation of this stream. The resulting string begins with the
string
- Definition Classes
- Stream → TraversableOnce → GenTraversableOnce
Example:
(defined at scala.collection.immutable.Stream)
def padTo[B >: A, That](len: Int, elem: B)(implicit bf: CanBuildFrom[Stream[A], B, That]): That
Returns a new sequence of given length containing the elements of this sequence followed by zero or more occurrences of given elements.
- B
- The type of the value to pad with.
- That
- The type contained within the resulting
Stream
.
- The type contained within the resulting
- len
- The number of elements to pad into the
Stream
.
- The number of elements to pad into the
- elem
- The value of the type
B
to use for padding.
- The value of the type
- bf
- an implicit value of class
CanBuildFrom
which determines the result classThat
from the current representation typeRepr
and the new element typeB
.
- an implicit value of class
- returns
- A new
Stream
representing the collection with values padding off to the end. If yourStream
represents an infinite series, this method will not return.
- A new
- Definition Classes
- Stream → SeqLike → GenSeqLike
Example:
(defined at scala.collection.immutable.Stream)
def partition(p: (A) ⇒ Boolean): (Stream[A], Stream[A])
Returns all the elements of this stream that satisfy the predicate p
returning
of scala.Tuple2 of Stream
s obeying the partition predicate p
. The order of
the elements is preserved.
- p
- the predicate used to filter the stream.
- returns
- the elements of this stream satisfying
p
.
- the elements of this stream satisfying
- Definition Classes
- Stream → TraversableLike → GenTraversableLike
Example:
(defined at scala.collection.immutable.Stream)
def print(sep: String): Unit
Prints elements of this stream one by one, separated by sep
.
- sep
- The separator string printed between consecutive elements.
(defined at scala.collection.immutable.Stream)
final def reduceLeft[B >: A](f: (B, A) ⇒ B): B
Stream specialization of reduceLeft which allows GC to collect along the way.
- B
- The type of value being accumulated.
- f
- The operation to perform on successive elements of the
Stream
.
- The operation to perform on successive elements of the
- returns
- The accumulated value from successive applications of
f
.
- The accumulated value from successive applications of
- Definition Classes
- Stream → LinearSeqOptimized → TraversableOnce
(defined at scala.collection.immutable.Stream)
def reverse: Stream[A]
A list consisting of all elements of this list in reverse order.
- returns
- A new
Stream
containing the representing of the originalStream
in reverse order.
- A new
- Definition Classes
- Stream → SeqLike → GenSeqLike
- Note
- This function must realize the entire
Stream
in order to perform this operation so if yourStream
represents an infinite sequence then this function will never return.
- This function must realize the entire
Example:
(defined at scala.collection.immutable.Stream)
final def scanLeft[B, That](z: B)(op: (B, A) ⇒ B)(implicit bf: CanBuildFrom[Stream[A], B, That]): That
Create a new stream which contains all intermediate results of applying the
operator to subsequent elements left to right. scanLeft
is analogous to
foldLeft
.
- B
- the type of the elements in the resulting collection
- That
- the actual type of the resulting collection
- z
- The initial value for the scan.
- op
- A function that will apply operations to successive values in the
Stream
against previous accumulated results.
- A function that will apply operations to successive values in the
- bf
- an implicit value of class
CanBuildFrom
which determines the result classThat
from the current representation typeRepr
and the new element typeB
.
- an implicit value of class
- returns
- A new collection containing the modifications from the application of
op
.
- A new collection containing the modifications from the application of
- Definition Classes
- Stream → TraversableLike → GenTraversableLike
- Note
- This works because the target type of the scala.collection.mutable.Builder
That
is aStream
.
- This works because the target type of the scala.collection.mutable.Builder
(defined at scala.collection.immutable.Stream)
def slice(from: Int, until: Int): Stream[A]
A substream starting at index from
and extending up to (but not including)
index until
. This returns a Stream
that is lazily evaluated.
- from
- The index of the first element of the returned subsequence
- until
- The index of the element following the returned subsequence
- returns
- A new string containing the elements requested from
start
untilend
.
- A new string containing the elements requested from
- Definition Classes
- Stream → LinearSeqOptimized → IterableLike → TraversableLike → GenTraversableLike
Example:
(defined at scala.collection.immutable.Stream)
def splitAt(n: Int): (Stream[A], Stream[A])
Splits this stream into two at a given position. Note: c splitAt n
is
equivalent to (but possibly more efficient than) (c take n, c drop n)
.
- n
- the position at which to split.
- returns
- a pair of streams consisting of the first
n
elements of this stream, and the other elements.
- a pair of streams consisting of the first
- Definition Classes
- Stream → TraversableLike → GenTraversableLike
(defined at scala.collection.immutable.Stream)
def take(n: Int): Stream[A]
Returns the n
first elements of this Stream
as another Stream
, or else
the whole Stream
, if it has less than n
elements.
The result of take
is, again, a Stream
meaning that it also does not make
any needless evaluations of the Stream
itself, delaying that until the usage
of the resulting Stream
.
- n
- the number of elements to take.
- returns
- the
n
first elements of this stream.
- the
- Definition Classes
- Stream → LinearSeqOptimized → IterableLike → TraversableLike → GenTraversableLike
Example:
(defined at scala.collection.immutable.Stream)
def takeRight(n: Int): Stream[A]
Returns the rightmost n
elements from this iterable.
- n
- the number of elements to take
- returns
- The last
n
elements from thisStream
.
- The last
- Definition Classes
- Stream → IterableLike
- Note
- Take serious caution here. If the
Stream
represents an infinite series then this function will not return . The right most elements of an infinite series takes an infinite amount of time to produce.
- Take serious caution here. If the
(defined at scala.collection.immutable.Stream)
def takeWhile(p: (A) ⇒ Boolean): Stream[A]
Returns the longest prefix of this Stream
whose elements satisfy the predicate
p
.
- p
- the test predicate.
- returns
- A new
Stream
representing the values that satisfy the predicatep
.
- A new
- Definition Classes
- Stream → LinearSeqOptimized → IterableLike → TraversableLike → GenTraversableLike
Example:
(defined at scala.collection.immutable.Stream)
def toStream: Stream[A]
Converts this stream to a stream.
- returns
- a stream containing all elements of this stream.
- Definition Classes
- Stream → IterableLike → TraversableLike → GenTraversableOnce
(defined at scala.collection.immutable.Stream)
def view: StreamView[A, Stream[A]]
Creates a non-strict view of this stream.
- returns
- a non-strict view of this stream.
- Definition Classes
- Stream → SeqLike → IterableLike → TraversableLike
(defined at scala.collection.immutable.Stream)
final def withFilter(p: (A) ⇒ Boolean): FilterMonadic[A, Stream[A]]
A FilterMonadic which allows GC of the head of stream during processing
- p
- the predicate used to test elements.
- returns
- an object of class
WithFilter
, which supportsmap
,flatMap
,foreach
, andwithFilter
operations. All these operations apply to those elements of this stream which satisfy the predicatep
.
- an object of class
- Definition Classes
- Stream → TraversableLike → FilterMonadic
- Annotations
- @ noinline ()
(defined at scala.collection.immutable.Stream)
def zipWithIndex[A1 >: A, That](implicit bf: CanBuildFrom[Stream[A], (A1, Int), That]): That
Zips this iterable with its indices. s.zipWithIndex
is equivalent to
s zip s.indices
.
This method is much like zip
in that it returns a single lazy Stream
of
scala.Tuple2.
- A1
- The type of the first element of the scala.Tuple2 in the resulting stream.
- That
- The type of the resulting
Stream
.
- The type of the resulting
- bf
- an implicit value of class
CanBuildFrom
which determines the result classThat
from the current representation typeRepr
and the new element type(A1, Int)
.
- an implicit value of class
- returns
Stream({a0,0}, ..., {an,n)}
- Definition Classes
- Stream → IterableLike → GenIterableLike
Example:
(defined at scala.collection.immutable.Stream)
final def zip[A1 >: A, B, That](that: GenIterable[B])(implicit bf: CanBuildFrom[Stream[A], (A1, B), That]): That
Returns a stream formed from this stream and the specified stream that
by
associating each element of the former with the element at the same position in
the latter.
If one of the two streams is longer than the other, its remaining elements are ignored.
The return type of this function may not be obvious. The lazy aspect of the
returned value is different than that of partition
. In partition
we get
back a scala.Tuple2 of two lazy Stream
s whereas here we get back a single
lazy Stream
of scala.Tuple2 s where the scala.Tuple2 ‘s type signature is
(A1, B)
.
- A1
- The type of the first parameter of the zipped tuple
- B
- The type of the second parameter of the zipped tuple
- That
- The type of the returned
Stream
.
- The type of the returned
- that
- The iterable providing the second half of each result pair
- bf
- an implicit value of class
CanBuildFrom
which determines the result classThat
from the current representation typeRepr
and the new element type(A1, B)
.
- an implicit value of class
- returns
Stream({a0,b0}, ..., {amin(m,n),bmin(m,n))}
whenStream(a0, ..., am) zip Stream(b0, ..., bn)
is invoked.
- Definition Classes
- Stream → IterableLike → GenIterableLike
Example:
(defined at scala.collection.immutable.Stream)
Instance Constructors From scala.collection.immutable.Stream
new Stream()
(defined at scala.collection.immutable.Stream)
Concrete Value Members From Implicit scala.collection.immutable.Stream.consWrapper# ——————————————————————————–
def #::(hd: A): Stream[A]
Construct a stream consisting of a given first element followed by elements from a lazily evaluated Stream.
- Implicit information
- This member is added by an implicit conversion from Stream [A] to ConsWrapper [A] performed by method consWrapper in scala.collection.immutable.Stream.
- Definition Classes
- ConsWrapper
(added by implicit convertion: scala.collection.immutable.Stream.consWrapper#)
def #:::(prefix: Stream[A]): Stream[A]
Construct a stream consisting of the concatenation of the given stream and a lazily evaluated Stream.
- Implicit information
- This member is added by an implicit conversion from Stream [A] to ConsWrapper [A] performed by method consWrapper in scala.collection.immutable.Stream.
- Definition Classes
- ConsWrapper
(added by implicit convertion: scala.collection.immutable.Stream.consWrapper#)
Concrete Value Members From Implicit scala.collection.parallel.CollectionsHaveToParArray ——————————————————————————–
def toParArray: ParArray[T]
- Implicit information
- This member is added by an implicit conversion from Stream [A] to CollectionsHaveToParArray [Stream [A], T] performed by method CollectionsHaveToParArray in scala.collection.parallel. This conversion will take place only if an implicit value of type (Stream [A]) ⇒ GenTraversableOnce [T] is in scope.
- Definition Classes
- CollectionsHaveToParArray (added by implicit convertion: scala.collection.parallel.CollectionsHaveToParArray)
Full Source:
Interested in Scala?
I send out weekly, personalized emails with articles and conference talks.
Subscribe now.