Spec-Zone.ru › Scala 2.13 Library

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

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

трейт Iterable[+A] extends collection.Iterable[A] with IterableOps[A, Iterable, Iterable[A]] with IterableFactoryDefaults[A, Iterable]

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

A

тип элементов коллекции

Источник
Iterable.scala
Линейные супертипы
collection.Iterable[A], IterableFactoryDefaults[A, [x]Iterable[x]], IterableOps[A, [_]Iterable[_], Iterable[A]], IterableOnceOps[A, [_]Iterable[_], Iterable[A]], IterableOnce[A], AnyRef, Any
Известные подклассы
ValueSet, ::, AbstractMap, AbstractSeq, AbstractSet, ArraySeq, ofBoolean, ofByte, ofChar, ofDouble, ofFloat, ofInt, ofLong, ofRef, ofShort, ofUnit, BitSet, HashMap, HashSet, IndexedSeq, IntMap, LazyList, LinearSeq, List, ListMap, ListSet, Node, LongMap, Map, Map1, Map2, Map3, Map4, WithDefault, ImmutableKeySet, Nil, NumericRange, Exclusive, Inclusive, Queue, Range,
Исключающий, Включающий, Последовательность, SeqMap, Множество, Множество1, Множество2, Множество3, Множество4, СортированныйMap, С параметром по умолчанию, Неизменяемое множество ключей, Сортированное множество, Cons, Пустой, TreeMap, TreeSeqMap, TreeSet, Вектор, ВекторныйMap, Оборачивающая строка, BitSet1, BitSet2, BitSetN, Поток

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

abstract def iterator: Итератор[A]

Итератор можно использовать только один раз

Definition Classes
IterableOnce

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

final def !=(arg0: Any): Boolean

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

returns

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

Definition Classes
AnyRef → Any

final def ##(): Int

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

returns

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

Definition Classes
AnyRef → Any

def +(other: String): String

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

final def ++[B >: A](suffix: IterableOnce[B]): Iterable[B]

Псевдоним для concat

Definition Classes
IterableOps
Annotations
@inline()

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

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

final def ==(arg0: Any): Boolean

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

возвращает

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

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

final 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

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

возвращает

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

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

final 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

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

возвращает

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

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

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
IterableOnceOps

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 className: String

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

Рекомендуется возвращать имя конкретного типа коллекции, а не подклассы реализации. Например, для ListMap этот метод должен возвращать "ListMap", а не "Map" (супертип) или "Node" (подкласс реализации).

По умолчанию реализация возвращает "Iterable". Она переопределена для основных типов коллекций "Seq", "IndexedSeq", "LinearSeq", "Buffer", "Set", "Map", "SortedSet", "SortedMap" и "View".

returns

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

Attributes
protected[this]
Definition Classes
Iterable

def clone(): AnyRef

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

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

возвращает

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

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

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

final def coll: Iterable.this.type

возвращает

Это коллекция в виде C.

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

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

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

B

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

pf

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

возвращает

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

Определяющие классы
IterableOps → IterableOnceOps
Примечание

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

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

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

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

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

pf

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

возвращает

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

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

    Seq("a", 1, 5L).collectFirst({ case x: Int => x*10 }) = Some(10)

def concat[B >: A](suffix: IterableOnce[B]): Iterable[B]

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

B

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

suffix

перебираемый для добавления.

returns

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

Definition Classes
IterableOps

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

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

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

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

B

тип элементов массива.

xs

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

start

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

len

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

returns

количество элементов, записанных в массив

Definition Classes
IterableOnceOps
Примечание

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

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

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

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

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

B

тип элементов массива.

xs

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

start

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

returns

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

Definition Classes
IterableOnceOps

def copyToArray[B >: A](xs: Array[B]): Int

Копирование элементов в массив, возвращая количество скопированных элементов.

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

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

B

тип элементов массива.

xs

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

returns

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

Definition Classes
IterableOnceOps

def corresponds[B](that: IterableOnce[B])(p: (A, B) => Boolean): Boolean

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

B

тип элементов that

that

другой набор

p

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

returns

true если оба набора имеют одинаковую длину и p(x, y) является true для всех соответствующих элементов x этого итератора и y that, в противном случае false

Definition Classes
IterableOnceOps

def count(p: (A) => Boolean): Int

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

p

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

returns

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

Definition Classes
IterableOnceOps

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

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

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

n

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

возвращает

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

Определяющие классы
IterableOps → IterableOnceOps
Примечание

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

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

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

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

n

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

возвращает

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

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

def dropWhile(p: (A) => Boolean): Iterable[A]

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

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

p

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

возвращает

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

Определяющие классы
IterableOps → IterableOnceOps
Примечание

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

def empty: Iterable[A]

Пустой итерируемый набор того же типа, что и этот итерируемый набор

возвращает

пустой итерируемый набор типа C.

Определяющие классы
IterableFactoryDefaults → IterableOps

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

Implicit
This member is added by an implicit conversion from Iterable[A] toEnsuring[Iterable[A]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring

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

Implicit
This member is added by an implicit conversion from Iterable[A] toEnsuring[Iterable[A]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring

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

Implicit
This member is added by an implicit conversion from Iterable[A] toEnsuring[Iterable[A]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring

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

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

final def eq(arg0: AnyRef): Boolean

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

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

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

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

возвращает

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

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

def equals(arg0: AnyRef): Boolean

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

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

возвращает

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

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

def exists(p: (A) => Boolean): Boolean

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

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

p

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

возвращает

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

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

def filter(pred: (A) => Boolean): Iterable[A]

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

returns

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

Definition Classes
IterableOps → IterableOnceOps

def filterNot(pred: (A) => Boolean): Iterable[A]

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

pred

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

returns

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

Definition Classes
IterableOps → IterableOnceOps

def finalize(): Unit

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

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

Attributes
protected[java.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
IterableOnceOps

def flatMap[B](f: (A) => IterableOnce[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: String) => 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
IterableOps → IterableOnceOps
Note

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

def flatten[B](implicit asIterable: (A) => IterableOnce[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

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

asIterable

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

returns

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

Definition Classes
IterableOps → IterableOnceOps
Note

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

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

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

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

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

A1

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

z

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

op

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

returns

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

Definition Classes
IterableOnceOps

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
IterableOnceOps

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
IterableOnceOps

def forall(p: (A) => Boolean): Boolean

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

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

p

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

returns

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

Definition Classes
IterableOnceOps

def foreach[U](f: (A) => U): Unit

Применяет f к каждому элементу для получения побочных эффектов. Примечание: параметр [U] необходим для помощи в выводе типов scalac.

Definition Classes
IterableOnceOps

def formatted(fmtstr: String): String

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

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

def fromSpecific(coll: IterableOnce[A]): Iterable[A]

Определяет, как преобразовать заданный Iterable[A] в коллекцию типа C.

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

Атрибуты
protected
Определяющие классы
IterableFactoryDefaults → IterableOps
Примечание

При реализации пользовательского типа коллекции и уточнении C до нового типа, этот метод необходимо переопределить (в противном случае компилятор выдаст ошибку). В общем случае, где C =:= CC[A], это можно сделать, добавив трейт IterableFactoryDefaults, который реализует метод с использованием iterableFactory.

,

Как свидетельствует аннотация @uncheckedVariance, использование этого метода может быть небезопасным. Однако, до тех пор, пока он вызывается с Iterable[A], полученным из this коллекции (как это происходит в реализациях операций, где мы используем View[A]), он безопасен.

final def getClass(): Class[_ <: AnyRef]

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

возвращает

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

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

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

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

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

K

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

f

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

возвращает

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

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

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

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

def groupMap[K, B](key: (A) => K)(f: (A) => B): Map[K, Iterable[B]]

Разделяет эту итерируемую коллекцию на карту итерируемых коллекций в соответствии с функцией-дискриминатором key. Каждый элемент в группе преобразуется в значение типа B с помощью функции value.

Эквивалентно groupBy(key).mapValues(_.map(f)), но более эффективно.

case class User(name: String, age: Int)

def namesByAge(users: Seq[User]): Map[Int, Seq[String]] =
  users.groupMap(_.age)(_.name)

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

K

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

B

тип значений, возвращаемых функцией преобразования

key

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

f

функция преобразования элементов

Definition Classes
IterableOps

def groupMapReduce[K, B](key: (A) => K)(f: (A) => B)(reduce: (B, B) => B): Map[K, B]

Разделяет эту итерируемую коллекцию по функции-дискриминатору key. Все значения с одинаковым дискриминатором преобразуются функцией value и затем сводятся к одному значению с помощью функции reduce.

Эквивалентно groupBy(key).mapValues(_.map(f).reduce(reduce)), но более эффективно.

def occurrences[A](as: Seq[A]): Map[A, Int] =
  as.groupMapReduce(identity)(_ => 1)(_ + _)

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

Definition Classes
IterableOps

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

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

size

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

returns

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

Definition Classes
IterableOps
See also

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

def hashCode(): Int

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

returns

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

Definition Classes
AnyRef → Any
Annotations
@native()

def head: A

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

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

returns

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

Definition Classes
IterableOps
Исключения

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

def headOption: Option[A]

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

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

returns

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

Definition Classes
IterableOps

def init: Iterable[A]

Часть коллекции без последнего элемента.

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

Definition Classes
IterableOps

def inits: Iterator[Iterable[A]]

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

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

returns

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

Definition Classes
IterableOps
Пример:

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

def isEmpty: Boolean

Проверяет, пуста ли коллекция.

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

returns

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

Definition Classes
IterableOnceOps

final def isInstanceOf[T0]: Boolean

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

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

returns

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

Definition Classes
Any

def isTraversableAgain: Boolean

Проверяет, можно ли многократно перебирать эту итерируемую коллекцию. Всегда true для Iterables и false для Iterators, если не переопределено.

returns

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

Definition Classes
IterableOps → IterableOnceOps

def iterableFactory: IterableFactory[Iterable]

Компаньон-объект этой неизменяемой коллекции, предоставляющий различные методы фабрики.

Definition Classes
Iterable → Iterable → IterableOps
Note

При реализации пользовательского типа коллекции и уточнении CC до нового типа, этот метод необходимо переопределить, чтобы вернуть фабрику для нового типа (в противном случае компилятор выдаст ошибку).

def knownSize: Int

returns

Количество элементов в этой коллекции, если его можно вычислить без затрат, -1 в противном случае. Без затрат обычно означает: Не требует обхода коллекции.

Definition Classes
IterableOnce

def last: A

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

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

возвращает

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

Классы определений
IterableOps
Исключения

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

def lastOption: Option[A]

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

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

возвращает

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

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

def lazyZip[B](that: collection.Iterable[B]): LazyZip2[A, B, Iterable.this.type]

Аналогично zip, но элементы в каждом наборе не потребляются до вызова строгой операции над возвращенным LazyZip2 декоратором.

Вызовы lazyZip могут быть объединены для поддержки более высоких арностей (до 4) без расходов на создание и разрушение промежуточных кортежей.

val xs = List(1, 2, 3)
val res = (xs lazyZip xs lazyZip xs lazyZip xs).map((a, b, c, d) => a + b + c + d)
// res == List(4, 8, 12)
B

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

that

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

возвращает

декоратор LazyZip2, который позволяет выполнять строгие операции над лениво вычисляемыми парами или цепочками вызовов lazyZip. Также поддерживается неявное преобразование в Iterable[(A, B)].

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

def map[B](f: (A) => B): Iterable[B]

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

B

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

f

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

возвращает

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

Классы определений
IterableOps → IterableOnceOps
Примечание

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

def max[B >: A](implicit ord: math.Ordering[B]): A

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

B

Тип, по которому определено упорядочение.

ord

Упорядочение для сравнения элементов.

returns

наибольший элемент этого набора по отношению к порядку ord.

Definition Classes
IterableOnceOps
Exceptions thrown

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

def maxBy[B](f: (A) => B)(implicit cmp: math.Ordering[B]): A

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

B

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

f

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

cmp

Упорядочение для сравнения элементов.

returns

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

Definition Classes
IterableOnceOps
Exceptions thrown

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

def maxByOption[B](f: (A) => B)(implicit cmp: math.Ordering[B]): Option[A]

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

B

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

f

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

cmp

Упорядочение для сравнения элементов.

returns

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

Definition Classes
IterableOnceOps

def maxOption[B >: A](implicit ord: math.Ordering[B]): Option[A]

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

B

Тип, по которому определено упорядочение.

ord

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

returns

значение Option, содержащее наибольший элемент в этом наборе по заданному упорядочению ord.

Definition Classes
IterableOnceOps

def min[B >: A](implicit ord: math.Ordering[B]): A

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

B

Тип, по которому определено упорядочение.

ord

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

returns

наименьший элемент в этом наборе по заданному упорядочению ord.

Definition Classes
IterableOnceOps
Exceptions thrown

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

def minBy[B](f: (A) => B)(implicit cmp: math.Ordering[B]): A

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

B

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

f

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

cmp

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

returns

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

Definition Classes
IterableOnceOps
Exceptions thrown

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

def minByOption[B](f: (A) => B)(implicit cmp: math.Ordering[B]): Option[A]

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

B

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

f

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

cmp

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

returns

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

Definition Classes
IterableOnceOps

def minOption[B >: A](implicit ord: math.Ordering[B]): Option[A]

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

B

Тип, по которому определён порядок.

ord

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

returns

значение Option, содержащее наименьший элемент этого набора относительно порядка ord.

Definition Classes
IterableOnceOps

final def mkString: String

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

Делегирует addString, который можно переопределить.

returns

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

Definition Classes
IterableOnceOps
Annotations
@inline()

final def mkString(sep: String): String

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

Делегирует вызов addString, который может быть переопределен.

sep

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

returns

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

Definition Classes
IterableOnceOps
Annotations
@inline()
Пример:

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

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

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

Делегирует вызов addString, который может быть переопределен.

start

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

sep

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

end

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

returns

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

Definition Classes
IterableOnceOps
Пример:

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

final def ne(arg0: AnyRef): Boolean

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

returns

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

Definition Classes
AnyRef

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

возвращает

строгий билдер для того же типа коллекции. Обратите внимание, что в случае ленивых коллекций (например, View или immutable.LazyList), реализовать этот метод возможно, но полученный Builder нарушит ленивость. Вследствие этого, операции предпочтительно реализовывать с помощью fromSpecific вместо этого метода.

Атрибуты
protected
Определяющие классы
IterableFactoryDefaults → IterableOps
Примечание

При реализации пользовательского типа коллекции и уточнении C до нового типа, этот метод необходимо переопределить (в противном случае компилятор выдаст ошибку). В общем случае, где C =:= CC[A], это можно сделать, смешав в себе IterableFactoryDefaults, который реализует метод с использованием iterableFactory.

,

Как свидетельствует аннотация @uncheckedVariance, использование этого метода может быть небезопасным. Однако, до тех пор, пока возвращаемый билдер получает только значения A взятые из this экземпляра, он безопасен.

def nonEmpty: Boolean

Проверяет, не пуста ли коллекция.

возвращает

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

Определяющие классы
IterableOnceOps
Аннотации
@deprecatedOverriding("nonEmpty is defined as !isEmpty; override isEmpty instead", "2.13.0")

final def notify(): Unit

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

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

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

final def notifyAll(): Unit

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

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

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

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

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

Представленное здесь по умолчанию реализация требует двух проходов по коллекции. Строгие коллекции имеют переопределенную версию partition в StrictOptimizedIterableOps, которая требует только одного прохода.

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

def partitionMap[A1, A2](f: (A) => Either[A1, A2]): (Iterable[A1], Iterable[A2])

Применяет функцию f к каждому элементу итерируемой коллекции и возвращает пару итерируемых коллекций: первая состоит из значений, возвращенных f, которые были обернуты в scala.util.Left, а вторая — из значений, обернутых в scala.util.Right.

Пример:

val xs = Iterable(1, "one", 2, "two", 3, "three") partitionMap {
 case i: Int => Left(i)
 case s: String => Right(s)
}
// xs == (Iterable(1, 2, 3),
//        Iterable(one, two, three))
A1

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

A2

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

f

функция 'разделения', отображающая элементы этой итерируемой коллекции в scala.util.Either

returns

пара итерируемых коллекций: первая состоит из значений, возвращенных f, которые были обернуты в scala.util.Left, а вторая — из значений, обернутых в scala.util.Right.

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

def product[B >: A](implicit num: math.Numeric[B]): B

Перемножает элементы этой коллекции.

B

тип результата операции *.

num

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

returns

произведение всех элементов этой коллекции относительно операции * в num.

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

def reduce[B >: A](op: (B, B) => B): B

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

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

B

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

op

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

returns

Результат применения оператора reduce op ко всем элементам, если набор не пустой.

Definition Classes
IterableOnceOps
Исключения

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
IterableOnceOps
Исключения

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

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

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

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

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

B

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

op

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

returns

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

Definition Classes
IterableOnceOps

def reduceOption[B >: A](op: (B, B) => B): Option[B]

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

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

B

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

op

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

returns

Значение типа Option, содержащее результат применения оператора reduce к op между всеми элементами, если коллекция непуста, и None в противном случае.

Definition Classes
IterableOnceOps

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

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

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

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

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

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

B

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

op

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

returns

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

Definition Classes
IterableOnceOps

def reversed: collection.Iterable[A]

Attributes
protected
Definition Classes
IterableOnceOps

def scan[B >: A](z: B)(op: (B, B) => B): Iterable[B]

Вычисляет префиксную сумму элементов коллекции.

Примечание: Нейтральный элемент z может быть применён более одного раза.

B

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

z

нейтральный элемент для оператора op

op

ассоциативный оператор для сканирования

returns

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

Definition Classes
IterableOps

def scanLeft[B](z: B)(op: (B, A) => B): Iterable[B]

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

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

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

B

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

z

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

op

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

returns

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

Definition Classes
IterableOps → IterableOnceOps
Note

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

def scanRight[B](z: B)(op: (A, B) => B): Iterable[B]

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

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

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

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

Пример:

List(1, 2, 3, 4).scanRight(0)(_ + _) == List(10, 9, 7, 4, 0)
B

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

z

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

op

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

returns

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

Definition Classes
IterableOps

def size: Int

Размер этой коллекции.

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

returns

количество элементов в этой коллекции.

Definition Classes
IterableOnceOps

def sizeCompare(that: collection.Iterable[_]): Int

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

that

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

returns

Значение x где

x <  0       if this.size <  that.size
x == 0       if this.size == that.size
x >  0       if this.size >  that.size

Реализация метода не вызывает size напрямую; её время выполнения равно O(this.size min that.size) вместо O(this.size + that.size). Метод следует переопределять, если вычисление size является дешёвым, и knownSize возвращает -1.

Definition Classes
IterableOps

def sizeCompare(otherSize: Int): Int

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

otherSize

значение теста, которое сравнивается с размером.

returns

Значение x где

x <  0       if this.size <  otherSize
x == 0       if this.size == otherSize
x >  0       if this.size >  otherSize

Реализация метода не вызывает size напрямую; её время выполнения равно O(size min otherSize) вместо O(size). Метод следует переопределять, если вычисление size является дешёвым, и knownSize возвращает -1.

Definition Classes
IterableOps
See also

sizeIs

final def sizeIs: SizeCompareOps

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

Эти операции реализованы с использованием sizeCompare(Int) и позволяют использовать более удобочитаемые варианты:

this.sizeIs < size     // this.sizeCompare(size) < 0
this.sizeIs <= size    // this.sizeCompare(size) <= 0
this.sizeIs == size    // this.sizeCompare(size) == 0
this.sizeIs != size    // this.sizeCompare(size) != 0
this.sizeIs >= size    // this.sizeCompare(size) >= 0
this.sizeIs > size     // this.sizeCompare(size) > 0
Классы-определения
IterableOps
Аннотации
@inline()

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

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

from <= indexOf(x) < until

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

from

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

until

наименьший индекс для исключения из этого итерируемого набора.

returns

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

Классы-определения
IterableOps → IterableOnceOps
Примечание

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

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

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

size

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

step

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

returns

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

Классы-определения
IterableOps
См. также

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

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

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

size

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

returns

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

Definition Classes
IterableOps
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 не вызывает побочных эффектов.

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

p

предикат проверки

returns

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

Definition Classes
IterableOps → IterableOnceOps
Note

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

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

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

Примечание: c splitAt n эквивалентно (но, возможно, более эффективно, чем) (c take n, c drop n).

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

n

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

returns

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

Definition Classes
IterableOps → IterableOnceOps
Note

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

def stepper[S <: Stepper[_]](implicit shape: StepperShape[A, S]): S

Возвращает Stepper для элементов этого набора.

Stepper позволяет создать поток Java для обработки набора, см. scala.jdk.StreamConverters. Для наборов, содержащих примитивные значения, Stepper может использоваться как итератор, который не упаковывает элементы.

Неявный параметр StepperShape определяет тип возвращаемого Stepper в соответствии с типом элементов этого набора.

    Для наборов Int, Short, Byte или Char, возвращается IntStepper. Для наборов Double или Float, возвращается DoubleStepper. Для наборов Long, возвращается LongStepper. Для любого другого типа элементов возвращается AnyStepper.

Обратите внимание, что этот метод переопределяется в подклассах, а тип возвращаемого значения уточняется до S with EfficientSplit, например, IndexedSeqOps.stepper. Для Steppers, помеченных scala.collection.Stepper.EfficientSplit, преобразователи в scala.jdk.StreamConverters позволяют создавать параллельные потоки, тогда как обычные Steppers могут быть преобразованы только в последовательные потоки.

Definition Classes
IterableOnce

def stringPrefix: String

Attributes
protected[this]
Definition Classes
Iterable
Annotations
@deprecatedOverriding("Override className instead", "2.13.0")

def sum[B >: A](implicit num: math.Numeric[B]): B

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

B

тип результата операции +.

num

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

returns

сумма всех элементов этого набора относительно оператора + в num.

Definition Classes
IterableOnceOps

final def synchronized[T0](arg0: => T0): T0

Definition Classes
AnyRef

def tail: Iterable[A]

Остальная часть коллекции без первого элемента.

Definition Classes
IterableOps

def tails: Iterator[Iterable[A]]

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

returns

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

Definition Classes
IterableOps
Пример:

    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
IterableOps → IterableOnceOps
Note

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

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

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

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

n

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

returns

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

Definition Classes
IterableOps

def takeWhile(p: (A) => Boolean): Iterable[A]

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

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

p

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

returns

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

Definition Classes
IterableOps → IterableOnceOps

def tapEach[U](f: (A) => U): Iterable[A]

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

U

тип возвращаемого значения f

f

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

returns

Такая же логическая коллекция, как и эта

Definition Classes
IterableOps → IterableOnceOps

def to[C1](factory: Factory[A, C1]): C1

Используя фабрику коллекций factory, преобразует эту коллекцию в соответствующее представление для текущего типа элемента A. Примеры использования:

xs.to(List) xs.to(ArrayBuffer) xs.to(BitSet) // для xs: Iterable[Int]

Definition Classes
IterableOnceOps

def toArray[B >: A](implicit arg0: ClassTag[B]): Array[B]

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

Definition Classes
IterableOnceOps

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

Definition Classes
IterableOnceOps
Annotations
@inline()

def toIndexedSeq: IndexedSeq[A]

Definition Classes
IterableOnceOps

final def toIterable: Iterable.this.type

возвращает

Это коллекция как Iterable[A]. Новый объект не будет создан, если this уже является Iterable[A].

Definition Classes
Iterable → IterableOps

def toList: List[A]

Definition Classes
IterableOnceOps

def toMap[K, V](implicit ev: <:<[A, (K, V)]): Map[K, V]

Definition Classes
IterableOnceOps

def toSeq: Seq[A]

возвращает

Эта коллекция как Seq[A]. Это эквивалентно to(Seq), но может быть быстрее.

Definition Classes
IterableOnceOps

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

Definition Classes
IterableOnceOps

def toString(): String

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

returns

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

Definition Classes
Iterable → AnyRef → Any

def toVector: Vector[A]

Definition Classes
IterableOnceOps

def transpose[B](implicit asIterable: (A) => collection.Iterable[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

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

asIterable

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

returns

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

Definition Classes
IterableOps
Exceptions thrown

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

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

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

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

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

A2

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

asPair

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

returns

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

Definition Classes
IterableOps

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

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

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

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

A2

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

A3

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

asTriple

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

returns

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

Definition Classes
IterableOps

def view: View[A]

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

Definition Classes
IterableOps

final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])

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

Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])

final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException]) @native()

def withFilter(p: (A) => Boolean): WithFilter[A, [_]Iterable[_]]

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

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

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

p

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

returns

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

Definition Classes
IterableOps

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

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

B

тип второй половины возвращаемых пар

that

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

returns

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

Definition Classes
IterableOps

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

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

that

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

thisElem

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

thatElem

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

returns

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

Definition Classes
IterableOps

def zipWithIndex: Iterable[(A, Int)]

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

returns

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

Definition Classes
IterableOps → IterableOnceOps
Пример:

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

Note

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

© 2002-2019 EPFL, with contributions from Lightbend.
Licensed under the Apache License, Version 2.0.
https://www.scala-lang.org/api/2.13.0/scala/collection/immutable/Iterable.html

Spec-Zone.ru

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