Spec-Zone.ru › Scala 2.12 Library

Трейт scala.collection.mutable.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

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

возвращает

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

Definition Classes
AnyRef → Any

final def ##(): Int

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

возвращает

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

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.

возвращает

новая коллекция типа 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.

возвращает

новая коллекция типа 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

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

возвращает

новая итерируемая коллекция, содержащая все элементы этой коллекции, за которыми следуют все элементы 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: scala.StringBuilder): scala.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: scala.StringBuilder, sep: String): scala.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: scala.StringBuilder, start: String, sep: String, end: String): scala.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
Full Signature

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.)

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

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

возвращает

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

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

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

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

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

возвращает

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

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

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

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

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

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

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

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

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

Неявный
Этот член добавлен неявным преобразованием из Iterable[A] в Ensuring[Iterable[A]], выполненным методом Ensuring в scala.Predef.
Классы-определения
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).

возвращает

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

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

def equals(arg0: Any): Boolean

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

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

возвращает

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

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

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

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

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

p

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

возвращает

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

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

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

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

p

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

возвращает

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

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

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

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

p

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

возвращает

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

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

def finalize(): Unit

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

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

Атрибуты
protected[lang]
Классы определения
AnyRef
Аннотации
@throws( classOf[java.lang.Throwable] )
Примечание

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

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

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

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

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

p

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

возвращает

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

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

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

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

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

Например:

def getWords(lines: Seq[String]): Seq[String] = lines flatMap (line => line split "\\W+")

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

// lettersOf will return a Seq[Char] of likely repeated letters, instead of a Set
def lettersOf(words: Seq[String]) = words flatMap (word => word.toSet)

// lettersOf will return a Set[Char], not a Seq
def lettersOf(words: Seq[String]) = words.toSet flatMap (word => word.toSeq)

// xs will be an Iterable[Int]
val xs = Map("a" -> List(11,111), "b" -> List(22,222)).flatMap(_._2)

// ys will be a Map[Int, Int]
val ys = Map("a" -> List(1 -> 11,1 -> 111), "b" -> List(2 -> 22,2 -> 222)).flatMap(_._2)
B

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

f

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

возвращает

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

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

def flatten[B]: Iterable[B]

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

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

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

val xs = List(
           Set(1, 2, 3),
           Set(1, 2, 3)
         ).flatten
// xs == List(1, 2, 3, 1, 2, 3)

val ys = Set(
           List(1, 2, 3),
           List(3, 2, 1)
         ).flatten
// ys == Set(1, 2, 3)
B

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

возвращает

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

Классы определения
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 строкой. Строки форматирования аналогичны 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): 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, если элементы не делятся равномерно.

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

возвращает

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

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

final def isTraversableAgain: Boolean

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

возвращает

true

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

def last: A

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

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

возвращает

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

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

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

def lastOption: Option[A]

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

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

возвращает

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

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

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

[случай использования]

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

B

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

f

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

возвращает

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

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

def max: A

[случай использования]

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

возвращает

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

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

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

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

[случай использования]

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

B

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

f

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

возвращает

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

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

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

def min: A

[use case]

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

возвращает

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

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

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

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

[use case]

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

B

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

f

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

возвращает

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

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

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

def mkString: String

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

возвращает

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

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

def mkString(sep: String): String

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

sep

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

возвращает

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

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

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

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

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

start

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

sep

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

end

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

возвращает

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

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

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

final def ne(arg0: AnyRef): Boolean

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

возвращает

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

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

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

Построитель, который строит экземпляры типа Traversable[A]

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

def nonEmpty: Boolean

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

возвращает

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

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

final def notify(): Unit

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

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

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

final def notifyAll(): Unit

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

Определяющие классы
AnyRef
Аннотации
@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

Результат применения оператора 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]

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

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

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
Exceptions thrown

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

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

возвращает

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

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

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

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

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

n

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

возвращает

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

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

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

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

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

возвращает

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

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

def thisCollection: collection.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]): collection.Iterable[A]

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

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

def toIndexedSeq: immutable.IndexedSeq[A]

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

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

возвращает

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

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

def toIterable: collection.Iterable[A]

Возвращает этот итерируемый набор как итерируемый набор.

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

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

возвращает

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

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

def toIterator: Iterator[A]

Возвращает итератор по элементам в этом итерируемом наборе. Возвращает тот же результат, что и iterator.

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

returns

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

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

def toList: List[A]

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

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

returns

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

Definition Classes
TraversableOnce → GenTraversableOnce

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

[use case]

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

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

returns

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

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

def toParArray: ParArray[T]

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

def toSeq: collection.Seq[A]

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

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

returns

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

Definition Classes
TraversableOnce → GenTraversableOnce

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

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

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

returns

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

Definition Classes
TraversableOnce → GenTraversableOnce

def toStream: immutable.Stream[A]

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

returns

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

Definition Classes
IterableLike → TraversableLike → GenTraversableOnce

def toString(): String

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

returns

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

Definition Classes
TraversableLike → Any

def toTraversable: collection.Traversable[A]

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

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

returns

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

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

def toVector: 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]]

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

returns

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

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
Полная сигнатура

... ``` ```html

def zipWithIndex: Iterable[(A, Int)]

[use case]

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

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

returns

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

Definition Classes
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.
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/mutable/Iterable.html

Spec-Zone.ru

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