Spec-Zone.ru › Scala 3.2

Класс BufferedSource.BufferedLineIterator

Исходный код

class BufferedLineIterator extends AbstractIterator[String] with Iterator[String]

Супертипы
class AbstractIterator[String]
trait Iterator[String]
trait IterableOnceOps[String, Iterator, Iterator[String]]
trait IterableOnce[String]
class Object
trait Matchable
class Any

Наследуемые классы

Исходный код
class GroupedIterator[B >: A](self: Iterator[B], size: Int, step: Int) extends AbstractIterator[Seq[B]]

Гибкий итератор для преобразования Iterator[A] в Iterator[Seq[A]], с настраиваемым размером последовательности, шагом и стратегией обработки элементов, которые не помещаются в последовательность равномерно.

Типичные использования можно достичь с помощью методов grouped и sliding.

Наследован от Iterator

Конкретные методы

Исходный код
override def hasNext: Boolean

Проверка наличия следующего элемента.

Возвращает

true если следующий элемент есть, false в противном случае

Примечание

Переиспользование: Итератор остается допустимым для дальнейшего использования независимо от возвращаемого результата.

Классы определения Iterator

Исходный код
override def next(): String

Возвращение следующего элемента и продвижение итератора.

Возвращает

следующий элемент.

Исключения
NoSuchElementException

если следующего элемента нет.

Примечание

Переиспользование: Продвигает итератор, что может исчерпать элементы. Допустимо выполнять дополнительные вызовы итератора.

Классы определения Iterator

Наследуемые методы

Исходный код
final def ++[B >: String](xs: => IterableOnce[B]): Iterator[B]

Наследован от Iterator

Исходный код
final def addString(b: StringBuilder): StringBuilder

Добавление всех элементов этой коллекции в строковый буфер. Записываемый текст состоит из строковых представлений (согласно методу toString) всех элементов этой коллекции без разделителя.

Пример:

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

строковый буфер, в который добавляются элементы.

Возвращает

строковый буфер b, в который были добавлены элементы.

Наследован от IterableOnceOps

Исходный код
final def addString(b: StringBuilder, sep: String): StringBuilder

Добавление всех элементов этой коллекции в строковый буфер с разделителем. Записываемый текст состоит из строковых представлений (согласно методу toString) всех элементов этой коллекции, разделенных строкой sep.

Пример:

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

строковый буфер, в который добавляются элементы.

sep

строка-разделитель.

Возвращает

строковый буфер b, в который были добавлены элементы.

Наследован от IterableOnceOps

Исходный код
def addString(b: StringBuilder, start: String, sep: String, end: String): StringBuilder

Добавление всех элементов этой коллекции в строковый буфер с начальной, конечной и разделительными строками. Записываемый текст начинается со строки start и заканчивается строкой end. Внутри строковые представления (согласно методу toString) всех элементов этой коллекции разделены строкой sep.

Пример:

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

строковый буфер, в который добавляются элементы.

end

конечная строка.

sep

строка-разделитель.

start

начальная строка.

Возвращает

строковый буфер b, в который были добавлены элементы.

Наследован от IterableOnceOps

Исходный код
def buffered: BufferedIterator[A]

Создание буферизованного итератора из этого итератора.

Возвращает

буферизованный итератор, производящий те же значения, что и этот итератор.

См. также

scala.collection.BufferedIterator

Примечание

Переиспользование: После вызова этого метода следует удалить итератор, на котором он был вызван, и использовать только возвращенный итератор. Использование старого итератора не определено, может измениться и может привести к изменениям в новом итераторе также.

Наследован от Iterator

Исходный код
def collect[B](pf: PartialFunction[String, B]): Iterator[B]

Построение нового итератора путем применения частичной функции ко всем элементам этого итератора, для которых функция определена.

Параметры типа
B

тип элемента возвращаемого итератора.

Параметры значения
pf

частичная функция, которая фильтрует и отображает итератор.

Возвращает

новый итератор, полученный в результате применения данной частичной функции pf к каждому элементу, для которого она определена, и сбора результатов. Порядок элементов сохраняется.

Наследован от Iterator

Исходный код
def collectFirst[B](pf: PartialFunction[String, B]): Option[B]

Поиск первого элемента в коллекции, для которого заданная частичная функция определена, и применение частичной функции к нему.

Примечание: может не завершиться для коллекций бесконечного размера.

Примечание: может возвращать разные результаты для разных запусков, если тип базовой коллекции не упорядочен.

Параметры значения
pf

частичная функция

Возвращает

значение типа Option, содержащее результат применения pf к первому значению, для которого оно определено, или None, если такого значения нет.

Пример

Seq("a", 1, 5L).collectFirst({ case x: Int => x*10 }) = Some(10)

Унаследовано от IterableOnceOps

Исходный код
def concat[B >: String](xs: => IterableOnce[B]): Iterator[B]

Унаследовано от Iterator

Исходный код
def contains(elem: Any): Boolean

Проверяет, содержит ли этот итератор заданное значение в качестве элемента.

Примечание: может не завершиться для бесконечных итераторов.

Параметры значения
elem

тестируемый элемент.

Возвращает

true если этот итератор генерирует некоторое значение, которое равно (как определяется ==) значению elem, false в противном случае.

Примечание

Повторное использование: после вызова этого метода итератор, на котором он был вызван, следует удалить. Использование его не определено и может измениться.

Унаследовано от Iterator

Исходный код
def copyToArray[B >: String](xs: Array[B], start: Int, len: Int): Int

Копирует элементы в массив, возвращая количество скопированных элементов.

Заполняет заданный массив xs начиная с индекса start не более чем len элементами из этого набора.

Копирование завершается, когда скопированы все элементы этого набора, или достигнут конец массива, или len элементов были скопированы.

Параметры типа
B

тип элементов массива.

Параметры значения
len

максимальное количество элементов для копирования.

start

начальный индекс xs.

xs

массив для заполнения.

Возвращает

количество элементов, записанных в массив

Примечание

Повторное использование: после вызова этого метода итератор, на котором он был вызван, следует удалить. Использование его не определено и может измениться.

Унаследовано от IterableOnceOps

Исходный код
def copyToArray[B >: String](xs: Array[B], start: Int): Int

Копирует элементы в массив, возвращая количество скопированных элементов.

Заполняет заданный массив xs начиная с индекса start значениями из этого набора.

Копирование завершается, когда скопированы все элементы этого набора, или достигнут конец массива.

Параметры типа
B

тип элементов массива.

Параметры значения
start

начальный индекс xs.

xs

массив для заполнения.

Возвращает

количество элементов, записанных в массив

Примечание

Повторное использование: после вызова этого метода итератор, на котором он был вызван, следует удалить. Использование его не определено и может измениться.

Унаследовано от IterableOnceOps

Исходный код
def copyToArray[B >: String](xs: Array[B]): Int

Копирует элементы в массив, возвращая количество скопированных элементов.

Заполняет заданный массив xs начиная с индекса start значениями из этого набора.

Копирование прекратится, как только будут скопированы все элементы этого набора или будет достигнут конец массива.

Параметры типа
B

тип элементов массива.

Параметры значения
xs

массив для заполнения.

Возвращает

количество элементов, записанных в массив

Примечание

Повторное использование: после вызова этого метода итератор, на котором он был вызван, следует отбросить. Его использование неопределено и может измениться.

Унаследовано от IterableOnceOps

Источник
def corresponds[B](that: IterableOnce[B])(p: (String, B) => Boolean): Boolean

Проверяет, соответствует ли каждый элемент итератора этого набора соответствующему элементу другого набора, удовлетворяя предикату проверки.

Примечание: не завершится для коллекций бесконечного размера.

Параметры типа
B

тип элементов that

Параметры значения
p

предикат проверки, связывающий элементы обеих коллекций

that

другая коллекция

Возвращает

true если обе коллекции имеют одинаковую длину и p(x, y) равно true для всех соответствующих элементов x этого итератора и y that, в противном случае false

Унаследовано от IterableOnceOps

Источник
def count(p: String => Boolean): Int

Подсчитывает количество элементов в коллекции, удовлетворяющих предикату.

Примечание: не завершится для коллекций бесконечного размера.

Параметры значения
p

предикат, используемый для проверки элементов.

Возвращает

количество элементов, удовлетворяющих предикату p.

Унаследовано от IterableOnceOps

Источник
def distinct: Iterator[A]

Создает новый итератор из этого, не содержащий дублирующихся элементов.

Возвращает

итератор с уникальными элементами

Примечание

Повторное использование: после вызова этого метода итератор, на котором он был вызван, следует отбросить. Его использование неопределено и может измениться.

Унаследовано от Iterator

Источник
def distinctBy[B](f: String => B): Iterator[A]

Создаёт новый итератор из этого, не содержащий дублирующихся элементов, как определено == после применения преобразования функции f.

Параметры типа
B

тип элементов после преобразования функцией f

Параметры значения
f

Функция преобразования, результат которой используется для определения уникальности каждого элемента

Возвращает

итератор с уникальными элементами

Примечание

Повторное использование: после вызова этого метода итератор, на котором он был вызван, следует отбросить. Его использование неопределено и может измениться.

Унаследовано от Iterator

Источник
def drop(n: Int): Iterator[A]

Выбирает все элементы, кроме первых n.

Примечание: может возвращать разные результаты для разных запусков, если тип базовой коллекции не упорядочен.

Параметры значения
n

количество элементов, которые нужно удалить из этого итератора.

Возвращает

итератор, состоящий из всех элементов этого итератора, кроме первых n элементов, или же пустой итератор, если у этого итератора меньше, чем n элементов. Если n отрицательно, то элементы не удаляются.

Унаследовано от Iterator

Источник
def dropWhile(p: String => Boolean): Iterator[A]

Удаляет наибольший префикс элементов, удовлетворяющих предикату.

Примечание: может возвращать разные результаты при разных запусках, если тип базовой коллекции не упорядочен.

Параметры значения
p

Предикат, используемый для проверки элементов.

Возвращает

наибольший суффикс этого итератора, первый элемент которого не удовлетворяет предикату p.

Унаследовано от Iterator

Источник
def duplicate: (Iterator[A], Iterator[A])

Создаёт два новых итератора, которые оба перебирают те же элементы, что и этот итератор (в том же порядке). Дублирующие итераторы считаются равными, если они находятся на одном и том же элементе.

Поскольку большинство методов для итераторов сделают исходный итератор непригодным для дальнейшего использования, этот метод предоставляет надёжный способ вызова нескольких таких методов для итератора.

Возвращает

пару итераторов

Примечание

Реализация может выделять временное хранилище для элементов, перебираемых одним итератором, но ещё не перебираемых другим.

Переиспользование: После вызова этого метода следует удалить итератор, на котором был вызван метод, и использовать только возвращённые итераторы. Использование старого итератора не определено, может измениться и может привести к изменениям в новых итераторах тоже.

Унаследовано от Iterator

Источник
def exists(p: String => Boolean): Boolean

Проверяет, выполняется ли предикат хотя бы для одного элемента этой коллекции.

Примечание: может не завершиться для коллекций бесконечного размера.

Параметры значения
p

предикат, используемый для проверки элементов.

Возвращает

true если заданный предикат p удовлетворяется хотя бы одним элементом этой коллекции, в противном случае false

Унаследовано от IterableOnceOps

Источник
def filter(p: String => Boolean): Iterator[A]

Выбирает все элементы этого итератора, которые удовлетворяют предикату.

Параметры значения
p

предикат, используемый для проверки элементов.

Возвращает

новый итератор, состоящий из всех элементов этого итератора, которые удовлетворяют заданному предикату p. Порядок элементов сохраняется.

Унаследовано от Iterator

Источник
def filterNot(p: String => Boolean): Iterator[A]

Выбирает все элементы этого итератора, которые не удовлетворяют предикату.

Параметры значения
pred

предикат, используемый для проверки элементов.

Возвращает

новый итератор, содержащий все элементы этого итератора, которые не удовлетворяют заданному предикату pred. Порядок их может не сохраняться.

Унаследовано от Iterator

Источник
def find(p: String => Boolean): Option[A]

Находит первый элемент коллекции, удовлетворяющий предикату, если такой существует.

Примечание: может не завершиться для коллекций бесконечного размера.

Примечание: может возвращать разные результаты при разных запусках, если тип базовой коллекции упорядочен.

Параметры значения
p

предикат, используемый для проверки элементов.

Возвращает

значение типа option, содержащее первый элемент в коллекции, который удовлетворяет p, или None если он не существует.

Унаследовано от IterableOnceOps

Источник
def flatMap[B](f: String => IterableOnce[B]): Iterator[B]

Строит новый итератор, применяя функцию ко всем элементам этого итератора и используя элементы полученных коллекций.

Например:

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

Тип результирующей коллекции определяется статическим типом итератора. Это может иногда приводить к неожиданным результатам. Например:

// 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: String) => 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)
Параметры типа
B

тип элемента возвращаемой коллекции.

Параметры значения
f

функция, которая применяется к каждому элементу.

Возвращает

новый итератор, полученный путём применения заданной функции, принимающей коллекцию f к каждому элементу этого итератора и конкатенации результатов.

Унаследовано от Iterator

Источник
def flatten[B](implicit ev: String => IterableOnce[B]): Iterator[B]

Преобразует этот итератор коллекций в итератор, образованный элементами этих коллекций.

Тип результирующей коллекции определяется типом итератора. Например:

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)
Параметры типа
B

тип элементов каждой коллекции.

Параметры значения
asIterable

явное преобразование, которое утверждает, что тип элемента этого итератора является GenTraversable.

Возвращает

новый итератор, полученный путём конкатенации всех итераторов элементов.

Унаследовано от Iterator

Источник
def fold[A1 >: String](z: A1)(op: (A1, A1) => A1): A1

Выполняет сжатие элементов этой коллекции с помощью заданного ассоциативного бинарного оператора. Реализация по умолчанию в IterableOnce эквивалентна foldLeft, но может быть переопределена для более эффективного порядка обхода.

Порядок выполнения операций над элементами не определён и может быть не детерминированным.

Примечание: не завершится для коллекций бесконечного размера.

Параметры типа
A1

параметр типа для бинарного оператора, супертип A.

Параметры значения
op

бинарный оператор, который должен быть ассоциативным.

z

нейтральный элемент для операции сжатия; может быть добавлен к результату любое количество раз, и не должен изменять результат (например, Nil для конкатенации списков, 0 для сложения или 1 для умножения).

Возвращает

результат применения оператора сжатия op между всеми элементами и z, или z если эта коллекция пуста.

Унаследовано от IterableOnceOps

Источник
def foldLeft[B](z: B)(op: (B, String) => B): B

Применяет бинарный оператор к начальному значению и всем элементам этого набора, слева направо.

Примечание: не будет завершаться для наборов бесконечной длины.

Примечание: может возвращать разные результаты при разных запусках, если тип базового набора не упорядочен или оператор не является ассоциативным и коммутативным.

Параметры типа
B

тип результата бинарного оператора.

Параметры значения
op

бинарный оператор.

z

начальное значение.

Возвращает

результат вставки op между последовательными элементами этого набора слева направо с начальным значением z слева: op(...op(z, x1), x2, ..., xn) где x1, ..., xn — элементы этого набора. Возвращает z , если этот набор пустой.

Унаследовано от IterableOnceOps

Источник
def foldRight[B](z: B)(op: (String, B) => B): B

Применяет бинарный оператор ко всем элементам этого набора и начальному значению, справа налево.

Примечание: не будет завершаться для наборов бесконечной длины.

Примечание: может возвращать разные результаты при разных запусках, если тип базового набора не упорядочен или оператор не является ассоциативным и коммутативным.

Параметры типа
B

тип результата бинарного оператора.

Параметры значения
op

бинарный оператор.

z

начальное значение.

Возвращает

результат вставки op между последовательными элементами этого набора справа налево с начальным значением z справа: op(x1, op(x2, ... op(xn, z)...)) где x1, ..., xn — элементы этого набора. Возвращает z , если этот набор пустой.

Унаследовано от IterableOnceOps

Источник
def forall(p: String => Boolean): Boolean

Проверяет, выполняется ли предикат для всех элементов этого набора.

Примечание: может не завершаться для наборов бесконечной длины.

Параметры значения
p

предикат, используемый для проверки элементов.

Возвращает

true , если этот набор пустой или указанный предикат p выполняется для всех элементов этого набора, в противном случае false.

Унаследовано от IterableOnceOps

Источник
def foreach[U](f: String => U): Unit

Применяет f к каждому элементу для побочных эффектов. Примечание: параметр [U] необходим для помощи в выводе типов scalac.

Унаследовано от IterableOnceOps

Источник
def grouped[B >: String](size: Int): GroupedIterator[B]

Возвращает итератор, который группирует этот итератор в блоки фиксированного размера. Примеры использования:

// 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
Примечание

Переиспользование: После вызова этого метода следует удалить итератор, на котором он был вызван, и использовать только возвращенный итератор. Использование старого итератора неопределено, может быть изменено и может привести к изменениям в новом итераторе.

Унаследовано от Iterator

Источник
def indexOf[B >: String](elem: B, from: Int): Int

Возвращает индекс первого вхождения указанного объекта в этом итерируемом объекте после или на некотором начальном индексе.

Примечание: может не завершаться для бесконечных итераторов.

Параметры значения
elem

элемент для поиска.

from

начальный индекс

Возвращает

индекс >= from первого вхождения elem в значениях, генерируемых этим итератором, или -1, если такой элемент не существует до тех пор, пока не будет достигнут конец итератора.

Примечание

Переиспользование: После вызова этого метода следует удалить итератор, на котором он был вызван. Использование его неопределенно и может быть изменено.

Унаследовано от Iterator

Источник
def indexOf[B >: String](elem: B): Int

Возвращает индекс первого вхождения указанного объекта в этом итерируемом объекте.

Примечание: может не завершаться для бесконечных итераторов.

Параметры значения
elem

элемент для поиска.

Возвращает

индекс первого вхождения elem в значениях, генерируемых этим итератором, или -1, если такой элемент не существует до тех пор, пока не будет достигнут конец итератора.

Примечание

Переиспользование: После вызова этого метода следует удалить итератор, на котором он был вызван. Использование его неопределенно и может быть изменено.

Унаследовано от Iterator

Источник
def indexWhere(p: String => Boolean, from: Int): Int

Унаследовано от Iterator

Источник
override def isEmpty: Boolean

Проверяет, пуст ли итератор.

Примечание: Реализации в подклассах, которые не являются многократно проходимыми, должны следить за тем, чтобы не потреблять элементы, когда isEmpty вызывается.

Возвращает

true , если итератор не содержит элементов, false в противном случае.

Классы определений Iterator -> IterableOnceOps
Унаследовано от Iterator

Источник
def isTraversableAgain: Boolean

Проверяет, можно ли многократно пройти по этому набору. Всегда true для наборов и false для итераторов, если не переопределено.

Возвращает

true , если можно многократно пройти, false в противном случае.

Унаследовано от IterableOnceOps

Источник
final def iterator: Iterator[A]

Итератор может быть использован только один раз

Унаследовано от Iterator

Источник
def knownSize: Int

Возвращает

Количество элементов в этом наборе, если его можно легко вычислить, в противном случае -1. Легко обычно означает: Не требуется обход набора.

Унаследовано от IterableOnce

Источник
final def length: Int

Наследуется от Iterator

Исходный код
def map[B](f: String => B): Iterator[B]

Создаёт новый итератор, применяя функцию ко всем элементам этого итератора.

Параметры типа
B

Тип элементов возвращаемого итератора.

Параметры значения
f

Функция, которая применяется к каждому элементу.

Возвращает

новый итератор, полученный путём применения заданной функции f к каждому элементу этого итератора и сбора результатов.

Наследуется от Iterator

Исходный код
def max[B >: String](implicit ord: Ordering[B]): A

Находит наибольший элемент.

Примечание: не завершится для коллекций бесконечного размера.

Параметры типа
B

Тип, над которым определено упорядочение.

Параметры значения
ord

Упорядочение, используемое для сравнения элементов.

Возвращает

наибольший элемент этой коллекции по отношению к упорядочению ord.

Исключения
UnsupportedOperationException

если эта коллекция пуста.

Наследуется от IterableOnceOps

Исходный код
def maxBy[B](f: String => B)(implicit cmp: Ordering[B]): A

Находит первый элемент, который даёт наибольшее значение, измеренное функцией f.

Примечание: не завершится для коллекций бесконечного размера.

Параметры типа
B

Тип результата функции f.

Параметры значения
cmp

Упорядочение, используемое для сравнения элементов.

f

Функция измерения.

Возвращает

первый элемент этой коллекции с наибольшим значением, измеренным функцией f по отношению к упорядочению cmp.

Исключения
UnsupportedOperationException

если эта коллекция пуста.

Наследуется от IterableOnceOps

Исходный код
def maxByOption[B](f: String => B)(implicit cmp: Ordering[B]): Option[A]

Находит первый элемент, который даёт наибольшее значение, измеренное функцией f.

Примечание: не завершится для коллекций бесконечного размера.

Параметры типа
B

Тип результата функции f.

Параметры значения
cmp

Упорядочение, используемое для сравнения элементов.

f

Функция измерения.

Возвращает

значение Option, содержащее первый элемент этой коллекции с наибольшим значением, измеренным функцией f по отношению к упорядочению cmp.

Наследуется от IterableOnceOps

Исходный код
def maxOption[B >: String](implicit ord: Ordering[B]): Option[A]

Находит наибольший элемент.

Примечание: не завершится для коллекций бесконечного размера.

Параметры типа
B

Тип, над которым определено упорядочение.

Параметры значения
ord

Упорядочение, используемое для сравнения элементов.

Возвращает

значение Option, содержащее наибольший элемент этой коллекции по отношению к упорядочению ord.

Наследуется от IterableOnceOps

Source
def min[B >: String](implicit ord: Ordering[B]): A

Находит наименьший элемент.

Примечание: не будет завершаться для коллекций бесконечного размера.

Параметры типа
B

Тип, по которому определяется упорядочение.

Параметры значения
ord

Упорядочение, используемое для сравнения элементов.

Возвращает

наименьший элемент этой коллекции относительно упорядочения ord.

Исключение
UnsupportedOperationException

если эта коллекция пустая.

Унаследовано от IterableOnceOps

Source
def minBy[B](f: String => B)(implicit cmp: Ordering[B]): A

Находит первый элемент, который возвращает наименьшее значение, измеренное функцией f.

Примечание: не будет завершаться для коллекций бесконечного размера.

Параметры типа
B

Тип результата функции f.

Параметры значения
cmp

Упорядочение, используемое для сравнения элементов.

f

Функция измерения.

Возвращает

первый элемент этой коллекции с наименьшим значением, измеренным функцией f, относительно упорядочения cmp.

Исключение
UnsupportedOperationException

если эта коллекция пустая.

Унаследовано от IterableOnceOps

Source
def minByOption[B](f: String => B)(implicit cmp: Ordering[B]): Option[A]

Находит первый элемент, который возвращает наименьшее значение, измеренное функцией f.

Примечание: не будет завершаться для коллекций бесконечного размера.

Параметры типа
B

Тип результата функции f.

Параметры значения
cmp

Упорядочение, используемое для сравнения элементов.

f

Функция измерения.

Возвращает

значение Option, содержащее первый элемент этой коллекции с наименьшим значением, измеренным функцией f, относительно упорядочения cmp.

Унаследовано от IterableOnceOps

Source
def minOption[B >: String](implicit ord: Ordering[B]): Option[A]

Находит наименьший элемент.

Примечание: не будет завершаться для коллекций бесконечного размера.

Параметры типа
B

Тип, по которому определяется упорядочение.

Параметры значения
ord

Упорядочение, используемое для сравнения элементов.

Возвращает

значение Option, содержащее наименьший элемент этой коллекции относительно упорядочения ord.

Унаследовано от IterableOnceOps

Source
final def mkString: String

Отображает все элементы этой коллекции в строке.

Делегирует addString, который может быть переопределён.

Возвращает

строковое представление этого набора. В результирующей строке строковые представления (с учётом метода toString) всех элементов этого набора следуют друг за другом без разделителя.

Унаследовано от IterableOnceOps

Источник
final def mkString(sep: String): String

Отображает все элементы этого набора в строке с использованием разделителя.

Делегирует addString, который может быть переопределён.

Параметры значения
sep

разделитель.

Возвращает

строковое представление этого набора. В результирующей строке строковые представления (с учётом метода toString) всех элементов этого набора разделены строкой sep.

Пример

List(1, 2, 3).mkString("|") = "1|2|3"

Унаследовано от IterableOnceOps

Источник
final def mkString(start: String, sep: String, end: String): String

Отображает все элементы этого набора в строке с использованием начальной, конечной и разделительных строк.

Делегирует addString, который может быть переопределён.

Параметры значения
end

конечная строка.

sep

разделитель.

start

начальная строка.

Возвращает

строковое представление этого набора. Результирующая строка начинается со строки start и заканчивается строкой end. Внутри строковые представления (с учётом метода toString) всех элементов этого набора разделены строкой sep.

Пример

List(1, 2, 3).mkString("(", "; ", ")") = "(1; 2; 3)"

Унаследовано от IterableOnceOps

Источник
def nextOption(): Option[A]

Оборачивает значение next() в объект Option.

Возвращает

Some(next) если следующий элемент существует, None в противном случае.

Унаследовано от Iterator

Источник
def nonEmpty: Boolean

Проверяет, не пуст ли набор.

Возвращает

true если набор содержит по крайней мере один элемент, false в противном случае.

Унаследовано от IterableOnceOps

Источник
def padTo[B >: String](len: Int, elem: B): Iterator[B]

Копия этого итератора с добавленным значением элемента до тех пор, пока не будет достигнута заданная длина.

Параметры типа
B

тип элемента возвращаемого итератора.

Параметры значения
elem

значение заполнения

len

целевая длина

Возвращает

новый итератор, состоящий из всех элементов этого итератора, за которым следует минимальное количество повторений elem, таким образом, чтобы результирующий набор имел длину как минимум len.

Унаследовано от Iterator

Source
def partition(p: String => Boolean): (Iterator[A], Iterator[A])

Разделяет этот итератор на два итератора в соответствии с предикатом.

Параметры значения
p

предикат для разделения

Возвращаемое значение

пара итераторов: итератор, удовлетворяющий предикату p , и итератор, который не удовлетворяет. Относительный порядок элементов в результирующих итераторах совпадает с порядком в исходном итераторе.

Примечание

Переиспользование: после вызова этого метода следует удалить вызвавший его итератор и использовать только возвращённые итераторы. Использование старого итератора является неопределённым, может быть изменено и может привести к изменениям в новых итераторах тоже.

Унаследовано от Iterator

Source
def patch[B >: String](from: Int, patchElems: Iterator[B], replaced: Int): Iterator[B]

Возвращает этот итератор с изменёнными значениями.

Замена по отрицательным индексам эквивалентна замене, начинающейся с 0. Замена по индексам, равным или большим длины исходного итератора, добавляет вставка в конец. Если заменяемых значений больше, чем фактически существует, избыток игнорируется.

Параметры значения
from

Начальный индекс для замены

patchElems

Итератор значений вставки

replaced

Количество значений в исходном итераторе, которые заменяются вставкой.

Примечание

Переиспользование: после вызова этого метода следует удалить вызвавший его итератор, а также переданный в качестве параметра, и использовать только возвращённый итератор. Использование старых итераторов неопределённо, может быть изменено и может привести к изменениям в новом итераторе тоже.

Унаследовано от Iterator

Source
def product[B >: String](implicit num: Numeric[B]): B

Перемножает элементы этого набора.

Примечание: не завершит работу для наборов бесконечной размерности.

Параметры типа
B

тип результата операции *.

Параметры значения
num

явный параметр, определяющий набор арифметических операций, включающий операцию *, используемую при формировании произведения.

Возвращаемое значение

произведение всех элементов этого набора по отношению к операции * в num.

Унаследовано от IterableOnceOps

Source
def reduce[B >: String](op: (B, B) => B): B

Сводит элементы этого набора, используя указанную ассоциативную бинарную операцию.

Порядок выполнения операций над элементами не определён и может быть не детерминированным.

Параметры типа
B

Параметр типа для бинарной операции, надтипом A.

Параметры значения
op

Бинарная операция, которая должна быть ассоциативной.

Возвращаемое значение

Результат применения оператора reduce op между всеми элементами, если набор не пустой.

Исключения
UnsupportedOperationException

если набор пустой.

Унаследовано от IterableOnceOps

Source
def reduceLeft[B >: String](op: (B, String) => B): B

Применяет бинарную операцию ко всем элементам этого набора слева направо.

Примечание: не завершит работу для наборов бесконечной размерности.

Примечание: может возвращать разные результаты для разных запусков, если тип базового набора не упорядочен или оператор не является ассоциативным и коммутативным.

Тип параметров
B

тип результата бинарного оператора.

Параметры значений
op

бинарный оператор.

Возвращает

результат вставки op между последовательными элементами этого набора, слева направо: op( op( ... op(x1, x2) ..., xn-1), xn) где x1, ..., xn — это элементы этого набора.

Выбрасывает
UnsupportedOperationException

если этот набор пуст.

Унаследовано от IterableOnceOps

Источник
def reduceLeftOption[B >: String](op: (B, String) => B): Option[B]

Применяет бинарный оператор ко всем элементам этого набора, слева направо.

Примечание: не будет завершаться для наборов бесконечного размера.

Примечание: может возвращать разные результаты при разных запусках, если тип базового набора не упорядочен или оператор не ассоциативен и коммутативен.

Тип параметров
B

тип результата бинарного оператора.

Параметры значений
op

бинарный оператор.

Возвращает

значение Option, содержащее результат reduceLeft(op) если этот набор не пустой, None в противном случае.

Унаследовано от IterableOnceOps

Источник
def reduceOption[B >: String](op: (B, B) => B): Option[B]

Редуцирует элементы этого набора, если таковые имеются, с использованием указанного ассоциативного бинарного оператора.

Порядок выполнения операций над элементами не определен и может быть не детерминированным.

Тип параметров
B

тип параметра бинарного оператора, супертип A.

Параметры значений
op

Бинарный оператор, который должен быть ассоциативным.

Возвращает

Значение Option, содержащее результат применения оператора reduce op между всеми элементами, если набор не пустой, и None в противном случае.

Унаследовано от IterableOnceOps

Источник
def reduceRight[B >: String](op: (String, B) => B): B

Применяет бинарный оператор ко всем элементам этого набора, справа налево.

Примечание: не будет завершаться для наборов бесконечного размера.

Примечание: может возвращать разные результаты при разных запусках, если тип базового набора упорядочен или оператор ассоциативен и коммутативен.

Тип параметров
B

тип результата бинарного оператора.

Параметры значений
op

бинарный оператор.

Возвращает

результат вставки op между последовательными элементами этого набора, справа налево: op(x1, op(x2, ..., op(xn-1, xn)...)) где x1, ..., xn — это элементы этого набора.

Выбрасывает
UnsupportedOperationException

если этот набор пуст.

Унаследовано от IterableOnceOps

Источник
def reduceRightOption[B >: String](op: (String, B) => B): Option[B]

Возвращает необязательное значение результата применения бинарного оператора к элементам этого набора, справа налево.

Примечание: не будет завершаться для наборов бесконечного размера.

Примечание: может возвращать разные результаты при разных запусках, если тип базового набора упорядочен или оператор ассоциативен и коммутативен.

Тип параметров
B

тип результата бинарного оператора.

Параметры значений
op

бинарный оператор.

Возвращает

значение Option, содержащее результат reduceRight(op) если этот набор не пустой, None в противном случае.

Унаследовано от IterableOnceOps

Источник
protected def reversed: Iterable[A]

Унаследовано от IterableOnceOps

Источник
def sameElements[B >: String](that: IterableOnce[B]): Boolean

Проверяет, сравниваются ли соответствующие элементы данного набора-коллекции равны (относительно ==) элементам этого итератора.

Тип параметров
B

тип элементов набора that.

Параметры значений
that

набор для сравнения

Возвращает

true если оба набора содержат равные элементы в том же порядке, false в противном случае. <invalid inheritdoc annotation>

Унаследовано от Iterator

Источник
def scanLeft[B](z: B)(op: (B, String) => B): Iterator[B]

Создает итератор, содержащий кумулятивные результаты применения оператора слева направо, включая начальное значение.

Примечание: не будет завершаться для наборов бесконечного размера.

Примечание: может возвращать разные результаты при разных запусках, если тип базового набора упорядочен.

Тип параметров
B

тип элементов в результирующем наборе

Параметры значений
op

бинарный оператор, применяемый к промежуточному результату и элементу

z

начальное значение

Возвращает

набор с промежуточными результатами

Унаследовано от Iterator

Источник
def size: Int

Размер этого набора.

Примечание: не будет завершаться для наборов бесконечного размера.

Возвращает

количество элементов в этом наборе.

Унаследовано от IterableOnceOps

Источник
def slice(from: Int, until: Int): Iterator[A]

Выбирает интервал элементов. Возвращаемый итератор состоит из всех элементов x, которые удовлетворяют инварианту:

from <= indexOf(x) < until

Примечание: может возвращать разные результаты при разных запусках, если тип базового набора упорядочен.

Параметры значений
from

наименьший индекс для включения из этого итератора.

until

наименьший индекс для ИСКЛЮЧЕНИЯ из этого итератора.

Возвращает

итератор, содержащий элементы, большие или равные индексу from и простирающиеся до (но не включая) индекса until этого итератора.

Унаследовано от Iterator

Источник
def sliding[B >: String](size: Int, step: Int): GroupedIterator[B]

Возвращает итератор, представляющий вид «скользящего окна» этой итерации. Первый аргумент — размер окна, а второй аргумент step — на сколько позиций продвигать окно на каждой итерации. Аргумент step по умолчанию равен 1.

Возвращённый GroupedIterator может быть настроен на заполнение частичного результата до размера size или на полное подавление частичного результата.

Примеры использования:

// 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
Параметры значения
size

количество элементов в группе

step

расстояние между первыми элементами последовательных групп

Возвращает

A GroupedIterator , генерирующий Seq[B]s размера size, за исключением последнего элемента (который может быть единственным элементом), который будет усечен, если оставшихся элементов меньше, чем size . Это поведение может быть настроено.

Примечание

Переиспользование: После вызова этого метода нужно удалить итератор, на котором он был вызван, и использовать только возвращённый итератор. Использование старого итератора не определено, может быть изменено и может привести к изменениям в новом итераторе также.

Унаследовано от Iterator

Исходный код
def span(p: String => Boolean): (Iterator[A], Iterator[A])

Разделяет эту итерацию на пару префикс/суффикс в соответствии с предикатом.

Примечание: c span p эквивалентно (но, возможно, более эффективно, чем) (c takeWhile p, c dropWhile p), при условии, что вычисление предиката p не вызывает побочных эффектов.

Примечание: может возвращать разные результаты при разных запусках, если тип базового набора не упорядочен.

Примечание

Переиспользование: После вызова этого метода нужно удалить итератор, на котором он был вызван, и использовать только возвращённые итераторы. Использование старого итератора не определено, может быть изменено и может привести к изменениям в новых итераторах также.

Унаследовано от Iterator

Исходный код
def splitAt(n: Int): (C, C)

Разделяет эту коллекцию на пару префикс/суффикс в заданной позиции.

Примечание: c splitAt n эквивалентно (но, возможно, более эффективно, чем) (c take n, c drop n).

Примечание: может возвращать разные результаты при разных запусках, если тип базового набора не упорядочен.

Параметры значения
n

позиция, в которой нужно разделить.

Возвращает

пара коллекций, состоящая из первых n элементов этой коллекции и остальных элементов.

Унаследовано от IterableOnceOps

Исходный код
def stepper[S <: Stepper[_]](implicit shape: StepperShape[String, S]): S

Возвращает scala.collection.Stepper для элементов этой коллекции.

Stepper позволяет создавать Java-поток для работы с коллекцией, см. scala.jdk.StreamConverters. Для коллекций, содержащих примитивные значения, Stepper может использоваться как итератор, который не упаковывает элементы.

Неявный параметр scala.collection.StepperShape определяет тип возвращаемого Stepper в соответствии с типом элемента этой коллекции.

  • Для коллекций Int, Short, Byte или Char, возвращается scala.collection.IntStepper

  • Для коллекций Double или Float, возвращается scala.collection.DoubleStepper

  • Для коллекций Long возвращается scala.collection.LongStepper

  • Для всех остальных типов элементов возвращается scala.collection.AnyStepper

Обратите внимание, что этот метод переопределён в подклассах, а тип возвращаемого значения уточняется до S with EfficientSplit, например scala.collection.IndexedSeqOps.stepper. Для Stepper, помеченных scala.collection.Stepper.EfficientSplit, конвертеры в scala.jdk.StreamConverters позволяют создавать параллельные потоки, в то время как обычные Stepper могут быть преобразованы только в последовательные потоки.

Унаследовано от IterableOnce

Исходный код
def sum[B >: String](implicit num: Numeric[B]): B

Суммирует элементы этой коллекции.

Примечание: не завершится для коллекций бесконечного размера.

Параметры типа
B

тип результата оператора +.

Параметры значения
num

неявный параметр, определяющий набор арифметических операций, который включает оператор + для использования при формировании суммы.

Возвращает

сумма всех элементов этой коллекции относительно оператора + в num.

Унаследовано от IterableOnceOps

Исходный код
def take(n: Int): Iterator[A]

Выбирает первые n элементов.

Примечание: может возвращать разные результаты при разных запусках, если тип базового набора не упорядочен.

Параметры значения
n

количество элементов для взятия из этой итерации.

Возвращает

итератор, состоящий только из первых n элементов этой итерации, или же вся итерация, если в ней меньше n элементов. Если n отрицательно, возвращает пустой итератор.

Унаследовано от Iterator

Исходный код
def takeWhile(p: String => Boolean): Iterator[A]

Взятие самого длинного префикса элементов, удовлетворяющих предикату.

Примечание: может возвращать разные результаты при разных запусках, если тип базового набора не упорядочен.

Параметры значения
p

Предикат для проверки элементов.

Возвращает

наибольший префикс этой итерации, чьи элементы удовлетворяют предикату p.

Унаследовано от Iterator

Исходный код
override def tapEach[U](f: String => U): Iterator[A]

Применяет функцию побочного эффекта к каждому элементу в этой коллекции. Строгие коллекции немедленно применяют f к своим элементам, в то время как ленивые коллекции, такие как Views и LazyLists, будут применять f только к каждому элементу, когда он будет оцениваться, и каждый раз, когда этот элемент оценивается.

Параметры типа
U

тип возвращаемого значения f

Параметры значения
f

функция, которая применяется к каждому элементу в этой итерации

Возвращает

Такая же логическая коллекция, что и эта

Классы определений Iterator -> IterableOnceOps
Унаследовано от Iterator

Исходный код
def to[C1](factory: Factory[String, C1]): C1

При заданном фабричном методе коллекции factory, преобразовать эту коллекцию в соответствующее представление для текущего типа элемента A. Примеры использования:

xs.to(List) xs.to(ArrayBuffer) xs.to(BitSet) // для xs: Iterable[Int]

Унаследовано от IterableOnceOps

Источник
def toArray[B >: String : ClassTag]: Массив[B]

Преобразовать коллекцию в массив.

Примечание реализации: НЕ вызывать Array.from из этого метода.

Унаследовано от IterableOnceOps

Источник
final def toBuffer[B >: String]: Буфер[B]

Унаследовано от IterableOnceOps

Источник
def toIndexedSeq: Индексированная последовательность[A]

Унаследовано от IterableOnceOps

Источник
def toList: Список[A]

Унаследовано от IterableOnceOps

Источник
def toMap[K, V](implicit ev: String <:< (K, V)): Карта[K, V]

Унаследовано от IterableOnceOps

Источник
def toSeq: Последовательность[A]

Возвращает

Эта коллекция как Seq[A]. Это эквивалентно to(Seq), но может быть быстрее.

Унаследовано от IterableOnceOps

Источник
def toSet[B >: Строка]: Множество[B]

Унаследовано от IterableOnceOps

Источник
override def toString: String

Преобразует этот итератор в строку.

Возвращает

"<iterator>"

Примечание

Повторное использование: итератор остается действительным для дальнейшего использования независимо от возвращаемого результата.

Классы определений Итератор -> Любой
Унаследовано от Итератор

Источник
def toVector: Вектор[A]

Унаследовано от IterableOnceOps

Источник
def withFilter(p: String => Boolean): Итератор[A]

Создает итератор по всем элементам этого итератора, удовлетворяющим предикату p. Порядок элементов сохраняется.

Примечание: withFilter эквивалентно filter для итераторов. Она существует для того, чтобы выражения for с фильтрами работали над итераторами.

Параметры значений
p

предикат для проверки значений.

Возвращает

итератор, который производит те значения этого итератора, которые удовлетворяют предикату p.

Примечание

Повторное использование: после вызова этого метода нужно удалить итератор, на котором он был вызван, и использовать только возвращенный итератор. Использование старого итератора не определено, может измениться и может привести к изменениям в новом итераторе.

Унаследовано от Итератор

Источник
def zip[B](that: IterableOnce[B]): Итератор[(A, B)]

Унаследовано от Итератор

Источник
def zipAll[A1 >: Строка, B](that: IterableOnce[B], thisElem: A1, thatElem: B): Итератор[(A1, B)]

Унаследовано от Итератор

Источник
def zipWithIndex: Итератор[(A, Целое число)]

Объединяет этот итератор со своими индексами.

Возвращает

Новый итератор, содержащий пары, состоящие из всех элементов этого итератора, соединенных с их индексом. Индексы начинаются с 0.

Пример

List("a", "b", "c").zipWithIndex == List(("a", 0), ("b", 1), ("c", 2))

Унаследовано от Итератор

Конкретные поля

Источник
var nextLine: Строка

© 2002-2022 EPFL, with contributions from Lightbend.
Licensed under the Apache License, Version 2.0.
https://scala-lang.org/api/3.2.0/scala/io/BufferedSource$BufferedLineIterator.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API