Spec-Zone.ru › Scala 2.12 Library

Трейт scala.collection.generic.IterableForwarder

трейт IterableForwarder[+A] extends Iterable[A] with TraversableForwarder[A]

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

  • toString, hashCode, equals, stringPrefix
  • newBuilder, view
  • всех вызовов, создающих новый итерируемый объект того же типа

Вышеперечисленные методы перенаправляются подклассом `IterableProxy`.

Аннотации
@deprecated
Устаревшее

(С версии 2.11.0) перенаправление ненадёжно, так как не автоматизировано, и методы могут быть забыты

Исходный код
IterableForwarder.scala
С версии

2.8

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

Члены типа

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

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

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

тип Self = Iterable[A]

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

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

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

абстрактный def underlying: Iterable[A]

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

Атрибуты
protected
Определяющие классы
IterableForwarder → TraversableForwarder

Члены конкретных значений

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

Неявный
Этот член добавлен с помощью неявного преобразования из IterableForwarder[A] в any2stringadd[IterableForwarder[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: 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): (IterableForwarder[A], B)

Implicit
Этот член добавлен неявным преобразованием из IterableForwarder[A] в ArrowAssoc[IterableForwarder[A]] при помощи метода ArrowAssoc в scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@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

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

returns

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

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

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

Definition Classes
TraversableForwarder → 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

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

returns

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

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

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

Definition Classes
TraversableForwarder → TraversableOnce → GenTraversableOnce

final def ==(arg0: Any): Boolean

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

returns

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

Definition Classes
AnyRef → Any

def addString(b: mutable.StringBuilder): mutable.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

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

returns

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

Definition Classes
TraversableForwarder → TraversableOnce

def addString(b: mutable.StringBuilder, sep: String): mutable.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

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

returns

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

Definition Classes
TraversableForwarder → TraversableOnce

def addString(b: mutable.StringBuilder, start: String, sep: String, end: String): mutable.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
TraversableForwarder → 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

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

возвращает

значение опции, содержащей применённую 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]): Unit

[use case]

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

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

xs

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

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

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

[use case]

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

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

xs

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

start

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

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

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

[use case]

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

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

xs

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

start

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

len

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

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

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

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

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

dest

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

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

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

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

p

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

возвращает

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

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

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

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

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

n

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

возвращает

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

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

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

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

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

n

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

returns

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

Definition Classes
IterableLike

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

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

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

returns

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

Definition Classes
TraversableLike → GenTraversableLike

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

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

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

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

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

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

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

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

final def eq(arg0: AnyRef): Boolean

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

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

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

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

returns

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

Definition Classes
AnyRef

def equals(arg0: Any): Boolean

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

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

returns

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

Definition Classes
AnyRef → Any

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

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

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

p

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

returns

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

Definition Classes
TraversableForwarder → TraversableLike → TraversableOnce → GenTraversableOnce

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

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

p

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

returns

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

Definition Classes
TraversableLike → GenTraversableLike

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

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

p

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

returns

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

Definition Classes
TraversableLike → GenTraversableLike

def finalize(): Unit

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

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

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

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

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

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

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

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

p

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

returns

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

Definition Classes
TraversableForwarder → TraversableLike → TraversableOnce → GenTraversableOnce

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

[use case]

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

Например:

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

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

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

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

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

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

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

f

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

returns

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

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

def flatten[B]: Iterable[B]

[use case]

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

Тип возвращаемой коллекции определяется статическим типом итерируемой коллекции. Например:

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

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

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

returns

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

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

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

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

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

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

A1

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

z

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

op

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

returns

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

Definition Classes
TraversableOnce → GenTraversableOnce

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

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

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

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

B

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

z

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

op

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

returns

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

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

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

Definition Classes
TraversableForwarder → 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
TraversableForwarder → TraversableOnce → GenTraversableOnce

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

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

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

p

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

returns

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

Definition Classes
TraversableForwarder → TraversableLike → TraversableOnce → GenTraversableOnce

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

[use case]
f

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

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

def formatted(fmtstr: String): String

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

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

def hashCode(): Int

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

returns

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

Definition Classes
AnyRef → Any
Annotations
@native()

def head: A

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

returns

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

Definition Classes
TraversableForwarder → GenericTraversableTemplate → TraversableLike → GenTraversableLike
Exceptions thrown

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

def headOption: Option[A]

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

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

returns

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

Definition Classes
TraversableForwarder → 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 в противном случае.

Классы-определения
TraversableForwarder → GenericTraversableTemplate → 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 iterator: Iterator[A]

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

возвращает

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

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

def last: A

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

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

возвращает

Последний элемент этой коллекции.

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

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

def lastOption: Option[A]

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

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

возвращает

последний элемент этой коллекции, если она не пуста, None если она пуста.

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

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

[use case]

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

B

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

f

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

возвращает

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

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

def max: A

[служебный случай]

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

возвращает

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

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

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

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

[служебный случай]

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

B

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

f

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

возвращает

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

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

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

def min: A

[служебный случай]

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

возвращает

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

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

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

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

[служебный случай]

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

B

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

f

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

возвращает

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

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

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

def mkString: String

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

возвращает

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

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

def mkString(sep: String): String

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

sep

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

возвращает

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

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

Определяющие классы
TraversableForwarder → 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 в противном случае.

Определяющие классы
TraversableForwarder → 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 занимает постоянное или подлинейное время.

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

возвращает

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

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

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

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

возвращает

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

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

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

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

p

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

возвращает

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

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

def product: A

[use case]

Произведение элементов этой коллекции.

возвращает

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

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

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

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

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

A1

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

op

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

возвращает

Результат применения редуцирующего оператора op между всеми элементами, если обход или итератор непусты.

Определяющие классы
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
TraversableForwarder → TraversableOnce
Исключения

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

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

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

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

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

B

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

op

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

returns

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

Definition Classes
TraversableForwarder → 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
TraversableForwarder → TraversableOnce → GenTraversableOnce
Исключения

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

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

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

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

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

B

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

op

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

returns

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

Definition Classes
TraversableForwarder → 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

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

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

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

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

that

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

returns

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

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

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

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

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

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

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

Классы-определения
TraversableLike → GenTraversableLike
Аннотации
@migration
Миграция

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

def seq: Iterable[A]

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

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

returns

последовательный вид набора.

Классы-определения
Iterable → GenIterable → Traversable → GenTraversable → Parallelizable → TraversableOnce → GenTraversableOnce

def size: Int

Размер этого набора.

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

возвращает

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

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

def sizeHintIfCheap: Int

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

возвращает

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

Атрибуты
protected[collection]
Классы определений
GenTraversableOnce

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

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

from <= indexOf(x) < until

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

возвращает

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

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

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

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

size

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

step

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

возвращает

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

Классы определений
IterableLike
См. также

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

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

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

size

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

возвращает

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

Классы определений
IterableLike
См. также

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

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

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

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

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

возвращает

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

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

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

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

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

n

позиция разделения.

возвращает

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

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

def stringPrefix: String

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

возвращает

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

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

def sum: A

[use case]

Суммирует элементы этого набора.

возвращает

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

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

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

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

def tail: Iterable[A]

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

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

возвращает

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

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

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

def tails: Iterator[Iterable[A]]

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

возвращает

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

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

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

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

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

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

возвращает

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

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

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

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

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

def toIndexedSeq: immutable.IndexedSeq[A]

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

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

возвращает

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

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

def toIterable: Iterable[A]

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

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

возвращает

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

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

def toIterator: Iterator[A]

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

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

возвращает

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

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

def toList: immutable.List[A]

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

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

возвращает

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

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

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

[use case]

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

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

возвращает

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

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

def toParArray: ParArray[T]

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

def toSeq: Seq[A]

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

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

возвращает

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

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

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

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

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

возвращает

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

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

def toStream: immutable.Stream[A]

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

возвращает

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

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

def toString(): String

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

возвращает

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

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

def toTraversable: Traversable[A]

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

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

возвращает

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

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

def toVector: Vector[A]

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

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

возвращает

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

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

def transpose[B](implicit asTraversable: (A) ⇒ GenTraversableOnce[B]): Iterable[Iterable[B]]

Транспонирует это множество итерируемых множеств в множество множеств.

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

val xs = List(
           Set(1, 2, 3),
           Set(4, 5, 6)).transpose
// xs == List(
//         List(1, 4),
//         List(2, 5),
//         List(3, 6))

val ys = Vector(
           List(1, 2, 3),
           List(4, 5, 6)).transpose
// ys == Vector(
//         Vector(1, 4),
//         Vector(2, 5),
//         Vector(3, 6))
B

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

asTraversable

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

возвращает

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

Определяющие классы
GenericTraversableTemplate
Аннотации
@migration
Миграция

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

Исключения

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
Полная подпись

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

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

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

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

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

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

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

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

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

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

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

Spec-Zone.ru

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