Class scala.collection.parallel.ParSeqLike.Elements
abstract class Elements extends SeqSplitter[T] with scala.BufferedIterator[T]
Type Members
class GroupedIterator[B >: A] extends AbstractIterator[Seq[B]] with Iterator[Seq[B]]
A flexible iterator for transforming an Iterator[A]
into an Iterator[Seq[A]], with configurable sequence size, step, and strategy for dealing with elements which don't fit evenly.
Typical uses can be achieved via methods grouped
and sliding
.
- Definition Classes
- Iterator
class Appended[U >: T, PI <: SeqSplitter[U]] extends SeqSplitter.Appended[U, PI] with SeqSplitter[U]
- Definition Classes
- SeqSplitter
class Mapped[S] extends SeqSplitter.Mapped[S] with SeqSplitter[S]
- Definition Classes
- SeqSplitter
class Patched[U >: T] extends SeqSplitter[U]
- Definition Classes
- SeqSplitter
class Taken extends SeqSplitter.Taken with SeqSplitter[T]
- Definition Classes
- SeqSplitter
class Zipped[S] extends SeqSplitter.Zipped[S] with SeqSplitter[(T, S)]
- Definition Classes
- SeqSplitter
class ZippedAll[U >: T, S] extends SeqSplitter.ZippedAll[U, S] with SeqSplitter[(U, S)]
- Definition Classes
- SeqSplitter
Value Members
final def !=(arg0: Any): Boolean
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
. 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
def +(other: String): String
- Implicit
- This member is added by an implicit conversion from Elements to any2stringadd[Elements] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
def ++(that: ⇒ Iterator[T]): Iterator[T]
Concatenates this iterator with another.
- that
the other iterator
- returns
a new iterator that first yields the values produced by this iterator followed by the values produced by iterator
that
.
- Definition Classes
- Iterator
def ->[B](y: B): (Elements, B)
- Implicit
- This member is added by an implicit conversion from Elements to ArrowAssoc[Elements] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
def /:[B](z: B)(op: (B, T) ⇒ 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.
scala> val a = List(1,2,3,4) a: List[Int] = List(1, 2, 3, 4) scala> val b = (5 /: a)(_+_) b: Int = 15 scala> val c = (5 /: a)((x,y) => x + y) c: Int = 15
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:op(...op(op(z, x_1), x_2), ..., x_n)
where
x1, ..., xn
are the elements of this traversable or iterator.
- Definition Classes
- TraversableOnce → GenTraversableOnce
def :\[B](z: B)(op: (T, 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.
scala> val a = List(1,2,3,4) a: List[Int] = List(1, 2, 3, 4) scala> val b = (a :\ 5)(_+_) b: Int = 15 scala> val c = (a :\ 5)((x,y) => x + y) c: Int = 15
- 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:op(x_1, op(x_2, ... op(x_n, z)...))
where
x1, ..., xn
are the elements of this traversable or iterator.
- Definition Classes
- TraversableOnce → GenTraversableOnce
final def ==(arg0: Any): Boolean
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 abort(): Unit
Sends an abort signal to other workers.
Abort flag being true means that a worker can abort and produce whatever result, since its result will not affect the final result of computation. An example of operations using this are find
, forall
and exists
methods.
- Definition Classes
- DelegatedSignalling → Signalling
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:
scala> val a = List(1,2,3,4) a: List[Int] = List(1, 2, 3, 4) scala> val b = new StringBuilder() b: StringBuilder = scala> val h = a.addString(b) h: StringBuilder = 1234
- b
the string builder to which elements are appended.
- returns
the string builder
b
to which elements were appended.
- Definition Classes
- 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:
scala> val a = List(1,2,3,4) a: List[Int] = List(1, 2, 3, 4) scala> val b = new StringBuilder() b: StringBuilder = scala> a.addString(b, ", ") res0: StringBuilder = 1, 2, 3, 4
- b
the string builder to which elements are appended.
- sep
the separator string.
- returns
the string builder
b
to which elements were appended.
- Definition Classes
- TraversableOnce
def addString(b: StringBuilder, start: String, sep: String, end: String): StringBuilder
Appends all elements of this traversable or iterator to a string builder using start, end, and separator strings. The written text begins with the string start
and ends with the string end
. Inside, the string representations (w.r.t. the method toString
) of all elements of this traversable or iterator are separated by the string sep
.
Example:
scala> val a = List(1,2,3,4) a: List[Int] = List(1, 2, 3, 4) scala> val b = new StringBuilder() b: StringBuilder = scala> a.addString(b , "List(" , ", " , ")") res5: StringBuilder = List(1, 2, 3, 4)
- b
the string builder to which elements are appended.
- start
the starting string.
- sep
the separator string.
- end
the ending string.
- returns
the string builder
b
to which elements were appended.
- Definition Classes
- TraversableOnce
def aggregate[B](z: ⇒ B)(seqop: (B, T) ⇒ 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:
List('a', 'b', 'c').aggregate(0)({ (sum, ch) => sum + ch.toInt }, { (p1, p2) => p1 + p2 })
- 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- 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
def appendParIterable[U >: T, PI <: IterableSplitter[U]](that: PI): Elements.Appended[U, PI]
- Definition Classes
- IterableSplitter
def appendParSeq[U >: T, PI <: SeqSplitter[U]](that: PI): Appended[U, PI]
- Definition Classes
- SeqSplitter
final def asInstanceOf[T0]: T0
Cast the receiver object to be of type T0
.
Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression 1.asInstanceOf[String]
will throw a ClassCastException
at runtime, while the expression List(1).asInstanceOf[List[String]]
will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested type.
- returns
the receiver object.
- Definition Classes
- Any
- Exceptions thrown
ClassCastException
if the receiver object is not an instance of the erasure of typeT0
.
def buffered: Elements.this.type
Creates a buffered iterator from this iterator.
- returns
a buffered iterator producing the same values as this iterator.
- Definition Classes
- BufferedIterator → Iterator
- Note
Reuse: After calling this method, one should discard the iterator it was called on, and use only the iterator that was returned. Using the old iterator is undefined, subject to change, and may result in changes to the new iterator as well.
- See also
def buildString(closure: ((String) ⇒ Unit) ⇒ Unit): String
- Attributes
- protected
- Definition Classes
- IterableSplitter
def clone(): AnyRef
Create a copy of the receiver object.
The default implementation of the clone
method is platform dependent.
- returns
a copy of the receiver object.
def collect[B](pf: PartialFunction[T, B]): Iterator[B]
Creates an iterator by transforming values produced by this iterator with a partial function, dropping those values for which the partial function is not defined.
- pf
the partial function which filters and maps the iterator.
- returns
a new iterator which yields each value
x
produced by this iterator for whichpf
is defined the imagepf(x)
.
- Definition Classes
- Iterator
- Annotations
- @migration
- Migration
(Changed in version 2.8.0)
collect
has changed. The previous behavior can be reproduced withtoSeq
.- Note
Reuse: After calling this method, one should discard the iterator it was called on, and use only the iterator that was returned. Using the old iterator is undefined, subject to change, and may result in changes to the new iterator as well.
def collect2combiner[S, That](pf: PartialFunction[T, S], cb: Combiner[S, That]): Combiner[S, That]
- Definition Classes
- AugmentedIterableIterator
def collectFirst[B](pf: PartialFunction[T, 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.
- Definition Classes
- TraversableOnce
Seq("a", 1, 5L).collectFirst({ case x: Int => x*10 }) = Some(10)
def contains(elem: Any): Boolean
Tests whether this iterator contains a given value as an element.
Note: may not terminate for infinite iterators.
- elem
the element to test.
- returns
true
if this iterator produces some value that is is equal (as determined by==
) toelem
,false
otherwise.
- Definition Classes
- Iterator
- Note
Reuse: After calling this method, one should discard the iterator it was called on. Using it is undefined and subject to change.
def copy2builder[U >: T, Coll, Bld <: Builder[U, Coll]](b: Bld): Bld
- Definition Classes
- AugmentedIterableIterator
def copyToArray(xs: Array[A], start: Int, len: Int): Unit
Copies selected values produced by this iterator to an array. Fills the given array xs
starting at index start
with at most len
values produced by this iterator. Copying will stop once either the end of the current iterator is reached, or the end of the array is reached, or len
elements have been copied.
Note: will not terminate for infinite iterators.
- xs
the array to fill.
- start
the starting index.
- len
the maximal number of elements to copy.
- Definition Classes
- AugmentedIterableIterator → Iterator → TraversableOnce → GenTraversableOnce
def copyToArray(xs: Array[A]): Unit
Copies the elements of this traversable or iterator to an array. Fills the given array xs
with values of this traversable or iterator. Copying will stop once either the end of the current traversable or iterator is reached, or the end of the target array is reached.
Note: will not terminate for infinite iterators.
- xs
the array to fill.
- Definition Classes
- TraversableOnce → GenTraversableOnce
def copyToArray(xs: Array[A], start: Int): Unit
Copies the elements of this traversable or iterator to an array. Fills the given array xs
with values of this traversable or iterator, beginning at index start
. Copying will stop once either the end of the current traversable or iterator is reached, or the end of the target array is reached.
Note: will not terminate for infinite iterators.
- xs
the array to fill.
- start
the starting index.
- Definition Classes
- TraversableOnce → GenTraversableOnce
def copyToBuffer[B >: T](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
def corresponds[S](corr: (T, S) ⇒ Boolean)(that: scala.Iterator[S]): Boolean
- Definition Classes
- AugmentedSeqIterator
def corresponds[B](that: GenTraversableOnce[B])(p: (T, B) ⇒ Boolean): Boolean
Tests whether every element of this iterator relates to the corresponding element of another collection by satisfying a test predicate.
- B
the type of the elements of
that
- that
the other collection
- p
the test predicate, which relates elements from both collections
- returns
true
if both collections have the same length andp(x, y)
istrue
for all corresponding elementsx
of this iterator andy
ofthat
, otherwisefalse
- Definition Classes
- Iterator
def count(p: (T) ⇒ 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
.
- Definition Classes
- AugmentedIterableIterator → TraversableOnce → GenTraversableOnce
def drop(n: Int): IterableSplitter[T]
Drop implemented as simple eager consumption.
- n
the number of elements to drop
- returns
an iterator which produces all values of the current iterator, except it omits the first
n
values.
- Definition Classes
- IterableSplitter → Iterator
def drop2combiner[U >: T, This](n: Int, cb: Combiner[U, This]): Combiner[U, This]
- Definition Classes
- AugmentedIterableIterator
def dropWhile(p: (T) ⇒ Boolean): Iterator[T]
Skips longest sequence of elements of this iterator which satisfy given predicate p
, and returns an iterator of the remaining elements.
- p
the predicate used to skip elements.
- returns
an iterator consisting of the remaining elements
- Definition Classes
- Iterator
- Note
Reuse: After calling this method, one should discard the iterator it was called on, and use only the iterator that was returned. Using the old iterator is undefined, subject to change, and may result in changes to the new iterator as well.
def dup: Elements
Creates a copy of this iterator.
- Definition Classes
- Elements → SeqSplitter → IterableSplitter
def duplicate: (Iterator[T], Iterator[T])
Creates two new iterators that both iterate over the same elements as this iterator (in the same order). The duplicate iterators are considered equal if they are positioned at the same element.
Given that most methods on iterators will make the original iterator unfit for further use, this methods provides a reliable way of calling multiple such methods on an iterator.
- returns
a pair of iterators
- Definition Classes
- Iterator
- Note
-
The implementation may allocate temporary storage for elements iterated by one iterator but not yet by the other.
,Reuse: After calling this method, one should discard the iterator it was called on, and use only the iterators that were returned. Using the old iterator is undefined, subject to change, and may result in changes to the new iterators as well.
val end: Int
def ensuring(cond: (Elements) ⇒ Boolean, msg: ⇒ Any): Elements
- Implicit
- This member is added by an implicit conversion from Elements to Ensuring[Elements] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
def ensuring(cond: (Elements) ⇒ Boolean): Elements
- Implicit
- This member is added by an implicit conversion from Elements to Ensuring[Elements] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
def ensuring(cond: Boolean, msg: ⇒ Any): Elements
- Implicit
- This member is added by an implicit conversion from Elements to Ensuring[Elements] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
def ensuring(cond: Boolean): Elements
- Implicit
- This member is added by an implicit conversion from Elements to Ensuring[Elements] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
final def eq(arg0: AnyRef): Boolean
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: Any): Boolean
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 exists(p: (T) ⇒ Boolean): Boolean
Tests whether a predicate holds for some of the values produced by this iterator.
Note: may not terminate for infinite iterators.
- p
the predicate used to test elements.
- returns
true
if the given predicatep
holds for some of the values produced by this iterator, otherwisefalse
.
- Definition Classes
- Iterator → TraversableOnce → GenTraversableOnce
- Note
Reuse: After calling this method, one should discard the iterator it was called on. Using it is undefined and subject to change.
def filter(p: (T) ⇒ Boolean): Iterator[T]
Returns an iterator over all the elements of this iterator that satisfy the predicate p
. The order of the elements is preserved.
- p
the predicate used to test values.
- returns
an iterator which produces those values of this iterator which satisfy the predicate
p
.
- Definition Classes
- Iterator
- Note
Reuse: After calling this method, one should discard the iterator it was called on, and use only the iterator that was returned. Using the old iterator is undefined, subject to change, and may result in changes to the new iterator as well.
def filter2combiner[U >: T, This](pred: (T) ⇒ Boolean, cb: Combiner[U, This]): Combiner[U, This]
- Definition Classes
- AugmentedIterableIterator
def filterNot(p: (T) ⇒ Boolean): Iterator[T]
Creates an iterator over all the elements of this iterator which do not satisfy a predicate p.
- p
the predicate used to test values.
- returns
an iterator which produces those values of this iterator which do not satisfy the predicate
p
.
- Definition Classes
- Iterator
- Note
Reuse: After calling this method, one should discard the iterator it was called on, and use only the iterator that was returned. Using the old iterator is undefined, subject to change, and may result in changes to the new iterator as well.
def filterNot2combiner[U >: T, This](pred: (T) ⇒ Boolean, cb: Combiner[U, This]): Combiner[U, This]
- Definition Classes
- AugmentedIterableIterator
def finalize(): Unit
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 find(p: (T) ⇒ Boolean): Option[T]
Finds the first value produced by the iterator satisfying a predicate, if any.
Note: may not terminate for infinite iterators.
- p
the predicate used to test values.
- returns
an option value containing the first value produced by the iterator that satisfies predicate
p
, orNone
if none exists.
- Definition Classes
- Iterator → TraversableOnce → GenTraversableOnce
- Note
Reuse: After calling this method, one should discard the iterator it was called on. Using it is undefined and subject to change.
def flatMap[B](f: (T) ⇒ GenTraversableOnce[B]): Iterator[B]
Creates a new iterator by applying a function to all values produced by this iterator and concatenating the results.
- f
the function to apply on each element.
- returns
the iterator resulting from applying the given iterator-valued function
f
to each value produced by this iterator and concatenating the results.
- Definition Classes
- Iterator
- Note
Reuse: After calling this method, one should discard the iterator it was called on, and use only the iterator that was returned. Using the old iterator is undefined, subject to change, and may result in changes to the new iterator as well.
def flatmap2combiner[S, That](f: (T) ⇒ GenTraversableOnce[S], cb: Combiner[S, That]): Combiner[S, That]
- Definition Classes
- AugmentedIterableIterator
def fold[U >: T](z: U)(op: (U, U) ⇒ U): U
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 iterators.
- 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).- 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.
- Definition Classes
- AugmentedIterableIterator → TraversableOnce → GenTraversableOnce
def foldLeft[B](z: B)(op: (B, T) ⇒ B): B
Applies a binary operator to a start value and 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.
- 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:op(...op(z, x_1), x_2, ..., x_n)
where
x1, ..., xn
are the elements of this traversable or iterator. Returnsz
if this traversable or iterator is empty.
- Definition Classes
- TraversableOnce → GenTraversableOnce
def foldRight[B](z: B)(op: (T, B) ⇒ B): B
Applies a binary operator to all elements of this traversable or iterator and a start value, 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.
- 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:op(x_1, op(x_2, ... op(x_n, z)...))
where
x1, ..., xn
are the elements of this traversable or iterator. Returnsz
if this traversable or iterator is empty.
- Definition Classes
- TraversableOnce → GenTraversableOnce
def forall(p: (T) ⇒ Boolean): Boolean
Tests whether a predicate holds for all values produced by this iterator.
Note: may not terminate for infinite iterators.
- p
the predicate used to test elements.
- returns
true
if the given predicatep
holds for all values produced by this iterator, otherwisefalse
.
- Definition Classes
- Iterator → TraversableOnce → GenTraversableOnce
- Note
Reuse: After calling this method, one should discard the iterator it was called on. Using it is undefined and subject to change.
def foreach(f: (T) ⇒ Unit): Unit
Applies a function f
to all values produced by this iterator.
- f
the function that is applied for its side-effect to every element. The result of function
f
is discarded.
- Definition Classes
- Iterator → TraversableOnce → GenTraversableOnce
def formatted(fmtstr: String): String
Returns string formatted according to given format
string. Format strings are as for String.format
(@see java.lang.String.format).
- Implicit
- This member is added by an implicit conversion from Elements to StringFormat[Elements] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @inline()
final def getClass(): Class[_]
Returns the runtime class representation of the object.
- returns
a class object corresponding to the runtime type of the receiver.
def grouped[B >: T](size: Int): GroupedIterator[B]
Returns an iterator which groups this iterator into fixed size blocks. Example usages:
// Returns List(List(1, 2, 3), List(4, 5, 6), List(7))) (1 to 7).iterator grouped 3 toList // Returns List(List(1, 2, 3), List(4, 5, 6)) (1 to 7).iterator grouped 3 withPartial false toList // Returns List(List(1, 2, 3), List(4, 5, 6), List(7, 20, 25) // Illustrating that withPadding's argument is by-name. val it2 = Iterator.iterate(20)(_ + 5) (1 to 7).iterator grouped 3 withPadding it2.next toList
- Definition Classes
- Iterator
- Note
Reuse: After calling this method, one should discard the iterator it was called on, and use only the iterator that was returned. Using the old iterator is undefined, subject to change, and may result in changes to the new iterator as well.
def hasDefiniteSize: Boolean
Tests whether this Iterator has a known size.
- returns
true
for empty Iterators,false
otherwise.
- Definition Classes
- Iterator → TraversableOnce → GenTraversableOnce
- Note
Reuse: The iterator remains valid for further use whatever result is returned.
def hasNext: Boolean
Tests whether this iterator can provide another element.
- returns
true
if a subsequent call tonext
will yield an element,false
otherwise.
def hashCode(): Int
The hashCode method for reference types. See hashCode in scala.Any.
- returns
the hash code value for this object.
def head: T
Returns next element of iterator without advancing beyond it.
- Definition Classes
- Elements → BufferedIterator
def headOption: Option[T]
Returns an option of the next element of an iterator without advancing beyond it.
- returns
the next element of this iterator if it has a next element
None
if it does not
- Definition Classes
- BufferedIterator
def indexFlag: Int
Returns the value of the index flag.
The index flag holds an integer which carries some operation-specific meaning. For instance, takeWhile
operation sets the index flag to the position of the element where the predicate fails. Other workers may check this index against the indices they are working on and return if this index is smaller than their index. Examples of operations using this are takeWhile
, dropWhile
, span
and indexOf
.
- returns
the value of the index flag
- Definition Classes
- DelegatedSignalling → Signalling
def indexOf[B >: T](elem: B, from: Int): Int
Returns the index of the first occurrence of the specified object in this iterable object after or at some start index.
Note: may not terminate for infinite iterators.
- elem
element to search for.
- from
the start index
- returns
the index
>= from
of the first occurrence ofelem
in the values produced by this iterator, or -1 if such an element does not exist until the end of the iterator is reached.
- Definition Classes
- Iterator
- Note
Reuse: After calling this method, one should discard the iterator it was called on. Using it is undefined and subject to change.
def indexOf[B >: T](elem: B): Int
Returns the index of the first occurrence of the specified object in this iterable object.
Note: may not terminate for infinite iterators.
- elem
element to search for.
- returns
the index of the first occurrence of
elem
in the values produced by this iterator, or -1 if such an element does not exist until the end of the iterator is reached.
- Definition Classes
- Iterator
- Note
Reuse: After calling this method, one should discard the iterator it was called on. Using it is undefined and subject to change.
def indexWhere(pred: (T) ⇒ Boolean): Int
Returns the index of the first produced value satisfying a predicate, or -1.
Note: may not terminate for infinite iterators.
- returns
the index of the first produced value satisfying
p
, or -1 if such an element does not exist until the end of the iterator is reached.
- Definition Classes
- AugmentedSeqIterator → Iterator
- Note
Reuse: After calling this method, one should discard the iterator it was called on. Using it is undefined and subject to change.
def indexWhere(p: (T) ⇒ Boolean, from: Int): Int
Returns the index of the first produced value satisfying a predicate, or -1, after or at some start index.
Note: may not terminate for infinite iterators.
- p
the predicate to test values
- from
the start index
- returns
the index
>= from
of the first produced value satisfyingp
, or -1 if such an element does not exist until the end of the iterator is reached.
- Definition Classes
- Iterator
- Note
Reuse: After calling this method, one should discard the iterator it was called on. Using it is undefined and subject to change.
def isAborted: Boolean
Checks whether an abort signal has been issued.
Abort flag being true means that a worker can abort and produce whatever result, since its result will not affect the final result of computation. An example of operations using this are find
, forall
and exists
methods.
- returns
the state of the abort
- Definition Classes
- DelegatedSignalling → Signalling
def isEmpty: Boolean
Tests whether this iterator is empty.
- returns
true
if hasNext is false,false
otherwise.
- Definition Classes
- Iterator → TraversableOnce → GenTraversableOnce
- Note
Reuse: The iterator remains valid for further use whatever result is returned.
final def isInstanceOf[T0]: Boolean
Test whether the dynamic type of the receiver object is T0
.
Note that the result of the test is modulo Scala's erasure semantics. Therefore the expression 1.isInstanceOf[String]
will return false
, while the expression List(1).isInstanceOf[List[String]]
will return true
. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the specified type.
- returns
true
if the receiver object is an instance of erasure of typeT0
;false
otherwise.
- Definition Classes
- Any
def isRemainingCheap: Boolean
For most collections, this is a cheap operation. Exceptions can override this method.
- Definition Classes
- RemainsIterator
def isTraversableAgain: Boolean
Tests whether this Iterator can be repeatedly traversed.
- returns
false
- Definition Classes
- Iterator → GenTraversableOnce
- Note
Reuse: The iterator remains valid for further use whatever result is returned.
def lastIndexWhere(pred: (T) ⇒ Boolean): Int
- Definition Classes
- AugmentedSeqIterator
def length: Int
Returns the number of elements in this iterator.
Note: will not terminate for infinite iterators.
- Definition Classes
- Iterator
- Note
Reuse: After calling this method, one should discard the iterator it was called on. Using it is undefined and subject to change.
def map[S](f: (T) ⇒ S): Mapped[S]
Creates a new iterator that maps all produced values of this iterator to new values using a transformation function.
- f
the transformation function
- returns
a new iterator which transforms every value produced by this iterator by applying the function
f
to it.
- Definition Classes
- SeqSplitter → IterableSplitter → Iterator
- Note
Reuse: After calling this method, one should discard the iterator it was called on, and use only the iterator that was returned. Using the old iterator is undefined, subject to change, and may result in changes to the new iterator as well.
def map2combiner[S, That](f: (T) ⇒ S, cb: Combiner[S, That]): Combiner[S, That]
- Definition Classes
- AugmentedIterableIterator
def max: A
Finds the largest element.
- returns
the largest element of this traversable or iterator.
- Definition Classes
- AugmentedIterableIterator → TraversableOnce → GenTraversableOnce
- Exceptions thrown
UnsupportedOperationException
if this traversable or iterator is empty.
def maxBy[B](f: (A) ⇒ B): A
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 traversable or iterator with the largest value measured by function f.
- Definition Classes
- TraversableOnce → GenTraversableOnce
- Exceptions thrown
UnsupportedOperationException
if this traversable or iterator is empty.
def min: A
Finds the smallest element.
- returns
the smallest element of this traversable or iterator
- Definition Classes
- AugmentedIterableIterator → TraversableOnce → GenTraversableOnce
- Exceptions thrown
UnsupportedOperationException
if this traversable or iterator is empty.
def minBy[B](f: (A) ⇒ B): A
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 traversable or iterator with the smallest value measured by function f.
- Definition Classes
- TraversableOnce → GenTraversableOnce
- Exceptions thrown
UnsupportedOperationException
if this traversable or iterator is empty.
def mkString: String
Displays all elements of this traversable or iterator in a string.
- returns
a string representation of this traversable or iterator. In the resulting string the string representations (w.r.t. the method
toString
) of all elements of this traversable or iterator follow each other without any separator string.
- Definition Classes
- TraversableOnce → GenTraversableOnce
def mkString(sep: String): String
Displays all elements of this traversable or iterator in a string using a separator string.
- sep
the separator string.
- returns
a string representation of this traversable or iterator. In the resulting string the string representations (w.r.t. the method
toString
) of all elements of this traversable or iterator are separated by the stringsep
.
- Definition Classes
- TraversableOnce → GenTraversableOnce
List(1, 2, 3).mkString("|") = "1|2|3"
def mkString(start: String, sep: String, end: String): String
Displays all elements of this traversable or iterator 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 traversable or iterator. 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 traversable or iterator are separated by the stringsep
.
- Definition Classes
- TraversableOnce → GenTraversableOnce
List(1, 2, 3).mkString("(", "; ", ")") = "(1; 2; 3)"
final def ne(arg0: AnyRef): Boolean
Equivalent to !(this eq that)
.
- returns
true
if the argument is not a reference to the receiver object;false
otherwise.
- Definition Classes
- AnyRef
def next(): T
Produces the next element of this iterator.
- returns
the next element of this iterator, if
hasNext
istrue
, undefined behavior otherwise.
def nonEmpty: Boolean
Tests whether the traversable or iterator is not empty.
- returns
true
if the traversable or iterator contains at least one element,false
otherwise.
- Definition Classes
- TraversableOnce → GenTraversableOnce
final def notify(): Unit
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.
- Definition Classes
- AnyRef
- Annotations
- @native()
- Note
not specified by SLS as a member of AnyRef
def padTo(len: Int, elem: T): Iterator[T]
Appends an element value to this iterator until a given target length is reached.
- len
the target length
- elem
the padding value
- returns
a new iterator consisting of producing all values of this iterator, followed by the minimal number of occurrences of
elem
so that the number of produced values is at leastlen
.
- Definition Classes
- Iterator
def partition(p: (T) ⇒ Boolean): (Iterator[T], Iterator[T])
Partitions this iterator in two iterators according to a predicate.
- p
the predicate on which to partition
- returns
a pair of iterators: the iterator that satisfies the predicate
p
and the iterator that does not. The relative order of the elements in the resulting iterators is the same as in the original iterator.
- Definition Classes
- Iterator
- Note
Reuse: After calling this method, one should discard the iterator it was called on, and use only the iterators that were returned. Using the old iterator is undefined, subject to change, and may result in changes to the new iterators as well.
def partition2combiners[U >: T, This](pred: (T) ⇒ Boolean, btrue: Combiner[U, This], bfalse: Combiner[U, This]): (Combiner[U, This], Combiner[U, This])
- Definition Classes
- AugmentedIterableIterator
def patch[B >: T](from: Int, patchElems: Iterator[B], replaced: Int): Iterator[B]
Returns this iterator with patched values. Patching at negative indices is the same as patching starting at 0. Patching at indices at or larger than the length of the original iterator appends the patch to the end. If more values are replaced than actually exist, the excess is ignored.
- from
The start index from which to patch
- patchElems
The iterator of patch values
- replaced
The number of values in the original iterator that are replaced by the patch.
- Definition Classes
- Iterator
- Note
Reuse: After calling this method, one should discard the iterator it was called on, as well as the one passed as a parameter, and use only the iterator that was returned. Using the old iterators is undefined, subject to change, and may result in changes to the new iterator as well.
def patchParSeq[U >: T](from: Int, patchElems: SeqSplitter[U], replaced: Int): Patched[U]
- Definition Classes
- SeqSplitter
def prefixLength(pred: (T) ⇒ Boolean): Int
- Definition Classes
- AugmentedSeqIterator
def product: A
Multiplies up the elements of this collection.
- returns
the product of all elements in this traversable or iterator of numbers of type
Int
. Instead ofInt
, any other typeT
with an implicitNumeric[T]
implementation can be used as element type of the traversable or iterator and as result type ofproduct
. Examples of such types are:Long
,Float
,Double
,BigInt
.
- Definition Classes
- AugmentedIterableIterator → TraversableOnce → GenTraversableOnce
def psplit(sizes: Int*): scala.Seq[SeqSplitter[T]]
Splits the splitter into disjunct views.
This overloaded version of the split
method is specific to precise splitters. It returns a sequence of splitters, each iterating some subset of the elements in this splitter. The sizes of the subsplitters in the partition is equal to the size in the corresponding argument, as long as there are enough elements in this splitter to split it that way.
If there aren't enough elements, a zero element splitter is appended for each additional argument. If there are additional elements, an additional splitter is appended at the end to compensate.
For example, say we have a splitter ps
with 100 elements. Invoking:
ps.split(50, 25, 25, 10, 5)
will return a sequence of five splitters, last two views being empty. On the other hand, calling:
ps.split(50, 40)
will return a sequence of three splitters, last of them containing ten elements.
Note: this method actually invalidates the current splitter.
Unlike the case with split
found in splitters, views returned by this method can be empty.
- sizes
the sizes used to split this split iterator into iterators that traverse disjunct subsets
- returns
a sequence of disjunct subsequence iterators of this parallel iterator
- Definition Classes
- Elements → SeqSplitter → PreciseSplitter
def psplitWithSignalling(sizes: Int*): scala.Seq[SeqSplitter[T]]
- Definition Classes
- SeqSplitter
def reduce[U >: T](op: (U, U) ⇒ U): U
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.
- 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.
- Definition Classes
- AugmentedIterableIterator → TraversableOnce → GenTraversableOnce
- Exceptions thrown
UnsupportedOperationException
if this traversable or iterator is empty.
def reduceLeft[U >: T](howmany: Int, op: (U, U) ⇒ U): U
- Definition Classes
- AugmentedIterableIterator
def reduceLeft[B >: T](op: (B, T) ⇒ B): B
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
-
the result of inserting
op
between consecutive elements of this traversable or iterator, going left to right:op( op( ... op(x_1, x_2) ..., x_{n-1}), x_n)
where
x1, ..., xn
are the elements of this traversable or iterator.
- Definition Classes
- TraversableOnce
- Exceptions thrown
UnsupportedOperationException
if this traversable or iterator is empty.
def reduceLeftOption[B >: T](op: (B, T) ⇒ 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.
- Definition Classes
- TraversableOnce → GenTraversableOnce
def reduceOption[A1 >: T](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
.- 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.
- Definition Classes
- TraversableOnce → GenTraversableOnce
def reduceRight[B >: T](op: (T, B) ⇒ B): B
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
-
the result of inserting
op
between consecutive elements of this traversable or iterator, going right to left:op(x_1, op(x_2, ..., op(x_{n-1}, x_n)...))
where
x1, ..., xn
are the elements of this traversable or iterator.
- Definition Classes
- TraversableOnce → GenTraversableOnce
- Exceptions thrown
UnsupportedOperationException
if this traversable or iterator is empty.
def reduceRightOption[B >: T](op: (T, 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.
- Definition Classes
- TraversableOnce → GenTraversableOnce
final def remaining: Int
The number of elements this iterator has yet to traverse. This method doesn't change the state of the iterator. Unlike the version of this method in the supertrait, method remaining
in ParSeqLike.this.ParIterator
must return an exact number of elements remaining in the iterator.
- returns
an exact number of elements this iterator has yet to iterate
- Definition Classes
- Elements → SeqSplitter → AugmentedSeqIterator → IterableSplitter → RemainsIterator
def reverse: SeqSplitter[T]
- Definition Classes
- SeqSplitter
def reverse2combiner[U >: T, This](cb: Combiner[U, This]): Combiner[U, This]
- Definition Classes
- AugmentedSeqIterator
def reverseMap2combiner[S, That](f: (T) ⇒ S, cb: Combiner[S, That]): Combiner[S, That]
- Definition Classes
- AugmentedSeqIterator
def reversed: List[T]
- Attributes
- protected[this]
- Definition Classes
- TraversableOnce
def sameElements(that: Iterator[_]): Boolean
Tests if another iterator produces the same values as this one.
Note: will not terminate for infinite iterators.
- that
the other iterator
- returns
true
, if both iterators produce the same elements in the same order,false
otherwise.
- Definition Classes
- Iterator
- Note
Reuse: After calling this method, one should discard the iterator it was called on, as well as the one passed as parameter. Using the old iterators is undefined and subject to change.
def scanLeft[B](z: B)(op: (B, T) ⇒ B): Iterator[B]
Produces a collection containing cumulative results of applying the operator going left to right, including the initial value.
Note: will not terminate for infinite iterators.
Note: might return different results for different runs, unless the underlying collection type is ordered.
- B
the type of the elements in the resulting collection
- z
the initial value
- op
the binary operator applied to the intermediate result and the element
- returns
iterator with intermediate results
- Definition Classes
- Iterator
- Note
Reuse: After calling this method, one should discard the iterator it was called on, and use only the iterator that was returned. Using the old iterator is undefined, subject to change, and may result in changes to the new iterator as well.
def scanRight[B](z: B)(op: (T, B) ⇒ B): Iterator[B]
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 iterators.
Note: might return different results for different runs, unless the underlying collection type is ordered.
- B
the type of the elements in the resulting collection
- z
the initial value
- op
the binary operator applied to the intermediate result and the element
- returns
iterator with intermediate results
- Definition Classes
- Iterator
- Note
Reuse: After calling this method, one should discard the iterator it was called on, and use only the iterator that was returned. Using the old iterator is undefined, subject to change, and may result in changes to the new iterator as well.
Iterator(1, 2, 3, 4).scanRight(0)(_ + _).toList == List(10, 9, 7, 4, 0)
def scanToArray[U >: T, A >: U](z: U, op: (U, U) ⇒ U, array: Array[A], from: Int): Unit
- Definition Classes
- AugmentedIterableIterator
def scanToCombiner[U >: T, That](howmany: Int, startValue: U, op: (U, U) ⇒ U, cb: Combiner[U, That]): Combiner[U, That]
- Definition Classes
- AugmentedIterableIterator
def scanToCombiner[U >: T, That](startValue: U, op: (U, U) ⇒ U, cb: Combiner[U, That]): Combiner[U, That]
- Definition Classes
- AugmentedIterableIterator
def seq: Iterator[T]
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
- Iterator → TraversableOnce → GenTraversableOnce
def setIndexFlag(f: Int): Unit
Sets the value of the index flag.
The index flag holds an integer which carries some operation-specific meaning. For instance, takeWhile
operation sets the index flag to the position of the element where the predicate fails. Other workers may check this index against the indices they are working on and return if this index is smaller than their index. Examples of operations using this are takeWhile
, dropWhile
, span
and indexOf
.
- f
the value to which the index flag is set.
- Definition Classes
- DelegatedSignalling → Signalling
def setIndexFlagIfGreater(f: Int): Unit
Sets the value of the index flag if argument is greater than current value. This method does this atomically.
The index flag holds an integer which carries some operation-specific meaning. For instance, takeWhile
operation sets the index flag to the position of the element where the predicate fails. Other workers may check this index against the indices they are working on and return if this index is smaller than their index. Examples of operations using this are takeWhile
, dropWhile
, span
and indexOf
.
- f
the value to which the index flag is set
- Definition Classes
- DelegatedSignalling → Signalling
def setIndexFlagIfLesser(f: Int): Unit
Sets the value of the index flag if argument is lesser than current value. This method does this atomically.
The index flag holds an integer which carries some operation-specific meaning. For instance, takeWhile
operation sets the index flag to the position of the element where the predicate fails. Other workers may check this index against the indices they are working on and return if this index is smaller than their index. Examples of operations using this are takeWhile
, dropWhile
, span
and indexOf
.
- f
the value to which the index flag is set
- Definition Classes
- DelegatedSignalling → Signalling
def shouldSplitFurther[S](coll: ParIterable[S], parallelismLevel: Int): Boolean
- Definition Classes
- IterableSplitter
val signalDelegate: Signalling
A delegate that method calls are redirected to.
- Definition Classes
- IterableSplitter → DelegatedSignalling
def size: Int
The size of this traversable or iterator.
Note: will not terminate for infinite-sized collections.
- returns
the number of elements in this traversable or iterator.
- Definition Classes
- TraversableOnce → GenTraversableOnce
def sizeHintIfCheap: Int
The size of this collection or iterator, if it can be cheaply computed
- returns
the number of elements in this collection or iterator, or -1 if the size cannot be determined cheaply
- Attributes
- protected[collection]
- Definition Classes
- GenTraversableOnce
def slice(from1: Int, until1: Int): SeqSplitter[T]
Creates an iterator returning an interval of the values produced by this iterator.
- returns
an iterator which advances this iterator past the first
from
elements usingdrop
, and then takesuntil - from
elements, usingtake
.
- Definition Classes
- SeqSplitter → IterableSplitter → Iterator
- Note
Reuse: After calling this method, one should discard the iterator it was called on, and use only the iterator that was returned. Using the old iterator is undefined, subject to change, and may result in changes to the new iterator as well.
def slice2combiner[U >: T, This](from: Int, until: Int, cb: Combiner[U, This]): Combiner[U, This]
- Definition Classes
- AugmentedIterableIterator
def sliceIterator(from: Int, until: Int): Iterator[T]
Creates an optionally bounded slice, unbounded if until
is negative.
- Attributes
- protected
- Definition Classes
- Iterator
def sliding[B >: T](size: Int, step: Int = 1): GroupedIterator[B]
Returns an iterator which presents a "sliding window" view of this iterator. The first argument is the window size, and the second argument step
is how far to advance the window on each iteration. The step
defaults to 1
.
The default GroupedIterator
can be configured to either pad a partial result to size size
or suppress the partial result entirely.
Example usages:
// Returns List(List(1, 2, 3), List(2, 3, 4), List(3, 4, 5)) (1 to 5).iterator.sliding(3).toList // Returns List(List(1, 2, 3, 4), List(4, 5)) (1 to 5).iterator.sliding(4, 3).toList // Returns List(List(1, 2, 3, 4)) (1 to 5).iterator.sliding(4, 3).withPartial(false).toList // Returns List(List(1, 2, 3, 4), List(4, 5, 20, 25)) // Illustrating that withPadding's argument is by-name. val it2 = Iterator.iterate(20)(_ + 5) (1 to 5).iterator.sliding(4, 3).withPadding(it2.next).toList
- returns
An iterator producing
Seq[B]
s of sizesize
, except the last element (which may be the only element) will be truncated if there are fewer thansize
elements remaining to be grouped. This behavior can be configured.
- Definition Classes
- Iterator
- Note
Reuse: After calling this method, one should discard the iterator it was called on, and use only the iterator that was returned. Using the old iterator is undefined, subject to change, and may result in changes to the new iterator as well.
def span(p: (T) ⇒ Boolean): (Iterator[T], Iterator[T])
Splits this Iterator into a prefix/suffix pair according to a predicate.
- p
the test predicate
- returns
a pair of Iterators consisting of the longest prefix of this whose elements all satisfy
p
, and the rest of the Iterator.
- Definition Classes
- Iterator
- Note
Reuse: After calling this method, one should discard the iterator it was called on, and use only the iterators that were returned. Using the old iterator is undefined, subject to change, and may result in changes to the new iterators as well.
def span2combiners[U >: T, This](p: (T) ⇒ Boolean, before: Combiner[U, This], after: Combiner[U, This]): (Combiner[U, This], Combiner[U, This])
- Definition Classes
- AugmentedIterableIterator
def split: Seq[SeqSplitter[T]]
Splits the iterator into a sequence of disjunct views.
Returns a sequence of split iterators, each iterating over some subset of the elements in the collection. These subsets are disjoint and should be approximately equal in size. These subsets are not empty, unless the iterator is empty in which case this method returns a sequence with a single empty iterator. If the splitter has more than two elements, this method will return two or more splitters.
Implementors are advised to keep this partition relatively small - two splitters are already enough when partitioning the collection, although there may be a few more.
Note: this method actually invalidates the current splitter.
- returns
a sequence of disjunct iterators of the collection
- Definition Classes
- Elements → SeqSplitter → PreciseSplitter → IterableSplitter → Splitter
def splitAt2combiners[U >: T, This](at: Int, before: Combiner[U, This], after: Combiner[U, This]): (Combiner[U, This], Combiner[U, This])
- Definition Classes
- AugmentedIterableIterator
def splitWithSignalling: scala.Seq[SeqSplitter[T]]
- Definition Classes
- SeqSplitter → IterableSplitter
def sum: A
Sums up the elements of this collection.
- returns
the sum of all elements in this traversable or iterator of numbers of type
Int
. Instead ofInt
, any other typeT
with an implicitNumeric[T]
implementation can be used as element type of the traversable or iterator and as result type ofsum
. Examples of such types are:Long
,Float
,Double
,BigInt
.
- Definition Classes
- AugmentedIterableIterator → TraversableOnce → GenTraversableOnce
final def synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
def tag: Int
A read only tag specific to the signalling object. It is used to give specific workers information on the part of the collection being operated on.
- Definition Classes
- DelegatedSignalling → Signalling
def take(n: Int): SeqSplitter[T]
Selects first n values of this iterator.
- n
the number of values to take
- returns
an iterator producing only the first
n
values of this iterator, or else the whole iterator, if it produces fewer thann
values.
- Definition Classes
- SeqSplitter → IterableSplitter → Iterator
- Note
Reuse: After calling this method, one should discard the iterator it was called on, and use only the iterator that was returned. Using the old iterator is undefined, subject to change, and may result in changes to the new iterator as well.
def take2combiner[U >: T, This](n: Int, cb: Combiner[U, This]): Combiner[U, This]
- Definition Classes
- AugmentedIterableIterator
def takeWhile(p: (T) ⇒ Boolean): Iterator[T]
Takes longest prefix of values produced by this iterator that satisfy a predicate.
- p
The predicate used to test elements.
- returns
An iterator returning the values produced by this iterator, until this iterator produces a value that does not satisfy the predicate
p
.
- Definition Classes
- Iterator
- Note
Reuse: After calling this method, one should discard the iterator it was called on, and use only the iterator that was returned. Using the old iterator is undefined, subject to change, and may result in changes to the new iterator as well.
def takeWhile2combiner[U >: T, This](p: (T) ⇒ Boolean, cb: Combiner[U, This]): (Combiner[U, This], Boolean)
- Definition Classes
- AugmentedIterableIterator
def to[Col[_]]: Col[A]
Converts this traversable or iterator into another by copying all elements.
Note: will not terminate for infinite iterators.
- Col
The collection type to build.
- returns
a new collection containing all elements of this traversable or iterator.
- Definition Classes
- TraversableOnce → GenTraversableOnce
def toArray: Array[A]
Converts this traversable or iterator to an array.
Note: will not terminate for infinite iterators.
- returns
an array containing all elements of this traversable or iterator. An
ClassTag
must be available for the element type of this traversable or iterator.
- Definition Classes
- TraversableOnce → GenTraversableOnce
def toBuffer[B >: T]: 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
def toIndexedSeq: immutable.IndexedSeq[T]
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
def toIterable: Iterable[T]
Converts this traversable or iterator to an iterable collection. Note that the choice of target Iterable
is lazy in this default implementation as this TraversableOnce
may be lazy and unevaluated (i.e. it may be an iterator which is only traversable once).
Note: will not terminate for infinite-sized collections.
- returns
an
Iterable
containing all elements of this traversable or iterator.
- Definition Classes
- TraversableOnce → GenTraversableOnce
def toIterator: Iterator[T]
Returns an Iterator over the elements in this traversable or iterator. Will return the same Iterator if this instance is already an Iterator.
Note: will not terminate for infinite iterators.
- returns
an Iterator containing all elements of this traversable or iterator.
- Definition Classes
- Iterator → GenTraversableOnce
def toList: List[T]
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
def toMap[T, U]: collection.Map[T, U]
Converts this traversable or iterator 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 iterators.
- returns
a map of type
immutable.Map[T, U]
containing all key/value pairs of type(T, U)
of this traversable or iterator.
- Definition Classes
- TraversableOnce → GenTraversableOnce
def toParArray: ParArray[T]
- Implicit
- This member is added by an implicit conversion from Elements to CollectionsHaveToParArray[Elements, T] performed by method CollectionsHaveToParArray in scala.collection.parallel. This conversion will take place only if an implicit value of type (Elements) ⇒ GenTraversableOnce[T] is in scope.
- Definition Classes
- CollectionsHaveToParArray
def toSeq: Seq[T]
Converts this traversable or iterator to a sequence. As with toIterable
, it's lazy in this default implementation, as this TraversableOnce
may be lazy and unevaluated.
Note: will not terminate for infinite-sized collections.
- returns
a sequence containing all elements of this traversable or iterator.
- Definition Classes
- TraversableOnce → GenTraversableOnce
def toSet[B >: T]: immutable.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
def toStream: immutable.Stream[T]
Converts this traversable or iterator to a stream.
- returns
a stream containing all elements of this traversable or iterator.
- Definition Classes
- Iterator → GenTraversableOnce
def toString(): String
Converts this iterator to a string.
- returns
"<iterator>"
whether or not the iterator is empty.
def toTraversable: Traversable[T]
Converts this traversable or iterator to an unspecified Traversable. Will return the same collection if this instance is already Traversable.
Note: will not terminate for infinite iterators.
- returns
a Traversable containing all elements of this traversable or iterator.
- Definition Classes
- Iterator → TraversableOnce → GenTraversableOnce
def toVector: Vector[T]
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
def updated2combiner[U >: T, That](index: Int, elem: U, cb: Combiner[U, That]): Combiner[U, That]
- Definition Classes
- AugmentedSeqIterator
final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
final def wait(arg0: Long): Unit
def withFilter(p: (T) ⇒ Boolean): Iterator[T]
Creates an iterator over all the elements of this iterator that satisfy the predicate p
. The order of the elements is preserved.
Note: withFilter
is the same as filter
on iterators. It exists so that for-expressions with filters work over iterators.
- p
the predicate used to test values.
- returns
an iterator which produces those values of this iterator which satisfy the predicate
p
.
- Definition Classes
- Iterator
- Note
Reuse: After calling this method, one should discard the iterator it was called on, and use only the iterator that was returned. Using the old iterator is undefined, subject to change, and may result in changes to the new iterator as well.
def zip[B](that: Iterator[B]): Iterator[(T, B)]
Creates an iterator formed from this iterator and another iterator by combining corresponding values in pairs. If one of the two iterators is longer than the other, its remaining elements are ignored.
- that
The iterator providing the second half of each result pair
- returns
a new iterator containing pairs consisting of corresponding elements of this iterator and
that
. The number of elements returned by the new iterator is the minimum of the number of elements returned by this iterator andthat
.
- Definition Classes
- Iterator
- Note
Reuse: After calling this method, one should discard the iterator it was called on, as well as the one passed as a parameter, and use only the iterator that was returned. Using the old iterators is undefined, subject to change, and may result in changes to the new iterator as well.
def zip2combiner[U >: T, S, That](otherpit: RemainsIterator[S], cb: Combiner[(U, S), That]): Combiner[(U, S), That]
- Definition Classes
- AugmentedIterableIterator
def zipAll[B](that: Iterator[B], thisElem: T, thatElem: B): Iterator[(T, B)]
Creates an iterator formed from this iterator and another iterator by combining corresponding elements in pairs. If one of the two iterators is shorter than the other, placeholder elements are used to extend the shorter iterator to the length of the longer.
- that
iterator
that
may have a different length as the self iterator.- thisElem
element
thisElem
is used to fill up the resulting iterator if the self iterator is shorter thanthat
- thatElem
element
thatElem
is used to fill up the resulting iterator ifthat
is shorter than the self iterator- returns
a new iterator containing pairs consisting of corresponding values of this iterator and
that
. The length of the returned iterator is the maximum of the lengths of this iterator andthat
. If this iterator is shorter thanthat
,thisElem
values are used to pad the result. Ifthat
is shorter than this iterator,thatElem
values are used to pad the result.
- Definition Classes
- Iterator
def zipAll2combiner[U >: T, S, That](that: RemainsIterator[S], thiselem: U, thatelem: S, cb: Combiner[(U, S), That]): Combiner[(U, S), That]
- Definition Classes
- AugmentedIterableIterator
def zipAllParSeq[S, U >: T, R >: S](that: SeqSplitter[S], thisElem: U, thatElem: R): ZippedAll[U, R]
- Definition Classes
- SeqSplitter → IterableSplitter
def zipParSeq[S](that: SeqSplitter[S]): Zipped[S]
- Definition Classes
- SeqSplitter → IterableSplitter
def zipWithIndex: Iterator[(T, Int)]
Creates an iterator that pairs each element produced by this iterator with its index, counting from 0.
- returns
a new iterator containing pairs consisting of corresponding elements of this iterator and their indices.
- Definition Classes
- Iterator
- Note
Reuse: After calling this method, one should discard the iterator it was called on, and use only the iterator that was returned. Using the old iterator is undefined, subject to change, and may result in changes to the new iterator as well.
def →[B](y: B): (Elements, B)
- Implicit
- This member is added by an implicit conversion from Elements to ArrowAssoc[Elements] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
Shadowed Implicit Value Members
def filter(p: (T) ⇒ Boolean): TraversableOnce[T]
- Implicit
- This member is added by an implicit conversion from Elements to MonadOps[T] performed by method MonadOps in scala.collection.TraversableOnce.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(elements: MonadOps[T]).filter(p)
- Definition Classes
- MonadOps
def flatMap[B](f: (T) ⇒ GenTraversableOnce[B]): TraversableOnce[B]
- Implicit
- This member is added by an implicit conversion from Elements to MonadOps[T] performed by method MonadOps in scala.collection.TraversableOnce.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(elements: MonadOps[T]).flatMap(f)
- Definition Classes
- MonadOps
def map[B](f: (T) ⇒ B): TraversableOnce[B]
- Implicit
- This member is added by an implicit conversion from Elements to MonadOps[T] performed by method MonadOps in scala.collection.TraversableOnce.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(elements: MonadOps[T]).map(f)
- Definition Classes
- MonadOps
def withFilter(p: (T) ⇒ Boolean): Iterator[T]
- Implicit
- This member is added by an implicit conversion from Elements to MonadOps[T] performed by method MonadOps in scala.collection.TraversableOnce.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(elements: MonadOps[T]).withFilter(p)
- Definition Classes
- MonadOps
© 2002-2019 EPFL, with contributions from Lightbend.
Licensed under the Apache License, Version 2.0.
https://www.scala-lang.org/api/2.12.9/scala/collection/parallel/ParSeqLike$Elements.html
Used to iterate elements using indices