Spec-Zone.ru › Scala 3.2

Класс Source.LineIterator

Исходный код

class LineIterator 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

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

Source
class GroupedIterator[B >: A](self: Iterator[B], size: Int, step: Int) extends AbstractIterator[Seq[B]]

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

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

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

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

Source
def getc(): Boolean

Source
def hasNext: Boolean

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

Возвращает

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

Примечание

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

Source
def isNewline(ch: Char): Boolean

Source
def next(): String

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

Возвращает

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

Исключения
NoSuchElementException

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

Примечание

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

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

Source
final def ++[B >: String](xs: => IterableOnce[B]): Iterator[B]

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

Source
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

Source
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

Source
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

Source
def buffered: BufferedIterator[A]

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

Возвращает

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

См. также

scala.collection.BufferedIterator

Примечание

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

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

Source
def collect[B](pf: PartialFunction[String, B]): Iterator[B]

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

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

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

Параметры
pf

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

Возвращает

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

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

Source
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

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

Возвращает

значение опции, содержащей первый элемент в коллекции, удовлетворяющий 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 для Iterables и false для Iterators, если не переопределено.

Возвращает

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 к каждому элементу этого итератора и сбора результатов.

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

Исходный код
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

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

Возвращает

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

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

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

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

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

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

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

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

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

Возвращает

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

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

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

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

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

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

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

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

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

Возвращает

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

Исключения
UnsupportedOperationException

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

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

Источник
def minBy[B](f: String => B)(implicit cmp: Ordering[B]): A

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

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

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

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

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

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

f

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

Возвращает

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

Исключения
UnsupportedOperationException

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

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

Источник
def minByOption[B](f: String => B)(implicit cmp: Ordering[B]): Option[A]

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

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

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

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

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

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

f

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

Возвращает

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

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

Источник
def minOption[B >: String](implicit ord: Ordering[B]): Option[A]

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

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

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

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

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

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

Возвращает

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

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

Источник
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() в опцию.

Возвращает

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

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

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

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

предикат, по которому производится разделение

Возвращает

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

Примечание

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

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

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

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

Применяет бинарный оператор ко всем элементам этого набора данных слева направо (по умолчанию).

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

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

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

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

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

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

Возвращает

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

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

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

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

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

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

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

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

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

Возвращает

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

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

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

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

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

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

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

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

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

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

Возвращает

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

Исключения
UnsupportedOperationException

если этот набор данных пустой.

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

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

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

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

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

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

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

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

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

Возвращает

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

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

Source
protected def reversed: Iterable[A]

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

Source
def sameElements[B >: String](that: IterableOnce[B]): Boolean

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

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

тип элементов коллекции that.

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

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

Возвращает

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

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

Source
def scanLeft[B](z: B)(op: (B, String) => B): Iterator[B]

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

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

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

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

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

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

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

z

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

Возвращает

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

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

Source
def size: Int

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

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

Возвращает

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

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

Source
def slice(from: Int, until: Int): Iterator[A]

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

from <= indexOf(x) < until

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

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

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

until

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

Возвращает

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

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

Source
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]ы размера 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 к своим элементам, в то время как ленивые коллекции, такие как представления и LazyList, применяют 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]: Array[B]

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

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

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

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

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

Источник
def toIndexedSeq: IndexedSeq[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 >: String]: Множество[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 >: String, 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))

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

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

Источник
lazy val iter: БуферизованныйИтератор[Символ]

© 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/Source$LineIterator.html

Spec-Zone.ru

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