Spec-Zone.ru › Scala 3.2

Object Stream.Empty

Исходный код

object Empty extends Stream[Nothing]

Суператрибуты
25 типов
class Stream[Nothing]
trait Serializable
trait LinearSeq[Nothing]
trait LinearSeqOps[Nothing, Stream, Stream[Nothing]]
trait LinearSeq[Nothing]
trait LinearSeqOps[Nothing, Stream, Stream[Nothing]]
class AbstractSeq[Nothing]
trait Seq[Nothing]
trait SeqOps[Nothing, Stream, Stream[Nothing]]
trait Iterable[Nothing]
class AbstractSeq[Nothing]
trait Seq[Nothing]
trait Equals
trait SeqOps[Nothing, Stream, Stream[Nothing]]
trait PartialFunction[Int, Nothing]
trait Int => Nothing
class AbstractIterable[Nothing]
trait Iterable[Nothing]
trait IterableFactoryDefaults[Nothing, Stream]
trait IterableOps[Nothing, Stream, Stream[Nothing]]
trait IterableOnceOps[Nothing, Stream, Stream[Nothing]]
trait IterableOnce[Nothing]
class Object
trait Matchable
class Any
Тип "self"
Empty.type

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

Исходный код
def force: Empty.type.this.type

Вызывает оценку всего Stream и возвращает его.

Возвращает

Полностью реализованное Stream.

Примечание

Часто мы используем Stream для представления бесконечного множества или ряда. Если это относится к вашему конкретному Stream, то эта функция никогда не вернётся и, вероятно, аварийно завершит работу виртуальной машины с исключением OutOfMemory. Однако эта функция не будет зависать при конечном цикле.

Исходный код
override def head: Nothing

Выбирает первый элемент этой неизменяемой коллекции.

Возвращает

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

Исключения
NoSuchElementException

если неизменяемая коллекция пуста.

Определяющие классы LinearSeqOps -> IterableOps

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

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

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

Возвращает

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

Определяющие классы LinearSeqOps -> SeqOps -> IterableOnceOps

Исходный код
override def knownSize: Int

Возвращает

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

Определяющие классы IterableOnce

Исходный код
override def tail: Stream[Nothing]

Остаток коллекции без её первого элемента.

Определяющие классы Stream -> LinearSeqOps -> IterableOps

Наследованные методы

Исходный код
final def ++[B](suffix: IterableOnce[B]): CC[B]

Псевдоним для concat

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

Исходный код
final override def ++:[B](prefix: IterableOnce[B]): CC[B]

Псевдоним для prependedAll

Определяющие классы SeqOps -> IterableOps
Унаследованно от SeqOps

Исходный код
final def +:[B](elem: B): CC[B]

Псевдоним для prepended.

Обратите внимание, что операторы с окончанием :- являются правоассоциативными (см. пример). Мемоническое для +: против :+ - двоеточие ставится со стороны коллекции.

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

Исходный код
final def :+[B](elem: B): CC[B]

Псевдоним для appended.

Обратите внимание, что операторы с окончанием :- являются правоассоциативными (см. пример). Мемоническое для +: против :+ - двоеточие ставится со стороны коллекции.

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

Исходный код
final def :++[B](suffix: IterableOnce[B]): CC[B]

Псевдоним для appendedAll

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

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

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

Неопределённые элементы представлены "_", неопределённый хвост представлен "<not computed>", а циклы - "<cycle>".

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

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

sb

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

sep

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

start

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

Возвращает

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

Определяющие классы Stream -> IterableOnceOps
Унаследовано от Stream

Источник
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 andThen[C](k: PartialFunction[Nothing, C]): PartialFunction[A, C]

Компонует данную частичную функцию с другой частичной функцией, которая применяется к результатам данной частичной функции.

Обратите внимание, что вызов isDefinedAt для полученной частичной функции может применить первую частичную функцию и выполнить её побочное действие. Для повышения эффективности рекомендуется вместо isDefinedAt или apply использовать applyOrElse.

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

тип результата функции преобразования.

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

функция преобразования

Возвращает

частичная функция с областью определения данной частичной функции, суженной другой частичной функцией, которая отображает аргументы x в k(this(x)).

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

Источник
override def andThen[C](k: Nothing => C): PartialFunction[A, C]

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

Если тип функции во время выполнения является PartialFunction, то используется другой метод andThen (обратите внимание на его предостережения).

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

тип результата функции преобразования.

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

функция преобразования

Возвращает

частичная функция с областью определения данной частичной функции, возможно, суженной указанной функцией, которая отображает аргументы x в k(this(x)).

Определяющие классы PartialFunction -> Function1
Унаследовано от PartialFunction

Источник
def appended[B](elem: B): CC[B]

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

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

Пример:

scala> val a = List(1)
a: List[Int] = List(1)

scala> val b = a :+ 2
b: List[Int] = List(1, 2)

scala> println(a)
List(1)
Параметры типа
B

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

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

добавляемый элемент

Возвращает

новый набор, состоящий из всех элементов этого набора, после которых идёт value.

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

Источник
def appendedAll[B](suffix: IterableOnce[B]): CC[B]

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

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

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

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

добавляемый итерируемый объект.

Возвращает

новая коллекция типа CC[B] , которая содержит все элементы этого набора, за которыми следуют все элементы suffix.

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

Источник
override def apply(n: Int): A

Получить элемент по указанному индексу. Эта операция предоставлена для удобства в Seq. Не следует предполагать её эффективность, если у вас нет IndexedSeq.

Определяющие классы LinearSeqOps -> SeqOps
Унаследовано от LinearSeqOps

Источник
def applyOrElse[A1 <: Int, B1](x: A1, default: A1 => B1): B1

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

Обратите внимание, что выражение pf.applyOrElse(x, default) эквивалентно

if(pf isDefinedAt x) pf(x) else default(x)

за исключением того, что метод applyOrElse может быть реализован более эффективно. Для всех частичных функций-литералов компилятор генерирует реализацию applyOrElse, которая избегает двойного вычисления согласований шаблонов и условий. Это делает applyOrElse основой для эффективной реализации во многих операциях и сценариях, таких как:

- объединение частичных функций в цепочки orElse/andThen не приводит к излишнему apply/isDefinedAt вычислению - lift и unlift не вычисляют исходные функции дважды при каждом вызове - runWith позволяет эффективно объединять частичные функции с условными действиями в императивном стиле

Для классов частичных функций, которые не являются литералами, и у которых метод isDefinedAt имеет сложность, рекомендуется переопределить applyOrElse со своей реализацией, которая избегает двойного isDefinedAt вычисления. Это может привести к лучшей производительности и более предсказуемому поведению с точки зрения побочных эффектов.

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

функция по умолчанию

x

аргумент функции

Возвращает

результат применения этой функции или функции по умолчанию.

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

Источник
def canEqual(that: Any): Boolean

Метод, который должен вызываться из каждой хорошо спроектированной функции equals, которая может быть переопределена в подклассе. См. Programming in Scala, Chapter 28 для обсуждения и проектирования.

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

значение, проверяемое на возможное равенство

Возвращает

true, если этот экземпляр может быть равен that, в противном случае false

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

Исходный код
final override def collect[B](pf: PartialFunction[Nothing, B]): Stream[B]

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

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

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

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

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

Возвращает

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

Классы-определения Stream -> IterableOps -> IterableOnceOps
Унаследовано от Stream

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

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

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

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

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

Возвращает

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

Пример

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

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

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

Итерируется по комбинациям. _Комбинация_ длины n — это подпоследовательность исходной последовательности, с элементами, взятыми в порядке следования. Таким образом, "xy" и "yy" являются комбинациями длины 2 последовательности "xyy", но "yx" таковой не является. Если существует более одного способа сгенерировать ту же подпоследовательность, будет возвращена только одна.

Например, "xyyy" имеет три способа сгенерировать "xy", в зависимости от того, какой первый, второй или третий "y" выбран. Однако, поскольку все они идентичны, будет выбран только один. Какой из трёх будет выбран — это деталь реализации, которая не определена.

Примечание: даже при применении к представлению или ленивой коллекции все элементы будут принудительно вычислены.

Возвращает

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

Пример

"abbbc".combinations(2) = Iterator(ab, ac, bb, bc)

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

Исходный код
def compose[R](k: PartialFunction[R, Int]): PartialFunction[R, B]

Компонует другую частичную функцию k с этой частичной функцией таким образом, что эта частичная функция применяется к результатам k.

Обратите внимание, что вызов isDefinedAt на результирующей частичной функции может применить первую частичную функцию и выполнить её побочное действие. Для повышения эффективности рекомендуется использовать applyOrElse вместо isDefinedAt или apply.

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

тип параметра функции преобразования.

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

функция преобразования

Возвращает

частичная функция с областью определения другой частичной функции, суженной этой частичной функцией, которая отображает аргументы x в this(k(x)).

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

Исходный код
def compose[A](g: A => Int): A => R

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

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

тип, к которому может быть применена функция g

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

функция A => T1

Возвращает

новая функция f такая, что f(x) == apply(g(x))

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

Исходный код
final override def concat[B](suffix: IterableOnce[B]): CC[B]

Возвращает новую последовательность, содержащую элементы из левого операнда, за которыми следуют элементы из правого операнда. Тип элемента последовательности — это самый общий суперкласс, охватывающий типы элементов двух операндов.

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

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

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

объединяемый обход.

Возвращает

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

Классы-предки SeqOps -> IterableOps
Унаследовано от SeqOps

Исходный код
override def contains[A1](elem: A1): Boolean

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

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

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

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

Возвращает

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

Классы-предки LinearSeqOps -> SeqOps
Унаследовано от LinearSeqOps

Исходный код
def containsSlice[B](that: Seq[B]): Boolean

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

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

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

последовательность для проверки

Возвращает

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

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

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

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

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

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

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

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

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

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

start

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

xs

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

Возвращает

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

Примечание

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

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

Источник
def copyToArray[B](xs: Array[B], start: Int): Int

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

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

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

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

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

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

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

xs

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

Возвращает

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

Примечание

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

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

Источник
def copyToArray[B](xs: Array[B]): Int

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

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

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

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

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

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

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

Возвращает

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

Примечание

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

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

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

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

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

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

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

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

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

that

другой набор

Возвращает

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

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

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

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

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

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

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

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

that

другая последовательность

Возвращает

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

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

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

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

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

class="attributes">
Параметры значения
p

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

Возвращает

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

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

Источник
def diff[B](that: Seq[B]): C

Вычисляет разность мультимножеств между этой последовательностью и другой последовательностью.

class="attributes">
Параметры значения
that

последовательность элементов для удаления

Возвращает

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

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

Источник
def distinct: C

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

class="attributes">
Возвращает

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

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

Источник
def distinctBy[B](f: Nothing => B): C

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

class="attributes">
Параметры типа
B

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

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

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

Возвращает

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

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

Источник
def drop(n: Int): C

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

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

class="attributes">
Параметры значения
n

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

Возвращает

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

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

Источник
def dropRight(n: Int): C

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

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

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

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

Возвращает

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

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

Источник
def dropWhile(p: Nothing => Boolean): C

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

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

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

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

Возвращает

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

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

Источник
def elementWise: ElementWiseExtractor[A, B]

Возвращает объект-экстрактор с методом unapplySeq, который извлекает каждый элемент данных последовательности.

Пример
val firstChar: String => Option[Char] = _.headOption
Seq("foo", "bar", "baz") match {
  case firstChar.unlift.elementWise(c0, c1, c2) =>
    println(s"$c0, $c1, $c2") // Output: f, b, b
}
Унаследовано от PartialFunction

Источник
override def empty: CC[A]

Пустой итерируемый набор того же типа, что и этот итерируемый набор

Возвращает

пустой итерируемый набор типа C.

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

Источник
def endsWith[B](that: Iterable[B]): Boolean

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

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

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

тестируемая последовательность

Возвращает

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

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

Источник
override def equals(o: Any): Boolean

Универсальный метод равенства, определенный в AnyRef.

Классы определений Seq -> Equals -> Any
Унаследовано от Seq

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

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

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

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

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

Возвращает

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

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

Источник
override def filter(pred: Nothing => Boolean): Stream[A]

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

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

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

Возвращает

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

Классы определения Stream -> IterableOps -> IterableOnceOps
Унаследовано от Stream

Источник
override def filterNot(pred: Nothing => Boolean): Stream[A]

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

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

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

Возвращает

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

Классы определения Stream -> IterableOps -> IterableOnceOps
Унаследовано от Stream

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

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

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

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

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

Возвращает

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

Классы определения Stream -> LinearSeqOps -> IterableOnceOps
Унаследовано от Stream

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

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

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

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

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

Возвращает

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

Классы определения LinearSeqOps -> SeqOps
Унаследовано от LinearSeqOps

Источник
final override def flatMap[B](f: Nothing => IterableOnce[B]): Stream[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, к каждому элементу этого неизменяемого набора и конкатенации результатов.

Определяющие классы Stream -> IterableOps -> IterableOnceOps
Унаследовано от Stream

Источник
def flatten[B](implicit asIterable: Nothing => IterableOnce[B]): CC[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.

Возвращает

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

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

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

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

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

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

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

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

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

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

z

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

Возвращает

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

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

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

Специализация Stream для foldLeft, которая позволяет сборщику мусора освобождать память по ходу.

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

Тип накапливаемого значения.

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

Операция, выполняемая над последовательными элементами Stream.

z

Начальное значение, подаваемое в функцию op.

Возвращает

Накопленное значение из последовательных применений op.

Определяющие классы Stream -> LinearSeqOps -> IterableOnceOps
Унаследовано от Stream

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

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

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

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

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

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

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

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

z

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

Возвращает

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

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

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

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

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

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

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

Возвращает

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

Определяющие классы LinearSeqOps -> IterableOnceOps
Унаследовано от LinearSeqOps

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

Применяет заданную функцию f к каждому элементу этой линейной последовательности (с соблюдением порядка элементов).

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

Обработка, применяемая к каждому элементу.

Примечание

Переопределён здесь как final для запуска оптимизации хвостовой рекурсии, которая заменяет 'this' на 'tail' на каждой итерации. Это абсолютно необходимо для того, чтобы сборщик мусора мог собирать базовый Stream по мере потребления элементов.

Эта функция заставит реализовать весь Stream, если f не выбросит исключение.

Определяющие классы Stream -> LinearSeqOps -> IterableOnceOps
Унаследовано от Stream

Источник
protected def fromSpecific(coll: IterableOnce[Nothing]): CC[A]

Определяет, как преобразовать заданный Iterable[A] в набор типа C.

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

Примечание

При реализации пользовательского типа набора и уточнении C до нового типа этот метод необходимо переопределить (в противном случае компилятор выдаст ошибку). В обычном случае C =:= CC[A], это можно сделать, смешав в себе trait scala.collection.IterableFactoryDefaults, который реализует метод с использованием iterableFactory.

Как показывает аннотация @uncheckedVariance, использование этого метода может быть небезопасным. Однако, при условии, что он вызывается с Iterable[A], полученным от this набора (как это происходит в реализациях операций, где мы используем View[A] набор), он безопасен.

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

Источник
def groupBy[K](f: Nothing => K): Map[K, C]

Разделяет этот итерируемый набор на карту итерируемых наборов в соответствии с некоторой функцией-дискриминатором.

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

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

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

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

функция-дискриминатор.

Возвращает

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

(xs groupBy f)(k) = xs filter (x => f(x) == k)

То есть, каждый ключ k сопоставлен итерируемой коллекции тех элементов x для которых f(x) равно k.

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

Источник
def groupMap[K, B](key: Nothing => K)(f: Nothing => B): Map[K, CC[B]]

Разделяет эту итерируемую коллекцию на словарь итерируемых коллекций в соответствии с функцией-дискриминатором key. Каждый элемент в группе преобразуется в значение типа B с использованием функции value.

Это эквивалентно groupBy(key).mapValues(_.map(f)), но более эффективно.

case class User(name: String, age: Int)

def namesByAge(users: Seq[User]): Map[Int, Seq[String]] =
  users.groupMap(_.age)(_.name)

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

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

тип значений, возвращаемых функцией преобразования

K

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

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

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

key

функция-дискриминатор

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

Источник
def groupMapReduce[K, B](key: Nothing => K)(f: Nothing => B)(reduce: (B, B) => B): Map[K, B]

Разделяет эту итерируемую коллекцию на словарь в соответствии с функцией-дискриминатором key. Все значения, имеющие одинаковый дискриминатор, затем преобразуются функцией f и затем сводятся к одному значению с помощью функции reduce.

Это эквивалентно groupBy(key).mapValues(_.map(f).reduce(reduce)), но более эффективно.

def occurrences[A](as: Seq[A]): Map[A, Int] =
  as.groupMapReduce(identity)(_ => 1)(_ + _)

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

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

Источник
def grouped(size: Int): Iterator[C]

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

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

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

Возвращает

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

См. также

scala.collection.Iterator, метод grouped

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

Источник
override def hashCode(): Int

Вычисляет значение хэш-кода для объекта.

Алгоритм хэширования по умолчанию зависит от платформы.

Обратите внимание, что для двух объектов допускается одинаковый хэш-код (o1.hashCode.equals(o2.hashCode)) но они могут не быть равны (o1.equals(o2) возвращает false). Вырожденная реализация может всегда возвращать 0. Однако, требуется, чтобы если два объекта равны (o1.equals(o2) возвращает true) у них были одинаковые хэш-коды (o1.hashCode.equals(o2.hashCode)). Поэтому при переопределении этого метода убедитесь, что поведение согласуется с методом equals.

Возвращает

значение хэш-кода для этого объекта.

Классы-определения Seq -> Any
Унаследовано от Seq

Источник
override def headOption: Option[A]

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

Возвращает

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

Классы-определения LinearSeqOps -> IterableOps
Унаследовано от LinearSeqOps

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

Находит индекс первого вхождения значения в этой последовательности.

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

тип элемента elem.

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

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

Возвращает

индекс >= 0 первого элемента этой последовательности, который равен (как определено ==) элементу elem, или -1, если такой элемент отсутствует.

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

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

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

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

тип элемента elem.

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

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

from

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

Возвращает

индекс >= from первого элемента этой последовательности, который равен (как определено ==) элементу elem, или -1, если такой элемент отсутствует.

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

Источник
def indexOfSlice[B](that: Seq[B]): Int

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

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

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

последовательность для проверки

Возвращает

первый индекс >= 0 такой, что элементы этой последовательности, начиная с этого индекса, соответствуют элементам последовательности that, или -1 если такой подпоследовательности не существует.

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

Источник
def indexOfSlice[B](that: Seq[B], from: Int): Int

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

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

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

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

that

последовательность для проверки

Возвращает

первый индекс >= from такой, что элементы этой последовательности, начиная с этого индекса, соответствуют элементам последовательности that, или -1 если такой подпоследовательности не существует.

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

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

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

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

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

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

p

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

Возвращает

индекс >= from первого элемента этой последовательности, удовлетворяющего предикату p, или -1, если такового нет.

Определяющие классы LinearSeqOps -> SeqOps
Унаследовано от LinearSeqOps

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

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

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

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

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

Возвращает

индекс >= 0 первого элемента этой последовательности, удовлетворяющего предикату p, или -1, если такового нет.

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

Источник
def indices: Range

Создает диапазон всех индексов этой последовательности.

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

Возвращает

значение Range от 0 до значения, на единицу меньшего, чем длина этой последовательности.

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

Источник
def init: C

Начальная часть коллекции без последнего элемента.

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

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

Источник
def inits: Iterator[C]

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

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

Возвращает

итератор по всем начальным частям этой итерируемой коллекции

Пример

List(1,2,3).inits = Iterator(List(1,2,3), List(1,2), List(1), Nil)

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

Источник
def intersect[B](that: Seq[B]): C

Вычисляет пересечение множеств между этой последовательностью и другой последовательностью.

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

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

Возвращает

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

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

Источник
override def isDefinedAt(x: Int): Boolean

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

Реализации методов apply и isDefinedAt преобразуют Seq[A] в PartialFunction[Int, A].

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

индекс для проверки

Возвращает

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

Определяющие классы LinearSeqOps -> SeqOps
Унаследовано от LinearSeqOps

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

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

Возвращает

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

Определяющие классы IterableOps -> IterableOnceOps
Унаследовано от IterableOps

Источник
override def iterableFactory: SeqFactory[Stream]

Объект-компаньон этой неизменяемой коллекции, предоставляющий различные методы фабрики.

Примечание

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

Определяющие классы Stream -> LinearSeq -> LinearSeq -> Seq -> Iterable -> Seq -> Iterable -> IterableOps
Унаследовано от Stream

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

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

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

Источник
override def last: A

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

Возвращает

Последний элемент этой последовательности.

Исключения
NoSuchElementException

Если последовательность пуста.

Определяющие классы LinearSeqOps -> IterableOps
Унаследовано от LinearSeqOps

Источник
def lastIndexOf[B](elem: B, end: Int): Int

Находит индекс последнего вхождения некоторого значения в этой последовательности до или в заданном конечном индексе.

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

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

тип элемента elem.

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

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

end

конечный индекс.

Возвращает

индекс <= end последнего элемента этой последовательности, который равен (как определено ==) elem, или -1, если такового нет.

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

Источник
def lastIndexOfSlice[B](that: Seq[B]): Int

Находит последний индекс, где эта последовательность содержит заданную последовательность как срез.

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

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

последовательность для проверки

Возвращает

последний индекс, такой что элементы этой последовательности, начиная с этого индекса, совпадают с элементами последовательности that, или -1 в случае отсутствия такой подпоследовательности.

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

Source
def lastIndexOfSlice[B](that: Seq[B], end: Int): Int

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

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

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

индекс окончания

that

последовательность для проверки

Возвращает

последний индекс <= end, такой что элементы этой последовательности, начиная с этого индекса, соответствуют элементам последовательности that, или -1, если такая подпоследовательность не существует.

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

Source
override def lastIndexWhere(p: Nothing => Boolean, end: Int): Int

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

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

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

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

Возвращает

индекс <= end последнего элемента этой последовательности, удовлетворяющего предикату p, или -1, если таковой не существует.

Классы определения LinearSeqOps -> SeqOps
Унаследовано от LinearSeqOps

Source
def lastIndexWhere(p: Nothing => Boolean): Int

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

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

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

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

Возвращает

индекс последнего элемента этой последовательности, удовлетворяющего предикату p, или -1, если таковой не существует.

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

Source
def lastOption: Option[A]

Возвращает необязательный последний элемент.

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

Возвращает

последний элемент этой итерируемой коллекции, если она не пуста, None если она пуста.

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

Source
def lazyAppendedAll[B](suffix: => IterableOnce[B]): Stream[B]

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

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

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

Возвращает

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

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

Source
def lazyZip[B](that: Iterable[B]): LazyZip2[A, B, Iterable]

Аналогично zip, за исключением того, что элементы в каждой коллекции не потребляются до тех пор, пока над возвращенным LazyZip2 декоратором не вызывается строгое действие.

Вызовы lazyZip могут быть сцеплены для поддержки более высоких арностей (до 4) без затрат на построение и разбор промежуточных кортежей.

val xs = List(1, 2, 3)
val res = (xs lazyZip xs lazyZip xs lazyZip xs).map((a, b, c, d) => a + b + c + d)
// res == List(4, 8, 12)
Параметры типа
B

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

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

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

Возвращает

декоратор LazyZip2, который позволяет выполнять строгие операции над лениво вычисляемыми парами или сцепленными вызовами lazyZip. Поддерживается также неявное преобразование в Iterable[(A, B)].

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

Source
def length: Int

Длина (количество элементов) последовательности. size является псевдонимом для length в коллекциях Seq.

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

Source
override def lengthCompare(that: Iterable[_]): Int

Сравнивает длину этой последовательности с размером другого Iterable.

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

объект Iterable, размер которого сравнивается с длиной этой последовательности.

Возвращает

Значение x, где

x <  0       if this.length <  that.size
x == 0       if this.length == that.size
x >  0       if this.length >  that.size

Метод, реализованный здесь, не вызывает length или size напрямую; его время выполнения составляет O(this.length min that.size) вместо O(this.length + that.size). Метод следует переопределить, если вычисление size является недорогим и knownSize возвращает -1.

Классы определения LinearSeqOps -> SeqOps
Унаследовано от LinearSeqOps

Source
override def lengthCompare(len: Int): Int

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

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

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

Возвращает

Значение x, где

x <  0       if this.length <  len
x == 0       if this.length == len
x >  0       if this.length >  len

Метод, реализованный здесь, не вызывает length напрямую; его время выполнения составляет O(length min len) вместо O(length). Метод следует переопределить, если вычисление length является недорогим и knownSize возвращает -1.

См. также

lengthIs

Классы определения LinearSeqOps -> SeqOps
Унаследовано от LinearSeqOps

Source
final def lengthIs: SizeCompareOps

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

Эти операции реализованы с помощью lengthCompare(Int) и позволяют использовать более удобочитаемые выражения:

this.lengthIs < len     // this.lengthCompare(len) < 0
this.lengthIs <= len    // this.lengthCompare(len) <= 0
this.lengthIs == len    // this.lengthCompare(len) == 0
this.lengthIs != len    // this.lengthCompare(len) != 0
this.lengthIs >= len    // this.lengthCompare(len) >= 0
this.lengthIs > len     // this.lengthCompare(len) > 0
Унаследовано от SeqOps

Source
def lift: A => Option[B]

Преобразует эту частичную функцию в обычную функцию, возвращающую результат Option.

Возвращает

функцию, которая принимает аргумент x, чтобы Some(this(x)) если this определен для x, и None в противном случае.

См. также

Function.unlift

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

Source
final override def map[B](f: Nothing => B): Stream[B]

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

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

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

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

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

Возвращает

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

Определяющие классы Stream -> IterableOps -> IterableOnceOps
Унаследовано от Stream

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

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

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

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

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

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

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

Возвращает

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

Исключения
UnsupportedOperationException

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

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

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

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

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

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

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

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

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

f

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

Возвращает

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

Исключения
UnsupportedOperationException

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

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

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

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

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

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

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

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

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

f

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

Возвращает

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

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

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

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

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

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

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

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

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

Возвращает

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

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

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

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

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

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

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

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

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

Возвращает

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

Исключения
UnsupportedOperationException

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

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

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

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

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

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

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

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

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

f

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

Возвращает

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

Исключения
UnsupportedOperationException

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

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

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

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

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

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

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

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

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

f

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

Возвращает

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

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

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

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

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

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

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

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

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

Возвращает

значение типа Option, содержащее наименьший элемент этого набора относительно порядка 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

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

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

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

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

sep

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

start

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

Возвращает

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

Пример

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

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

Источник
protected def newSpecificBuilder: Builder[A, CC[A]]

Возвращает

строгий билдер для того же типа набора. Обратите внимание, что в случае ленивых наборов (например, scala.collection.View или scala.collection.immutable.LazyList), этот метод можно реализовать, но полученный Builder нарушит ленивость. Вследствие этого операции предпочтительнее реализовывать с помощью fromSpecific вместо этого метода.

Примечание

При реализации пользовательского типа набора и уточнении C до нового типа необходимо переопределить этот метод (в противном случае компилятор выдаст ошибку). В общем случае, где C =:= CC[A], это можно сделать, добавив в себя трейт scala.collection.IterableFactoryDefaults, который реализует метод с помощью iterableFactory.

Как видно из аннотации @uncheckedVariance, использование этого метода может быть небезопасным. Однако, до тех пор, пока возвращаемый билдер получает только A значения, взятые из this экземпляра, он безопасен.

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

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

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

Возвращает

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

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

Источник
def orElse[A1 <: Int, B1](that: PartialFunction[A1, B1]): PartialFunction[A1, B1]

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

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

тип аргумента резервной функции

B1

тип результата резервной функции

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

резервная функция

Возвращает

частичная функция, область определения которой является объединением областей определения данной частичной функции и that. Полученная частичная функция принимает x к this(x), где this определена, и к that(x) в противном случае.

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

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

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

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

тип элементов возвращаемой последовательности.

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

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

len

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

Возвращает

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

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

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

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

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

Классы определения Stream -> IterableOps
Унаследовано от Stream

Источник
def partitionMap[A1, A2](f: Nothing => Either[A1, A2]): (CC[A1], CC[A2])

Применяет функцию f к каждому элементу итерабельного набора и возвращает пару итерабельных наборов: первый содержит значения, возвращенные f и завернутые в scala.util.Left, а второй — значения, завернутые в scala.util.Right.

Пример:

val xs = Iterable(1, "one", 2, "two", 3, "three") partitionMap {
 case i: Int => Left(i)
 case s: String => Right(s)
}
// xs == (Iterable(1, 2, 3),
//        Iterable(one, two, three))
Параметры типа
A1

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

A2

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

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

'функция разделения', отображающая элементы этого итерабельного набора в scala.util.Either

Возвращает

пара итерабельных наборов: первый содержит значения, возвращенные f и завернутые в scala.util.Left, а второй — значения, завернутые в scala.util.Right.

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

Источник
def patch[B](from: Int, other: IterableOnce[B], replaced: Int): CC[B]

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

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

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

тип элементов возвращаемой последовательности.

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

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

other

заменяющая последовательность

replaced

количество элементов для удаления в исходной последовательности

Возвращает

новая последовательность, состоящая из всех элементов исходной последовательности, за исключением того, что replaced элементы, начиная с from, заменены всеми элементами other.

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

Источник
def permutations: Iterator[C]

Итерируется по различным перестановкам.

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

END_OF_DOCUMENT_MARKER
Возвращает

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

Пример

"abb".permutations = Iterator(abb, bab, bba)

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

Исходный код
final override def prepended[B](elem: B): Stream[B]

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

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

Пример:

scala> val x = List(1)
x: List[Int] = List(1)

scala> val y = 2 +: x
y: List[Int] = List(2, 1)

scala> println(x)
List(1)
Параметры типа
B

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

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

элемент, добавляемый в начало

Возвращает

новый неизменяемый набор, состоящий из value и всех элементов этого неизменяемого набора.

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

Исходный код
def prependedAll[B](prefix: IterableOnce[B]): CC[B]

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

Он отличается от :++ тем, что правый операнд определяет тип результирующего набора, а не левый. Мемоника: двоеточие стоит на стороне нового типа набора.

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

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

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

итерируемый объект для добавления в начало.

Возвращает

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

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

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

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

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

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

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

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

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

Возвращает

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

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

Исходный код
def reduce[B](op: (B, B) => B): B

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

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

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

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

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

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

Возвращает

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

Исключения
UnsupportedOperationException

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

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

Исходный код
final override def reduceLeft[B](f: (B, Nothing) => B): B

Специализация Stream для reduceLeft, которая позволяет GC собирать по мере необходимости.

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

Тип накапливаемого значения.

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

Операция, выполняемая над последовательными элементами Stream.

Возвращает

Накопленное значение из последовательных применений f.

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

Исходный код
def reduceLeftOption[B](op: (B, Nothing) => B): Option[B]

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

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

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

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

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

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

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

Возвращает

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

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

Исходный код
def reduceOption[B](op: (B, B) => B): Option[B]

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

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

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

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

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

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

Возвращает

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

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

Исходный код
def reduceRight[B](op: (Nothing, B) => B): B

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

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

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

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

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

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

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

Возвращает

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

Исключения
UnsupportedOperationException

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

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

Исходный код
def reduceRightOption[B](op: (Nothing, B) => B): Option[B]

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

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

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

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

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

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

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

Возвращает

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

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

Source
def reverse: C

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

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

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

Возвращает

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

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

Source
def reverseIterator: Iterator[A]

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

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

Примечание: xs.reverseIterator — это то же самое, что и xs.reverse.iterator, но может быть более эффективным.

Возвращает

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

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

Source
protected def reversed: Iterable[A]

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

Source
def runWith[U](action: Nothing => U): A => Boolean

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

Обратите внимание, что выражение pf.runWith(action)(x) эквивалентно

if(pf isDefinedAt x) { action(pf(x)); true } else false

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

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

функция действия

Возвращает

функция, которая сопоставляет аргументы x с isDefinedAt(x). Результирующая функция выполняет action(this(x)), где this определено.

См. также

applyOrElse.

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

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

Являются ли элементы этой коллекции одинаковыми (и в том же порядке), что и элементы that?

Определяющие классы LinearSeqOps -> SeqOps
Унаследовано от LinearSeqOps

Source
def scan[B](z: B)(op: (B, B) => B): CC[B]

Вычисляет префиксное сканирование элементов коллекции.

Примечание: нейтральный элемент z может применяться более одного раза.

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

тип элементов результирующей коллекции

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

ассоциативный оператор для сканирования

z

нейтральный элемент для оператора op

Возвращает

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

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

Source
override def scanLeft[B](z: B)(op: (B, Nothing) => B): Stream[B]

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

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

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

тип элементов в результирующей коллекции

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

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

z

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

Возвращает

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

Определяющие классы Stream -> IterableOps -> IterableOnceOps
Унаследовано от Stream

Source
def scanRight[B](z: B)(op: (Nothing, B) => B): CC[B]

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

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

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

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

Пример:

List(1, 2, 3, 4).scanRight(0)(_ + _) == List(10, 9, 7, 4, 0)
Параметры типа
B

тип элементов в результирующей коллекции

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

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

z

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

Возвращает

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

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

Source
def search[B](elem: B, from: Int, to: Int)(implicit ord: Ordering[B]): SearchResult

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

Последовательность должна быть отсортирована с тем же Ordering перед вызовом; в противном случае результаты не определены.

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

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

from

индекс, с которого начинается поиск.

ord

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

to

индекс, следующий за тем, где поиск заканчивается.

Возвращает

значение Found, содержащее индекс, соответствующий элементу в последовательности, или InsertionPoint, где элемент был бы вставлен, если элемент не в последовательности.

См. также

scala.collection.IndexedSeq

scala.math.Ordering

scala.collection.SeqOps, метод sorted

Примечание

если to <= from, пространство поиска пустое, и возвращается InsertionPoint в from

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

Source
def search[B](elem: B)(implicit ord: Ordering[B]): SearchResult

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

Последовательность должна быть отсортирована с тем же Ordering перед вызовом; в противном случае результаты не определены.

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

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

ord

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

Возвращает

значение Found, содержащее индекс, соответствующий элементу в последовательности, или InsertionPoint, где элемент был бы вставлен, если элемент не в последовательности.

См. также

scala.collection.IndexedSeq

scala.math.Ordering

scala.collection.SeqOps, метод sorted

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

Source
override def segmentLength(p: Nothing => Boolean, from: Int): Int

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

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

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

индекс, с которого начинается поиск.

p

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

Возвращает

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

Определяющие классы LinearSeqOps -> SeqOps
Унаследовано от LinearSeqOps

Источник
final def segmentLength(p: Nothing => Boolean): Int

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

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

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

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

Возвращает

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

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

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

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

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

Возвращает

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

Определяющие классы SeqOps -> IterableOnceOps
Унаследовано от SeqOps

Источник
final override def sizeCompare(that: Iterable[_]): Int

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

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

набор Iterable, размер которого сравнивается с размером этого набора.

Возвращает

Значение x, где

x <  0       if this.size <  that.size
x == 0       if this.size == that.size
x >  0       if this.size >  that.size

Метод, как реализован здесь, не вызывает size напрямую; его время выполнения составляет O(this.size min that.size) вместо O(this.size + that.size). Метод следует переопределить, если вычисление size является быстрым, и knownSize возвращает -1.

Определяющие классы SeqOps -> IterableOps
Унаследовано от SeqOps

Источник
final override def sizeCompare(otherSize: Int): Int

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

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

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

Возвращает

Значение x, где

x <  0       if this.size <  otherSize
x == 0       if this.size == otherSize
x >  0       if this.size >  otherSize

Метод, как реализован здесь, не вызывает size напрямую; его время выполнения составляет O(size min otherSize) вместо O(size). Метод следует переопределить, если вычисление size является быстрым, и knownSize возвращает -1.

См. также

sizeIs

Определяющие классы SeqOps -> IterableOps
Унаследовано от SeqOps

Источник
final def sizeIs: SizeCompareOps

Возвращает объект-значение, содержащий операции для сравнения размера этой итерируемой коллекции со значением для проверки.

Эти операции реализованы в терминах sizeCompare(Int) и позволяют использовать следующие более читаемые варианты:

this.sizeIs < size     // this.sizeCompare(size) < 0
this.sizeIs <= size    // this.sizeCompare(size) <= 0
this.sizeIs == size    // this.sizeCompare(size) == 0
this.sizeIs != size    // this.sizeCompare(size) != 0
this.sizeIs >= size    // this.sizeCompare(size) >= 0
this.sizeIs > size     // this.sizeCompare(size) > 0
Унаследовано от IterableOps

Источник
def slice(from: Int, until: Int): C

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

from <= indexOf(x) < until

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

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

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

until

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

Возвращает

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

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

Источник
def sliding(size: Int, step: Int): Iterator[C]

Группирует элементы в блоки фиксированного размера, пропуская «скользящее окно» по ним (в отличие от разбиения их, как это делается в grouped).

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

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

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

step

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

Возвращает

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

См. также

scala.collection.Iterator, метод sliding

Пример

List(1, 2, 3, 4, 5).sliding(2, 2) = Iterator(List(1, 2), List(3, 4), List(5))

List(1, 2, 3, 4, 5, 6).sliding(2, 3) = Iterator(List(1, 2), List(4, 5))

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

Источник
def sliding(size: Int): Iterator[C]

Группирует элементы в блоки фиксированного размера, пропуская «скользящее окно» по ним (в отличие от разбиения их, как это делается в grouped).

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

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

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

Возвращает

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

См. также

scala.collection.Iterator, метод sliding

Пример

List().sliding(2) = empty iterator

List(1).sliding(2) = Iterator(List(1))

List(1, 2).sliding(2) = Iterator(List(1, 2))

List(1, 2, 3).sliding(2) = Iterator(List(1, 2), List(2, 3))

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

Источник
def sortBy[B](f: Nothing => B)(implicit ord: Ordering[B]): C

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

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

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

Сортировка является стабильной. То есть элементы, которые равны (как определено в ord.compare ) будут появляться в отсортированном наборе в том же порядке, что и в исходном наборе.

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

целевой тип преобразования f, и тип, где определено упорядочение ord.

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

функция преобразования, отображающая элементы в какой-то другой домен B.

ord

упорядочение, предполагаемое в домене B.

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

последовательность, состоящая из элементов этой последовательности, отсортированных в соответствии с порядком, где x < y , если ord.lt(f(x), f(y)).

См. также

scala.math.Ordering

Пример
val words = "The quick brown fox jumped over the lazy dog".split(' ')
// this works because scala.Ordering will implicitly provide an Ordering[Tuple2[Int, Char]]
words.sortBy(x => (x.length, x.head))
res0: Array[String] = Array(The, dog, fox, the, lazy, over, brown, quick, jumped)
Унаследовано от SeqOps

Исходный код
def sortWith(lt: (Nothing, Nothing) => Boolean): C

Сортирует эту последовательность в соответствии с функцией сравнения.

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

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

Сортировка стабильна. Это означает, что элементы, которые равны (как определено lt), появляются в отсортированной последовательности в том же порядке, что и в исходной.

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

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

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

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

Пример
List("Steve", "Tom", "John", "Bob").sortWith(_.compareTo(_) < 0) =
List("Bob", "John", "Steve", "Tom")
Унаследовано от SeqOps

Исходный код
def sorted[B](implicit ord: Ordering[B]): C

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

Сортировка стабильна. То есть элементы, которые равны (как определено ord.compare), появляются в отсортированной последовательности в том же порядке, что и в исходной.

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

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

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

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

См. также

scala.math.Ordering Примечание: даже при применении к представлению или ленивой коллекции, она всегда будет принудительно вычислять элементы.

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

Исходный код
def span(p: Nothing => Boolean): (C, C)

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

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

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

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

предикат-тест

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

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

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

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

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

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

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

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

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

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

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

Определяющие классы IterableOps -> IterableOnceOps
Унаследовано от IterableOps

Исходный код
def startsWith[B](that: IterableOnce[B], offset: Int): Boolean

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

Примечание: Если и получающий объект this и аргумент that являются бесконечными последовательностями, этот метод может не завершиться.

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

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

that

последовательность для проверки

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

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

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

Исходный код
def stepper[S <: Stepper[_]](implicit shape: StepperShape[Nothing, 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](implicit num: Numeric[B]): B

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

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

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

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

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

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

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

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

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

Исходный код
override def tails: Iterator[C]

Итерируется по хвостам этой последовательности. Первое значение будет этой последовательностью, а последнее - пустой последовательностью, при этом промежуточные значения будут результатами последовательных применений tail.

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

итератор по всем хвостам этой последовательности

Пример

List(1,2,3).tails = Iterator(List(1,2,3), List(2,3), List(3), Nil)

Определяющие классы LinearSeqOps -> IterableOps
Унаследовано от LinearSeqOps

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

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

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

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

Возвращает

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

Определяющие классы Stream -> IterableOps -> IterableOnceOps
Унаследовано от Stream

Источник
def takeRight(n: Int): C

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

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

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

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

Возвращает

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

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

Источник
def takeWhile(p: Nothing => Boolean): C

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

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

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

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

Возвращает

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

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

Источник
override def tapEach[U](f: Nothing => U): C

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

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

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

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

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

Возвращает

логически тот же набор, что и этот

Определяющие классы IterableOps -> IterableOnceOps
Унаследовано от IterableOps

Источник
def to[C1](factory: Factory[Nothing, C1]): C1

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

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

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

Источник
def toArray[B : ClassTag]: Array[B]

Преобразовать набор в массив.

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

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

Источник
final def toBuffer[B]: Buffer[B]

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

Источник
def toIndexedSeq: IndexedSeq[A]

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

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

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

Источник
def toMap[K, V](implicit ev: Nothing <:< (K, V)): Map[K, V]

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

Источник
final override def toSeq: Seq.this.type

Возвращает

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

Классы определения Seq -> IterableOnceOps
Наследуется от Seq

Источник
def toSet[B]: Set[B]

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

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

Возвращает

строковое представление этой коллекции. Неопределённые элементы представлены как "_", неопределённый хвост представлен как "<not computed>", а циклы представлены как "<cycle>" Примеры:

  • "Stream(_, <not computed>)", непустой поток, у которого головной элемент не был оценён;

  • "Stream(_, 1, _, <not computed>)", поток с как минимум тремя элементами, второй из которых был оценён;

  • "Stream(1, 2, 3, <cycle>)", бесконечный поток, в котором цикл начинается с четвёртого элемента.

Классы определения Stream -> Seq -> Function1 -> Iterable -> Any
Наследуется от Stream

Источник
def toVector: Vector[A]

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

Источник
def transpose[B](implicit asIterable: Nothing => Iterable[B]): CC[CC[B]]

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

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

val xs = List(
           Set(1, 2, 3),
           Set(4, 5, 6)).transpose
// xs == List(
//         List(1, 4),
//         List(2, 5),
//         List(3, 6))

val ys = Vector(
           List(1, 2, 3),
           List(4, 5, 6)).transpose
// ys == Vector(
//         Vector(1, 4),
//         Vector(2, 5),
//         Vector(3, 6))

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

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

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

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

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

Возвращает

двухмерная итерируемая коллекция итерируемых коллекций, в которой n-я строка соответствует n-му столбцу этой итерируемой коллекции.

Исключения
IllegalArgumentException

если все коллекции в этой итерируемой коллекции не имеют одинаковый размер.

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

Исходный код
def unapply(a: Int): Option[B]

Попытка извлечь B из A в выражении сопоставления с образцом.

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

Исходный код
def unzip[A1, A2](implicit asPair: Nothing => (A1, A2)): (CC[A1], CC[A2])

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

val xs = Iterable(
           (1, "one"),
           (2, "two"),
           (3, "three")).unzip
// xs == (Iterable(1, 2, 3),
//        Iterable(one, two, three))
Параметры типа
A1

тип первой половины пар элементов

A2

тип второй половины пар элементов

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

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

Возвращает

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

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

Исходный код
def unzip3[A1, A2, A3](implicit asTriple: Nothing => (A1, A2, A3)): (CC[A1], CC[A2], CC[A3])

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

val xs = Iterable(
           (1, "one", '1'),
           (2, "two", '2'),
           (3, "three", '3')).unzip3
// xs == (Iterable(1, 2, 3),
//        Iterable(one, two, three),
//        Iterable(1, 2, 3))
Параметры типа
A1

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

A2

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

A3

тип третьего члена троек элементов

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

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

Возвращает

тройка итерируемых множеств, содержащих первый, второй и соответственно третий член каждой тройки элементов этого итерируемого множества.

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

Исходный код
def updated[B](index: Int, elem: B): CC[B]

Копия этого набора с заменой одного элемента.

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

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

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

элемент замены

index

позиция замены

Возвращает

новый набор, который является копией этого набора с элементом на позиции index заменённым на elem.

Исключения
IndexOutOfBoundsException

если index не удовлетворяет 0 <= index < length. В случае ленивого набора это исключение может быть выброшено в более позднее время или вообще не выброшено (если конец набора никогда не оценивается).

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

Исходный код
override def view: SeqView[A]

Вид на элементы этого набора.

Классы определения SeqOps -> IterableOps
Унаследовано от SeqOps

Исходный код
final override def withFilter(p: Nothing => Boolean): WithFilter[A, Stream]

Вид, который позволяет сборке мусора заголовка потока во время обработки

Классы определения Stream -> IterableOps
Унаследовано от Stream

Исходный код
final override def zip[B](that: IterableOnce[B]): Stream[(A, B)]

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

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

тип второй половины возвращаемых пар

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

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

Возвращает

новая неизменяемая коллекция, содержащая пары, состоящие из соответствующих элементов этой неизменяемой коллекции и that. Длина возвращаемой коллекции — минимальная из длин этой неизменяемой коллекции и that.

Классы определения Stream -> IterableOps
Унаследовано от Stream

Исходный код
def zipAll[A1, B](that: Iterable[B], thisElem: A1, thatElem: B): CC[(A1, B)]

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

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

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

thatElem

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

thisElem

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

Возвращает

новый набор типа That, содержащий пары, состоящие из соответствующих элементов этой итерируемой коллекции и that. Длина возвращаемой коллекции — максимальная из длин этой итерируемой коллекции и that. Если эта итерируемая коллекция короче that, значения thisElem используются для заполнения результата. Если that короче, чем эта итерируемая коллекция, значения thatElem используются для заполнения результата.

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

Исходный код
final override def zipWithIndex: Stream[(A, Int)]

Комбинирует эту неизменяемую коллекцию со своими индексами.

Возвращает

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

Пример

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

Классы определения Stream -> IterableOps -> IterableOnceOps
Унаследовано от Stream

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

Spec-Zone.ru

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