Spec-Zone.ru › Scala 2.12 Library

Трейт scala.collection.IterableLike

Трейт IterableLike[+A, +Repr] extends Equals with TraversableLike[A, Repr] with GenIterableLike[A, Repr]

Шаблонный трейт для итерируемых коллекций типа Iterable[A].

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

def iterator: Iterator[A]

Они также должны предоставить метод newBuilder, который создаёт билдер для коллекций того же типа.

Этот трейт реализует метод Iterable's foreach, проходя по всем элементам с помощью iterator. Подклассы должны повторно реализовать foreach чем-то более эффективным, если это возможно.

Этот трейт добавляет методы iterator, sameElements, takeRight, dropRight к методам, унаследованным от трейта `Traversable`.

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

Self Type
IterableLike[A, Repr]
Source
IterableLike.scala
Линейные надтипы
Известные подклассы

Члены типа

тип Self = Repr

Тип, реализующий этот итерируемый объект

Атрибуты
protected[this]
Классы определения
TraversableLike

класс WithFilter extends FilterMonadic[A, Repr]

Класс, поддерживающий отфильтрованные операции. Экземпляры этого класса возвращаются методом withFilter.

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

Абстрактные члены значения

абстрактный def getClass(): Class[_]

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

возвращает

объект класса, соответствующий типу получателя во время выполнения.

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

абстрактный def iterator: Iterator[A]

Создаёт новый итератор по всем элементам, содержащимся в этом итерируемом объекте.

возвращает

новый итератор

Классы определения
IterableLike → GenIterableLike

абстрактный def newBuilder: Builder[A, Repr]

Создаёт новый билдер для этого типа коллекции.

Атрибуты
protected[this]
Классы определения
TraversableLike → HasNewBuilder

абстрактный def seq: TraversableOnce[A]

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

Члены-значения конкретных типов

final def !=(arg0: Any): Boolean

Проверка двух объектов на неравенство.

returns

true если !(this == that), в противном случае false.

Definition Classes
Any

final def ##(): Int

Эквивалентно x.hashCode за исключением упакованных числовых типов и null. Для числовых типов возвращает значение хэш-кода, соответствующее равенству значений: если два экземпляра типов значений сравниваются как true, то ## возвратит одинаковое значение хэш-кода для каждого из них. Для null возвращает хэш-код, где null.hashCode выбрасывает NullPointerException.

returns

значение хэш-кода, соответствующее ==

Definition Classes
Any

def +(other: String): String

Неявный
Этот член добавляется неявным преобразованием из IterableLike[A, Repr] в any2stringadd[IterableLike[A, Repr]] выполненным методом any2stringadd в scala.Predef.
Definition Classes
any2stringadd

def ++[B >: A, That](that: GenTraversableOnce[B])(implicit bf: CanBuildFrom[Repr, B, That]): That

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

B

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

That

класс возвращаемой коллекции. Где возможно, That — тот же класс, что и текущий класс коллекции Repr, но это зависит от того, допускается ли тип элемента B для этого класса, что означает, что найден неявный экземпляр типа CanBuildFrom[Repr, B, That].

that

объект Traversable для добавления.

bf

неявное значение класса CanBuildFrom, которое определяет возвращаемый класс That из текущего типа представления Repr и нового типа элемента B.

returns

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

Definition Classes
TraversableLike → GenTraversableLike

def ++:[B >: A, That](that: Traversable[B])(implicit bf: CanBuildFrom[Repr, B, That]): That

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

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

Пример:

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

scala> val y = LinkedList(2)
y: scala.collection.mutable.LinkedList[Int] = LinkedList(2)

scala> val z = x ++: y
z: scala.collection.mutable.LinkedList[Int] = LinkedList(1, 2)

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

Так как TraversableOnce не имеет метода ++, мы должны реализовать его напрямую, но Traversable и ниже могут использовать перегрузку.

B

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

That

класс возвращаемой коллекции. Где возможно, That — тот же класс, что и текущий класс коллекции Repr, но это зависит от того, допускается ли тип элемента B для этого класса, что означает, что найден неявный экземпляр типа CanBuildFrom[Repr, B, That].

that

объект Traversable для добавления.

bf

неявное значение класса CanBuildFrom, которое определяет возвращаемый класс That из текущего типа представления Repr и нового типа элемента B.

returns

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

Definition Classes
TraversableLike

def ++:[B](that: TraversableOnce[B]): Iterable[B]

[use case]

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

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

Пример:

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

scala> val y = LinkedList(2)
y: scala.collection.mutable.LinkedList[Int] = LinkedList(2)

scala> val z = x ++: y
z: scala.collection.mutable.LinkedList[Int] = LinkedList(1, 2)
B

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

that

объект Traversable для добавления.

returns

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

Definition Classes
TraversableLike
Полная подпись

def ->[B](y: B): (IterableLike[A, Repr], B)

Неявный
Этот член добавлен с помощью неявного преобразования из IterableLike[A, Repr] в ArrowAssoc[IterableLike[A, Repr]], выполненное методом ArrowAssoc в scala.Predef.
Классы определений
ArrowAssoc
Аннотации
@inline()

def /:[B](z: B)(op: (B, A) ⇒ B): B

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

Примечание: /: — это альтернативная синтаксическая конструкция для foldLeft; z /: xs эквивалентно xs foldLeft z.

Примеры:

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

scala> val a = List(1,2,3,4)
a: List[Int] = List(1, 2, 3, 4)

scala> val b = (5 /: a)(_+_)
b: Int = 15

scala> val c = (5 /: a)((x,y) => x + y)
c: Int = 15

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

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

B

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

z

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

op

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

возвращает

результат вставки op между последовательными элементами этого итерируемого объекта или итератора слева направо с начальным значением z слева:

op(...op(op(z, x_1), x_2), ..., x_n)

где x1, ..., xn — элементы этого итерируемого объекта или итератора.

Классы определений
TraversableOnce → GenTraversableOnce

def :\[B](z: B)(op: (A, B) ⇒ B): B

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

Примечание: :\ — это альтернативная синтаксическая конструкция для foldRight; xs :\ z эквивалентно xs foldRight z.

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

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

Примеры:

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

scala> val a = List(1,2,3,4)
a: List[Int] = List(1, 2, 3, 4)

scala> val b = (a :\ 5)(_+_)
b: Int = 15

scala> val c = (a :\ 5)((x,y) => x + y)
c: Int = 15
B

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

z

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

op

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

возвращает

результат вставки op между последовательными элементами этого итерируемого объекта или итератора справа налево с начальным значением z справа:

op(x_1, op(x_2, ... op(x_n, z)...))

где x1, ..., xn — элементы этого итерируемого объекта или итератора.

Классы определений
TraversableOnce → GenTraversableOnce

final def ==(arg0: Any): Boolean

Тестирует два объекта на равенство. Выражение x == that эквивалентно if (x eq null) that eq null else x.equals(that).

возвращает

true если объект-получатель эквивалентен аргументу; false в противном случае.

Классы определений
Any

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, в который были добавлены элементы.

Классы определений
TraversableOnce

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, в который были добавлены элементы.

Классы определений
TraversableOnce

def addString(b: StringBuilder, start: String, sep: String, end: String): StringBuilder

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

Пример:

scala> val a = List(1,2,3,4)
a: List[Int] = List(1, 2, 3, 4)

scala> val b = new StringBuilder()
b: StringBuilder =

scala> a.addString(b , "List(" , ", " , ")")
res5: StringBuilder = List(1, 2, 3, 4)
b

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

start

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

sep

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

end

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

returns

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

Definition Classes
TraversableOnce

def aggregate[B](z: ⇒ B)(seqop: (B, A) ⇒ B, combop: (B, B) ⇒ B): B

Агрегирует результаты применения оператора к последующим элементам.

Это более общая форма fold и reduce. Она похожа на foldLeft, поскольку не требует, чтобы результат был супертипом типа элемента. Кроме того, она позволяет обрабатывать параллельные коллекции частями, а затем объединять промежуточные результаты.

aggregate разделяет итерируемый объект или итератор на разделы и обрабатывает каждый раздел, последовательно применяя seqop, начиная с z (как foldLeft). Затем эти промежуточные результаты объединяются с помощью combop (как fold). Реализация этой операции может работать с произвольным количеством разделов коллекции (даже с 1), поэтому combop может быть вызвана произвольное количество раз (даже 0).

Например, рассмотрим суммирование целых значений списка символов. Начальное значение для суммы равно 0. Сначала seqop преобразует каждый входной символ в целое число и добавляет его к сумме (раздела). Затем combop просто суммирует промежуточные результаты разделов:

List('a', 'b', 'c').aggregate(0)({ (sum, ch) => sum + ch.toInt }, { (p1, p2) => p1 + p2 })
B

тип накопленных результатов

z

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

seqop

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

combop

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

Definition Classes
TraversableOnce → GenTraversableOnce

final def asInstanceOf[T0]: T0

Преобразует получаемый объект к типу T0.

Обратите внимание, что успех приведения типов во время выполнения зависит от семантики стирания типов Scala. Поэтому выражение 1.asInstanceOf[String] выбросит исключение ClassCastException во время выполнения, в то время как выражение List(1).asInstanceOf[List[String]] не выбросит. В последнем примере, так как аргумент типа стирается на этапе компиляции, невозможно проверить, соответствуют ли содержимое списка требуемому типу.

returns

получаемый объект.

Definition Classes
Any
Исключения

ClassCastException, если получаемый объект не является экземпляром стирания типа T0.

def canEqual(that: Any): Boolean

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

that

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

returns

true, если эта итерируемая коллекция может потенциально быть равна that, false в противном случае. Тестирование учитывает только типы объектов во время выполнения, но игнорирует их элементы.

Definition Classes
IterableLike → Equals

def collect[B](pf: PartialFunction[A, B]): Iterable[B]

[use case]

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

B

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

pf

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

returns

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

Definition Classes
TraversableLike → GenTraversableLike
Полная сигнатура

def collectFirst[B](pf: PartialFunction[A, B]): Option[B]

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

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

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

pf

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

returns

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

Definition Classes
TraversableOnce
Пример:

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

def copyToArray(xs: Array[A], start: Int, len: Int): Unit

[use case]

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

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

xs

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

start

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

len

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

Definition Classes
IterableLike → TraversableLike → TraversableOnce → GenTraversableOnce
Полная сигнатура

def copyToArray(xs: Array[A]): Unit

[use case]

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

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

xs

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

Definition Classes
TraversableOnce → GenTraversableOnce
Полная сигнатура

def copyToArray(xs: Array[A], start: Int): Unit

[use case]

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

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

xs

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

start

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

Definition Classes
TraversableOnce → GenTraversableOnce
Полная сигнатура

def copyToBuffer[B >: A](dest: Buffer[B]): Unit

Копирует все элементы этого перечислимого или итератора в буфер.

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

dest

Буфер, в который копируются элементы.

Definition Classes
TraversableOnce

def count(p: (A) ⇒ Boolean): Int

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

p

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

returns

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

Definition Classes
TraversableOnce → GenTraversableOnce

def drop(n: Int): Repr

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

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

n

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

returns

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

Definition Classes
IterableLike → TraversableLike → GenTraversableLike

def dropRight(n: Int): Repr

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

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

n

Количество элементов для взятия

returns

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

def dropWhile(p: (A) ⇒ Boolean): Repr

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

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

returns

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

Definition Classes
TraversableLike → GenTraversableLike

def ensuring(cond: (IterableLike[A, Repr]) ⇒ Boolean, msg: ⇒ Any): IterableLike[A, Repr]

Неявный
Этот член добавлен неявным преобразованием из IterableLike[A, Repr] в Ensuring[IterableLike[A, Repr]] выполненным методом Ensuring в scala.Predef.
Классы определения
Ensuring

def ensuring(cond: (IterableLike[A, Repr]) ⇒ Boolean): IterableLike[A, Repr]

Неявный
Этот член добавлен неявным преобразованием из IterableLike[A, Repr] в Ensuring[IterableLike[A, Repr]] выполненным методом Ensuring в scala.Predef.
Классы определения
Ensuring

def ensuring(cond: Boolean, msg: ⇒ Any): IterableLike[A, Repr]

Неявный
Этот член добавлен неявным преобразованием из IterableLike[A, Repr] в Ensuring[IterableLike[A, Repr]] выполненным методом Ensuring в scala.Predef.
Классы определения
Ensuring

def ensuring(cond: Boolean): IterableLike[A, Repr]

Неявный
Этот член добавлен неявным преобразованием из IterableLike[A, Repr] в Ensuring[IterableLike[A, Repr]] выполненным методом Ensuring в scala.Predef.
Классы определения
Ensuring

def equals(arg0: Any): Boolean

Сравнивает текущий объект (this) с объектом-аргументом (that) на предмет эквивалентности.

Любая реализация этого метода должна быть отношением эквивалентности:

    Он рефлексивен: для любого экземпляра x типа Any, x.equals(x) должно возвращать true.Он симметричен: для любых экземпляров x и y типа Any, x.equals(y) должно возвращать true тогда и только тогда, когда y.equals(x) возвращает true.Он транзитивен: для любых экземпляров x, y, и z типа Any если x.equals(y) возвращает true и y.equals(z) возвращает true, тогда x.equals(z) должно возвращать true.

Если вы переопределяете этот метод, вы должны убедиться, что ваша реализация остается отношением эквивалентности. Кроме того, при переопределении этого метода обычно необходимо переопределить hashCode для обеспечения того, что объекты, которые «равны» (o1.equals(o2) возвращает true) хешируются в тот же scala.Int. (o1.hashCode.equals(o2.hashCode)).

возвращает

true если текущий объект эквивалентен аргументу; false в противном случае.

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

def exists(p: (A) ⇒ Boolean): Boolean

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

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

p

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

возвращает

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

Классы определения
IterableLike → TraversableLike → TraversableOnce → GenTraversableOnce

def filter(p: (A) ⇒ Boolean): Repr

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

p

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

возвращает

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

Классы определения
TraversableLike → GenTraversableLike

def filterNot(p: (A) ⇒ Boolean): Repr

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

p

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

returns

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

Definition Classes
TraversableLike → GenTraversableLike

def find(p: (A) ⇒ Boolean): Option[A]

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

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

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

p

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

returns

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

Definition Classes
IterableLike → TraversableLike → TraversableOnce → GenTraversableOnce

def flatMap[B](f: (A) ⇒ GenTraversableOnce[B]): Iterable[B]

[use case]

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

Например:

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 => 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

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

returns

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

Definition Classes
TraversableLike → GenTraversableLike → FilterMonadic
Полная подпись

def fold[A1 >: A](z: A1)(op: (A1, A1) ⇒ A1): A1

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

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

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

A1

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

z

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

op

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

returns

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

Definition Classes
TraversableOnce → GenTraversableOnce

def foldLeft[B](z: B)(op: (B, A) ⇒ B): B

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

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

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

B

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

z

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

op

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

returns

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

op(...op(z, x_1), x_2, ..., x_n)

где x1, ..., xn — элементы этого итерируемого набора или итератора. Возвращает z если этот итерируемый набор или итератор пуст.

Definition Classes
TraversableOnce → GenTraversableOnce

def foldRight[B](z: B)(op: (A, B) ⇒ B): B

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

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

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

B

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

z

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

op

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

returns

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

op(x_1, op(x_2, ... op(x_n, z)...))

где x1, ..., xn — элементы этого итерируемого набора. Возвращает z если этот итерируемый набор пуст.

Definition Classes
IterableLike → TraversableOnce → GenTraversableOnce

def forall(p: (A) ⇒ Boolean): Boolean

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

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

p

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

returns

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

Definition Classes
IterableLike → TraversableLike → TraversableOnce → GenTraversableOnce

def foreach(f: (A) ⇒ Unit): Unit

[use case]

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

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

f

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

Definition Classes
IterableLike → TraversableLike → GenTraversableLike → TraversableOnce → GenTraversableOnce → FilterMonadic
Полная подпись

def formatted(fmtstr: String): String

Возвращает строку, отформатированную в соответствии с заданной строкой format. Форматные строки соответствуют String.format (@см. java.lang.String.format).

Неявный
Этот член добавляется неявным преобразованием из IterableLike[A, Repr] в StringFormat[IterableLike[A, Repr]] с помощью метода StringFormat в scala.Predef.
Definition Classes
StringFormat
Annotations
@inline()

def groupBy[K](f: (A) ⇒ K): immutable.Map[K, Repr]

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

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

K

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

f

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

returns

Карта из ключей к итерируемым наборам, в которой выполняется следующее инвариантное свойство:

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

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

Definition Classes
TraversableLike → GenTraversableLike

def grouped(size: Int): Iterator[Repr]

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

size

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

returns

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

См. также

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

def hasDefiniteSize: Boolean

Проверяет, известно ли, что у этого итерируемого набора конечный размер. Все строго типизированные наборы известны как наборы конечного размера. Для нестрого типизированного набора, например Stream, предикат возвращает true , если все элементы были вычислены. Он возвращает false , если поток ещё не пройден до конца. Непустые итераторы обычно возвращают false , даже если они были созданы из набора с известным конечным размером.

Примечание: многие методы коллекций не будут работать с коллекциями бесконечного размера. Типичным режимом отказа является бесконечный цикл. Эти методы всегда пытаются пройтись по нему, не проверяя предварительно, что hasDefiniteSize возвращает true. Однако, проверка hasDefiniteSize может обеспечить уверенность в том, что размер определён, и не будет проблем с бесконечной обработкой.

returns

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

Definition Classes
TraversableLike → TraversableOnce → GenTraversableOnce

def hashCode(): Int

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

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

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

returns

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

Definition Classes
Any

def head: A

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

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

возвращает

первый элемент этого итерируемого набора.

Классы определения
IterableLike → TraversableLike → GenTraversableLike
Исключения

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

def headOption: Option[A]

Необязательно выбирает первый элемент.

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

возвращает

первый элемент этого итерируемого набора, если он не пустой, None если он пустой.

Классы определения
TraversableLike → GenTraversableLike

def init: Repr

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

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

возвращает

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

Классы определения
TraversableLike → GenTraversableLike
Исключения

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

def inits: Iterator[Repr]

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

возвращает

итератор по всем наборам inits этого итерируемого набора

Классы определения
TraversableLike
Пример:

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

def isEmpty: Boolean

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

возвращает

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

Классы определения
IterableLike → TraversableLike → TraversableOnce → GenTraversableOnce

final def isInstanceOf[T0]: Boolean

Проверяет, является ли динамический тип объекта-получателя T0.

Обратите внимание, что результат проверки учитывает семантику стирания Scala. Следовательно, выражение 1.isInstanceOf[String] вернёт false, а выражение List(1).isInstanceOf[List[String]] вернёт true. В последнем примере из-за стирания типа аргумента в процессе компиляции невозможно проверить, содержатся ли элементы списка указанного типа.

возвращает

true если объект-получатель является экземпляром стираемого типа T0; false в противном случае.

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

final def isTraversableAgain: Boolean

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

возвращает

true

Классы определения
TraversableLike → GenTraversableLike → GenTraversableOnce

def last: A

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

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

возвращает

Последний элемент этого итерируемого набора.

Классы определения
TraversableLike → GenTraversableLike
Исключения

NoSuchElementException Если итерируемый набор пустой.

def lastOption: Option[A]

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

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

возвращает

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

Классы определения
TraversableLike → GenTraversableLike

def map[B](f: (A) ⇒ B): Iterable[B]

[use case]

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

B

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

f

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

возвращает

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

Классы определения
TraversableLike → GenTraversableLike → FilterMonadic
Полная сигнатура

def max: A

[use case]

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

возвращает

наибольший элемент этого итерируемого набора.

Классы определений
TraversableOnce → GenTraversableOnce
Полная подпись
Исключения

UnsupportedOperationException, если этот итерируемый набор пуст.

def maxBy[B](f: (A) ⇒ B): A

[use case]

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

B

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

f

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

возвращает

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

Классы определений
TraversableOnce → GenTraversableOnce
Полная подпись
Исключения

UnsupportedOperationException, если этот итерируемый набор пуст.

def min: A

[use case]

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

возвращает

наименьший элемент этого итерируемого набора

Классы определений
TraversableOnce → GenTraversableOnce
Полная подпись
Исключения

UnsupportedOperationException, если этот итерируемый набор пуст.

def minBy[B](f: (A) ⇒ B): A

[use case]

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

B

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

f

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

возвращает

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

Классы определений
TraversableOnce → GenTraversableOnce
Полная подпись
Исключения

UnsupportedOperationException, если этот итерируемый набор пуст.

def mkString: String

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

возвращает

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

Классы определений
TraversableOnce → GenTraversableOnce

def mkString(sep: String): String

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

sep

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

возвращает

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

Классы определений
TraversableOnce → GenTraversableOnce
Пример:

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

def mkString(start: String, sep: String, end: String): String

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

start

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

sep

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

end

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

возвращает

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

Классы определений
TraversableOnce → GenTraversableOnce
Пример:

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

def nonEmpty: Boolean

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

возвращает

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

Классы определений
TraversableOnce → GenTraversableOnce

def par: ParIterable[A]

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

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

Некоторые наборы (например, ParArray или mutable.ParHashMap) переопределяют это поведение по умолчанию, создавая параллельный набор, который использует ту же самую базу данных. Для этих наборов par занимает постоянное или сублинейное время.

Все параллельные наборы возвращают ссылку на себя.

returns

параллельная реализация этого набора

Definition Classes
Parallelizable

def parCombiner: Combiner[A, ParIterable[A]]

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

returns

комбинирующий объект для параллельного набора типа ParRepr

Attributes
protected[this]
Definition Classes
TraversableLike → Parallelizable

def partition(p: (A) ⇒ Boolean): (Repr, Repr)

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

p

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

returns

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

Definition Classes
TraversableLike → GenTraversableLike

def product: A

[use case]

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

returns

произведение всех элементов в этом итерируемом наборе чисел типа Int. Вместо Int, можно использовать любой другой тип T с неявной реализацией Numeric[T] в качестве типа элементов итерируемого набора и в качестве типа результата product. Примеры таких типов: Long, Float, Double, BigInt.

Definition Classes
TraversableOnce → GenTraversableOnce
Полная сигнатура

def reduce[A1 >: A](op: (A1, A1) ⇒ A1): A1

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

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

A1

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

op

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

returns

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

Definition Classes
TraversableOnce → GenTraversableOnce
Исключения

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

def reduceLeft[B >: A](op: (B, A) ⇒ B): B

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

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

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

B

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

op

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

returns

результат вставки op между соседними элементами этого набора слева направо:

op( op( ... op(x_1, x_2) ..., x_{n-1}), x_n)

где x1, ..., xn — элементы этого набора.

Definition Classes
TraversableOnce
Исключения

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

def reduceLeftOption[B >: A](op: (B, A) ⇒ B): Option[B]

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

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

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

B

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

op

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

returns

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

Definition Classes
TraversableOnce → GenTraversableOnce

def reduceOption[A1 >: A](op: (A1, A1) ⇒ A1): Option[A1]

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

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

A1

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

op

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

returns

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

Definition Classes
TraversableOnce → GenTraversableOnce

def reduceRight[B >: A](op: (A, B) ⇒ B): B

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

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

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

B

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

op

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

returns

результат вставки op между последовательными элементами этой итерируемой коллекции справа налево:

op(x_1, op(x_2, ..., op(x_{n-1}, x_n)...))

где x1, ..., xn - элементы этой итерируемой коллекции.

Definition Classes
IterableLike → TraversableOnce → GenTraversableOnce
Exceptions thrown

UnsupportedOperationException, если эта итерируемая коллекция пуста.

def reduceRightOption[B >: A](op: (A, B) ⇒ B): Option[B]

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

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

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

B

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

op

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

returns

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

Definition Classes
TraversableOnce → GenTraversableOnce

def repr: Repr

Коллекция типа итерируемой коллекции, лежащая в основе этого объекта TraversableLike. По умолчанию реализуется как сам объект TraversableLike, но это можно переопределить.

Definition Classes
TraversableLike → GenTraversableLike

def reversed: List[A]

Attributes
protected[this]
Definition Classes
TraversableOnce

def sameElements(that: GenIterable[A]): Boolean

[use case]

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

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

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

that

коллекция для сравнения.

returns

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

Definition Classes
IterableLike → GenIterableLike
Полная сигнатура

def scan[B >: A, That](z: B)(op: (B, B) ⇒ B)(implicit cbf: CanBuildFrom[Repr, B, That]): That

Вычисляет префиксное сканирование элементов коллекции.

Примечание: нейтральный элемент z может применяться более одного раза.

B

тип элементов результирующей коллекции

That

тип результирующей коллекции

z

нейтральный элемент для оператора op

op

ассоциативный оператор для сканирования

cbf

фабрика комбайнеров, которая предоставляет комбайнер

returns

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

Definition Classes
TraversableLike → GenTraversableLike

def scanLeft[B, That](z: B)(op: (B, A) ⇒ B)(implicit bf: CanBuildFrom[Repr, B, That]): That

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

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

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

B

тип элементов в результирующей коллекции

That

фактический тип результирующей коллекции

z

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

op

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

bf

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

returns

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

Definition Classes
TraversableLike → GenTraversableLike

def scanRight[B, That](z: B)(op: (A, B) ⇒ B)(implicit bf: CanBuildFrom[Repr, B, That]): That

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

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

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

Пример:

List(1, 2, 3, 4).scanRight(0)(_ + _) == List(10, 9, 7, 4, 0)
B

тип элементов в результирующей коллекции

That

фактический тип результирующей коллекции

z

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

op

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

bf

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

returns

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

Definition Classes
TraversableLike → GenTraversableLike
Annotations
@migration
Migration

(Изменено в версии 2.9.0) Поведение scanRight изменилось. Предыдущее поведение можно воспроизвести с помощью scanRight.reverse.

def size: Int

Размер этой коллекций или итератора.

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

returns

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

Definition Classes
TraversableOnce → GenTraversableOnce

def sizeHintIfCheap: Int

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

returns

количество элементов в этой коллекции или итераторе, или -1, если размер нельзя определить недорого.

Attributes
protected[collection]
Definition Classes
GenTraversableOnce

def slice(from: Int, until: Int): Repr

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

from <= indexOf(x) < until

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

returns

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

Definition Classes
IterableLike → TraversableLike → GenTraversableLike

def sliding(size: Int, step: Int): Iterator[Repr]

Группирует элементы в блоки фиксированного размера, перемещая "скользящее окно" по ним (в отличие от разбиения их, как это делается в grouped.)

size

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

step

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

returns

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

See also

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

def sliding(size: Int): Iterator[Repr]

Группирует элементы в блоки фиксированного размера, перемещая "скользящее окно" по ним (в отличие от разбиения их, как это делается в grouped.) Шаг "скользящего окна" равен единице.

size

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

returns

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

See also

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

def span(p: (A) ⇒ Boolean): (Repr, Repr)

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

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

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

возвращает

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

Классы-определения
TraversableLike → GenTraversableLike

def splitAt(n: Int): (Repr, Repr)

Разделяет эту коллекцию на две части в заданной позиции. Примечание: c splitAt n эквивалентно (но, возможно, более эффективно, чем) (c take n, c drop n).

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

n

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

возвращает

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

Классы-определения
TraversableLike → GenTraversableLike

def stringPrefix: String

Определяет префикс представления toString этого объекта.

возвращает

представление в виде строки, которое начинается с результата toString, применённого к этой коллекции. По умолчанию префикс строки — простое имя класса коллекции traversable collection.

Классы-определения
TraversableLike → GenTraversableLike

def sum: A

[use case]

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

возвращает

сумму всех элементов в этой итерируемой коллекции чисел типа Int. Вместо Int, может быть использован любой другой тип T с неявной Numeric[T] реализацией, который может быть использован как тип элементов итерируемой коллекции и как тип результата sum. Примеры таких типов: Long, Float, Double, BigInt.

Классы-определения
TraversableOnce → GenTraversableOnce
Полная сигнатура

def tail: Repr

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

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

возвращает

коллекцию, состоящую из всех элементов этой коллекции, кроме первого.

Классы-определения
TraversableLike → GenTraversableLike
Исключения

java.lang.UnsupportedOperationException, если коллекция пуста.

def tails: Iterator[Repr]

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

возвращает

итератор по всем хвостам этой коллекции

Классы-определения
TraversableLike
Пример:

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

def take(n: Int): Repr

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

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

n

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

возвращает

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

Классы-определения
IterableLike → TraversableLike → GenTraversableLike

def takeRight(n: Int): Repr

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

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

n

количество элементов для взятия

возвращает

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

def takeWhile(p: (A) ⇒ Boolean): Repr

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

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

возвращает

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

Классы-определения
IterableLike → TraversableLike → GenTraversableLike

def thisCollection: Iterable[A]

Базовое коллекцию, представленное экземпляром Iterable. По умолчанию это сам текущий объект коллекции, но это можно переопределить.

Атрибуты
protected[this]
Определяющие классы
IterableLike → TraversableLike

def to[Col[_]]: Col[A]

[use case]

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

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

Col

Тип коллекции, который нужно создать.

возвращает

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

Определяющие классы
TraversableLike → TraversableOnce → GenTraversableOnce
Полная сигнатура

def toArray: Array[A]

[use case]

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

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

возвращает

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

Определяющие классы
TraversableOnce → GenTraversableOnce
Полная сигнатура

def toBuffer[B >: A]: Buffer[B]

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

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

возвращает

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

Определяющие классы
TraversableOnce → GenTraversableOnce

def toCollection(repr: Repr): Iterable[A]

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

Атрибуты
protected[this]
Определяющие классы
IterableLike → TraversableLike

def toIndexedSeq: immutable.IndexedSeq[A]

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

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

возвращает

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

Определяющие классы
TraversableOnce → GenTraversableOnce

def toIterable: Iterable[A]

Возвращает эту итерируемую коллекцию как итерируемую коллекцию.

Новая коллекция не будет создана; ленивые коллекции останутся ленивыми.

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

возвращает

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

Определяющие классы
IterableLike → TraversableOnce → GenTraversableOnce

def toIterator: Iterator[A]

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

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

возвращает

итератор, содержащий все элементы этой итерируемой коллекции.

Определяющие классы
IterableLike → TraversableLike → GenTraversableOnce
Аннотации
@deprecatedOverriding( message = ... , since = "2.11.0" )

def toList: List[A]

Преобразует этот перебираемый объект или итератор в список.

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

возвращает

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

Определяющие классы
TraversableOnce → GenTraversableOnce

def toMap[T, U]: Map[T, U]

[use case]

Преобразует эту итерируемую коллекцию в словарь. Этот метод недоступен, если элементы не являются членами Tuple2, каждый ((T, U)) становится парой ключ-значение в словаре. Дублирующиеся ключи будут перезаписаны последующими ключами: если это неупорядоченная коллекция, ключ в результирующем словаре не определен.

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

возвращает

словарь типа immutable.Map[T, U], содержащий все пары ключ/значение типа (T, U) этой итерируемой коллекции.

Определяющие классы
TraversableOnce → GenTraversableOnce
Полная сигнатура

def toParArray: ParArray[T]

Неявный
Этот член добавляется неявным преобразованием из IterableLike[A, Repr] в CollectionsHaveToParArray[IterableLike[A, Repr], T] с помощью метода CollectionsHaveToParArray в scala.collection.parallel. Это преобразование выполнится только в том случае, если в области видимости есть неявное значение типа (IterableLike[A, Repr]) ⇒ GenTraversableOnce[T].
Определяющие классы
CollectionsHaveToParArray

def toSeq: Seq[A]

Преобразует это итерируемое или итератор в последовательность. Как и toIterable, это ленивая реализация по умолчанию, так как это TraversableOnce может быть ленивым и невычисленным.

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

возвращает

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

Определяющие классы
TraversableOnce → GenTraversableOnce

def toSet[B >: A]: immutable.Set[B]

Преобразует это итерируемое или итератор в множество.

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

возвращает

множество, содержащее все элементы этого итерируемого или итератора.

Определяющие классы
TraversableOnce → GenTraversableOnce

def toStream: immutable.Stream[A]

Преобразует это итерируемое множество в поток.

возвращает

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

Определяющие классы
IterableLike → TraversableLike → GenTraversableOnce

def toString(): String

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

возвращает

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

Определяющие классы
TraversableLike → Any

def toTraversable: Traversable[A]

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

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

возвращает

Traversable, содержащий все элементы этого итерируемого множества.

Определяющие классы
TraversableLike → TraversableOnce → GenTraversableOnce
Аннотации
@deprecatedOverriding( message = ... , since = "2.11.0" )

def toVector: Vector[A]

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

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

возвращает

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

Определяющие классы
TraversableOnce → GenTraversableOnce

def view(from: Int, until: Int): IterableView[A, Repr]

Создаёт нестрогий вид среза этого итерируемого множества.

Примечание: разница между view и slice в том, что view создаёт вид текущего итерируемого множества, тогда как slice создаёт новую итерируемую коллекцию.

Примечание: view(from, to) эквивалентно view.slice(from, to).

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

from

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

until

индекс элемента, следующего за видом

возвращает

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

Определяющие классы
IterableLike → TraversableLike

def view: IterableView[A, Repr]

Создаёт нестрогий вид этого итерируемого множества.

возвращает

нестрогий вид этого итерируемого множества.

Определяющие классы
IterableLike → TraversableLike

def withFilter(p: (A) ⇒ Boolean): FilterMonadic[A, Repr]

Создаёт нестрогий фильтр этого итерируемого набора.

Примечание: различие между c filter p и c withFilter p состоит в том, что первый создаёт новый набор, а второй только ограничивает область действия последующих map, flatMap, foreach, и withFilter операций.

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

p

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

returns

объект класса WithFilter, который поддерживает map, flatMap, foreach, и withFilter операции. Все эти операции применяются к тем элементам этого итерируемого набора, которые удовлетворяют предикату p.

Definition Classes
TraversableLike → FilterMonadic

def zip[B](that: GenIterable[B]): Iterable[(A, B)]

[use case]

Возвращает итерируемый набор, сформированный из этого итерируемого набора и другого итерируемого набора путём объединения соответствующих элементов в пары. Если один из двух наборов длиннее другого, его оставшиеся элементы игнорируются.

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

B

тип второй половины возвращаемых пар

that

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

returns

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

Definition Classes
IterableLike → GenIterableLike
Полная сигнатура

def zipAll[B](that: Iterable[B], thisElem: A, thatElem: B): Iterable[(A, B)]

[use case]

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

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

...

def zipWithIndex: Iterable[(A, Int)]

[use case]

Объединяет этот итерируемый набор с его индексами.

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

returns

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

def →[B](y: B): (IterableLike[A, Repr], B)

Неявный
Этот член добавлен неявным преобразованием из IterableLike[A, Repr] в ArrowAssoc[IterableLike[A, Repr]], выполненным методом ArrowAssoc в scala.Predef.
Definition Classes
ArrowAssoc

Затенённые неявные члены значения

def filter(p: (A) ⇒ Boolean): TraversableOnce[A]

Неявный
Этот член добавлен с помощью неявного преобразования из IterableLike[A, Repr] в MonadOps[A] с помощью метода MonadOps в scala.collection.TraversableOnce.
Затенение
Этот неявно унаследованный член затенён одним или несколькими членами в этом классе.
Для доступа к этому члену можно использовать привязку типа:
(iterableLike: MonadOps[A]).filter(p)
Определяющие классы
MonadOps

def flatMap[B](f: (A) ⇒ GenTraversableOnce[B]): TraversableOnce[B]

Неявный
Этот член добавлен с помощью неявного преобразования из IterableLike[A, Repr] в MonadOps[A] с помощью метода MonadOps в scala.collection.TraversableOnce.
Затенение
Этот неявно унаследованный член затенён одним или несколькими членами в этом классе.
Для доступа к этому члену можно использовать привязку типа:
(iterableLike: MonadOps[A]).flatMap(f)
Определяющие классы
MonadOps

def map[B](f: (A) ⇒ B): TraversableOnce[B]

Неявный
Этот член добавлен с помощью неявного преобразования из IterableLike[A, Repr] в MonadOps[A] с помощью метода MonadOps в scala.collection.TraversableOnce.
Затенение
Этот неявно унаследованный член затенён одним или несколькими членами в этом классе.
Для доступа к этому члену можно использовать привязку типа:
(iterableLike: MonadOps[A]).map(f)
Определяющие классы
MonadOps

def withFilter(p: (A) ⇒ Boolean): Iterator[A]

Неявный
Этот член добавлен с помощью неявного преобразования из IterableLike[A, Repr] в MonadOps[A] с помощью метода MonadOps в scala.collection.TraversableOnce.
Затенение
Этот неявно унаследованный член затенён одним или несколькими членами в этом классе.
Для доступа к этому члену можно использовать привязку типа:
(iterableLike: MonadOps[A]).withFilter(p)
Определяющие классы
MonadOps

© 2002-2019 EPFL, with contributions from Lightbend.
Licensed under the Apache License, Version 2.0.
https://www.scala-lang.org/api/2.12.9/scala/collection/IterableLike.html

Spec-Zone.ru

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