Spec-Zone.ru › Scala 2.12 Library

Трейт scala.collection.Iterable

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

трейт Iterable[+A] extends Traversable[A] with GenIterable[A] with GenericTraversableTemplate[A, Iterable] with IterableLike[A, Iterable[A]]

Базовый трейт для итерируемых коллекций.

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

def iterator: Iterator[A]

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

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

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

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

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

Типовые члены

тип Self = Iterable[A]

Тип, реализующий этот обход

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

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

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

Классы-родители
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

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

bf

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

returns

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

Definition Classes
TraversableLike → GenTraversableLike

def ++:[B >: A, That](that: 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

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

bf

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

returns

новая коллекция типа That, которая содержит все элементы этой коллекции Traversable, за которыми следуют все элементы 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): (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

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

возвращает

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

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

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

Определяющие классы
Iterable → GenIterable → Traversable → GenTraversable → GenericTraversableTemplate

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

[use case]

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

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

xs

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

start

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

len

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

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

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

[use case]

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

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

xs

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

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

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

[use case]

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

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

xs

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

start

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

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

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

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

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

dest

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

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

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

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

p

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

возвращает

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

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

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

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

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

n

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

возвращает

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

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

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

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

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

n

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

возвращает

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

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

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

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

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

returns

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

Definition Classes
TraversableLike → GenTraversableLike

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

Implicit
Этот член добавлен неявным преобразованием из Iterable[A] в Ensuring[Iterable[A]], выполненным методом Ensuring в scala.Predef.
Definition Classes
Ensuring

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

Implicit
Этот член добавлен неявным преобразованием из Iterable[A] в Ensuring[Iterable[A]], выполненным методом Ensuring в scala.Predef.
Definition Classes
Ensuring

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

Implicit
Этот член добавлен неявным преобразованием из Iterable[A] в Ensuring[Iterable[A]], выполненным методом Ensuring в scala.Predef.
Definition Classes
Ensuring

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

Implicit
Этот член добавлен неявным преобразованием из Iterable[A] в Ensuring[Iterable[A]], выполненным методом Ensuring в scala.Predef.
Definition Classes
Ensuring

final def eq(arg0: AnyRef): Boolean

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

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

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

нейтральный элемент для операции 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 (@see 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 для произвольных типов элементов.

Definition Classes
GenericTraversableTemplate

final def getClass(): Class[_]

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

returns

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

Definition Classes
AnyRef → Any
Annotations
@native()

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

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

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

K

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

f

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

возвращает

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

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

То есть каждый ключ k связан с коллекцией обхода тех элементов 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

Проверяет, известно ли, что эта коллекция обхода имеет конечный размер. Все строгие коллекции известны как имеющие конечный размер. Для нестрогой коллекции, такой как 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]

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

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

возвращает

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

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

def init: Iterable[A]

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

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

возвращает

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

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

UnsupportedOperationException если коллекция обхода пустая.

def inits: Iterator[Iterable[A]]

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

возвращает

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

Классы-определения
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. В последнем примере, из-за стирания типа аргумента во время компиляции невозможно проверить, относятся ли элементы списка к указанному типу.

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]

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

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

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

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

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

returns

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

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

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

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

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

Находит первый элемент, который даёт наименьшее значение, измеренное функцией 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()
Note

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

final def notifyAll(): Unit

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

Definition Classes
AnyRef
Annotations
@native()
Note

не указано 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
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

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

Definition Classes
TraversableOnce → GenTraversableOnce

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

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

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

A1

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

op

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

returns

Значение Option, содержащее результат применения оператора reduce 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
Исключения

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

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

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

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

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

B

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

op

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

returns

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

Definition Classes
TraversableOnce → GenTraversableOnce

def repr: Iterable[A]

Коллекция типа итерируемого объекта, лежащего в основе этого 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[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 → GenIterable → 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

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

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]

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

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

возвращает

самый длинный префикс этой итерируемой коллекции, все элементы которой удовлетворяют предикату 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: Iterable[A]): 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( сообщение = ... , с = "2.11.0" )

def toList: List[A]

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

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

возвращает

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

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

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

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

Преобразует эту итерируемую коллекцию в карту. Этот метод недоступен, если элементы не являются членами 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: 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]

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

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

возвращает

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

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

def toVector: Vector[A]

Преобразует эту обходную структуру или итератор в вектор.

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

возвращает

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

Классы определений
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]]

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

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

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

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

from

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

until

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

returns

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

Definition Classes
IterableLike → TraversableLike

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

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

returns

нестрогая (lazy) просмотр (view) этой коллекции.

Definition Classes
IterableLike → TraversableLike

final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

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

Definition Classes
AnyRef
Annotations
@throws( ... )

final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... ) @native()

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

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

Примечание: разница между 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): (Iterable[A], B)

Неявный
Этот член добавлен неявным преобразованием из Iterable[A] в ArrowAssoc[Iterable[A]], выполненного методом ArrowAssoc в scala.Predef.
Definition Classes
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/Iterable.html

Spec-Zone.ru

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