Spec-Zone.ru › Scala 2.12 Library

Трейт scala.collection.immutable.Iterable

Компонент объект Iterable

трейт Iterable[+A] extends Traversable[A] with collection.Iterable[A] with GenericTraversableTemplate[A, Iterable] with IterableLike[A, Iterable[A]] with Parallelizable[A, ParIterable[A]]

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

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

def iterator: Iterator[A]

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

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

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

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

Источник
Iterable.scala
Линейные супертипы
Известные подклассы

Типы-члены

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

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

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

тип Self = Iterable[A]

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

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

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

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

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

возвращает

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

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

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

final def !=(arg0: Any): Boolean

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

returns

true если !(this == that), иначе false.

Definition Classes
AnyRef → Any

final def ##(): Int

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

returns

значение хеша, согласованное с ==

Definition Classes
AnyRef → Any

def +(other: String): String

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

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

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

B

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

That

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

that

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

bf

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

returns

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

Definition Classes
TraversableLike → GenTraversableLike

def ++:[B >: A, That](that: collection.Traversable[B])(implicit bf: CanBuildFrom[Iterable[A], 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

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

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

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

returns

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

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

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

Неявный
Этот член добавлен с помощью неявного преобразования из Iterable[A] в ArrowAssoc[Iterable[A]], выполненное методом 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 в противном случае.

Классы-определения
AnyRef → 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
Exceptions thrown

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

def canEqual(that: Any): Boolean

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

that

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

returns

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

Definition Classes
IterableLike → Equals

def clone(): AnyRef

Создаёт копию получаемого объекта.

По умолчанию реализация метода clone зависит от платформы.

returns

копия получаемого объекта.

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws( ... ) @native()
Note

не определён в SLS как член AnyRef

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 companion: GenericCompanion[Iterable]

Компаньон-объект-фабрика, создающий экземпляры класса immutable.Iterable. (или его Iterable суперкласса, где класс immutable.Iterable не является Seq.)

Definition Classes
Iterable → Iterable → GenIterable → Traversable → Traversable → GenTraversable → GenericTraversableTemplate

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): Iterable[A]

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

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

n

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

returns

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

Definition Classes
IterableLike → TraversableLike → GenTraversableLike

def dropRight(n: Int): Iterable[A]

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

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

n

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

returns

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

Definition Classes
IterableLike

def dropWhile(p: (A) ⇒ Boolean): Iterable[A]

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

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

returns

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

Definition Classes
TraversableLike → GenTraversableLike

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

Неявный
Этот член добавлен неявным преобразованием из Iterable[A] в Ensuring[Iterable[A]] с помощью метода Ensuring в scala.Predef.
Definition Classes
Ensuring

def ensuring(cond: (Iterable[A]) ⇒ Boolean): Iterable[A]

Неявный
Этот член добавлен неявным преобразованием из Iterable[A] в Ensuring[Iterable[A]] с помощью метода Ensuring в scala.Predef.
Definition Classes
Ensuring

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

Неявный
Этот член добавлен неявным преобразованием из Iterable[A] в Ensuring[Iterable[A]] с помощью метода Ensuring в scala.Predef.
Definition Classes
Ensuring

def ensuring(cond: Boolean): Iterable[A]

Неявный
Этот член добавлен неявным преобразованием из Iterable[A] в Ensuring[Iterable[A]] с помощью метода Ensuring в scala.Predef.
Definition Classes
Ensuring

final def eq(arg0: AnyRef): Boolean

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

Метод eq реализует отношение эквивалентности на не-null экземплярах AnyRef, и обладает тремя дополнительными свойствами:

    Он согласован: для любых не-null экземпляров x и y типа AnyRef, многократные вызовы x.eq(y) последовательно возвращают true или последовательно возвращают false.Для любого не-null экземпляра x типа AnyRef, x.eq(null) и null.eq(x) возвращает false. null.eq(null) возвращает true.

При переопределении методов equals или hashCode важно обеспечить согласованность их поведения с равенством по ссылке. Поэтому, если два объекта являются ссылками друг на друга (o1 eq o2), они должны быть равны друг другу (o1 == o2) и должны иметь одинаковое значение хэша (o1.hashCode == o2.hashCode).

returns

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

Definition Classes
AnyRef

def equals(arg0: Any): Boolean

Метод сравнения для ссылочных типов. Реализация по умолчанию делегирует eq.

См. также equals в scala.Any.

returns

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

Definition Classes
AnyRef → Any

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

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

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

p

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

returns

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

Definition Classes
IterableLike → TraversableLike → TraversableOnce → GenTraversableOnce

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

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

p

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

returns

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

Definition Classes
TraversableLike → GenTraversableLike

def filterNot(p: (A) ⇒ Boolean): Iterable[A]

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

p

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

returns

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

Definition Classes
TraversableLike → GenTraversableLike

def finalize(): Unit

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

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

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
Note

не указано SLS в качестве члена AnyRef

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 flatten[B]: Iterable[B]

[use case]

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

Тип результирующего набора будет определяться статическим типом неизменяемого итерируемого набора. Например:

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

тип элементов каждого набора.

returns

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

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

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

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

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

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

A1

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

z

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

op

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

returns

результат применения оператора слияния 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 (@см. java.lang.String.format).

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

def genericBuilder[B]: Builder[B, Iterable[B]]

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

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

final def getClass(): Class[_]

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

возвращает

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

Определяющие классы
AnyRef → Any
Аннотации
@native()

def groupBy[K](f: (A) ⇒ K): Map[K, Iterable[A]]

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

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

K

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

f

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

возвращает

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

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

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

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

def grouped(size: Int): Iterator[Iterable[A]]

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

size

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

возвращает

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

Определяющие классы
IterableLike
См. также

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

def hasDefiniteSize: Boolean

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

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

возвращает

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

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

def hashCode(): Int

Метод hashCode для ссылочных типов. См. hashCode в scala.Any.

возвращает

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

Определяющие классы
AnyRef → Any
Аннотации
@native()

def head: A

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

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

возвращает

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

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

NoSuchElementException если итерируемая коллекция пуста.

def headOption: Option[A]

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

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

возвращает

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

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

def init: Iterable[A]

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

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

возвращает

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

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

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

def inits: Iterator[Iterable[A]]

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

returns

итератор по всем начальным фрагментам (inits) этого итерируемого набора

Definition Classes
TraversableLike
Пример:

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

def isEmpty: Boolean

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

returns

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

Definition Classes
IterableLike → TraversableLike → TraversableOnce → GenTraversableOnce

final def isInstanceOf[T0]: Boolean

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

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

returns

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

Definition Classes
Any

final def isTraversableAgain: Boolean

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

returns

true

Definition Classes
TraversableLike → GenTraversableLike → GenTraversableOnce

def last: A

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

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

returns

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

Definition Classes
TraversableLike → GenTraversableLike
Исключения

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

def lastOption: Option[A]

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

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

returns

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

Definition Classes
TraversableLike → GenTraversableLike

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

[пример использования]

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

B

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

f

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

returns

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

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

def max: A

[пример использования]

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

returns

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

Definition Classes
TraversableOnce → GenTraversableOnce
Полная сигнатура
Исключения

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

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

[пример использования]

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

B

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

f

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

returns

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

Definition Classes
TraversableOnce → GenTraversableOnce
Полная сигнатура
Исключения

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

def min: A

[use case]

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

returns

наименьший элемент этой неизменяемой итерируемой коллекции

Definition Classes
TraversableOnce → GenTraversableOnce
Полная подпись
Исключения

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

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

[use case]

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

B

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

f

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

returns

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

Definition Classes
TraversableOnce → GenTraversableOnce
Полная подпись
Исключения

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

def mkString: String

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

returns

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

Definition Classes
TraversableOnce → GenTraversableOnce

def mkString(sep: String): String

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

sep

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

returns

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

Definition Classes
TraversableOnce → GenTraversableOnce
Пример:

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

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

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

start

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

sep

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

end

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

returns

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

Definition Classes
TraversableOnce → GenTraversableOnce
Пример:

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

final def ne(arg0: AnyRef): Boolean

Эквивалентно !(this eq that).

returns

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

Definition Classes
AnyRef

def newBuilder: Builder[A, Iterable[A]]

Библиотека, создающая экземпляры типа Traversable[A].

Attributes
protected[this]
Definition Classes
GenericTraversableTemplate → HasNewBuilder

def nonEmpty: Boolean

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

returns

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

Definition Classes
TraversableOnce → GenTraversableOnce

final def notify(): Unit

Разбуживает один поток, ожидающий монитора объекта-получателя.

Definition Classes
AnyRef
Annotations
@native()
Примечание

не указано в SLS как член AnyRef

final def notifyAll(): Unit

Разбуживает все потоки, ожидающие монитора объекта-получателя.

Definition Classes
AnyRef
Annotations
@native()
Примечание

не указано в SLS как член AnyRef

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
Iterable → TraversableLike → Parallelizable

def partition(p: (A) ⇒ Boolean): (Iterable[A], Iterable[A])

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

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

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

Definition Classes
TraversableOnce → GenTraversableOnce

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

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

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

A1

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

op

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

returns

Значение типа Option, содержащее результат применения оператора reduce к всем элементам, если коллекция не пуста, и 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: Iterable[A]

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

Definition Classes
TraversableLike → GenTraversableLike

def reversed: scala.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[Iterable[A], 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[Iterable[A], 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[Iterable[A], 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 seq: Iterable[A]

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

Этот метод возвращает ссылку на эту коллекцию. В параллельных коллекциях он переопределяется для возврата последовательной реализации этой коллекции. В обоих случаях сложность составляет O(1).

returns

последовательный вид коллекции.

Definition Classes
Iterable → Iterable → GenIterable → Traversable → Traversable → GenTraversable → Parallelizable → TraversableOnce → GenTraversableOnce

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): Iterable[A]

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

from <= indexOf(x) < until

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

returns

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

Definition Classes
IterableLike → TraversableLike → GenTraversableLike

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

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

size

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

step

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

returns

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

Definition Classes
IterableLike
See also

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

def sliding(size: Int): Iterator[Iterable[A]]

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

size

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

returns

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

Definition Classes
IterableLike
See also

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

def span(p: (A) ⇒ Boolean): (Iterable[A], Iterable[A])

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

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

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

returns

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

Definition Classes
TraversableLike → GenTraversableLike

def splitAt(n: Int): (Iterable[A], Iterable[A])

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

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

n

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

returns

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

Definition Classes
TraversableLike → GenTraversableLike

def stringPrefix: String

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

returns

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

Definition Classes
TraversableLike → GenTraversableLike

def sum: A

[use case]

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

returns

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

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

final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef

def tail: Iterable[A]

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

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

returns

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

Definition Classes
TraversableLike → GenTraversableLike
Исключения

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

def tails: Iterator[Iterable[A]]

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

returns

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

Definition Classes
TraversableLike
Пример:

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

def take(n: Int): Iterable[A]

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

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

n

количество элементов, которые нужно взять из этой итерируемой коллекции.

returns

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

Definition Classes
IterableLike → TraversableLike → GenTraversableLike

def takeRight(n: Int): Iterable[A]

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

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

n

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

returns

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

Definition Classes
IterableLike

def takeWhile(p: (A) ⇒ Boolean): Iterable[A]

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

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

returns

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

Definition Classes
IterableLike → TraversableLike → GenTraversableLike

def thisCollection: collection.Iterable[A]

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

Attributes
protected[this]
Definition Classes
IterableLike → TraversableLike

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

[use case]

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

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

Col

Тип коллекции для построения.

returns

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

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

def toArray: Array[A]

[use case]

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

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

returns

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

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

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

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

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

returns

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

Definition Classes
TraversableOnce → GenTraversableOnce

def toCollection(repr: Iterable[A]): collection.Iterable[A]

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

Attributes
protected[this]
Definition Classes
IterableLike → TraversableLike

def toIndexedSeq: IndexedSeq[A]

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

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

returns

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

Definition Classes
TraversableOnce → GenTraversableOnce

def toIterable: collection.Iterable[A]

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

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

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

возвращает

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

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

def toIterator: Iterator[A]

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

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

возвращает

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

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

def toList: scala.List[A]

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

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

возвращает

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

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

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

[use case]

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

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

возвращает

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

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

def toParArray: ParArray[T]

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

def toSeq: collection.Seq[A]

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

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

возвращает

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

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

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

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

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

возвращает

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

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

def toStream: Stream[A]

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

возвращает

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

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

def toString(): String

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

возвращает

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

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

def toTraversable: collection.Traversable[A]

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

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

returns

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

Definition Classes
TraversableLike → TraversableOnce → GenTraversableOnce
Annotations
@deprecatedOverriding( message = ... , since = "2.11.0" )

def toVector: scala.Vector[A]

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

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

returns

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

Definition Classes
TraversableOnce → GenTraversableOnce

def transpose[B](implicit asTraversable: (A) ⇒ GenTraversableOnce[B]): Iterable[Iterable[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

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

asTraversable

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

returns

двумерная коллекция коллекций, у которой n-я строка — это n-й столбец этой коллекции.

Definition Classes
GenericTraversableTemplate
Annotations
@migration
Migration

(Изменено в версии 2.9.0) transpose выбросит IllegalArgumentException если коллекции не имеют одинаковый размер.

Exceptions thrown

IllegalArgumentException если все коллекции в этой коллекции не имеют одинаковый размер.

def unzip[A1, A2](implicit asPair: (A) ⇒ (A1, A2)): (Iterable[A1], Iterable[A2])

Преобразует эту коллекцию пар в две коллекции из первой и второй половины каждой пары.

val xs = Traversable(
           (1, "one"),
           (2, "two"),
           (3, "three")).unzip
// xs == (Traversable(1, 2, 3),
//        Traversable(one, two, three))
A1

тип первой половины пар элементов

A2

тип второй половины пар элементов

asPair

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

returns

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

Definition Classes
GenericTraversableTemplate

def unzip3[A1, A2, A3](implicit asTriple: (A) ⇒ (A1, A2, A3)): (Iterable[A1], Iterable[A2], Iterable[A3])

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

val xs = Traversable(
           (1, "one", '1'),
           (2, "two", '2'),
           (3, "three", '3')).unzip3
// xs == (Traversable(1, 2, 3),
//        Traversable(one, two, three),
//        Traversable(1, 2, 3))
A1

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

A2

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

A3

тип третьего члена троек элементов

asTriple

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

returns

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

Definition Classes
GenericTraversableTemplate

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

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

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

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

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

from

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

until

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

returns

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

Definition Classes
IterableLike → TraversableLike

def view: IterableView[A, Iterable[A]]

Создаёт нестрогую (non-strict) просмотр (view) этой итерируемой коллекции.

returns

нестрогую (non-strict) просмотр (view) этой итерируемой коллекции.

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

final def wait(): Unit

Классы-определения
AnyRef
Аннотации
@throws( ... )

final def wait(arg0: Long, arg1: Int): Unit

Классы-определения
AnyRef
Аннотации
@throws( ... )

final def wait(arg0: Long): Unit

Классы-определения
AnyRef
Аннотации
@throws( ... ) @native()

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

Создаёт нестрогую (non-strict) фильтрацию (filter) этой коллекции.

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

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

p

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

returns

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

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

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

[пример использования]

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

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

B

тип второй части возвращаемых пар

that

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

returns

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

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

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

[пример использования]

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

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

B

тип второй части возвращаемых пар

that

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

thisElem

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

thatElem

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

returns

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

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

def zipWithIndex: Iterable[(A, Int)]

[пример использования]

Объединяет эту неизменяемую итерируемую коллекцию со своими индексами.

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

returns

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

Классы-определения
IterableLike → GenIterableLike
Полная подпись
Пример:

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

def →[B](y: B): (Iterable[A], B)

Неявный
Этот член добавлен неявным преобразованием из Iterable[A] в ArrowAssoc[Iterable[A]], выполненное методом ArrowAssoc в scala.Predef.
Определяющие классы
ArrowAssoc

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

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

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

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

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

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

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

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

Неявный
Этот член добавлен неявным преобразованием из Iterable[A] в MonadOps[A], выполненное методом MonadOps в scala.collection.TraversableOnce.
Затенение
Этот неявно унаследованный член затенён одним или несколькими членами в этом классе.
Чтобы получить доступ к этому члену, можно использовать явное указание типа:
(iterable: 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/immutable/Iterable.html

Spec-Zone.ru

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