Spec-Zone.ru › Scala 2.13 Library

Тракт scala.collection.Iterable

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

тракт Iterable[+A] extends IterableOnce[A] with IterableOps[A, Iterable, Iterable[A]] with IterableFactoryDefaults[A, Iterable]

Базовый тракт для обобщенных коллекций.

A

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

Источник
Iterable.scala
Линейные супертипы
IterableFactoryDefaults[A, Iterable], IterableOps[A, Iterable, Iterable[A]], IterableOnceOps[A, Iterable, Iterable[A]], IterableOnce[A], AnyRef, Any
Известные подклассы
ValueSet, AbstractIndexedSeqView, AbstractIterable, AbstractMap, AbstractMapView, AbstractSeq, AbstractSeqView, AbstractSet, AbstractView, BitSet, IndexedSeq, IndexedSeqView, Appended, Concat, Drop, DropRight, Id, Map, Prepended, Reverse, Slice, Take, TakeRight, LinearSeq, Map, KeySet, MapView, Filter, FilterKeys, Id, MapValues, TapEach, Seq, SeqMap, SeqView, Appended, Concat, Drop, DropRight, Id, Map, Prepended, Reverse, Sorted, Take, TakeRight, Set, SortedMap, KeySortedSet, SortedSet, StringView, View, Appended, Collect, Concat, DistinctBy, Drop, DropRight, DropWhile, Elems, Empty, Fill, Filter, FlatMap, Iterate, LeftPartitionMapped, Map, PadTo, Prepended, RightPartitionMapped, ScanLeft, Single, Tabulate, Take, TakeRight, TakeWhile, Unfold, Updated, Zip, ZipAll, ZipWithIndex, Map, TrieMap, ::, AbstractMap, AbstractSeq, AbstractSet, ArraySeq, ofBoolean,
ofByte, ofChar, ofDouble, ofFloat, ofInt, ofLong, ofRef, ofShort, ofUnit, BitSet, HashMap, HashSet, IndexedSeq, IntMap, Iterable, LazyList, LinearSeq, List, ListMap, ListSet, Узел, LongMap, Map, Map1, Map2, Map3, Map4, С дефолтным значением, Неизменяемый набор ключей, Nil, Числовой диапазон, Исключающий, Включающий, Очередь, Диапазон, Исключающий, Включающий, Последовательность, SeqMap, Множество, Set1, Set2, Set3, Set4, Отсортированное отображение, С дефолтным значением, Неизменяемый набор отсортированных ключей, Отсортированное множество, Cons, Пустой, TreeMap, TreeSeqMap, TreeSet, Вектор, VectorMap, Обёрнутая строка, Абстрактный буфер, Абстрактная итерируемая структура, Абстрактная карта, Абстрактная последовательность, Абстрактное множество, AnyRefMap, Массивный буфер, Просмотр массива, Двусторонняя очередь, Массивный последовательность, ofBoolean, ofByte, ofChar, ofDouble, ofFloat, ofInt, ofLong, ofRef, ofShort, ofUnit, BitSet, Буфер,
CollisionProofHashMap, HashMap, HashSet, IndexedBuffer, IndexedSeq, Iterable, LinkedHashMap, LinkedKeySet, LinkedHashSet, ListBuffer, LongMap, Map, WithDefault, MultiMap, PriorityQueue, Queue, Seq, SeqMap, Set, SortedMap, WithDefault, SortedSet, Stack, StringBuilder, TreeMap, TreeSet, UnrolledBuffer, Accumulator, AnyAccumulator, DoubleAccumulator, IntAccumulator, LongAccumulator, SystemProperties, DefaultMap, BitSet1, BitSet2, BitSetN, Stream, ListMap, OpenHashMap

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

abstract def iterator: Iterator[A]

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

Definition Classes
IterableOnce

Члены-значения

final def !=(arg0: Any): Boolean

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

возвращает

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

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

final def ##(): Int

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

возвращает

значение хеша, соответствующее ==

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

def +(other: String): String

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

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

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

Определяющие классы
IterableOps
Аннотации
@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, в который были добавлены элементы.

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

final def asInstanceOf[T0]: T0

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

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

returns

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

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

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

def className: String

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

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

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

returns

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

Атрибуты
protected[this]

def clone(): AnyRef

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

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

returns

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

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

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

final def coll: Iterable.this.type

returns

Эта коллекция как C.

Атрибуты
protected
Классы определения
Iterable → IterableOps

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

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

B

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

pf

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

returns

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

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

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

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

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

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

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

pf

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

returns

значение типа 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.

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

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

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

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

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

B

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

xs

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

start

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

len

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

returns

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

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

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

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

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

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

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

B

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

xs

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

start

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

returns

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

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

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

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

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

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

B

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

xs

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

returns

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

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

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

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

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

p

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

returns

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

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

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

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

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

n

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

returns

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

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

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

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

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

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

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

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

final def eq(arg0: AnyRef): Boolean

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

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

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

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

returns

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

Definition Classes
AnyRef

def equals(arg0: AnyRef): Boolean

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

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

returns

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

Definition Classes
AnyRef → Any

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

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

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

p

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

returns

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

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

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

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

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

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

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

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

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

A1

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

z

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

op

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

returns

результат применения оператора сворачивания op ко всем элементам и z, или z, если эта коллекция пуста.

Определяющие классы
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, если эта коллекция пуста.

Определяющие классы
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, если эта коллекция пуста.

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

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

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

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

p

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

returns

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

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

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

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

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

def formatted(fmtstr: String): String

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

Неявный
Этот член добавляется неявным преобразованием из Iterable[A] в StringFormat[Iterable[A]] с помощью метода StringFormat в scala.Predef.
Определяющие классы
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): immutable.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): immutable.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

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

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

def groupMapReduce[K, B](key: (A) => K)(f: (A) => B)(reduce: (B, B) => B): immutable.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)(_ + _)

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

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

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

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

размер

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

возвращает

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

Определяющие классы
IterableOps
См. также

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

def hashCode(): Int

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

возвращает

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

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

def head: A

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

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

возвращает

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

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

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

def headOption: Option[A]

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

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

возвращает

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

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

def init: Iterable[A]

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

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

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

def inits: Iterator[Iterable[A]]

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

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

возвращает

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

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

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

def isEmpty: Boolean

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

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

возвращает

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

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

final def isInstanceOf[T0]: Boolean

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

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

возвращает

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

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

def isTraversableAgain: Boolean

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

возвращает

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

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

def iterableFactory: IterableFactory[Iterable]

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

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

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

def knownSize: Int

возвращает

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

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

def last: A

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

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

возвращает

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

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

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

def lastOption: Option[A]

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

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

возвращает

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

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

def lazyZip[B](that: 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)].

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

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

возвращает

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

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

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

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

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

B

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

f

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

cmp

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

возвращает

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

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

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

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

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

B

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

f

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

cmp

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

возвращает

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

Классы определений
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: scala.math.Ordering[B]): A

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

B

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

ord

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

returns

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

Definition Classes
IterableOnceOps
Exceptions thrown

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

def minBy[B](f: (A) => B)(implicit cmp: scala.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: scala.math.Ordering[B]): scala.Option[A]

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

B

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

f

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

cmp

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

returns

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

Definition Classes
IterableOnceOps

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

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

B

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

ord

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

returns

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

Definition Classes
IterableOnceOps

final def mkString: String

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

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

returns

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

Definition Classes
IterableOnceOps
Annotations
@scala.inline()

final def mkString(sep: String): String

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

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

sep

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

returns

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

Definition Classes
IterableOnceOps
Annotations
@scala.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]]

returns

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

Attributes
protected
Definition Classes
IterableFactoryDefaults → IterableOps
Note

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

,

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

def nonEmpty: Boolean

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

returns

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

Definition Classes
IterableOnceOps
Annotations
@deprecatedOverriding("nonEmpty is defined as !isEmpty; override isEmpty instead", "2.13.0")

final def notify(): Unit

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

Definition Classes
AnyRef
Annotations
@native()
Note

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

final def notifyAll(): Unit

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

Definition Classes
AnyRef
Annotations
@native()
Note

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

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

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

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

Definition Classes
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.

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

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

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

Определяющие классы
IterableOnceOps
Выбрасываемые исключения

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

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

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

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

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

B

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

op

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

returns

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

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

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

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

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

B

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

op

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

returns

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

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

Определяющие классы
IterableOnceOps
Выбрасываемые исключения

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

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

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

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

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

B

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

op

бинарная операция.

returns

объект Option, содержащий результат операции, если коллекция не пуста, иначе None.

Definition Classes
IterableOnceOps

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

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

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

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

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: Iterable[_]): Int

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

that

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

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
Definition Classes
IterableOps
Annotations
@inline()

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

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

from <= indexOf(x) < until

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

from

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

until

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

returns

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

Definition Classes
IterableOps → IterableOnceOps
Note

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

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

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

size

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

step

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

returns

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

Definition Classes
IterableOps
See also

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

позиция, в которой нужно разделить.

возвращает

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

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

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

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. Для Stepper, помеченных как scala.collection.Stepper.EfficientSplit, преобразователи в scala.jdk.StreamConverters позволяют создавать параллельные потоки, в то время как простые Stepper можно преобразовать только в последовательные потоки.

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

def stringPrefix: String

Атрибуты
protected[this]
Аннотации
@deprecatedOverriding("Override className instead", "2.13.0")

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

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

B

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

num

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

возвращает

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

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

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

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

def tail: Iterable[A]

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

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

def tails: Iterator[Iterable[A]]

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

возвращает

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

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

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

возвращает

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

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

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

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 к своим элементам немедленно, тогда как ленивые коллекции, такие как Views и 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: immutable.IndexedSeq[A]

Definition Classes
IterableOnceOps

final def toIterable: Iterable.this.type

returns

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

Definition Classes
Iterable → IterableOps

def toList: immutable.List[A]

Definition Classes
IterableOnceOps

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

Definition Classes
IterableOnceOps

def toSeq: immutable.Seq[A]

returns

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

Definition Classes
IterableOnceOps

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

Definition Classes
IterableOnceOps

def toString(): String

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

returns

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

Definition Classes
Iterable → AnyRef → Any

def toVector: immutable.Vector[A]

Definition Classes
IterableOnceOps

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

Spec-Zone.ru

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