Spec-Zone.ru › Scala 2.12 Library

Класс scala.collection.AbstractIterable

абстрактный класс AbstractIterable[+A] extends AbstractTraversable[A] with Iterable[A]

Явное создание экземпляра Iterable-трейта для уменьшения размера файла класса в подклассах.

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

Конструкторы экземпляров

новый AbstractIterable()

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

тип 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

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

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

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

B

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

That

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

that

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

bf

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

returns

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

Definition Classes
TraversableLike → GenTraversableLike

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

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

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

Пример:

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

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

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

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

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

B

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

That

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

that

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

bf

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

returns

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

Definition Classes
TraversableLike

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

[use case]

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

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

Пример:

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

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

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

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

that

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

returns

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

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

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

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

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

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

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

Примеры:

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

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

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

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

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

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

B

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

z

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

op

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

возвращает

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

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

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

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

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

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

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

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

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

Примеры:

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

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

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

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

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

z

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

op

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

возвращает

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

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

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

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

final def ==(arg0: Any): Boolean

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

возвращает

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

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

def addString(b: StringBuilder): StringBuilder

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

Пример:

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

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

scala> val h = a.addString(b)
h: StringBuilder = 1234
b

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

возвращает

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

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

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

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

Пример:

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

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

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

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

sep

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

возвращает

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

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

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

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

Пример:

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

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

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

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

start

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

sep

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

end

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

returns

строка-построитель b, в которую были добавлены элементы.

Definition Classes
TraversableOnce

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

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

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

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

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

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

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

z

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

seqop

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

combop

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

Definition Classes
TraversableOnce → GenTraversableOnce

final def asInstanceOf[T0]: T0

Преобразует объект-получатель в объект типа T0.

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

returns

объект-получатель.

Definition Classes
Any
Exceptions thrown

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

def canEqual(that: Any): Boolean

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

that

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

returns

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

Definition Classes
IterableLike → Equals

def clone(): AnyRef

Создает копию объекта-получателя.

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

returns

копию объекта-получателя.

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

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

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

[use case]

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

B

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

pf

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

returns

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

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

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

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

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

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

pf

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

возвращает

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

Определяющие классы
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]

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

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

возвращает

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

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

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

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

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

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

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

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

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

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

final def eq(arg0: AnyRef): Boolean

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

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

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

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

возвращает

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

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

возвращает

значение опциона, содержащее первый элемент в итерируемом наборе, который удовлетворяет 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

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

Неявный
Этот член добавлен неявным преобразованием из AbstractIterable[A] в StringFormat[AbstractIterable[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

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

returns

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

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

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

Definition Classes
TraversableLike → GenTraversableLike

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

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

size

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

returns

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

Definition Classes
IterableLike
See also

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

def hasDefiniteSize: Boolean

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

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

returns

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

Definition Classes
TraversableLike → TraversableOnce → GenTraversableOnce

def hashCode(): Int

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

returns

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

Definition Classes
AnyRef → Any
Annotations
@native()

def head: A

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

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

returns

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

Definition Classes
IterableLike → TraversableLike → GenTraversableLike
Exceptions thrown

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

def headOption: Option[A]

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

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

returns

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

Definition Classes
TraversableLike → GenTraversableLike

def init: Iterable[A]

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

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

returns

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

Definition Classes
TraversableLike → GenTraversableLike
Exceptions thrown

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

def inits: Iterator[Iterable[A]]

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

returns

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

Definition Classes
TraversableLike
Пример:

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

def isEmpty: Boolean

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

returns

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

Definition Classes
IterableLike → TraversableLike → TraversableOnce → GenTraversableOnce

final def isInstanceOf[T0]: Boolean

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

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

returns

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

Definition Classes
Any

final def isTraversableAgain: Boolean

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

returns

true

Definition Classes
TraversableLike → GenTraversableLike → GenTraversableOnce

def last: A

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

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

returns

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

Definition Classes
TraversableLike → GenTraversableLike
Exceptions thrown

NoSuchElementException Если итерируемое множество пустое.

def lastOption: Option[A]

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

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

returns

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

Definition Classes
TraversableLike → GenTraversableLike

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

[use case]

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

B

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

f

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

returns

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

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

def max: A

[use case]

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

returns

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

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

UnsupportedOperationException если это итерируемое множество пустое.

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

[use case]

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

B

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

f

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

returns

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

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

UnsupportedOperationException если это итерируемое множество пустое.

def min: A

[use case]

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

returns

наименьший элемент этого итерируемого множества

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

UnsupportedOperationException если это итерируемое множество пустое.

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

[use case]

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

B

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

f

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

returns

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

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

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

def mkString: String

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

returns

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

Definition Classes
TraversableOnce → GenTraversableOnce

def mkString(sep: String): String

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

sep

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

returns

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

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

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

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

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

start

стартовая строка.

sep

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

end

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

returns

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

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

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

final def ne(arg0: AnyRef): Boolean

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

returns

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

Definition Classes
AnyRef

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

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

Attributes
protected[this]
Definition Classes
GenericTraversableTemplate → HasNewBuilder

def nonEmpty: Boolean

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

returns

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

Definition Classes
TraversableOnce → GenTraversableOnce

final def notify(): Unit

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

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

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

final def notifyAll(): Unit

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

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

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

def par: ParIterable[A]

Возвращает параллельное представление этого набора.

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

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

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

returns

параллельное представление этого набора

Definition Classes
Parallelizable

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

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

returns

комбиниратор для параллельной коллекции типа ParRepr

Attributes
protected[this]
Definition Classes
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
Exceptions thrown

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

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

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

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

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

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

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

B

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

op

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

returns

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

Definition Classes
TraversableOnce → GenTraversableOnce

def repr: Iterable[A]

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

Definition Classes
TraversableLike → GenTraversableLike

def reversed: 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

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

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

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

возвращает

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

Определяющие классы
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( message = ... , since = "2.11.0" )

def toList: List[A]

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

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

returns

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

Definition Classes
TraversableOnce → GenTraversableOnce

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

[use case]

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

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

returns

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

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

def toParArray: ParArray[T]

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

def toSeq: 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: Traversable[A]

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

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

returns

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

Definition Classes
TraversableLike → TraversableOnce → GenTraversableOnce
Аннотации
@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]]

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

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

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

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

from

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

until

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

returns

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

Definition Classes
IterableLike → TraversableLike

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

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

returns

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

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]

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

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

B

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

that

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

thisElem

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

thatElem

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

returns

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

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

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): (AbstractIterable[A], B)

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

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

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

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

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

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

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

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

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

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

Spec-Zone.ru

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