LineIterator

Attributes

Inherited from:: Iterator
Source: Iterator.scala

Appends all elements of this $coll to a string builder.

Appends all elements of this $coll to a string builder. The written text consists of the string representations (w.r.t. the method toString) of all elements of this $coll 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

Value parameters

b: the string builder to which elements are appended.

Attributes

Returns: the string builder b to which elements were appended.
Inherited from:: IterableOnceOps
Source: IterableOnce.scala

Appends all elements of this $coll to a string builder using a separator string.

Appends all elements of this $coll 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 $coll, 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

Value parameters

b: the string builder to which elements are appended.
sep: the separator string.

Attributes

Returns: the string builder b to which elements were appended.
Inherited from:: IterableOnceOps
Source: IterableOnce.scala

Appends all elements of this $coll to a string builder using start, end, and separator strings.

Appends all elements of this $coll 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 $coll 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)

Value parameters

b: the string builder to which elements are appended.
end: the ending string.
sep: the separator string.
start: the starting string.

Attributes

Returns: the string builder b to which elements were appended.
Inherited from:: IterableOnceOps
Source: IterableOnce.scala

Creates a buffered iterator from this iterator.

Attributes

Returns: a buffered iterator producing the same values as this iterator.
See also: scala.collection.BufferedIterator
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.
Inherited from:: Iterator
Source: Iterator.scala

Builds a new iterator by applying a partial function to all elements of this iterator on which the function is defined.

Type parameters

B: the element type of the returned iterator.

Value parameters

pf: the partial function which filters and maps the iterator.

Attributes

Returns: a new iterator 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.
Inherited from:: Iterator
Source: Iterator.scala

Finds the first element of the $coll 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.

Value parameters

pf: the partial function

Attributes

Returns: an option value containing pf applied to the first value for which it is defined, or None if none exists.
Example: Seq("a", 1, 5L).collectFirst({ case x: Int => x*10 }) = Some(10)
Inherited from:: IterableOnceOps
Source: IterableOnce.scala

Attributes

Inherited from:: Iterator
Source: Iterator.scala

Tests whether this iterator contains a given value as an element.

Note: may not terminate for infinite iterators.

Value parameters

elem: the element to test.

Attributes

Returns: true if this iterator produces some value that is is equal (as determined by ==) to elem, false otherwise.
Note: Reuse: After calling this method, one should discard the iterator it was called on. Using it is undefined and subject to change.
Inherited from:: Iterator
Source: Iterator.scala

Copy elements to an array, returning the number of elements written.

Fills the given array xs starting at index start with at most len elements of this $coll.

Copying will stop once either all the elements of this $coll have been copied, or the end of the array is reached, or len elements have been copied.

Type parameters

B: the type of the elements of the array.

Value parameters

len: the maximal number of elements to copy.
start: the starting index of xs.
xs: the array to fill.

Attributes

Returns: the number of elements written to the array
Note: Reuse: After calling this method, one should discard the iterator it was called on. Using it is undefined and subject to change.
Inherited from:: IterableOnceOps
Source: IterableOnce.scala

Copies elements to an array, returning the number of elements written.

Fills the given array xs starting at index start with values of this $coll.

Copying will stop once either all the elements of this $coll have been copied, or the end of the array is reached.

Type parameters

B: the type of the elements of the array.

Value parameters

start: the starting index of xs.
xs: the array to fill.

Attributes

Returns: the number of elements written to the array
Note: Reuse: After calling this method, one should discard the iterator it was called on. Using it is undefined and subject to change.
Inherited from:: IterableOnceOps
Source: IterableOnce.scala

Copies elements to an array, returning the number of elements written.

Fills the given array xs starting at index start with values of this $coll.

Copying will stop once either all the elements of this $coll have been copied, or the end of the array is reached.

Type parameters

B: the type of the elements of the array.

Value parameters

xs: the array to fill.

Attributes

Returns: the number of elements written to the array
Note: Reuse: After calling this method, one should discard the iterator it was called on. Using it is undefined and subject to change.
Inherited from:: IterableOnceOps
Source: IterableOnce.scala

Tests whether every element of this collection's iterator relates to the corresponding element of another collection by satisfying a test predicate.

Note: will not terminate for infinite-sized collections.

Type parameters

B: the type of the elements of that

Value parameters

p: the test predicate, which relates elements from both collections
that: the other collection

Attributes

Returns: true if both collections have the same length and p(x, y) is true for all corresponding elements x of this iterator and y of that, otherwise false
Inherited from:: IterableOnceOps
Source: IterableOnce.scala

Counts the number of elements in the $coll which satisfy a predicate.

Note: will not terminate for infinite-sized collections.

Value parameters

p: the predicate used to test elements.

Attributes

Returns: the number of elements satisfying the predicate p.
Inherited from:: IterableOnceOps
Source: IterableOnce.scala

Builds a new iterator from this one without any duplicated elements on it.

Attributes

Returns: iterator with distinct elements
Note: Reuse: After calling this method, one should discard the iterator it was called on. Using it is undefined and subject to change.
Inherited from:: Iterator
Source: Iterator.scala

Builds a new iterator from this one without any duplicated elements as determined by == after applying the transforming function f.

Type parameters

B: the type of the elements after being transformed by f

Value parameters

f: The transforming function whose result is used to determine the uniqueness of each element

Attributes

Returns: iterator with distinct elements
Note: Reuse: After calling this method, one should discard the iterator it was called on. Using it is undefined and subject to change.
Inherited from:: Iterator
Source: Iterator.scala

Selects all elements except the first n ones.

Note: might return different results for different runs, unless the underlying collection type is ordered.

Value parameters

n: the number of elements to drop from this iterator.

Attributes

Returns: a iterator consisting of all elements of this iterator except the first n ones, or else the empty iterator, if this iterator has less than n elements. If n is negative, don't drop any elements.
Inherited from:: Iterator
Source: Iterator.scala

Selects all elements except the longest prefix that satisfies a predicate.

The matching prefix starts with the first element of this iterator, and the element following the prefix is the first element that does not satisfy the predicate. The matching prefix may be empty, so that this method returns the entire iterator.

Example:

scala> List(1, 2, 3, 100, 4).dropWhile(n => n < 10)
val res0: List[Int] = List(100, 4)

scala> List(1, 2, 3, 100, 4).dropWhile(n => n == 0)
val res1: List[Int] = List(1, 2, 3, 100, 4)

Use span to obtain both the prefix and suffix. Use filterNot to drop all elements that satisfy the predicate.

Note: might return different results for different runs, unless the underlying collection type is ordered.

Value parameters

p: The predicate used to test elements.

Attributes

Returns: the longest suffix of this iterator whose first element does not satisfy the predicate p.
Inherited from:: Iterator
Source: Iterator.scala

Creates two new iterators that both iterate over the same elements as this iterator (in the same order).

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.

Attributes

Returns: a pair of iterators
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.
Inherited from:: Iterator
Source: Iterator.scala

Tests whether a predicate holds for at least one element of this $coll.

Note: may not terminate for infinite-sized collections.

Value parameters

p: the predicate used to test elements.

Attributes

Returns: true if the given predicate p is satisfied by at least one element of this $coll, otherwise false
Inherited from:: IterableOnceOps
Source: IterableOnce.scala

Selects all elements of this iterator which satisfy a predicate.

Value parameters

p: the predicate used to test elements.

Attributes

Returns: a new iterator consisting of all elements of this iterator that satisfy the given predicate p. The order of the elements is preserved.
Inherited from:: Iterator
Source: Iterator.scala

Selects all elements of this iterator which do not satisfy a predicate.

Value parameters

pred: the predicate used to test elements.

Attributes

Returns: a new iterator consisting of all elements of this iterator that do not satisfy the given predicate pred. Their order may not be preserved.
Inherited from:: Iterator
Source: Iterator.scala

Finds the first element of the $coll satisfying a predicate, if any.

Note: may not terminate for infinite-sized collections.

Note: might return different results for different runs, unless the underlying collection type is ordered.

Value parameters

p: the predicate used to test elements.

Attributes

Returns: an option value containing the first element in the $coll that satisfies p, or None if none exists.
Inherited from:: IterableOnceOps
Source: IterableOnce.scala

Builds a new iterator by applying a function to all elements of this iterator and using the elements of the resulting collections.

For example:

def getWords(lines: Seq[String]): Seq[String] = lines.flatMap(line => line.split("\\W+"))

The type of the resulting collection is guided by the static type of this iterator. This might cause unexpected results sometimes. For example:

// lettersOf will return a Seq[Char] of likely repeated letters, instead of a Set
def lettersOf(words: Seq[String]) = words.flatMap(word => word.toSet)

// lettersOf will return a Set[Char], not a Seq
def lettersOf(words: Seq[String]) = words.toSet.flatMap(word => word.toSeq)

// xs will be an Iterable[Int]
val xs = Map("a" -> List(11, 111), "b" -> List(22, 222)).flatMap(_._2)

// ys will be a Map[Int, Int]
val ys = Map("a" -> List(1 -> 11, 1 -> 111), "b" -> List(2 -> 22, 2 -> 222)).flatMap(_._2)

Type parameters

B: the element type of the returned collection.

Value parameters

f: the function to apply to each element.

Attributes

Returns: a new iterator resulting from applying the given collection-valued function f to each element of this iterator and concatenating the results.
Inherited from:: Iterator
Source: Iterator.scala

Given that the elements of this collection are themselves iterable collections, converts this iterator into a iterator comprising the elements of these iterable collections.

The resulting collection's type will be guided by the type of iterator. For example:

val xs = List(
           Set(1, 2, 3),
           Set(1, 2, 3)
         ).flatten
// xs == List(1, 2, 3, 1, 2, 3)

val ys = Set(
           List(1, 2, 3),
           List(3, 2, 1)
         ).flatten
// ys == Set(1, 2, 3)

Type parameters

B: the type of the elements of each iterable collection.

Value parameters

asIterable: an implicit conversion which asserts that the element type of this iterator is an Iterable.

Attributes

Returns: a new iterator resulting from concatenating all element collections.
Inherited from:: Iterator
Source: Iterator.scala

Applies the given binary operator op to the given initial value z and all elements of this $coll.

For each application of the operator, each operand is either an element of this $coll, the initial value, or another such application of the operator.

The order of applications of the operator is unspecified and may be nondeterministic. Each element appears exactly once in the computation. The initial value may be used an arbitrary number of times, but at least once.

If this collection is ordered, then for any application of the operator, the element(s) appearing in the left operand will precede those in the right.

Note: might return different results for different runs, unless either of the following conditions is met: (1) the operator is associative, and the underlying collection type is ordered; or (2) the operator is associative and commutative. In either case, it is also necessary that the initial value be a neutral value for the operator, e.g. Nil for List concatenation or 1 for multiplication.

The default implementation in IterableOnce is equivalent to foldLeft but may be overridden for more efficient traversal orders.

Note: will not terminate for infinite-sized collections.

Type parameters

A1: The type parameter for the binary operator, a supertype of A.

Value parameters

op: A binary operator; must be associative for the result to always be the same across runs.
z: An initial value; may be used an arbitrary number of times in the computation of the result; must be a neutral value for op for the result to always be the same across runs.

Attributes

Returns: The result of applying op between all the elements and z, or z if this $coll is empty.
Inherited from:: IterableOnceOps
Source: IterableOnce.scala

Applies the given binary operator op to the given initial value z and all elements of this $coll, going left to right.

Applies the given binary operator op to the given initial value z and all elements of this $coll, going left to right. Returns the initial value if this $coll is empty.

"Going left to right" only makes sense if this collection is ordered: then if x1, x2, ..., xn are the elements of this $coll, the result is op( op( ... op( op(z, x1), x2) ... ), xn).

If this collection is not ordered, then for each application of the operator, each right operand is an element. In addition, the leftmost operand is the initial value, and each other left operand is itself an application of the operator. The elements of this $coll and the initial value all appear exactly once in the computation.

Note: might return different results for different runs, unless the underlying collection type is ordered.

Note: will not terminate for infinite-sized collections.

Type parameters

B: The result type of the binary operator.

Value parameters

op: A binary operator.
z: An initial value.

Attributes

Returns: The result of applying op to z and all elements of this $coll, going left to right. Returns z if this $coll is empty.
Inherited from:: IterableOnceOps
Source: IterableOnce.scala

Applies the given binary operator op to all elements of this $coll and the given initial value z, going right to left.

Applies the given binary operator op to all elements of this $coll and the given initial value z, going right to left. Returns the initial value if this $coll is empty.

"Going right to left" only makes sense if this collection is ordered: then if x1, x2, ..., xn are the elements of this $coll, the result is op(x1, op(x2, op( ... op(xn, z) ... ))).

If this collection is not ordered, then for each application of the operator, each left operand is an element. In addition, the rightmost operand is the initial value, and each other right operand is itself an application of the operator. The elements of this $coll and the initial value all appear exactly once in the computation.

Note: might return different results for different runs, unless the underlying collection type is ordered.

Note: will not terminate for infinite-sized collections.

Type parameters

B: The result type of the binary operator.

Value parameters

op: A binary operator.
z: An initial value.

Attributes

Returns: The result of applying op to all elements of this $coll and z, going right to left. Returns z if this $coll is empty.
Inherited from:: IterableOnceOps
Source: IterableOnce.scala

Tests whether a predicate holds for all elements of this $coll.

Note: may not terminate for infinite-sized collections.

Value parameters

p: the predicate used to test elements.

Attributes

Returns: true if this $coll is empty or the given predicate p holds for all elements of this $coll, otherwise false.
Inherited from:: IterableOnceOps
Source: IterableOnce.scala

Applies f to each element for its side effects.

Applies f to each element for its side effects. Note: U parameter needed to help scalac's type inference.

Attributes

Inherited from:: IterableOnceOps
Source: IterableOnce.scala

Returns an iterator which groups this iterator into fixed size blocks.

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

Attributes

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.
Inherited from:: Iterator
Source: Iterator.scala

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.

Value parameters

elem: element to search for.
from: the start index

Attributes

Returns: the index >= from 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.
Note: Reuse: After calling this method, one should discard the iterator it was called on. Using it is undefined and subject to change.
Inherited from:: Iterator
Source: Iterator.scala

Returns the index of the first occurrence of the specified object in this iterable object.

Note: may not terminate for infinite iterators.

Value parameters

elem: element to search for.

Attributes

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.
Note: Reuse: After calling this method, one should discard the iterator it was called on. Using it is undefined and subject to change.
Inherited from:: Iterator
Source: Iterator.scala

Finds index of the first element satisfying some predicate after or at some start index.

Note: may not terminate for infinite iterators.

Value parameters

from: the start index
p: the predicate used to test elements.

Attributes

Returns: the index >= from of the first element of this iterator that satisfies the predicate p, or -1, if none exists.
Note: Reuse: After calling this method, one should discard the iterator it was called on. Using it is undefined and subject to change.
Inherited from:: Iterator
Source: Iterator.scala

Tests whether the iterator is empty.

Note: The default implementation creates and discards an iterator.

Note: Implementations in subclasses that are not repeatedly iterable must take care not to consume any elements when isEmpty is called.

Attributes

Returns: true if the iterator contains no elements, false otherwise.
Definition Classes: Iterator -> IterableOnceOps
Inherited from:: Iterator
Source: Iterator.scala

Tests whether this $coll can be repeatedly traversed.

Tests whether this $coll can be repeatedly traversed. Always true for Iterables and false for Iterators unless overridden.

Attributes

Returns: true if it is repeatedly traversable, false otherwise.
Inherited from:: IterableOnceOps
Source: IterableOnce.scala

An scala.collection.Iterator over the elements of this iterator.

If an IterableOnce object is in fact an scala.collection.Iterator, this method always returns itself, in its current state, but if it is an scala.collection.Iterable, this method always returns a new scala.collection.Iterator.

Attributes

Inherited from:: Iterator
Source: Iterator.scala

The number of elements in this collection, if it can be cheaply computed, -1 otherwise.

The number of elements in this collection, if it can be cheaply computed, -1 otherwise. Cheaply usually means: Not requiring a collection traversal.

Attributes

Inherited from:: IterableOnce
Source: IterableOnce.scala

Attributes

Inherited from:: Iterator
Source: Iterator.scala

Builds a new iterator by applying a function to all elements of this iterator.

Type parameters

B: the element type of the returned iterator.

Value parameters

f: the function to apply to each element.

Attributes

Returns: a new iterator resulting from applying the given function f to each element of this iterator and collecting the results.
Inherited from:: Iterator
Source: Iterator.scala

Finds the largest element.

Note: will not terminate for infinite-sized collections.

Type parameters

B: The type over which the ordering is defined.

Value parameters

ord: An ordering to be used for comparing elements.

Attributes

Returns: the largest element of this $coll with respect to the ordering ord.
Throws: UnsupportedOperationException if this $coll is empty.
Inherited from:: IterableOnceOps
Source: IterableOnce.scala

Finds the first element which yields the largest value measured by function f.

Note: will not terminate for infinite-sized collections.

Type parameters

B: The result type of the function f.

Value parameters

cmp: An ordering to be used for comparing elements.
f: The measuring function.

Attributes

Returns: the first element of this $coll with the largest value measured by function f with respect to the ordering cmp.
Throws: UnsupportedOperationException if this $coll is empty.
Inherited from:: IterableOnceOps
Source: IterableOnce.scala

Finds the first element which yields the largest value measured by function f.

Note: will not terminate for infinite-sized collections.

Type parameters

B: The result type of the function f.

Value parameters

cmp: An ordering to be used for comparing elements.
f: The measuring function.

Attributes

Returns: an option value containing the first element of this $coll with the largest value measured by function f with respect to the ordering cmp.
Inherited from:: IterableOnceOps
Source: IterableOnce.scala

Finds the largest element.

Note: will not terminate for infinite-sized collections.

Type parameters

B: The type over which the ordering is defined.

Value parameters

ord: An ordering to be used for comparing elements.

Attributes

Returns: an option value containing the largest element of this $coll with respect to the ordering ord.
Inherited from:: IterableOnceOps
Source: IterableOnce.scala

Finds the smallest element.

Note: will not terminate for infinite-sized collections.

Type parameters

B: The type over which the ordering is defined.

Value parameters

ord: An ordering to be used for comparing elements.

Attributes

Returns: the smallest element of this $coll with respect to the ordering ord.
Throws: UnsupportedOperationException if this $coll is empty.
Inherited from:: IterableOnceOps
Source: IterableOnce.scala

Finds the first element which yields the smallest value measured by function f.

Note: will not terminate for infinite-sized collections.

Type parameters

B: The result type of the function f.

Value parameters

cmp: An ordering to be used for comparing elements.
f: The measuring function.

Attributes

Returns: the first element of this $coll with the smallest value measured by function f with respect to the ordering cmp.
Throws: UnsupportedOperationException if this $coll is empty.
Inherited from:: IterableOnceOps
Source: IterableOnce.scala

Finds the first element which yields the smallest value measured by function f.

Note: will not terminate for infinite-sized collections.

Type parameters

B: The result type of the function f.

Value parameters

cmp: An ordering to be used for comparing elements.
f: The measuring function.

Attributes

Returns: an option value containing the first element of this $coll with the smallest value measured by function f with respect to the ordering cmp.
Inherited from:: IterableOnceOps
Source: IterableOnce.scala

Finds the smallest element.

Note: will not terminate for infinite-sized collections.

Type parameters

B: The type over which the ordering is defined.

Value parameters

ord: An ordering to be used for comparing elements.

Attributes

Returns: an option value containing the smallest element of this $coll with respect to the ordering ord.
Inherited from:: IterableOnceOps
Source: IterableOnce.scala

Displays all elements of this $coll in a string.

Delegates to addString, which can be overridden.

Attributes

Returns: a string representation of this $coll. In the resulting string the string representations (w.r.t. the method toString) of all elements of this $coll follow each other without any separator string.
Inherited from:: IterableOnceOps
Source: IterableOnce.scala

Displays all elements of this $coll in a string using a separator string.

Delegates to addString, which can be overridden.

Value parameters

sep: the separator string.

Attributes

Returns: a string representation of this $coll. In the resulting string the string representations (w.r.t. the method toString) of all elements of this $coll are separated by the string sep.
Example: List(1, 2, 3).mkString("|") = "1|2|3"
Inherited from:: IterableOnceOps
Source: IterableOnce.scala

Displays all elements of this $coll in a string using start, end, and separator strings.

Delegates to addString, which can be overridden.

Value parameters

end: the ending string.
sep: the separator string.
start: the starting string.

Attributes

Returns: a string representation of this $coll. The resulting string 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 $coll are separated by the string sep.
Example: List(1, 2, 3).mkString("(", "; ", ")") = "(1; 2; 3)"
Inherited from:: IterableOnceOps
Source: IterableOnce.scala

Wraps the value of next() in an option.

Attributes

Returns: Some(next) if a next element exists, None otherwise.
Inherited from:: Iterator
Source: Iterator.scala

Tests whether the $coll is not empty.

Attributes

Returns: true if the $coll contains at least one element, false otherwise.
Inherited from:: IterableOnceOps
Source: IterableOnce.scala

A copy of this iterator with an element value appended until a given target length is reached.

Type parameters

B: the element type of the returned iterator.

Value parameters

elem: the padding value
len: the target length

Attributes

Returns: a new iterator consisting of all elements of this iterator followed by the minimal number of occurrences of elem so that the resulting collection has a length of at least len.
Inherited from:: Iterator
Source: Iterator.scala

Partitions this iterator in two iterators according to a predicate.

Value parameters

p: the predicate on which to partition

Attributes

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.
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.
Inherited from:: Iterator
Source: Iterator.scala

Returns this iterator with patched values.

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.

Value parameters

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.

Attributes

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.
Inherited from:: Iterator
Source: Iterator.scala

Multiplies together the elements of this collection.

The default implementation uses reduce for a known non-empty collection, foldLeft otherwise.

Note: will not terminate for infinite-sized collections.

Type parameters

B: the result type of the * operator.

Value parameters

num: an implicit parameter defining a set of numeric operations which includes the * operator to be used in forming the product.

Attributes

Returns: the product of all elements of this $coll with respect to the * operator in num.
Inherited from:: IterableOnceOps
Source: IterableOnce.scala

Applies the given binary operator op to all elements of this $coll.

For each application of the operator, each operand is either an element of this $coll or another such application of the operator. The order of applications of the operator is unspecified and may be nondeterministic. Each element appears exactly once in the computation.

If this collection is ordered, then for any application of the operator, the element(s) appearing in the left operand will precede those in the right.

Note: might return different results for different runs, unless either of the following conditions is met: (1) the operator is associative, and the underlying collection type is ordered; or (2) the operator is associative and commutative.

Note: will not terminate for infinite-sized collections.

Type parameters

B: The type parameter for the binary operator, a supertype of A.

Value parameters

op: A binary operator; must be associative for the result to always be the same across runs.

Attributes

Returns: The result of applying op between all the elements if the $coll is nonempty.
Throws: UnsupportedOperationException if this $coll is empty.
Inherited from:: IterableOnceOps
Source: IterableOnce.scala

Applies the given binary operator op to all elements of this $coll, going left to right.

"Going left to right" only makes sense if this collection is ordered: then if x1, x2, ..., xn are the elements of this $coll, the result is op( op( op( ... op(x1, x2) ... ), xn-1), xn).

If this collection is not ordered, then for each application of the operator, each right operand is an element. In addition, the leftmost operand is the first element of this $coll and each other left operand is itself an application of the operator. Each element appears exactly once in the computation.

Note: might return different results for different runs, unless the underlying collection type is ordered or the operator is associative and commutative.

Note: will not terminate for infinite-sized collections.

Type parameters

B: The result type of the binary operator, a supertype of A.

Value parameters

op: A binary operator.

Attributes

Returns: The result of applying op to all elements of this $coll, going left to right.
Throws: UnsupportedOperationException if this $coll is empty.
Inherited from:: IterableOnceOps
Source: IterableOnce.scala

If this $coll is nonempty, reduces it with the given binary operator op, going left to right.

The behavior is the same as reduceLeft except that the value is None if the $coll is empty. Each element appears exactly once in the computation.

Note: might return different results for different runs, unless the underlying collection type is ordered or the operator is associative and commutative.

Note: will not terminate for infinite-sized collections.

Type parameters

B: The result type of the binary operator, a supertype of A.

Value parameters

op: A binary operator.

Attributes

Returns: The result of reducing this $coll with op going left to right if the $coll is nonempty, inside a Some, and None otherwise.
Inherited from:: IterableOnceOps
Source: IterableOnce.scala

If this $coll is nonempty, reduces it with the given binary operator op.

The behavior is the same as reduce except that the value is None if the $coll is empty. The order of applications of the operator is unspecified and may be nondeterministic. Each element appears exactly once in the computation.

Note: might return different results for different runs, unless either of the following conditions is met: (1) the operator is associative, and the underlying collection type is ordered; or (2) the operator is associative and commutative.

Note: will not terminate for infinite-sized collections.

Type parameters

B: A type parameter for the binary operator, a supertype of A.

Value parameters

op: A binary operator; must be associative for the result to always be the same across runs.

Attributes

Returns: The result of reducing this $coll with op if the $coll is nonempty, inside a Some, and None otherwise.
Inherited from:: IterableOnceOps
Source: IterableOnce.scala

Applies the given binary operator op to all elements of this $coll, going right to left.

"Going right to left" only makes sense if this collection is ordered: then if x1, x2, ..., xn are the elements of this $coll, the result is op(x1, op(x2, op( ... op(xn-1, xn) ... ))).

If this collection is not ordered, then for each application of the operator, each left operand is an element. In addition, the rightmost operand is the last element of this $coll and each other right operand is itself an application of the operator. Each element appears exactly once in the computation.

Note: might return different results for different runs, unless the underlying collection type is ordered or the operator is associative and commutative.

Note: will not terminate for infinite-sized collections.

Type parameters

B: The result type of the binary operator, a supertype of A.

Value parameters

op: A binary operator.

Attributes

Returns: The result of applying op to all elements of this $coll, going right to left.
Throws: UnsupportedOperationException if this $coll is empty.
Inherited from:: IterableOnceOps
Source: IterableOnce.scala

If this $coll is nonempty, reduces it with the given binary operator op, going right to left.

The behavior is the same as reduceRight except that the value is None if the $coll is empty. Each element appears exactly once in the computation.

Note: might return different results for different runs, unless the underlying collection type is ordered or the operator is associative and commutative.

Note: will not terminate for infinite-sized collections.

Type parameters

B: The result type of the binary operator, a supertype of A.

Value parameters

op: A binary operator.

Attributes

Returns: The result of reducing this $coll with op going right to left if the $coll is nonempty, inside a Some, and None otherwise.
Inherited from:: IterableOnceOps
Source: IterableOnce.scala

Attributes

Inherited from:: IterableOnceOps
Source: IterableOnce.scala

Checks whether corresponding elements of the given iterable collection compare equal (with respect to ==) to elements of this iterator.

Type parameters

B: the type of the elements of collection that.

Value parameters

that: the collection to compare

Attributes

Returns: true if both collections contain equal elements in the same order, false otherwise.
Inherited from:: Iterator
Source: Iterator.scala

Produces a iterator containing cumulative results of applying the operator going left to right, including the initial value.

Note: will not terminate for infinite-sized collections.

Note: might return different results for different runs, unless the underlying collection type is ordered.

Type parameters

B: the type of the elements in the resulting collection

Value parameters

op: the binary operator applied to the intermediate result and the element
z: the initial value

Attributes

Returns: collection with intermediate results
Inherited from:: Iterator
Source: Iterator.scala

The size of this $coll.

Note: will not terminate for infinite-sized collections.

Attributes

Returns: the number of elements in this $coll.
Inherited from:: IterableOnceOps
Source: IterableOnce.scala

Selects an interval of elements.

Selects an interval of elements. The returned iterator is made up of all elements x which satisfy the invariant:

from <= indexOf(x) < until

Note: might return different results for different runs, unless the underlying collection type is ordered.

Value parameters

from: the lowest index to include from this iterator.
until: the lowest index to EXCLUDE from this iterator.

Attributes

Returns: a iterator containing the elements greater than or equal to index from extending up to (but not including) index until of this iterator.
Inherited from:: Iterator
Source: Iterator.scala

Returns an iterator which presents a "sliding window" view of this iterator.

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 returned GroupedIterator can be configured to either pad a partial result to size size or suppress the partial result entirely.

Example usages:

// Returns List(ArraySeq(1, 2, 3), ArraySeq(2, 3, 4), ArraySeq(3, 4, 5))
(1 to 5).iterator.sliding(3).toList
// Returns List(ArraySeq(1, 2, 3, 4), ArraySeq(4, 5))
(1 to 5).iterator.sliding(4, 3).toList
// Returns List(ArraySeq(1, 2, 3, 4))
(1 to 5).iterator.sliding(4, 3).withPartial(false).toList
// Returns List(ArraySeq(1, 2, 3, 4), ArraySeq(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

Value parameters

size: the number of elements per group
step: the distance between the first elements of successive groups

Attributes

Returns: A GroupedIterator producing Seq[B]s of size size, except the last element (which may be the only element) will be truncated if there are fewer than size elements remaining to be grouped. This behavior can be configured.
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.
Inherited from:: Iterator
Source: Iterator.scala

Splits this iterator 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.

Note: might return different results for different runs, unless the underlying collection type is ordered.

Attributes

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.
Inherited from:: Iterator
Source: Iterator.scala

Splits this $coll into a prefix/suffix pair at a given position.

Note: c splitAt n is equivalent to (but possibly more efficient than) (c take n, c drop n).

Note: might return different results for different runs, unless the underlying collection type is ordered.

Value parameters

n: the position at which to split.

Attributes

Returns: a pair of ${coll}s consisting of the first n elements of this $coll, and the other elements.
Inherited from:: IterableOnceOps
Source: IterableOnce.scala

Returns a scala.collection.Stepper for the elements of this collection.

The Stepper enables creating a Java stream to operate on the collection, see scala.jdk.StreamConverters. For collections holding primitive values, the Stepper can be used as an iterator which doesn't box the elements.

The implicit scala.collection.StepperShape parameter defines the resulting Stepper type according to the element type of this collection.

For collections of Int, Short, Byte or Char, an scala.collection.IntStepper is returned
For collections of Double or Float, a scala.collection.DoubleStepper is returned
For collections of Long a scala.collection.LongStepper is returned
For any other element type, an scala.collection.AnyStepper is returned

Note that this method is overridden in subclasses and the return type is refined to S with EfficientSplit, for example scala.collection.IndexedSeqOps.stepper. For Steppers marked with scala.collection.Stepper.EfficientSplit, the converters in scala.jdk.StreamConverters allow creating parallel streams, whereas bare Steppers can be converted only to sequential streams.

Attributes

Inherited from:: IterableOnce
Source: IterableOnce.scala

Sums the elements of this collection.

The default implementation uses reduce for a known non-empty collection, foldLeft otherwise.

Note: will not terminate for infinite-sized collections.

Type parameters

B: the result type of the + operator.

Value parameters

num: an implicit parameter defining a set of numeric operations which includes the + operator to be used in forming the sum.

Attributes

Returns: the sum of all elements of this $coll with respect to the + operator in num.
Inherited from:: IterableOnceOps
Source: IterableOnce.scala

Selects the first n elements.

Note: might return different results for different runs, unless the underlying collection type is ordered.

Value parameters

n: the number of elements to take from this iterator.

Attributes

Returns: a iterator consisting only of the first n elements of this iterator, or else the whole iterator, if it has less than n elements. If n is negative, returns an empty iterator.
Inherited from:: Iterator
Source: Iterator.scala

Selects the longest prefix of elements that satisfy a predicate.

The matching prefix starts with the first element of this iterator, and the element following the prefix is the first element that does not satisfy the predicate. The matching prefix may empty, so that this method returns an empty iterator.

Example:

scala> List(1, 2, 3, 100, 4).takeWhile(n => n < 10)
val res0: List[Int] = List(1, 2, 3)

scala> List(1, 2, 3, 100, 4).takeWhile(n => n == 0)
val res1: List[Int] = List()

Use span to obtain both the prefix and suffix. Use filter to retain only those elements from the entire iterator that satisfy the predicate.

Note: might return different results for different runs, unless the underlying collection type is ordered.

Value parameters

p: The predicate used to test elements.

Attributes

Returns: the longest prefix of this iterator whose elements all satisfy the predicate p.
Inherited from:: Iterator
Source: Iterator.scala

Applies a side-effecting function to each element in this collection.

Applies a side-effecting function to each element in this collection. Strict collections will apply f to their elements immediately, while lazy collections like Views and LazyLists will only apply f on each element if and when that element is evaluated, and each time that element is evaluated.

Type parameters

U: the return type of f

Value parameters

f: a function to apply to each element in this iterator

Attributes

Returns: The same logical collection as this
Definition Classes: Iterator -> IterableOnceOps
Inherited from:: Iterator
Source: Iterator.scala

Given a collection factory factory, converts this $coll to the appropriate representation for the current element type A.

Given a collection factory factory, converts this $coll to the appropriate representation for the current element type A. Example uses:

xs.to(List)
xs.to(ArrayBuffer)
xs.to(BitSet) // for xs: Iterable[Int]

Attributes

Inherited from:: IterableOnceOps
Source: IterableOnce.scala

Converts this $coll to an Array.

Implementation note: DO NOT call Array.from from this method.

Type parameters

B: The type of elements of the result, a supertype of A.

Attributes

Returns: This $coll as an Array[B].
Inherited from:: IterableOnceOps
Source: IterableOnce.scala

Converts this $coll to a Buffer.

Type parameters

B: The type of elements of the result, a supertype of A.

Attributes

Returns: This $coll as a Buffer[B].
Inherited from:: IterableOnceOps
Source: IterableOnce.scala

Converts this $coll to an IndexedSeq.

Attributes

Returns: This $coll as an IndexedSeq[A].
Inherited from:: IterableOnceOps
Source: IterableOnce.scala

Converts this $coll to a List.

Attributes

Returns: This $coll as a List[A].
Inherited from:: IterableOnceOps
Source: IterableOnce.scala

Converts this $coll to a Map, given an implicit coercion from the $coll's type to a key-value tuple.

Type parameters

K: The key type for the resulting map.
V: The value type for the resulting map.

Value parameters

ev: An implicit coercion from A to [K, V].

Attributes

Returns: This $coll as a Map[K, V].
Inherited from:: IterableOnceOps
Source: IterableOnce.scala

Attributes

Returns: This $coll as a Seq[A]. This is equivalent to to(Seq) but might be faster.
Inherited from:: IterableOnceOps
Source: IterableOnce.scala

Converts this $coll to a Set.

Type parameters

B: The type of elements of the result, a supertype of A.

Attributes

Returns: This $coll as a Set[B].
Inherited from:: IterableOnceOps
Source: IterableOnce.scala

Converts this iterator to a string.

Attributes

Returns: "<iterator>"
Note: Reuse: The iterator remains valid for further use whatever result is returned.
Definition Classes: Iterator -> Any
Inherited from:: Iterator
Source: Iterator.scala

Converts this $coll to a Vector.

Attributes

Returns: This $coll as a Vector[A].
Inherited from:: IterableOnceOps
Source: IterableOnce.scala

Creates an iterator over all the elements of this iterator that satisfy the predicate p.

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.

Value parameters

p: the predicate used to test values.

Attributes

Returns: an iterator which produces those values of this iterator which satisfy the predicate p.
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.
Inherited from:: Iterator
Source: Iterator.scala

Attributes

Inherited from:: Iterator
Source: Iterator.scala

Attributes

Inherited from:: Iterator
Source: Iterator.scala

Zips this iterator with its indices.

Attributes

Returns: A new iterator containing pairs consisting of all elements of this iterator paired with their index. Indices start at 0.
Example: List("a", "b", "c").zipWithIndex == List(("a", 0), ("b", 1), ("c", 2))
Inherited from:: Iterator
Source: Iterator.scala

LineIterator

Attributes

Members list

Type members

Inherited classlikes

Attributes

Value members

Concrete methods

Attributes

Attributes

Attributes

Attributes

Inherited methods

Attributes

Value parameters

Attributes

Value parameters

Attributes

Value parameters

Attributes

Attributes

Type parameters

Value parameters

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Type parameters

Value parameters

Attributes

Type parameters

Value parameters

Attributes

Type parameters

Value parameters

Attributes

Type parameters

Value parameters

Attributes

Value parameters

Attributes

Attributes

Type parameters

Value parameters

Attributes

Value parameters

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Value parameters

Attributes

Value parameters

Attributes

Value parameters

Attributes

Type parameters

Value parameters

Attributes

Type parameters

Value parameters

Attributes

Type parameters

Value parameters

Attributes

Type parameters

Value parameters

Attributes

Type parameters

Value parameters

Attributes

Value parameters

Attributes

Attributes

Attributes

Value parameters